com.sun.jersey.server.wadl.generators.resourcedoc
Class WadlGeneratorResourceDocSupport

java.lang.Object
  com.sun.jersey.server.wadl.generators.resourcedoc.WadlGeneratorResourceDocSupport

All Implemented Interfaces:

WadlGenerator

public class WadlGeneratorResourceDocSupport
extends java.lang.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.

Version:

$Id: WadlGeneratorResourceDocSupport.java 4584 2011-02-10 09:12:27Z pavel_bucek $

Author:

Martin Grotzke

RESOURCE_DOC_FILE

public static final java.lang.String RESOURCE_DOC_FILE

See Also:

Constant Field Values

WadlGeneratorResourceDocSupport

public WadlGeneratorResourceDocSupport()

WadlGeneratorResourceDocSupport

public WadlGeneratorResourceDocSupport(WadlGenerator wadlGenerator,
                                       ResourceDocType resourceDoc)

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(java.io.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(java.io.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 java.lang.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:

java.lang.Exception

getRequiredJaxbContextPath

public java.lang.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}.

createApplication

public com.sun.research.ws.wadl.Application createApplication()

Specified by:

createApplication in interface WadlGenerator

Returns:

the Application created by the delegate

See Also:

WadlGenerator.createApplication()

createResource

public com.sun.research.ws.wadl.Resource createResource(AbstractResource r,
                                                        java.lang.String path)

Specified by:

createResource in interface WadlGenerator

Parameters:

r -

path -

Returns:

the enhanced Resource

See Also:

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

createMethod

public com.sun.research.ws.wadl.Method createMethod(AbstractResource r,
                                                    AbstractResourceMethod m)

Specified by:

createMethod in interface WadlGenerator

Parameters:

r -

m -

Returns:

the enhanced Method

See Also:

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

createRequestRepresentation

public com.sun.research.ws.wadl.RepresentationType createRequestRepresentation(AbstractResource r,
                                                                               AbstractResourceMethod m,
                                                                               MediaType mediaType)

Specified by:

createRequestRepresentation in interface WadlGenerator

Parameters:

r -

m -

mediaType -

Returns:

the enhanced RepresentationType

See Also:

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

createRequest

public com.sun.research.ws.wadl.Request createRequest(AbstractResource r,
                                                      AbstractResourceMethod m)

Specified by:

createRequest in interface WadlGenerator

Parameters:

r -

m -

Returns:

the enhanced Request

See Also:

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

createResponse

public com.sun.research.ws.wadl.Response createResponse(AbstractResource r,
                                                        AbstractResourceMethod m)

Specified by:

createResponse in interface WadlGenerator

Parameters:

r -

m -

Returns:

the enhanced Response

See Also:

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

createParam

public com.sun.research.ws.wadl.Param createParam(AbstractResource r,
                                                  AbstractMethod m,
                                                  Parameter p)

Specified by:

createParam in interface WadlGenerator

Parameters:

r -

m -

p -

Returns:

the enhanced Param

See Also:

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

createResources

public com.sun.research.ws.wadl.Resources createResources()

Specified by:

createResources in interface WadlGenerator

Returns:

the Resources created by the delegate

See Also:

WadlGenerator.createResources()