|
||||||||||
| 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.
| Constructor Summary | |
|---|---|
WadlGeneratorGrammarsSupport()
|
|
WadlGeneratorGrammarsSupport(WadlGenerator delegate,
com.sun.research.ws.wadl.Grammars grammars)
|
|
| Method Summary | |
|---|---|
com.sun.research.ws.wadl.Application |
createApplication()
|
com.sun.research.ws.wadl.Method |
createMethod(AbstractResource arg0,
AbstractResourceMethod arg1)
|
com.sun.research.ws.wadl.Param |
createParam(AbstractResource arg0,
AbstractMethod arg1,
Parameter arg2)
|
com.sun.research.ws.wadl.Request |
createRequest(AbstractResource arg0,
AbstractResourceMethod arg1)
|
com.sun.research.ws.wadl.RepresentationType |
createRequestRepresentation(AbstractResource arg0,
AbstractResourceMethod arg1,
javax.ws.rs.core.MediaType arg2)
|
com.sun.research.ws.wadl.Resource |
createResource(AbstractResource arg0,
java.lang.String arg1)
|
com.sun.research.ws.wadl.Resources |
createResources()
|
com.sun.research.ws.wadl.Response |
createResponse(AbstractResource arg0,
AbstractResourceMethod arg1)
|
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 WadlGeneratorcom.sun.jersey.server.impl.wadl.WadlGenerator#createApplication()
public com.sun.research.ws.wadl.Method createMethod(AbstractResource arg0,
AbstractResourceMethod arg1)
createMethod in interface WadlGeneratorarg0 - arg1 -
com.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.Request createRequest(AbstractResource arg0,
AbstractResourceMethod arg1)
createRequest in interface WadlGeneratorarg0 - arg1 -
com.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.Param createParam(AbstractResource arg0,
AbstractMethod arg1,
Parameter arg2)
createParam in interface WadlGeneratorarg0 - arg1 - arg2 -
com.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.RepresentationType createRequestRepresentation(AbstractResource arg0,
AbstractResourceMethod arg1,
javax.ws.rs.core.MediaType arg2)
createRequestRepresentation in interface WadlGeneratorarg0 - arg1 - arg2 -
com.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.Resource createResource(AbstractResource arg0,
java.lang.String arg1)
createResource in interface WadlGeneratorarg0 - arg1 -
com.sun.jersey.server.impl.wadl.WadlGenerator#createResource(com.sun.jersey.api.model.AbstractResource, java.lang.String)public com.sun.research.ws.wadl.Resources createResources()
createResources in interface WadlGeneratorcom.sun.jersey.server.impl.wadl.WadlGenerator#createResources()
public com.sun.research.ws.wadl.Response createResponse(AbstractResource arg0,
AbstractResourceMethod arg1)
createResponse in interface WadlGeneratorarg0 - arg1 -
com.sun.jersey.server.impl.wadl.WadlGenerator#createResponse(com.sun.jersey.api.model.AbstractResource, com.sun.jersey.api.model.AbstractResourceMethod)
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||