Class WadlGeneratorImpl
- java.lang.Object
-
- org.glassfish.jersey.server.wadl.internal.WadlGeneratorImpl
-
- All Implemented Interfaces:
WadlGenerator
public class WadlGeneratorImpl extends java.lang.Object implements WadlGenerator
This WadlGenerator creates the basic wadl artifacts.
Created on: Jun 16, 2008
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from interface org.glassfish.jersey.server.wadl.WadlGenerator
WadlGenerator.ExternalGrammarDefinition, WadlGenerator.Resolver
-
-
Constructor Summary
Constructors Constructor Description WadlGeneratorImpl()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method 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 r, ResourceMethod m)
Param
createParam(Resource r, ResourceMethod m, Parameter p)
Request
createRequest(Resource r, ResourceMethod m)
Representation
createRequestRepresentation(Resource r, ResourceMethod m, javax.ws.rs.core.MediaType mediaType)
Resource
createResource(Resource resource, java.lang.String path)
Resources
createResources()
Representation
createResponseRepresentation(Resource r, ResourceMethod m, javax.ws.rs.core.MediaType mediaType)
java.util.List<Response>
createResponses(Resource r, ResourceMethod m)
java.lang.String
getRequiredJaxbContextPath()
The jaxb context path that is used when the generated wadl application is marshalled to a file.private boolean
hasEmptyProducibleMediaTypeSet(ResourceMethod method)
void
init()
Invoked before all methods related to wadl-building are invoked.void
setWadlGeneratorDelegate(WadlGenerator delegate)
Sets the delegate that is decorated by this wadl generator.
-
-
-
Method Detail
-
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 byWadlGenerator.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 withXmlRegistry
) to this package.- Specified by:
getRequiredJaxbContextPath
in interfaceWadlGenerator
- Returns:
- simply the
getRequiredJaxbContextPath()
of the delegate or thegetRequiredJaxbContextPath() + ":" + ${yourContextPath}
.
-
init
public void init()
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 invokethis.delegate.init()
.- Specified by:
init
in interfaceWadlGenerator
-
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 beforeWadlGenerator.init()
or any setter method is invoked.- Specified by:
setWadlGeneratorDelegate
in interfaceWadlGenerator
- Parameters:
delegate
- the wadl generator to decorate
-
createResources
public Resources createResources()
- Specified by:
createResources
in interfaceWadlGenerator
-
createApplication
public Application createApplication()
- Specified by:
createApplication
in interfaceWadlGenerator
-
createMethod
public Method createMethod(Resource r, ResourceMethod m)
- Specified by:
createMethod
in interfaceWadlGenerator
-
createRequestRepresentation
public Representation createRequestRepresentation(Resource r, ResourceMethod m, javax.ws.rs.core.MediaType mediaType)
- Specified by:
createRequestRepresentation
in interfaceWadlGenerator
-
createRequest
public Request createRequest(Resource r, ResourceMethod m)
- Specified by:
createRequest
in interfaceWadlGenerator
-
createParam
public Param createParam(Resource r, ResourceMethod m, Parameter p)
- Specified by:
createParam
in interfaceWadlGenerator
-
createResource
public Resource createResource(Resource resource, java.lang.String path)
- Specified by:
createResource
in interfaceWadlGenerator
-
createResponses
public java.util.List<Response> createResponses(Resource r, ResourceMethod m)
- Specified by:
createResponses
in interfaceWadlGenerator
-
hasEmptyProducibleMediaTypeSet
private boolean hasEmptyProducibleMediaTypeSet(ResourceMethod method)
-
createResponseRepresentation
public Representation createResponseRepresentation(Resource r, ResourceMethod m, javax.ws.rs.core.MediaType mediaType)
-
createExternalGrammar
public WadlGenerator.ExternalGrammarDefinition createExternalGrammar()
Description copied from interface:WadlGenerator
Perform any post create functions such as generating grammars.- Specified by:
createExternalGrammar
in interfaceWadlGenerator
- 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 interfaceWadlGenerator
- Parameters:
egd
- The root description used to resolve these entries
-
-