ServiceCustom (JiBX Java data binding to XML

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.ServiceCustom

```
public class ServiceCustom
extends NestingBase
```
Service customization information. This supports direct service 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

Fields
Modifier and Type	Field	Description
`private java.lang.String`	`m_bindingName`
`private IClass`	`m_classInformation`
`private java.lang.String`	`m_className`
`private java.util.List`	`m_documentation`
`private java.lang.String[]`	`m_excludes`
`private java.lang.String[]`	`m_includes`
`private java.lang.String`	`m_namespace`
`private java.util.ArrayList`	`m_operations`
`private java.lang.String`	`m_portName`
`private java.lang.String`	`m_portTypeName`
`private java.lang.String`	`m_serviceAddress`
`private java.lang.String`	`m_serviceName`
`private java.lang.String`	`m_wsdlNamespace`
`static StringArray`	`s_allowedAttributes`	Enumeration of allowed attribute names
`private static 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

Constructors
Constructor Description

ServiceCustom(SharedNestingBase parent, java.lang.String clas)
Constructor.

Constructors
Constructor	Description
`ServiceCustom(SharedNestingBase parent, java.lang.String clas)`	Constructor.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`protected void`	`addChild(CustomBase child)`	Add child.
`void`	`apply(IClassLocator icl, IDocumentFormatter fmt)`	Apply customizations to service to fill out members.
`private java.lang.String`	`deriveServiceNamespace(java.lang.String uri)`	Derive service-specific namespace URI.
`private static ServiceCustom`	`factory(IUnmarshallingContext ictx)`	Unmarshalling factory.
`java.lang.String`	`getBindingName()`	Get the binding name.
`java.lang.String`	`getClassName()`	Get service class name.
`java.util.List`	`getDocumentation()`	Get service documentation node list.
`java.lang.String[]`	`getExcludes()`	Get list of method names to be excluded as operations.
`java.lang.String[]`	`getIncludes()`	Get list of method names to be included as operations.
`java.util.ArrayList`	`getOperations()`	Get list of children.
`java.lang.String`	`getPortName()`	Get the port name.
`java.lang.String`	`getPortTypeName()`	Get the portType name.
`java.lang.String`	`getServiceAddress()`	Get the service address.
`java.lang.String`	`getServiceName()`	Get the service name.
`java.lang.String`	`getWsdlNamespace()`	Get the namespace for WSDL definitions of this service.
`private void`	`preSet(IUnmarshallingContext uctx)`	Make sure all attributes are defined.

Methods inherited from class org.jibx.custom.classes.CustomBase
convertName, deriveItemName, deriveNamespace, getContainingObject, getGlobal, getParent, packageOfType, packageToNamespace, validateAttributes

Methods inherited from class org.jibx.ws.wsdl.tools.custom.NestingBase
getChild, getContainingClass, getServiceBase, isNillable, isSoapAction, isWrapped, registerName

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from class org.jibx.custom.classes.SharedNestingBase
convertName, getFormatterClass, getNamespace, getNamespaceStyle, getNameStyle, getSpecifiedNamespace, isObjectRequired, isPrimitiveRequired, isUseJavaDocs, setNamespace, setNamespaceStyle, setNameStyle

- Field Detail
  - s_logger
```
private static final Logger s_logger
```
    Logger for class.
  - s_allowedAttributes
```
public static final StringArray s_allowedAttributes
```
    Enumeration of allowed attribute names
  - m_className
```
private final java.lang.String m_className
```
  - m_serviceName
```
private java.lang.String m_serviceName
```
  - m_portName
```
private java.lang.String m_portName
```
  - m_bindingName
```
private java.lang.String m_bindingName
```
  - m_portTypeName
```
private java.lang.String m_portTypeName
```
  - m_wsdlNamespace
```
private java.lang.String m_wsdlNamespace
```
  - m_serviceAddress
```
private java.lang.String m_serviceAddress
```
  - m_documentation
```
private java.util.List m_documentation
```
  - m_includes
```
private java.lang.String[] m_includes
```
  - m_excludes
```
private java.lang.String[] m_excludes
```
  - m_operations
```
private final java.util.ArrayList m_operations
```
  - m_classInformation
```
private IClass m_classInformation
```
  - m_namespace
```
private java.lang.String m_namespace
```
- Constructor Detail
  - ServiceCustom
```
public ServiceCustom(SharedNestingBase parent,
                     java.lang.String clas)
```
    Constructor.
    
    Parameters:
    
    parent -
    
    clas -
- Method Detail
  - preSet
```
private void preSet(IUnmarshallingContext uctx)
```
    Make sure all attributes are defined.
    
    Parameters:
    
    uctx - unmarshalling context
  - getClassName
```
public java.lang.String getClassName()
```
    Get service class name.
    
    Returns:
    
    class name
  - getServiceName
```
public java.lang.String getServiceName()
```
    Get the service name.
    
    Returns:
    
    service name
  - getPortName
```
public java.lang.String getPortName()
```
    Get the port name.
    
    Returns:
    
    port name
  - getBindingName
```
public java.lang.String getBindingName()
```
    Get the binding name.
    
    Returns:
    
    binding name
  - getPortTypeName
```
public java.lang.String getPortTypeName()
```
    Get the portType name.
    
    Returns:
    
    portType name
  - getServiceAddress
```
public java.lang.String getServiceAddress()
```
    Get the service address.
    
    Returns:
    
    service address
  - getDocumentation
```
public java.util.List getDocumentation()
```
    Get service documentation node list.
    
    Returns:
    
    list of documentation nodes (null if none)
  - getExcludes
```
public java.lang.String[] getExcludes()
```
    Get list of method names to be excluded as operations.
    
    Returns:
    
    excludes (null if none)
  - getIncludes
```
public java.lang.String[] getIncludes()
```
    Get list of method names to be included as operations.
    
    Returns:
    
    includes (null if none)
  - getOperations
```
public java.util.ArrayList getOperations()
```
    Get list of children.
    
    Returns:
    
    list
  - getWsdlNamespace
```
public java.lang.String getWsdlNamespace()
```
    Get the namespace for WSDL definitions of this service. This value is set by the #apply(IClassLocator) method.
    
    Specified by:
    
    getWsdlNamespace in class NestingBase
    
    Returns:
    
    WSDL namespace
  - addChild
```
protected void addChild(CustomBase child)
```
    Add child.
    
    Parameters:
    
    child -
  - factory
```
private static ServiceCustom 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
  - deriveServiceNamespace
```
private java.lang.String deriveServiceNamespace(java.lang.String uri)
```
    Derive service-specific namespace URI. The appends the service name to the supplied URI, adding a path separator if necessary.
    
    Parameters:
    
    uri - base URI
    
    Returns:
    
    service-specific URI
  - apply
```
public void apply(IClassLocator icl,
                  IDocumentFormatter fmt)
```
    Apply customizations to service to fill out members.
    
    Parameters:
    
    icl - class locator
    
    fmt - JavaDoc formatter

Class ServiceCustom

Field Summary

Fields inherited from class org.jibx.custom.classes.CustomBase

Constructor Summary

Method Summary

Methods inherited from class org.jibx.custom.classes.CustomBase

Methods inherited from class org.jibx.ws.wsdl.tools.custom.NestingBase

Methods inherited from class java.lang.Object

Methods inherited from class org.jibx.custom.classes.SharedNestingBase

Field Detail

s_logger

s_allowedAttributes

m_className

m_serviceName

m_portName

m_bindingName

m_portTypeName

m_wsdlNamespace

m_serviceAddress

m_documentation

m_includes

m_excludes

m_operations

m_classInformation

m_namespace

Constructor Detail

ServiceCustom

Method Detail

preSet

getClassName

getServiceName

getPortName

getBindingName

getPortTypeName

getServiceAddress

getDocumentation

getExcludes

getIncludes

getOperations

getWsdlNamespace

addChild

factory

deriveServiceNamespace

apply