com.atlassian.plugins.rest.doclet.generators.resourcedoc
Class AtlassianWadlGeneratorResourceDocSupport

java.lang.Object
  com.sun.jersey.server.wadl.generators.resourcedoc.WadlGeneratorResourceDocSupport
      com.atlassian.plugins.rest.doclet.generators.resourcedoc.AtlassianWadlGeneratorResourceDocSupport

All Implemented Interfaces:

com.sun.jersey.server.wadl.WadlGenerator

public class AtlassianWadlGeneratorResourceDocSupport
extends com.sun.jersey.server.wadl.generators.resourcedoc.WadlGeneratorResourceDocSupport

This class generates the WADL description of rest resources and considers the rest plugin module descriptors configured inside the atlassian-plugin.xml file when generating the resource path. It builds up a map that contains a mapping of a package name to a resource path. The full resource path is concatenated of the following strings: 1) path as configured for rest plugin module descriptor: e.g. api 2) version as configured for rest plugin module descriptor e.g. 2.0.alpha1 3) path of the rest end point e.g. worklog e.g. /api/2.0.alpha1/worklog/

Nested Class Summary

class

AtlassianWadlGeneratorResourceDocSupport.ResourcePathInformation

Field Summary

Fields inherited from class com.sun.jersey.server.wadl.generators.resourcedoc.WadlGeneratorResourceDocSupport

RESOURCE_DOC_FILE

Constructor Summary

AtlassianWadlGeneratorResourceDocSupport()

AtlassianWadlGeneratorResourceDocSupport(com.sun.jersey.server.wadl.WadlGenerator wadlGenerator, com.sun.jersey.server.wadl.generators.resourcedoc.model.ResourceDocType resourceDoc)

Method Summary

com.sun.research.ws.wadl.Method	createMethod(com.sun.jersey.api.model.AbstractResource r, com.sun.jersey.api.model.AbstractResourceMethod m)
com.sun.research.ws.wadl.Resource	createResource(com.sun.jersey.api.model.AbstractResource r, java.lang.String path)
void	init()

Methods inherited from class com.sun.jersey.server.wadl.generators.resourcedoc.WadlGeneratorResourceDocSupport

createApplication, createParam, createRequest, createRequestRepresentation, createResources, createResponse, getRequiredJaxbContextPath, setResourceDocFile, setResourceDocStream, setWadlGeneratorDelegate

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AtlassianWadlGeneratorResourceDocSupport

public AtlassianWadlGeneratorResourceDocSupport()

AtlassianWadlGeneratorResourceDocSupport

public AtlassianWadlGeneratorResourceDocSupport(com.sun.jersey.server.wadl.WadlGenerator wadlGenerator,
                                                com.sun.jersey.server.wadl.generators.resourcedoc.model.ResourceDocType resourceDoc)

Method Detail

init

public void init()
          throws java.lang.Exception

Specified by:

init in interface com.sun.jersey.server.wadl.WadlGenerator

Overrides:

init in class com.sun.jersey.server.wadl.generators.resourcedoc.WadlGeneratorResourceDocSupport

Throws:

java.lang.Exception

createResource

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

Specified by:

createResource in interface com.sun.jersey.server.wadl.WadlGenerator

Overrides:

createResource in class com.sun.jersey.server.wadl.generators.resourcedoc.WadlGeneratorResourceDocSupport

createMethod

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

Specified by:

createMethod in interface com.sun.jersey.server.wadl.WadlGenerator

Overrides:

createMethod in class com.sun.jersey.server.wadl.generators.resourcedoc.WadlGeneratorResourceDocSupport