|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectcom.sun.jersey.server.wadl.generators.resourcedoc.WadlGeneratorResourceDocSupport
public class WadlGeneratorResourceDocSupport
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.
| Field Summary | |
|---|---|
static java.lang.String |
RESOURCE_DOC_FILE
|
| Constructor Summary | |
|---|---|
WadlGeneratorResourceDocSupport()
|
|
WadlGeneratorResourceDocSupport(WadlGenerator wadlGenerator,
ResourceDocType resourceDoc)
|
|
| Method Summary | |
|---|---|
com.sun.research.ws.wadl.Application |
createApplication()
|
com.sun.research.ws.wadl.Method |
createMethod(AbstractResource r,
AbstractResourceMethod m)
|
com.sun.research.ws.wadl.Param |
createParam(AbstractResource r,
AbstractMethod m,
Parameter p)
|
com.sun.research.ws.wadl.Request |
createRequest(AbstractResource r,
AbstractResourceMethod m)
|
com.sun.research.ws.wadl.RepresentationType |
createRequestRepresentation(AbstractResource r,
AbstractResourceMethod m,
javax.ws.rs.core.MediaType mediaType)
|
com.sun.research.ws.wadl.Resource |
createResource(AbstractResource r,
java.lang.String path)
|
com.sun.research.ws.wadl.Resources |
createResources()
|
com.sun.research.ws.wadl.Response |
createResponse(AbstractResource r,
AbstractResourceMethod m)
|
java.lang.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. |
void |
setResourceDocFile(java.io.File resourceDocFile)
Set the resourceDocFile to the given file. |
void |
setResourceDocStream(java.io.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 |
| Field Detail |
|---|
public static final java.lang.String RESOURCE_DOC_FILE
| Constructor Detail |
|---|
public WadlGeneratorResourceDocSupport()
public WadlGeneratorResourceDocSupport(WadlGenerator wadlGenerator,
ResourceDocType resourceDoc)
| Method Detail |
|---|
public void setWadlGeneratorDelegate(WadlGenerator delegate)
WadlGeneratorWadlGenerator.init() or any setter method is invoked.
setWadlGeneratorDelegate in interface WadlGeneratordelegate - the wadl generator to decoratepublic void setResourceDocFile(java.io.File resourceDocFile)
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.
resourceDocFile - the resourcedoc file to set.public void setResourceDocStream(java.io.InputStream resourceDocStream)
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.
resourceDocStream - the resourcedoc stream to set.
public void init()
throws java.lang.Exception
WadlGeneratorthis.delegate.init().
init in interface WadlGeneratorjava.lang.Exceptionpublic java.lang.String getRequiredJaxbContextPath()
WadlGeneratorWadlGenerator.setWadlGeneratorDelegate(WadlGenerator)._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.
getRequiredJaxbContextPath in interface WadlGeneratorWadlGenerator.getRequiredJaxbContextPath() of the delegate or the
WadlGenerator.getRequiredJaxbContextPath() + ":" + ${yourContextPath}.public com.sun.research.ws.wadl.Application createApplication()
createApplication in interface WadlGeneratorApplication created by the delegatecom.sun.jersey.server.impl.wadl.WadlGenerator#createApplication()
public com.sun.research.ws.wadl.Resource createResource(AbstractResource r,
java.lang.String path)
createResource in interface WadlGeneratorr - path -
Resourcecom.sun.jersey.server.impl.wadl.WadlGenerator#createResource(com.sun.jersey.api.model.AbstractResource, java.lang.String)
public com.sun.research.ws.wadl.Method createMethod(AbstractResource r,
AbstractResourceMethod m)
createMethod in interface WadlGeneratorr - m -
Methodcom.sun.jersey.server.impl.wadl.WadlGenerator#createMethod(com.sun.jersey.api.model.AbstractResource, com.sun.jersey.api.model.AbstractResourceMethod)
public com.sun.research.ws.wadl.RepresentationType createRequestRepresentation(AbstractResource r,
AbstractResourceMethod m,
javax.ws.rs.core.MediaType mediaType)
createRequestRepresentation in interface WadlGeneratorr - m - mediaType -
RepresentationTypecom.sun.jersey.server.impl.wadl.WadlGenerator#createRequestRepresentation(com.sun.jersey.api.model.AbstractResource, com.sun.jersey.api.model.AbstractResourceMethod, javax.ws.rs.core.MediaType)
public com.sun.research.ws.wadl.Request createRequest(AbstractResource r,
AbstractResourceMethod m)
createRequest in interface WadlGeneratorr - m -
Requestcom.sun.jersey.server.impl.wadl.WadlGenerator#createRequest(com.sun.jersey.api.model.AbstractResource, com.sun.jersey.api.model.AbstractResourceMethod)
public com.sun.research.ws.wadl.Response createResponse(AbstractResource r,
AbstractResourceMethod m)
createResponse in interface WadlGeneratorr - m -
Responsecom.sun.jersey.server.impl.wadl.WadlGenerator#createResponse(com.sun.jersey.api.model.AbstractResource, com.sun.jersey.api.model.AbstractResourceMethod)
public com.sun.research.ws.wadl.Param createParam(AbstractResource r,
AbstractMethod m,
Parameter p)
createParam in interface WadlGeneratorr - m - p -
Paramcom.sun.jersey.server.impl.wadl.WadlGenerator#createParam(com.sun.jersey.api.model.AbstractResource, com.sun.jersey.api.model.AbstractMethod, com.sun.jersey.api.model.Parameter)public com.sun.research.ws.wadl.Resources createResources()
createResources in interface WadlGeneratorResources created by the delegatecom.sun.jersey.server.impl.wadl.WadlGenerator#createResources()
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||