Package org.exoplatform.services.rest.wadl

Class BaseWadlGeneratorImpl

java.lang.Object

org.exoplatform.services.rest.wadl.BaseWadlGeneratorImpl

All Implemented Interfaces:

WadlGenerator

public class BaseWadlGeneratorImpl
extends Object
implements WadlGenerator

Base implementation of WadlGenerator. This implementation does not provide doc and grammar extension of WADL.

Version:

$Id: $

Author:

Andrey Parfonov

Constructor Summary

Constructors

Constructor	Description
BaseWadlGeneratorImpl()

Method Summary

Modifier and Type	Method	Description
Application	createApplication()
Method	createMethod(ResourceMethodDescriptor rmd)
Param	createParam(MethodParameter methodParameter)
Request	createRequest()
RepresentationType	createRequestRepresentation(javax.ws.rs.core.MediaType mediaType)
Resource	createResource(String path)
Resource	createResource(AbstractResourceDescriptor rd)
Resources	createResources()
Response	createResponse()
RepresentationType	createResponseRepresentation(javax.ws.rs.core.MediaType mediaType)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

BaseWadlGeneratorImpl

public BaseWadlGeneratorImpl()

Method Details

createApplication

public Application createApplication()

Specified by:

createApplication in interface WadlGenerator

Returns:

Application instance, it is root element in WADL

createResources

public Resources createResources()

Specified by:

createResources in interface WadlGenerator

Returns:

Resources instance. Element resources in WADL document is container for the descriptions of resources provided by application

createResource

public Resource createResource(AbstractResourceDescriptor rd)

Specified by:

createResource in interface WadlGenerator

Parameters:

rd - See AbstractResourceDescriptor

Returns:

Resource describes application resource, each resource identified by a URI

createResource

public Resource createResource(String path)

Specified by:

createResource in interface WadlGenerator

Parameters:

path - resource relative path

Returns:

Resource describes application resource, each resource identified by a URI

createMethod

public Method createMethod(ResourceMethodDescriptor rmd)

Specified by:

createMethod in interface WadlGenerator

Parameters:

rmd - See ResourceMethodDescriptor

Returns:

Method describes the input to and output from an HTTP protocol method they may be applied to a resource

createRequest

public Request createRequest()

Specified by:

createRequest in interface WadlGenerator

Returns:

Request describes the input to be included when applying an HTTP method to a resource

See Also:

• Method

createResponse

public Response createResponse()

Specified by:

createResponse in interface WadlGenerator

Returns:

Response describes the output that result from performing an HTTP method on a resource

See Also:

• Method

createRequestRepresentation

public RepresentationType createRequestRepresentation(javax.ws.rs.core.MediaType mediaType)

Specified by:

createRequestRepresentation in interface WadlGenerator

Parameters:

mediaType - one of media type that resource can consume

Returns:

RepresentationType describes a representation of resource's state

createResponseRepresentation

public RepresentationType createResponseRepresentation(javax.ws.rs.core.MediaType mediaType)

Specified by:

createResponseRepresentation in interface WadlGenerator

Parameters:

mediaType - one of media type that resource can produce

Returns:

RepresentationType describes a representation of resource's state

createParam

public Param createParam(MethodParameter methodParameter)

Specified by:

createParam in interface WadlGenerator

Parameters:

methodParameter - See MethodParameter

Returns:

Param describes a parameterized component of its parent element resource, request, response

See Also:

• Resource
• Request
• Response