|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectcom.sun.jersey.server.wadl.generators.WadlGeneratorGrammarsSupport
public class WadlGeneratorGrammarsSupport
This WadlGenerator adds the provided Grammars element to the
generated wadl-file.
The Grammars content can either be provided via a File (setGrammarsFile(File)) reference or
via an InputStream (setGrammarsStream(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.
| Nested Class Summary |
|---|
| Nested classes/interfaces inherited from interface com.sun.jersey.server.wadl.WadlGenerator |
|---|
WadlGenerator.ExternalGrammarDefinition, WadlGenerator.Resolver |
| Constructor Summary | |
|---|---|
WadlGeneratorGrammarsSupport()
|
|
WadlGeneratorGrammarsSupport(WadlGenerator delegate,
com.sun.research.ws.wadl.Grammars grammars)
|
|
| Method Summary | |
|---|---|
void |
attachTypes(ApplicationDescription egd)
Process the elements in the WADL definition to attach schema types as required. |
com.sun.research.ws.wadl.Application |
createApplication()
|
WadlGenerator.ExternalGrammarDefinition |
createExternalGrammar()
Perform any post create functions such as generating grammars. |
com.sun.research.ws.wadl.Method |
createMethod(AbstractResource ar,
AbstractResourceMethod arm)
|
com.sun.research.ws.wadl.Param |
createParam(AbstractResource ar,
AbstractMethod am,
Parameter p)
|
com.sun.research.ws.wadl.Request |
createRequest(AbstractResource ar,
AbstractResourceMethod arm)
|
com.sun.research.ws.wadl.Representation |
createRequestRepresentation(AbstractResource ar,
AbstractResourceMethod arm,
MediaType mt)
|
com.sun.research.ws.wadl.Resource |
createResource(AbstractResource ar,
java.lang.String path)
|
com.sun.research.ws.wadl.Resources |
createResources()
|
com.sun.research.ws.wadl.Response |
createResponse(AbstractResource ar,
AbstractResourceMethod arm)
|
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 |
setGrammarsFile(java.io.File grammarsFile)
|
void |
setGrammarsStream(java.io.InputStream grammarsStream)
|
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 |
|---|
public WadlGeneratorGrammarsSupport()
public WadlGeneratorGrammarsSupport(WadlGenerator delegate,
com.sun.research.ws.wadl.Grammars grammars)
| Method Detail |
|---|
public void setWadlGeneratorDelegate(WadlGenerator delegate)
WadlGeneratorWadlGenerator.init() or any setter method is invoked.
setWadlGeneratorDelegate in interface WadlGeneratordelegate - the wadl generator to decoratepublic 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 void setGrammarsFile(java.io.File grammarsFile)
public void setGrammarsStream(java.io.InputStream grammarsStream)
public void init()
throws java.lang.Exception
WadlGeneratorthis.delegate.init().
init in interface WadlGeneratorjava.lang.Exceptionpublic com.sun.research.ws.wadl.Application createApplication()
createApplication in interface WadlGeneratorWadlGenerator.createApplication()
public com.sun.research.ws.wadl.Method createMethod(AbstractResource ar,
AbstractResourceMethod arm)
createMethod in interface WadlGeneratorar - abstract resourcearm - abstract resource method
WadlGenerator.createMethod(com.sun.jersey.api.model.AbstractResource, com.sun.jersey.api.model.AbstractResourceMethod)
public com.sun.research.ws.wadl.Request createRequest(AbstractResource ar,
AbstractResourceMethod arm)
createRequest in interface WadlGeneratorar - abstract resourcearm - abstract resource method
WadlGenerator.createRequest(com.sun.jersey.api.model.AbstractResource, com.sun.jersey.api.model.AbstractResourceMethod)
public com.sun.research.ws.wadl.Param createParam(AbstractResource ar,
AbstractMethod am,
Parameter p)
createParam in interface WadlGeneratorar - abstract resourceam - abstract methodp - parameter
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.Representation createRequestRepresentation(AbstractResource ar,
AbstractResourceMethod arm,
MediaType mt)
createRequestRepresentation in interface WadlGeneratorar - abstract resourcearm - abstract resource methodmt - media type
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.Resource createResource(AbstractResource ar,
java.lang.String path)
createResource in interface WadlGeneratorar - abstract resourcepath -
WadlGenerator.createResource(com.sun.jersey.api.model.AbstractResource, java.lang.String)public com.sun.research.ws.wadl.Resources createResources()
createResources in interface WadlGeneratorWadlGenerator.createResources()
public com.sun.research.ws.wadl.Response createResponse(AbstractResource ar,
AbstractResourceMethod arm)
createResponse in interface WadlGeneratorar - abstract resourcearm - abstract resource method
WadlGenerator.createResponse(com.sun.jersey.api.model.AbstractResource, com.sun.jersey.api.model.AbstractResourceMethod)public WadlGenerator.ExternalGrammarDefinition createExternalGrammar()
WadlGenerator
createExternalGrammar in interface WadlGeneratorpublic void attachTypes(ApplicationDescription egd)
WadlGenerator
attachTypes in interface WadlGeneratoregd - The root description used to resolve these entries
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||