org.apache.cxf.jaxrs.model.wadl
Class WadlGenerator

java.lang.Object
  org.apache.cxf.jaxrs.model.wadl.WadlGenerator

All Implemented Interfaces:

RequestHandler

public class WadlGenerator
extends Object
implements RequestHandler

WADL_QUERY

public static final String WADL_QUERY

See Also:

Constant Field Values

WADL_TYPE

public static final javax.ws.rs.core.MediaType WADL_TYPE

WADL_NS

public static final String WADL_NS

See Also:

Constant Field Values

WadlGenerator

public WadlGenerator()

WadlGenerator

public WadlGenerator(org.apache.cxf.Bus bus)

WadlGenerator

public WadlGenerator(WadlGenerator other)

handleRequest

public javax.ws.rs.core.Response handleRequest(org.apache.cxf.message.Message m,
                                               ClassResourceInfo resource)

Specified by:

handleRequest in interface RequestHandler

generateWADL

public StringBuilder generateWADL(String baseURI,
                                  List<ClassResourceInfo> cris,
                                  boolean isJson,
                                  org.apache.cxf.message.Message m,
                                  javax.ws.rs.core.UriInfo ui)

handleGrammars

protected void handleGrammars(StringBuilder sbApp,
                              StringBuilder sbGrammars,
                              WadlGenerator.SchemaWriter writer,
                              Map<Class<?>,QName> clsMap)

handleResource

protected void handleResource(StringBuilder sb,
                              Set<Class<?>> jaxbTypes,
                              ElementQNameResolver qnameResolver,
                              Map<Class<?>,QName> clsMap,
                              ClassResourceInfo cri,
                              Set<ClassResourceInfo> visitedResources,
                              boolean isJson)

getPath

protected String getPath(String path)

endMethodTag

protected void endMethodTag(StringBuilder sb,
                            OperationResourceInfo ori)

startMethodRequestTag

protected void startMethodRequestTag(StringBuilder sb,
                                     OperationResourceInfo ori)

startMethodResponseTag

protected void startMethodResponseTag(StringBuilder sb,
                                      OperationResourceInfo ori)

endMethodRequestTag

protected void endMethodRequestTag(StringBuilder sb,
                                   OperationResourceInfo ori)

endMethodResponseTag

protected void endMethodResponseTag(StringBuilder sb,
                                    OperationResourceInfo ori)

startResourceTag

protected void startResourceTag(StringBuilder sb,
                                OperationResourceInfo ori,
                                String path)

endResourceTag

protected void endResourceTag(StringBuilder sb,
                              OperationResourceInfo ori)

handleOperation

protected boolean handleOperation(StringBuilder sb,
                                  Set<Class<?>> jaxbTypes,
                                  ElementQNameResolver qnameResolver,
                                  Map<Class<?>,QName> clsMap,
                                  OperationResourceInfo ori,
                                  Map<Parameter,Object> classParams,
                                  OperationResourceInfo nextOp,
                                  boolean resourceTagOpened,
                                  boolean isJson,
                                  int index)

compareOperations

protected boolean compareOperations(OperationResourceInfo ori1,
                                    OperationResourceInfo ori2)

handleDynamicSubresource

protected void handleDynamicSubresource(StringBuilder sb,
                                        Set<Class<?>> jaxbTypes,
                                        ElementQNameResolver qnameResolver,
                                        Map<Class<?>,QName> clsMap,
                                        OperationResourceInfo ori,
                                        ClassResourceInfo subcri,
                                        boolean isJson)

handlePathAndMatrixClassParams

protected void handlePathAndMatrixClassParams(StringBuilder sb,
                                              Map<Parameter,Object> params,
                                              boolean isJson)

doHandleClassParams

protected void doHandleClassParams(StringBuilder sb,
                                   Map<Parameter,Object> params,
                                   boolean isJson,
                                   ParameterType... pType)

doHandleJaxrsBeanParamClassParams

protected void doHandleJaxrsBeanParamClassParams(StringBuilder sb,
                                                 Map<Parameter,Object> params,
                                                 boolean isJson,
                                                 ParameterType... pType)

handlePathAndMatrixParams

protected void handlePathAndMatrixParams(StringBuilder sb,
                                         OperationResourceInfo ori,
                                         boolean isJson)

handleParameter

protected void handleParameter(StringBuilder sb,
                               Set<Class<?>> jaxbTypes,
                               ElementQNameResolver qnameResolver,
                               Map<Class<?>,QName> clsMap,
                               OperationResourceInfo ori,
                               Parameter pm,
                               boolean isJson)

handleParams

protected void handleParams(StringBuilder sb,
                            OperationResourceInfo ori,
                            ParameterType type,
                            boolean isJson)

doWriteParam

protected void doWriteParam(StringBuilder sb,
                            Parameter pm,
                            Class<?> type,
                            Type genericType,
                            String paramName,
                            Annotation[] anns,
                            boolean isJson)

handleRepresentation

protected void handleRepresentation(StringBuilder sb,
                                    Set<Class<?>> jaxbTypes,
                                    ElementQNameResolver qnameResolver,
                                    Map<Class<?>,QName> clsMap,
                                    OperationResourceInfo ori,
                                    Class<?> type,
                                    boolean isJson,
                                    boolean inbound)

sortOperationsByPath

protected List<OperationResourceInfo> sortOperationsByPath(Set<OperationResourceInfo> ops)

getResourcesList

public List<ClassResourceInfo> getResourcesList(org.apache.cxf.message.Message m,
                                                ClassResourceInfo cri)

getExistingWadl

public javax.ws.rs.core.Response getExistingWadl(org.apache.cxf.message.Message m,
                                                 javax.ws.rs.core.UriInfo ui,
                                                 javax.ws.rs.core.MediaType mt)

getExistingResource

public javax.ws.rs.core.Response getExistingResource(org.apache.cxf.message.Message m,
                                                     javax.ws.rs.core.UriInfo ui,
                                                     String href)

addSchemaDocument

public boolean addSchemaDocument(org.apache.cxf.common.xmlschema.SchemaCollection col,
                                 List<String> tnsList,
                                 Document d,
                                 String systemId,
                                 boolean hackAroundEmptyNamespaceIssue)

setIgnoreMessageWriters

public void setIgnoreMessageWriters(boolean ignoreMessageWriters)

handleDocs

protected void handleDocs(Annotation[] anns,
                          StringBuilder sb,
                          String category,
                          boolean allowDefault,
                          boolean isJson)

setWadlNamespace

public void setWadlNamespace(String namespace)

setSingleResourceMultipleMethods

public void setSingleResourceMultipleMethods(boolean singleResourceMultipleMethods)

setUseSingleSlashResource

public void setUseSingleSlashResource(boolean useSingleSlashResource)

setLinkJsonToXmlSchema

public void setLinkJsonToXmlSchema(boolean link)

setLinkAnyMediaTypeToXmlSchema

public void setLinkAnyMediaTypeToXmlSchema(boolean link)

setSchemaLocations

public void setSchemaLocations(List<String> locations)

setUseJaxbContextForQnames

public void setUseJaxbContextForQnames(boolean checkJaxbOnly)

createElementQNameResolver

protected ElementQNameResolver createElementQNameResolver(JAXBContext context)

createSchemaWriter

protected WadlGenerator.SchemaWriter createSchemaWriter(ResourceTypes resourceTypes,
                                                        JAXBContext context,
                                                        javax.ws.rs.core.UriInfo ui)

setExternalLinks

public void setExternalLinks(List<String> externalLinks)

setResolver

public void setResolver(ElementQNameResolver resolver)

setPrivateAddresses

public void setPrivateAddresses(List<String> privateAddresses)

getPrivateAddresses

public List<String> getPrivateAddresses()

setAddResourceAndMethodIds

public void setAddResourceAndMethodIds(boolean addResourceAndMethodIds)

setApplicationTitle

public void setApplicationTitle(String applicationTitle)

setNamespacePrefix

public void setNamespacePrefix(String prefix)

setIgnoreForwardSlash

public void setIgnoreForwardSlash(boolean ignoreForwardSlash)

setIgnoreRequests

public void setIgnoreRequests(boolean ignoreRequests)

setSupportCollections

public void setSupportCollections(boolean support)

setDefaultMediaType

public void setDefaultMediaType(String mt)

setSupportJaxbXmlType

public void setSupportJaxbXmlType(boolean supportJaxbXmlType)

setSupportJaxbSubstitutions

public void setSupportJaxbSubstitutions(boolean supportJaxbSubstitutions)