xdoclet.modules.wsee

Class WseeTagsHandler

public class WseeTagsHandler extends XDocletTagSupport

Tags handler for dealing with wsee extensions.

Version: $Revision: 1.5 $

Author: Christoph G. Jung (christoph.jung@infor.de) Jason Essington (jasone@greenrivercomputing.com)

UNKNOWN: 23.12.03 namespace = "Wsee"

Field Summary
XTagcurrentHandler
state
static StringHANDLER
name of javadoc tag indicating a handler
static StringPORT_COMPONENT
name of javadoc tag indicating a port component
Method Summary
voidforAllHandlers(String template, Properties attributes)
Iterates over all handler tags annotating the current class.
voidforAllPortComponents(String template, Properties attributes)
Iterates over all classes loaded by javadoc and being a port component.
protected StringgetJaxrpcFilePattern()
Get the value of the jaxrpc file pattern
static StringgetNamespaceForPackage(XPackage pak)
Gets the namespace for the specified package.
static StringgetNamespaceForPackage(String pak)
Gets the namespace for the specified package.
StringgetNamespaceURI(XClass clazz)
return the namespace of the specified class
static ListgetPackageNamespaceMappings()
Gets the package-namespace mappings for the subtask.
protected StringgetWsdlFilePattern()
Get the value of the wsdl file pattern
StringhandlerTagValue(Properties props)
extract the value of the current handler tag
voidifHasHandlerTag(String template, Properties props)
conditional checking presence of a handler tag
voidifNotWsdlPerClass(String template, Properties props)
conditional to handle single wsdl generation
voidifWsdlPerClass(String template, Properties props)
conditional to handle per class wsdl
protected booleanisJaxrpcPerClass()
Is jaxrpc generation by class or as a single file?
static booleanisPortComponent(XClass clazz)
check whether the given class is a port component
protected booleanisWsdlPerClass()
Is wsdl generation by class or as a single file?
StringjaxrpcMappingFilename(Properties props)
Constructs a guestimated filename for the jaxrpc file.
StringnamespaceURI()
return the namespace of the current clazz/package
StringserviceEndpoint(Properties props)
returns the service endpoint interface name belonging to the current class
StringserviceEndpointLink(Properties props)
returns the service endpoint link pointing to the current class
StringwsdlFilename(Properties props)
Constructs a guestimated filename for the wsdl file.

Field Detail

currentHandler

public XTag currentHandler
state

HANDLER

public static final String HANDLER
name of javadoc tag indicating a handler

PORT_COMPONENT

public static final String PORT_COMPONENT
name of javadoc tag indicating a port component

Method Detail

forAllHandlers

public void forAllHandlers(String template, Properties attributes)
Iterates over all handler tags annotating the current class.

Parameters: template The body of the block tag attributes The attributes of the template tag

Throws: XDocletException

UNKNOWN: type = "block"

forAllPortComponents

public void forAllPortComponents(String template, Properties attributes)
Iterates over all classes loaded by javadoc and being a port component.

Parameters: template The body of the block tag attributes The attributes of the template tag

Throws: XDocletException Description of Exception

UNKNOWN: type = "block" name = "abstract" optional = "true" values = "true,false" description = "If true then accept * abstract classes also; otherwise don't." name = "type" optional = "true" description = "For all classes by the type."

getJaxrpcFilePattern

protected String getJaxrpcFilePattern()
Get the value of the jaxrpc file pattern

Returns: pattern

getNamespaceForPackage

public static String getNamespaceForPackage(XPackage pak)
Gets the namespace for the specified package.

Parameters: pak package

Returns: namespace

See Also: WseeTagsHandler

getNamespaceForPackage

public static String getNamespaceForPackage(String pak)
Gets the namespace for the specified package.

Parameters: pak package

Returns: namespace

getNamespaceURI

public String getNamespaceURI(XClass clazz)
return the namespace of the specified class

Parameters: clazz class

Returns: namespace URI

Throws: XDocletException

getPackageNamespaceMappings

public static List getPackageNamespaceMappings()
Gets the package-namespace mappings for the subtask.

Returns: List of packageNamespaceMapping config params

getWsdlFilePattern

protected String getWsdlFilePattern()
Get the value of the wsdl file pattern

Returns: pattern

handlerTagValue

public String handlerTagValue(Properties props)
extract the value of the current handler tag

Parameters: props The attributes of the template tag

Returns:

Throws: XDocletException

UNKNOWN: type = "content" name = "paramName" optional = "false" description = "The name of the parameter"

ifHasHandlerTag

public void ifHasHandlerTag(String template, Properties props)
conditional checking presence of a handler tag

Parameters: template The body of the block tag props The attributes of the template tag

Throws: XDocletException

UNKNOWN: type = "block" name = "paramName" optional = "false" description = "The name of the parameter"

ifNotWsdlPerClass

public void ifNotWsdlPerClass(String template, Properties props)
conditional to handle single wsdl generation

Parameters: template The body of the block tag props The attributes of the template tag

Throws: XDocletException

UNKNOWN: type = "block"

ifWsdlPerClass

public void ifWsdlPerClass(String template, Properties props)
conditional to handle per class wsdl

Parameters: template The body of the block tag props The attributes of the template tag

Throws: XDocletException

UNKNOWN: type = "block"

isJaxrpcPerClass

protected boolean isJaxrpcPerClass()
Is jaxrpc generation by class or as a single file?

Returns: true if by class

isPortComponent

public static boolean isPortComponent(XClass clazz)
check whether the given class is a port component

Parameters: clazz class

Returns:

Throws: XDocletException

isWsdlPerClass

protected boolean isWsdlPerClass()
Is wsdl generation by class or as a single file?

Returns: true if by class

jaxrpcMappingFilename

public String jaxrpcMappingFilename(Properties props)
Constructs a guestimated filename for the jaxrpc file.

Parameters: props If prefixWithPackageStructure is specified for the wsdl sub task, the property prefixWithPackage="true" will need to be specified.

Returns: filename

UNKNOWN: type = "content" name = "prefixWithPackage" optional = "true" values = "true,false" description = "Whether to prefix the * filename with the package hierarchy."

namespaceURI

public String namespaceURI()
return the namespace of the current clazz/package

Returns:

Throws: XDocletException

UNKNOWN: type = "content"

serviceEndpoint

public String serviceEndpoint(Properties props)
returns the service endpoint interface name belonging to the current class

Parameters: props The attributes of the template tag

Returns:

Throws: XDocletException

UNKNOWN: type = "content"

serviceEndpointLink

public String serviceEndpointLink(Properties props)
returns the service endpoint link pointing to the current class

Parameters: props The attributes of the template tag

Returns:

Throws: XDocletException

UNKNOWN: type = "content"

wsdlFilename

public String wsdlFilename(Properties props)
Constructs a guestimated filename for the wsdl file. It also attempts to decide if the file should be in META-INF or WEB-INF. This should yield a filename that will be correct for use within the webservices.xml file.

Parameters: props If prefixWithPackageStructure is specified for the wsdl sub task, the property prefixWithPackage="true" will need to be specified.

Returns: filename

UNKNOWN: type = "content" name = "prefixWithPackage" optional = "true" values = "true,false" description = "Whether to prefix the * filename with the package hierarchy."