Package org.jibx.ws.wsdl.tools.custom
Class OperationCustom
java.lang.Object
org.jibx.custom.classes.CustomBase
org.jibx.custom.classes.SharedNestingBase
org.jibx.ws.wsdl.tools.custom.NestingBase
org.jibx.ws.wsdl.tools.custom.OperationCustom
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
FieldsModifier and TypeFieldDescriptionprivate List
private String
private String
private String[]
private final ArrayList
private String
private String
private String[]
private String
private String
private ValueCustom
private String
private final ArrayList
static final StringArray
Enumeration of allowed attribute namesprivate static final 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
Constructors -
Method Summary
Modifier and TypeMethodDescriptionprotected 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 static Boolean
checkRequired
(String name, Set reqset, Set optset) Check if a particular value is required or optional.private static OperationCustom
factory
(IUnmarshallingContext ictx) Unmarshalling factory.Get operation documentation.Get method name.Get the operation name.Get list of children.Get request message name.Get request wrapper element name.Get response message name.Get response wrapper name.Get return value.Get SOAPAction.Get list of throws customizations.Get the namespace for WSDL definitions of this service.private boolean
isCollection
(String type, IClassLocator icl) Check if type is a collection type (specifically collection, not array).private 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
-
Field Details
-
s_logger
private static final Logger s_loggerLogger for class. -
s_allowedAttributes
Enumeration of allowed attribute names -
m_methodName
-
m_operationName
-
m_requestMessageName
-
m_requestWrapperName
-
m_responseMessageName
-
m_responseWrapperName
-
m_soapAction
-
m_documentation
-
m_requireds
-
m_optionals
-
m_parameters
-
m_return
-
m_throws
-
-
Constructor Details
-
OperationCustom
OperationCustom(NestingBase parent, String name) Constructor.- Parameters:
parent
-name
- method name
-
-
Method Details
-
getWsdlNamespace
Get the namespace for WSDL definitions of this service.- Specified by:
getWsdlNamespace
in classNestingBase
- Returns:
- WSDL namespace
-
getMethodName
Get method name.- Returns:
- name
-
getOperationName
Get the operation name.- Returns:
- operation name
-
getRequestMessageName
Get request message name.- Returns:
- name
-
getRequestWrapperName
Get request wrapper element name.- Returns:
- name
-
getResponseMessageName
Get response message name.- Returns:
- name
-
getResponseWrapperName
Get response wrapper name.- Returns:
- name
-
getReturn
Get return value.- Returns:
- return
-
getSoapAction
Get SOAPAction.- Returns:
- soapAction
-
getDocumentation
Get operation documentation.- Returns:
- list of documentation nodes (
null
if none)
-
getParameters
Get list of children.- Returns:
- list
-
getThrows
Get list of throws customizations.- Returns:
- list
-
addChild
Add child.- Parameters:
child
-
-
factory
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
Check if type is a collection type (specifically collection, not array).- Parameters:
type
-- Returns:
- item type,
null
if not a collection type
-
parameterType
Parse parameter type.- Parameters:
parse
-- Returns:
- parameter type
-
checkRequired
Check if a particular value is required or optional.- Parameters:
name
-reqset
-optset
-- Returns:
TRUE
if required,FALSE
if optional,null
if unknown
-
apply
Apply customizations to method to fill out parameter and return information.- Parameters:
method
-icl
-fmt
-
-