org.everrest.core.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 Summary

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

Method Detail

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:

org.everrest.core.wadl.research.Resource.Resource describes application resource, each resource identified by a URI

createResource

Resource createResource(String path)

Parameters:

path - resource relative path

Returns:

org.everrest.core.wadl.research.Resource.Resource describes application resource, each resource identified by a URI

createMethod

Method createMethod(ResourceMethodDescriptor md)

Parameters:

md - See ResourceMethodDescriptor

Returns:

org.everrest.core.rest.wadl.research.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:

org.everrest.core.wadl.research.Method}

createResponse

Response createResponse()

Returns:

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

See Also:

org.everrest.core.wadl.research.Method}

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:

Resource, Request, Response