Package org.glassfish.jersey.server.wadl.internal

Class WadlBuilder

java.lang.Object

org.glassfish.jersey.server.wadl.internal.WadlBuilder

public class WadlBuilder
extends java.lang.Object

This class implements the algorithm how the wadl is built for one or more Resource classes. Wadl artifacts are created by a WadlGenerator. Created on: Jun 18, 2008

Field Summary

Fields

Modifier and Type	Field	Description
private WadlGenerator	_wadlGenerator
private boolean	detailedWadl
private javax.ws.rs.core.UriInfo	uriInfo

Constructor Summary

Constructors

Constructor	Description
WadlBuilder(WadlGenerator wadlGenerator, boolean detailedWadl, javax.ws.rs.core.UriInfo uriInfo)

Method Summary

Modifier and Type	Method	Description
private void	addHint(Application wadlApplication)
private void	addVersion(Application wadlApplication)
ApplicationDescription	generate(java.util.List<Resource> resources)	Generate WADL for a set of resources.
Application	generate(ApplicationDescription description, Resource resource)	Generate WADL for a resource.
private Method	generateMethod(Resource parentResource, java.util.Map<java.lang.String,Param> wadlResourceParams, ResourceMethod resourceMethod)
private Param	generateParam(Resource resource, ResourceMethod method, Parameter param)
private Request	generateRequest(Resource parentResource, ResourceMethod resourceMethod, java.util.Map<java.lang.String,Param> wadlResourceParams)
private Resource	generateResource(Resource r, java.lang.String path)
private Resource	generateResource(Resource resource, java.lang.String path, java.util.Set<Resource> visitedResources)
private java.util.List<Response>	generateResponses(Resource r, ResourceMethod m)
private Param	getParamByName(java.util.List<Param> params, java.lang.String name)
private Representation	getRepresentationByMediaType(java.util.List<Representation> representations, javax.ws.rs.core.MediaType mediaType)
private void	processRequestParameters(Resource parentResource, ResourceMethod resourceMethod, java.util.Map<java.lang.String,Param> wadlResourceParams, java.util.Collection<Parameter> requestParameters, Request wadlRequest)	Recursively processes provided request parameters and adds the resulting WADL information into the WADL request.
private Representation	setRepresentationForMediaType(Resource r, ResourceMethod m, javax.ws.rs.core.MediaType mediaType, Request wadlRequest)	Create the wadl Representation for the specified MediaType if not yet existing for the wadl Request and return it.

Methods inherited from class java.lang.Object

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

Field Detail

_wadlGenerator

private final WadlGenerator _wadlGenerator

uriInfo

private final javax.ws.rs.core.UriInfo uriInfo

detailedWadl

private final boolean detailedWadl

Constructor Detail

WadlBuilder

public WadlBuilder(WadlGenerator wadlGenerator,
                   boolean detailedWadl,
                   javax.ws.rs.core.UriInfo uriInfo)

Method Detail

generate

public ApplicationDescription generate(java.util.List<Resource> resources)

Generate WADL for a set of resources.

Parameters:

resources - the set of resources.

Returns:

the JAXB WADL application bean.

generate

public Application generate(ApplicationDescription description,
                            Resource resource)

Generate WADL for a resource.

Parameters:

resource - the resource

description - the overall application description so we can

Returns:

the JAXB WADL application bean

addVersion

private void addVersion(Application wadlApplication)

addHint

private void addHint(Application wadlApplication)

generateMethod

private Method generateMethod(Resource parentResource,
                              java.util.Map<java.lang.String,Param> wadlResourceParams,
                              ResourceMethod resourceMethod)

generateRequest

private Request generateRequest(Resource parentResource,
                                ResourceMethod resourceMethod,
                                java.util.Map<java.lang.String,Param> wadlResourceParams)

processRequestParameters

private void processRequestParameters(Resource parentResource,
                                      ResourceMethod resourceMethod,
                                      java.util.Map<java.lang.String,Param> wadlResourceParams,
                                      java.util.Collection<Parameter> requestParameters,
                                      Request wadlRequest)

Recursively processes provided request parameters and adds the resulting WADL information into the WADL request.

getParamByName

private Param getParamByName(java.util.List<Param> params,
                             java.lang.String name)

setRepresentationForMediaType

private Representation setRepresentationForMediaType(Resource r,
                                                     ResourceMethod m,
                                                     javax.ws.rs.core.MediaType mediaType,
                                                     Request wadlRequest)

Create the wadl Representation for the specified MediaType if not yet existing for the wadl Request and return it.

Parameters:

r - the resource

m - the resource method

mediaType - an accepted media type of the resource method

wadlRequest - the wadl request the wadl representation is to be created for (if not yet existing).

Returns:

the wadl request representation for the specified MediaType.

getRepresentationByMediaType

private Representation getRepresentationByMediaType(java.util.List<Representation> representations,
                                                    javax.ws.rs.core.MediaType mediaType)

generateParam

private Param generateParam(Resource resource,
                            ResourceMethod method,
                            Parameter param)

generateResource

private Resource generateResource(Resource r,
                                  java.lang.String path)

generateResource

private Resource generateResource(Resource resource,
                                  java.lang.String path,
                                  java.util.Set<Resource> visitedResources)

generateResponses

private java.util.List<Response> generateResponses(Resource r,
                                                   ResourceMethod m)