com.sun.jersey.server.wadl.generators

Class AbstractWadlGeneratorGrammarGenerator<T>

java.lang.Object

com.sun.jersey.server.wadl.generators.AbstractWadlGeneratorGrammarGenerator<T>

All Implemented Interfaces:

WadlGenerator

Direct Known Subclasses:

WadlGeneratorJAXBGrammarGenerator, WadlGeneratorJSONGrammarGenerator

public abstract class AbstractWadlGeneratorGrammarGenerator<T>
extends Object
implements WadlGenerator

This WadlGenerator generates a grammar based on the referenced elements. This is a template class designed to be overridden by specific implementations, for example XML Schema and JSON Schema

Created on: Sept 17, 2012

Version:

$Id: AbstractWadlGeneratorGrammarGenerator.java $

Author:

Gerard Davison

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static interface	AbstractWadlGeneratorGrammarGenerator.HasType
protected class	AbstractWadlGeneratorGrammarGenerator.Pair
protected static interface	AbstractWadlGeneratorGrammarGenerator.WantsName<T>

Nested classes/interfaces inherited from interface com.sun.jersey.server.wadl.WadlGenerator

WadlGenerator.ExternalGrammarDefinition, WadlGenerator.Resolver

Field Summary

Fields

Modifier and Type	Field and Description
protected List<AbstractWadlGeneratorGrammarGenerator.Pair>	_hasTypeWantsName
protected Class<T>	_resolvedType
protected URI	_root
protected Set<Class>	_seeAlso
protected URI	_wadl
static Set<Class>	SPECIAL_GENERIC_TYPES

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractWadlGeneratorGrammarGenerator(WadlGenerator delegate, Class<T> resolvedType)

Method Summary

Modifier and Type	Method and Description
abstract boolean	acceptMediaType(javax.ws.rs.core.MediaType type)
void	attachTypes(ApplicationDescription introspector) Process the elements in the WADL definition to attach schema types as required.
protected abstract WadlGenerator.Resolver	buildModelAndSchemas(Map<String,ApplicationDescription.ExternalGrammar> extraFiles) Build the the external schema files and generate a suitable resolver
Application	createApplication(javax.ws.rs.core.UriInfo requestInfo)
WadlGenerator.ExternalGrammarDefinition	createExternalGrammar() Perform any post create functions such as generating grammars.
Method	createMethod(AbstractResource ar, AbstractResourceMethod arm)
Param	createParam(AbstractResource ar, AbstractMethod am, Parameter p)
protected abstract AbstractWadlGeneratorGrammarGenerator.WantsName<T>	createParmWantsName(Param param)
protected abstract AbstractWadlGeneratorGrammarGenerator.WantsName<T>	createRepresentationWantsName(Representation rt)
Request	createRequest(AbstractResource ar, AbstractResourceMethod arm)
Representation	createRequestRepresentation(AbstractResource ar, AbstractResourceMethod arm, javax.ws.rs.core.MediaType mt)
Resource	createResource(AbstractResource ar, String path)
Resources	createResources()
List<Response>	createResponses(AbstractResource ar, AbstractResourceMethod arm)
String	getRequiredJaxbContextPath() The jaxb context path that is used when the generated wadl application is marshalled to a file. This method is used in a decorator like manner. The result return the path (or a colon-separated list of package names) containing jaxb-beans that are added to wadl elements by this WadlGenerator, additionally to the context path of the decorated WadlGenerator (set by WadlGenerator.setWadlGeneratorDelegate(WadlGenerator). If you do not use custom jaxb beans, then simply return _delegate.getRequiredJaxbContextPath(), otherwise return the delegate's WadlGenerator.getRequiredJaxbContextPath() together with your required context path (separated by a colon):
void	init() Invoked before all methods related to wadl-building are invoked.
protected static AbstractWadlGeneratorGrammarGenerator.HasType	parameter(Parameter param, javax.ws.rs.core.MediaType mt)
void	setWadlGeneratorDelegate(WadlGenerator delegate) Sets the delegate that is decorated by this wadl generator.

Methods inherited from class java.lang.Object

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

Field Detail

SPECIAL_GENERIC_TYPES

public static final Set<Class> SPECIAL_GENERIC_TYPES

_seeAlso

protected Set<Class> _seeAlso

_hasTypeWantsName

protected List<AbstractWadlGeneratorGrammarGenerator.Pair> _hasTypeWantsName

_root

protected URI _root

_wadl

protected URI _wadl

_resolvedType

protected Class<T> _resolvedType

Constructor Detail

AbstractWadlGeneratorGrammarGenerator

protected AbstractWadlGeneratorGrammarGenerator(WadlGenerator delegate,
                                                Class<T> resolvedType)

Method Detail

parameter

protected static AbstractWadlGeneratorGrammarGenerator.HasType parameter(Parameter param,
                                                                         javax.ws.rs.core.MediaType mt)

Parameters:

param - parameter.

Returns:

An adapter for Parameter

setWadlGeneratorDelegate

public void setWadlGeneratorDelegate(WadlGenerator delegate)

Description copied from interface: WadlGenerator

Sets the delegate that is decorated by this wadl generator. Is invoked directly after this generator is instantiated before WadlGenerator.init() or any setter method is invoked.

Specified by:

setWadlGeneratorDelegate in interface WadlGenerator

Parameters:

delegate - the wadl generator to decorate

getRequiredJaxbContextPath

public String getRequiredJaxbContextPath()

Description copied from interface: WadlGenerator

The jaxb context path that is used when the generated wadl application is marshalled to a file.
This method is used in a decorator like manner.
The result return the path (or a colon-separated list of package names) containing jaxb-beans that are added to wadl elements by this WadlGenerator, additionally to the context path of the decorated WadlGenerator (set by WadlGenerator.setWadlGeneratorDelegate(WadlGenerator).
If you do not use custom jaxb beans, then simply return _delegate.getRequiredJaxbContextPath(), otherwise return the delegate's WadlGenerator.getRequiredJaxbContextPath() together with your required context path (separated by a colon):

_delegate.getRequiredJaxbContextPath() == null
     ? ${yourContextPath}
     : _delegate.getRequiredJaxbContextPath() + ":" + ${yourContextPath};

If you add the path for your custom jaxb beans, don't forget to add an ObjectFactory (annotated with XmlRegistry) to this package.

Specified by:

getRequiredJaxbContextPath in interface WadlGenerator

Returns:

simply the WadlGenerator.getRequiredJaxbContextPath() of the delegate or the WadlGenerator.getRequiredJaxbContextPath() + ":" + ${yourContextPath}.

init

public void init()
          throws Exception

Description copied from interface: WadlGenerator

Invoked before all methods related to wadl-building are invoked. This method is used in a decorator like manner, and therefore has to invoke this.delegate.init().

Specified by:

init in interface WadlGenerator

Throws:

Exception

acceptMediaType

public abstract boolean acceptMediaType(javax.ws.rs.core.MediaType type)

Parameters:

type -

Returns:

Whether we want to acceptMediaType this element, for example the grammar generator wouldn't necessarily want to selector for JAX-B or vice versa.

createApplication

public Application createApplication(javax.ws.rs.core.UriInfo requestInfo)

Specified by:

createApplication in interface WadlGenerator

Returns:

application

See Also:

com.sun.jersey.server.wadl.WadlGenerator#createApplication()

createMethod

public Method createMethod(AbstractResource ar,
                           AbstractResourceMethod arm)

Specified by:

createMethod in interface WadlGenerator

Parameters:

ar - abstract resource

arm - abstract resource method

Returns:

method

See Also:

WadlGenerator.createMethod(com.sun.jersey.api.model.AbstractResource, com.sun.jersey.api.model.AbstractResourceMethod)

createRequest

public Request createRequest(AbstractResource ar,
                             AbstractResourceMethod arm)

Specified by:

createRequest in interface WadlGenerator

Parameters:

ar - abstract resource

arm - abstract resource method

Returns:

request

See Also:

WadlGenerator.createRequest(com.sun.jersey.api.model.AbstractResource, com.sun.jersey.api.model.AbstractResourceMethod)

createParam

public Param createParam(AbstractResource ar,
                         AbstractMethod am,
                         Parameter p)

Specified by:

createParam in interface WadlGenerator

Parameters:

ar - abstract resource

am - abstract method

p - parameter

Returns:

parameter

See Also:

WadlGenerator.createParam(com.sun.jersey.api.model.AbstractResource, com.sun.jersey.api.model.AbstractMethod, com.sun.jersey.api.model.Parameter)

createRequestRepresentation

public Representation createRequestRepresentation(AbstractResource ar,
                                                  AbstractResourceMethod arm,
                                                  javax.ws.rs.core.MediaType mt)

Specified by:

createRequestRepresentation in interface WadlGenerator

Parameters:

ar - abstract resource

arm - abstract resource method

mt - media type

Returns:

respresentation type

See Also:

WadlGenerator.createRequestRepresentation(com.sun.jersey.api.model.AbstractResource, com.sun.jersey.api.model.AbstractResourceMethod, javax.ws.rs.core.MediaType)

createResource

public Resource createResource(AbstractResource ar,
                               String path)

Specified by:

createResource in interface WadlGenerator

Parameters:

ar - abstract resource

path - resources path

Returns:

resource

See Also:

WadlGenerator.createResource(com.sun.jersey.api.model.AbstractResource, java.lang.String)

createResources

public Resources createResources()

Specified by:

createResources in interface WadlGenerator

Returns:

resources

See Also:

WadlGenerator.createResources()

createResponses

public List<Response> createResponses(AbstractResource ar,
                                      AbstractResourceMethod arm)

Specified by:

createResponses in interface WadlGenerator

Parameters:

ar - abstract resource

arm - abstract resource method

Returns:

response

See Also:

WadlGenerator.createResponses(com.sun.jersey.api.model.AbstractResource, com.sun.jersey.api.model.AbstractResourceMethod)

createExternalGrammar

public WadlGenerator.ExternalGrammarDefinition createExternalGrammar()

Description copied from interface: WadlGenerator

Perform any post create functions such as generating grammars.

Specified by:

createExternalGrammar in interface WadlGenerator

Returns:

A map of extra files to the content of those file encoded in UTF-8

buildModelAndSchemas

protected abstract WadlGenerator.Resolver buildModelAndSchemas(Map<String,ApplicationDescription.ExternalGrammar> extraFiles)

Build the the external schema files and generate a suitable resolver

Parameters:

extraFiles -

attachTypes

public void attachTypes(ApplicationDescription introspector)

Description copied from interface: WadlGenerator

Process the elements in the WADL definition to attach schema types as required.

Specified by:

attachTypes in interface WadlGenerator

Parameters:

introspector - The root description used to resolve these entries

createParmWantsName

protected abstract AbstractWadlGeneratorGrammarGenerator.WantsName<T> createParmWantsName(Param param)

createRepresentationWantsName

protected abstract AbstractWadlGeneratorGrammarGenerator.WantsName<T> createRepresentationWantsName(Representation rt)