org.jibx.ws.wsdl.tools.custom
Class OperationCustom

java.lang.Object
  extended by org.jibx.custom.classes.CustomBase
      extended by org.jibx.custom.classes.SharedNestingBase
          extended by org.jibx.ws.wsdl.tools.custom.NestingBase
              extended by org.jibx.ws.wsdl.tools.custom.OperationCustom

public class OperationCustom
extends NestingBase

Operation customization information. This supports direct operation customizations (such as the corresponding request and/or response element name) and also acts as a container for parameter and/or return customizations.

Author:
Dennis M. Sosnoski

Field Summary
private  java.util.List m_documentation
           
private  java.lang.String m_methodName
           
private  java.lang.String m_operationName
           
private  java.lang.String[] m_optionals
           
private  java.util.ArrayList m_parameters
           
private  java.lang.String m_requestMessageName
           
private  java.lang.String m_requestWrapperName
           
private  java.lang.String[] m_requireds
           
private  java.lang.String m_responseMessageName
           
private  java.lang.String m_responseWrapperName
           
private  ValueCustom m_return
           
private  java.lang.String m_soapAction
           
private  java.util.ArrayList m_throws
           
static StringArray s_allowedAttributes
          Enumeration of allowed attribute names
private static org.apache.log4j.Logger s_logger
          Logger for class.
 
Fields inherited from class org.jibx.custom.classes.CustomBase
CAMEL_CASE_NAMES, DERIVE_BY_PACKAGE, DERIVE_FIXED, DERIVE_NONE, DOTTED_NAMES, HYPHENATED_NAMES, REQUIRE_ALL, REQUIRE_NONE, REQUIRE_OBJECTS, REQUIRE_PRIMITIVES, s_namespaceStyleEnum, s_nameStyleEnum, s_requireEnum, UNDERSCORED_NAMES, UPPER_CAMEL_CASE_NAMES
 
Constructor Summary
OperationCustom(NestingBase parent, java.lang.String name)
          Constructor.
 
Method Summary
protected  void addChild(CustomBase child)
          Add child.
 void apply(IClassItem method, IClassLocator icl, IDocumentFormatter fmt)
          Apply customizations to method to fill out parameter and return information.
private  ValueCustom buildValue(java.lang.String name, java.lang.String itype)
          Build value representation.
private static java.lang.Boolean checkRequired(java.lang.String name, java.util.Set reqset, java.util.Set optset)
          Check if a particular value is required or optional.
private static OperationCustom factory(IUnmarshallingContext ictx)
          Unmarshalling factory.
 java.util.List getDocumentation()
          Get operation documentation.
 java.lang.String getMethodName()
          Get method name.
 java.lang.String getOperationName()
          Get the operation name.
 java.util.ArrayList getParameters()
          Get list of children.
 java.lang.String getRequestMessageName()
          Get request message name.
 java.lang.String getRequestWrapperName()
          Get request wrapper element name.
 java.lang.String getResponseMessageName()
          Get response message name.
 java.lang.String getResponseWrapperName()
          Get response wrapper name.
 ValueCustom getReturn()
          Get return value.
 java.lang.String getSoapAction()
          Get SOAPAction.
 java.util.ArrayList getThrows()
          Get list of throws customizations.
 java.lang.String getWsdlNamespace()
          Get the namespace for WSDL definitions of this service.
private  boolean isCollection(java.lang.String type, IClassLocator icl)
          Check if type is a collection type (specifically collection, not array).
private  java.lang.String parameterType(SignatureParser parse)
          Parse parameter type.
 
Methods inherited from class org.jibx.ws.wsdl.tools.custom.NestingBase
getChild, getContainingClass, getServiceBase, isNillable, isSoapAction, isWrapped, registerName
 
Methods inherited from class org.jibx.custom.classes.SharedNestingBase
convertName, getFormatterClass, getNamespace, getNamespaceStyle, getNameStyle, getSpecifiedNamespace, isObjectRequired, isPrimitiveRequired, isUseJavaDocs, setNamespace, setNamespaceStyle, setNameStyle
 
Methods inherited from class org.jibx.custom.classes.CustomBase
convertName, deriveItemName, deriveNamespace, getContainingObject, getGlobal, getParent, packageOfType, packageToNamespace, validateAttributes
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

s_logger

private static final org.apache.log4j.Logger s_logger
Logger for class.


s_allowedAttributes

public static final StringArray s_allowedAttributes
Enumeration of allowed attribute names


m_methodName

private java.lang.String m_methodName

m_operationName

private java.lang.String m_operationName

m_requestMessageName

private java.lang.String m_requestMessageName

m_requestWrapperName

private java.lang.String m_requestWrapperName

m_responseMessageName

private java.lang.String m_responseMessageName

m_responseWrapperName

private java.lang.String m_responseWrapperName

m_soapAction

private java.lang.String m_soapAction

m_documentation

private java.util.List m_documentation

m_requireds

private java.lang.String[] m_requireds

m_optionals

private java.lang.String[] m_optionals

m_parameters

private final java.util.ArrayList m_parameters

m_return

private ValueCustom m_return

m_throws

private final java.util.ArrayList m_throws
Constructor Detail

OperationCustom

OperationCustom(NestingBase parent,
                java.lang.String name)
Constructor.

Parameters:
parent -
name - method name
Method Detail

getWsdlNamespace

public java.lang.String getWsdlNamespace()
Get the namespace for WSDL definitions of this service.

Specified by:
getWsdlNamespace in class NestingBase
Returns:
WSDL namespace

getMethodName

public java.lang.String getMethodName()
Get method name.

Returns:
name

getOperationName

public java.lang.String getOperationName()
Get the operation name.

Returns:
operation name

getRequestMessageName

public java.lang.String getRequestMessageName()
Get request message name.

Returns:
name

getRequestWrapperName

public java.lang.String getRequestWrapperName()
Get request wrapper element name.

Returns:
name

getResponseMessageName

public java.lang.String getResponseMessageName()
Get response message name.

Returns:
name

getResponseWrapperName

public java.lang.String getResponseWrapperName()
Get response wrapper name.

Returns:
name

getReturn

public ValueCustom getReturn()
Get return value.

Returns:
return

getSoapAction

public java.lang.String getSoapAction()
Get SOAPAction.

Returns:
soapAction

getDocumentation

public java.util.List getDocumentation()
Get operation documentation.

Returns:
list of documentation nodes (null if none)

getParameters

public java.util.ArrayList getParameters()
Get list of children.

Returns:
list

getThrows

public java.util.ArrayList getThrows()
Get list of throws customizations.

Returns:
list

addChild

protected void addChild(CustomBase child)
Add child.

Parameters:
child -

factory

private static OperationCustom factory(IUnmarshallingContext ictx)
                                throws JiBXException
Unmarshalling factory. This gets the containing element and the name so that the standard constructor can be used.

Parameters:
ictx -
Returns:
created instance
Throws:
JiBXException

isCollection

private boolean isCollection(java.lang.String type,
                             IClassLocator icl)
Check if type is a collection type (specifically collection, not array).

Parameters:
type -
Returns:
item type, null if not a collection type

parameterType

private java.lang.String parameterType(SignatureParser parse)
Parse parameter type.

Parameters:
parse -
Returns:
parameter type

buildValue

private ValueCustom buildValue(java.lang.String name,
                               java.lang.String itype)
Build value representation. The value may be either a simple value or a collection value.

Parameters:
name -
itype - item type (null if not a collection)
Returns:
value

checkRequired

private static java.lang.Boolean checkRequired(java.lang.String name,
                                               java.util.Set reqset,
                                               java.util.Set optset)
Check if a particular value is required or optional.

Parameters:
name -
reqset -
optset -
Returns:
TRUE if required, FALSE if optional, null if unknown

apply

public void apply(IClassItem method,
                  IClassLocator icl,
                  IDocumentFormatter fmt)
Apply customizations to method to fill out parameter and return information.

Parameters:
method -
icl -
fmt -


Project Web Site