org.glassfish.jersey.server.wadl.internal.generators.resourcedoc

Class WadlGeneratorResourceDocSupport

java.lang.Object

org.glassfish.jersey.server.wadl.internal.generators.resourcedoc.WadlGeneratorResourceDocSupport

All Implemented Interfaces:

WadlGenerator

public class WadlGeneratorResourceDocSupport
extends Object
implements WadlGenerator

A WadlGenerator implementation that enhances the generated wadl by information read from a resourcedoc (containing javadoc information about resource classes).

The resourcedoc information can either be provided via a File (setResourceDocFile(File)) reference or via an InputStream (setResourceDocStream(InputStream)).

The File should be used when using the maven-wadl-plugin for generating wadl offline, the InputStream should be used when the extended wadl is generated by jersey at runtime, e.g. using the WadlGeneratorConfig for configuration.

Author:

Martin Grotzke (martin.grotzke at freiheit.com), Miroslav Fuksa

Nested Class Summary

Nested classes/interfaces inherited from interface org.glassfish.jersey.server.wadl.WadlGenerator

WadlGenerator.ExternalGrammarDefinition, WadlGenerator.Resolver

Constructor Summary

Constructors

Constructor and Description
WadlGeneratorResourceDocSupport()
WadlGeneratorResourceDocSupport(WadlGenerator wadlGenerator, ResourceDocType resourceDoc)

Method Summary

Modifier and Type	Method and Description
void	attachTypes(ApplicationDescription egd) Process the elements in the WADL definition to attach schema types as required.
Application	createApplication()
WadlGenerator.ExternalGrammarDefinition	createExternalGrammar() Perform any post create functions such as generating grammars.
Method	createMethod(Resource resource, ResourceMethod resourceMethod)
Param	createParam(Resource r, ResourceMethod m, Parameter p)
Request	createRequest(Resource r, ResourceMethod m)
Representation	createRequestRepresentation(Resource r, ResourceMethod m, MediaType mediaType)
Resource	createResource(Resource r, String path)
Resources	createResources()
List<Response>	createResponses(Resource r, ResourceMethod m)
String	getRequiredJaxbContextPath() The jaxb context path that is used when the generated wadl application is marshalled to a file.
void	init() Invoked before all methods related to wadl-building are invoked.
void	setResourceDocFile(File resourceDocFile) Set the resourceDocFile to the given file.
void	setResourceDocStream(InputStream resourceDocStream) Set the resourceDocStream to the given file.
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

Constructor Detail

WadlGeneratorResourceDocSupport

public WadlGeneratorResourceDocSupport()

WadlGeneratorResourceDocSupport

public WadlGeneratorResourceDocSupport(WadlGenerator wadlGenerator,
                                       ResourceDocType resourceDoc)

Method Detail

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

setResourceDocFile

public void setResourceDocFile(File resourceDocFile)

Set the resourceDocFile to the given file. Invoking this method is only allowed, as long as the resourceDocStream is not set, otherwise an IllegalStateException will be thrown.

Parameters:

resourceDocFile - the resourcedoc file to set.

setResourceDocStream

public void setResourceDocStream(InputStream resourceDocStream)

Set the resourceDocStream to the given file. Invoking this method is only allowed, as long as the resourceDocFile is not set, otherwise an IllegalStateException will be thrown.

The resourcedoc stream must be closed by the client providing the stream.

Parameters:

resourceDocStream - the resourcedoc stream to set.

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:

IllegalStateException

jakarta.xml.bind.JAXBException

Exception

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 #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 getRequiredJaxbContextPath() of the delegate or the getRequiredJaxbContextPath() + ":" + ${yourContextPath}.

createApplication

public Application createApplication()

Specified by:

createApplication in interface WadlGenerator

Returns:

the Application created by the delegate.

See Also:

WadlGenerator.createApplication()

createResource

public Resource createResource(Resource r,
                               String path)

Specified by:

createResource in interface WadlGenerator

Parameters:

r - Jersey resource component for which the WADL reource is to be created.

path - path where the resource is exposed.

Returns:

the enhanced Resource.

See Also:

WadlGenerator.createResource(org.glassfish.jersey.server.model.Resource, String)

createMethod

public Method createMethod(Resource resource,
                           ResourceMethod resourceMethod)

Specified by:

createMethod in interface WadlGenerator

Parameters:

resource - Jersey resource component.

resourceMethod - resource method.

Returns:

the enhanced Method.

See Also:

WadlGenerator.createMethod(org.glassfish.jersey.server.model.Resource, org.glassfish.jersey.server.model.ResourceMethod)

createRequestRepresentation

public Representation createRequestRepresentation(Resource r,
                                                  ResourceMethod m,
                                                  MediaType mediaType)

Specified by:

createRequestRepresentation in interface WadlGenerator

Parameters:

r - Jersey resource component.

m - resource method.

mediaType - media type.

Returns:

the enhanced Representation.

See Also:

WadlGenerator.createRequestRepresentation(org.glassfish.jersey.server.model.Resource, org.glassfish.jersey.server.model.ResourceMethod, jakarta.ws.rs.core.MediaType)

createRequest

public Request createRequest(Resource r,
                             ResourceMethod m)

Specified by:

createRequest in interface WadlGenerator

Parameters:

r - Jersey resource component.

m - resource method.

Returns:

the enhanced Request.

See Also:

WadlGenerator.createRequest(org.glassfish.jersey.server.model.Resource, org.glassfish.jersey.server.model.ResourceMethod)

createResponses

public List<Response> createResponses(Resource r,
                                      ResourceMethod m)

Specified by:

createResponses in interface WadlGenerator

Parameters:

r - Jersey resource component.

m - resource method.

Returns:

the enhanced Response.

See Also:

WadlGenerator.createResponses(org.glassfish.jersey.server.model.Resource, org.glassfish.jersey.server.model.ResourceMethod)

createParam

public Param createParam(Resource r,
                         ResourceMethod m,
                         Parameter p)

Specified by:

createParam in interface WadlGenerator

Parameters:

r - Jersey resource component.

m - resource method.

p - method parameter.

Returns:

the enhanced Param.

See Also:

WadlGenerator.createParam(org.glassfish.jersey.server.model.Resource, org.glassfish.jersey.server.model.ResourceMethod, org.glassfish.jersey.server.model.Parameter)

createResources

public Resources createResources()

Specified by:

createResources in interface WadlGenerator

Returns:

the Resources created by the delegate.

See Also:

WadlGenerator.createResources()

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

attachTypes

public void attachTypes(ApplicationDescription egd)

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:

egd - The root description used to resolve these entries