Package org.exoplatform.services.rest.wadl

Interface WadlGenerator

All Known Implementing Classes:
BaseWadlGeneratorImpl
public interface WadlGenerator
A WadGenerator creates structure that can be reflected to WADL representation.
Version:
$Id: $
Author:
Andrey Parfonov

  • Method Details

    • createApplication

      Application createApplication()
      Returns:
      Application instance, it is root element in WADL

    • createResources

      Resources createResources()
      Returns:
      Resources instance. Element resources in WADL document is container for the descriptions of resources provided by application

    • createResource

      Resource createResource(AbstractResourceDescriptor rd)
      Parameters:
      rd - See AbstractResourceDescriptor
      Returns:
      Resource describes application resource, each resource identified by a URI

    • createResource

      Resource createResource(String path)
      Parameters:
      path - resource relative path
      Returns:
      Resource describes application resource, each resource identified by a URI

    • createMethod

      Method createMethod(ResourceMethodDescriptor md)
      Parameters:
      md - See ResourceMethodDescriptor
      Returns:
      Method describes the input to and output from an HTTP protocol method they may be applied to a resource

    • createRequest

      Request createRequest()
      Returns:
      Request describes the input to be included when applying an HTTP method to a resource
      See Also:

    • createResponse

      Response createResponse()
      Returns:
      Response describes the output that result from performing an HTTP method on a resource
      See Also:

    • createRequestRepresentation

      RepresentationType createRequestRepresentation(javax.ws.rs.core.MediaType mediaType)
      Parameters:
      mediaType - one of media type that resource can consume
      Returns:
      RepresentationType describes a representation of resource's state

    • createResponseRepresentation

      RepresentationType createResponseRepresentation(javax.ws.rs.core.MediaType mediaType)
      Parameters:
      mediaType - one of media type that resource can produce
      Returns:
      RepresentationType describes a representation of resource's state

    • createParam

      Param createParam(MethodParameter methodParameter)
      Parameters:
      methodParameter - See MethodParameter
      Returns:
      Param describes a parameterized component of its parent element resource, request, response
      See Also: