PortComposite (Apache Axis2 - Metadata 1.7.9 API)

java.lang.Object
- org.apache.axis2.jaxws.description.builder.DescriptionBuilderComposite
- - org.apache.axis2.jaxws.description.builder.PortComposite

All Implemented Interfaces:

TMAnnotationComposite, TMFAnnotationComposite
```
public class PortComposite
extends DescriptionBuilderComposite
```
This subclass of the DescriptionBuilderComposite will be used to model information specific to a port. The DescriptionBuilderComposite, when used in server-side processing, more or less represents a single web service implementation class. It is possible, and likely, that a single implementation class will serve multiple ports. The PortComposite allows metadata that applies at the port level to be separated from the DescriptionBuilderComposite. This will allow processing and configuring of multiple ports in the description hierarchy from a single DBC object.

Constructor Summary

Constructors
Constructor and Description

PortComposite(DescriptionBuilderComposite baseDBC)

Constructors
Constructor and Description
`PortComposite(DescriptionBuilderComposite baseDBC)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addPortComposite(PortComposite portDBC)` Adds a PortComposite to the generic list.
`BindingTypeAnnot`	`getBindingTypeAnnot()`
`JAXWSCatalogManager`	`getCatalogManager()` Returns the catalog manager associated with this composite, if any.
`ClassLoader`	`getClassLoader()`
`String[]`	`getClassModifiers()`
`String`	`getClassName()`
`List<CustomAnnotationInstance>`	`getCustomAnnotationInstances()`
`Map<String,CustomAnnotationProcessor>`	`getCustomAnnotationProcessors()`
`WsdlGenerator`	`getCustomWsdlGenerator()`
`FieldDescriptionComposite`	`getFieldDescriptionComposite(String fieldName)`
`HandlerChainAnnot`	`getHandlerChainAnnot()`
`HandlerChainsType`	`getHandlerChainsType()`
`List<String>`	`getInterfacesList()`
`List<MethodDescriptionComposite>`	`getMethodDescriptionComposite(String methodName)` Returns a collection of all MethodDescriptionComposites that match the specified name
`MethodDescriptionComposite`	`getMethodDescriptionComposite(String methodName, int occurence)` Returns the nth occurence of this MethodComposite.
`List<MethodDescriptionComposite>`	`getMethodDescriptionsList()`
`List<PortComposite>`	`getPortComposites()` Gets the generic PortComposite instances.
`QName`	`getPreferredPort()` For a service requester, the QName of the prefered port for this service.
`QName`	`getPreferredPort(Object key)`
`Map<String,Object>`	`getProperties()`
`ServiceModeAnnot`	`getServiceModeAnnot()`
`Set<QName>`	`getServiceQNames()` Get the set of wsdl:service QNames represented by this DBC's metadata
`SoapBindingAnnot`	`getSoapBindingAnnot()`
`String`	`getSuperClassName()`
`WebServiceAnnot`	`getWebServiceAnnot()`
`WebServiceProviderAnnot`	`getWebServiceProviderAnnot()`
`javax.wsdl.Definition`	`getWsdlDefinition()`
`javax.wsdl.Definition`	`getWsdlDefinition(QName serviceQName)` Retrive a WSDL Definition by a service QName
`URL`	`getWsdlURL(QName serviceQName)` Retrive a WSDL URL by a service QName
`boolean`	`isInterface()`
`boolean`	`isMTOMEnabled()`
`void`	`setBindingTypeAnnot(BindingTypeAnnot bindingTypeAnnot)`
`void`	`setCustomWsdlGenerator(WsdlGenerator wsdlGenerator)`
`void`	`setHandlerChainAnnot(HandlerChainAnnot handlerChainAnnot)`
`void`	`setHandlerChainsType(HandlerChainsType handlerChainsType)`
`void`	`setIsMTOMEnabled(boolean isMTOMEnabled)`
`void`	`setProperties(Map<String,Object> properties)`
`void`	`setServiceQNames(Set<QName> serviceQNames)` Add the set of wsdl:service QNames that are represented by this DBC's metadata
`void`	`setWebServiceAnnot(WebServiceAnnot webServiceAnnot)`
`void`	`setWebServiceProviderAnnot(WebServiceProviderAnnot webServiceProviderAnnot)`
`void`	`setWsdlDefinition(QName serviceQName, javax.wsdl.Definition definition)` Store a WSDL Definition keyed by a service QName
`void`	`setwsdlURL(QName serviceQName, URL url)` Store a WSDL URL keyed by a service QName
`String`	`toString()` Convenience method for unit testing.

Methods inherited from class org.apache.axis2.jaxws.description.builder.DescriptionBuilderComposite
addCustomAnnotationInstance, addCustomAnnotationProcessor, addFieldDescriptionComposite, addMethodDescriptionComposite, addPortComposite, addWebServiceFeature, addWebServiceRefAnnot, getAllWebServiceRefAnnots, getConfigurationContext, getCorrespondingClass, getPortComposites, getServiceRefName, getServiceRefName, getSparseComposite, getWebFaultAnnot, getWebServiceClientAnnot, getWebServiceClientAnnot, getWebServiceFeatures, getWebServiceRefAnnot, getWsdlURL, isMTOMEnabled, isServiceProvider, setCatalogManager, setClassLoader, setClassModifiers, setClassName, setCorrespondingClass, setInterfacesList, setIsInterface, setIsServiceProvider, setPreferredPort, setServiceModeAnnot, setSoapBindingAnnot, setSparseComposite, setSuperClassName, setWebFaultAnnot, setWebServiceClientAnnot, setWebServiceFeatures, setWebServiceRefAnnot, setWsdlDefinition, setwsdlURL

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

- Constructor Detail
  - PortComposite
```
public PortComposite(DescriptionBuilderComposite baseDBC)
```
- Method Detail
  - getCustomWsdlGenerator
```
public WsdlGenerator getCustomWsdlGenerator()
```
    Overrides:
    
    getCustomWsdlGenerator in class DescriptionBuilderComposite
    
    Returns:
    
    Returns the ModuleClassType.
  - getWebServiceAnnot
```
public WebServiceAnnot getWebServiceAnnot()
```
    Overrides:
    
    getWebServiceAnnot in class DescriptionBuilderComposite
  - getWebServiceProviderAnnot
```
public WebServiceProviderAnnot getWebServiceProviderAnnot()
```
    Overrides:
    
    getWebServiceProviderAnnot in class DescriptionBuilderComposite
    
    Returns:
    
    Returns the webServiceProviderAnnot.
  - setCustomWsdlGenerator
```
public void setCustomWsdlGenerator(WsdlGenerator wsdlGenerator)
```
    Overrides:
    
    setCustomWsdlGenerator in class DescriptionBuilderComposite
  - setHandlerChainAnnot
```
public void setHandlerChainAnnot(HandlerChainAnnot handlerChainAnnot)
```
    Specified by:
    
    setHandlerChainAnnot in interface TMFAnnotationComposite
    
    Overrides:
    
    setHandlerChainAnnot in class DescriptionBuilderComposite
    
    Parameters:
    
    handlerChainAnnot - The handlerChainAnnot to set.
  - setHandlerChainsType
```
public void setHandlerChainsType(HandlerChainsType handlerChainsType)
```
    Overrides:
    
    setHandlerChainsType in class DescriptionBuilderComposite
  - setIsMTOMEnabled
```
public void setIsMTOMEnabled(boolean isMTOMEnabled)
```
    Overrides:
    
    setIsMTOMEnabled in class DescriptionBuilderComposite
  - setProperties
```
public void setProperties(Map<String,Object> properties)
```
    Overrides:
    
    setProperties in class DescriptionBuilderComposite
  - setWebServiceAnnot
```
public void setWebServiceAnnot(WebServiceAnnot webServiceAnnot)
```
    Overrides:
    
    setWebServiceAnnot in class DescriptionBuilderComposite
  - setWebServiceProviderAnnot
```
public void setWebServiceProviderAnnot(WebServiceProviderAnnot webServiceProviderAnnot)
```
    Overrides:
    
    setWebServiceProviderAnnot in class DescriptionBuilderComposite
    
    Parameters:
    
    webServiceProviderAnnot - The webServiceProviderAnnot to set.
  - getBindingTypeAnnot
```
public BindingTypeAnnot getBindingTypeAnnot()
```
    Overrides:
    
    getBindingTypeAnnot in class DescriptionBuilderComposite
    
    Returns:
    
    Returns the webServiceRefAnnot.
  - getHandlerChainAnnot
```
public HandlerChainAnnot getHandlerChainAnnot()
```
    Overrides:
    
    getHandlerChainAnnot in class DescriptionBuilderComposite
    
    Returns:
    
    Returns the handlerChainAnnotImpl.
  - getHandlerChainsType
```
public HandlerChainsType getHandlerChainsType()
```
    Overrides:
    
    getHandlerChainsType in class DescriptionBuilderComposite
  - isMTOMEnabled
```
public boolean isMTOMEnabled()
```
    Overrides:
    
    isMTOMEnabled in class DescriptionBuilderComposite
  - setBindingTypeAnnot
```
public void setBindingTypeAnnot(BindingTypeAnnot bindingTypeAnnot)
```
    Overrides:
    
    setBindingTypeAnnot in class DescriptionBuilderComposite
  - getProperties
```
public Map<String,Object> getProperties()
```
    Overrides:
    
    getProperties in class DescriptionBuilderComposite
  - addPortComposite
```
public void addPortComposite(PortComposite portDBC)
```
    Description copied from class: DescriptionBuilderComposite
    
    Adds a PortComposite to the generic list. This list of PortComposite objects is not keyed by wsdl:service QName.
    
    Overrides:
    
    addPortComposite in class DescriptionBuilderComposite
  - getPortComposites
```
public List<PortComposite> getPortComposites()
```
    Description copied from class: DescriptionBuilderComposite
    
    Gets the generic PortComposite instances.
    
    Overrides:
    
    getPortComposites in class DescriptionBuilderComposite
  - getCatalogManager
```
public JAXWSCatalogManager getCatalogManager()
```
    Description copied from class: DescriptionBuilderComposite
    
    Returns the catalog manager associated with this composite, if any.
    
    Overrides:
    
    getCatalogManager in class DescriptionBuilderComposite
    
    Returns:
  - getClassLoader
```
public ClassLoader getClassLoader()
```
    Overrides:
    
    getClassLoader in class DescriptionBuilderComposite
    
    Returns:
    
    Returns the ClassLoader.
  - getClassModifiers
```
public String[] getClassModifiers()
```
    Overrides:
    
    getClassModifiers in class DescriptionBuilderComposite
    
    Returns:
    
    Returns the classModifiers.
  - getClassName
```
public String getClassName()
```
    Overrides:
    
    getClassName in class DescriptionBuilderComposite
    
    Returns:
    
    Returns the className.
  - getCustomAnnotationInstances
```
public List<CustomAnnotationInstance> getCustomAnnotationInstances()
```
    Overrides:
    
    getCustomAnnotationInstances in class DescriptionBuilderComposite
  - getCustomAnnotationProcessors
```
public Map<String,CustomAnnotationProcessor> getCustomAnnotationProcessors()
```
    Overrides:
    
    getCustomAnnotationProcessors in class DescriptionBuilderComposite
  - getFieldDescriptionComposite
```
public FieldDescriptionComposite getFieldDescriptionComposite(String fieldName)
```
    Overrides:
    
    getFieldDescriptionComposite in class DescriptionBuilderComposite
    
    Returns:
    
    Returns the methodDescriptionComposite..null if not found
  - getInterfacesList
```
public List<String> getInterfacesList()
```
    Overrides:
    
    getInterfacesList in class DescriptionBuilderComposite
    
    Returns:
    
    Returns the list of implemented interfaces.
  - getMethodDescriptionComposite
```
public MethodDescriptionComposite getMethodDescriptionComposite(String methodName,
                                                                int occurence)
```
    Description copied from class: DescriptionBuilderComposite
    
    Returns the nth occurence of this MethodComposite. Since method names are not unique, we have to account for multiple occurrences
    
    Overrides:
    
    getMethodDescriptionComposite in class DescriptionBuilderComposite
    
    occurence - The nth occurance to return; not this is NOT 0 based
    
    Returns:
    
    Returns the methodDescriptionComposite
  - getMethodDescriptionComposite
```
public List<MethodDescriptionComposite> getMethodDescriptionComposite(String methodName)
```
    Description copied from class: DescriptionBuilderComposite
    
    Returns a collection of all MethodDescriptionComposites that match the specified name
    
    Overrides:
    
    getMethodDescriptionComposite in class DescriptionBuilderComposite
  - getMethodDescriptionsList
```
public List<MethodDescriptionComposite> getMethodDescriptionsList()
```
    Overrides:
    
    getMethodDescriptionsList in class DescriptionBuilderComposite
  - getPreferredPort
```
public QName getPreferredPort()
```
    Description copied from class: DescriptionBuilderComposite
    
    For a service requester, the QName of the prefered port for this service. This indicates which port should be returned if a port QName wasn't specified. This may be null, indicating the first valid port in the WSDL should be returned.
    
    Overrides:
    
    getPreferredPort in class DescriptionBuilderComposite
    
    Returns:
  - getPreferredPort
```
public QName getPreferredPort(Object key)
```
    Overrides:
    
    getPreferredPort in class DescriptionBuilderComposite
  - getServiceModeAnnot
```
public ServiceModeAnnot getServiceModeAnnot()
```
    Overrides:
    
    getServiceModeAnnot in class DescriptionBuilderComposite
    
    Returns:
    
    Returns the serviceModeAnnot.
  - getSoapBindingAnnot
```
public SoapBindingAnnot getSoapBindingAnnot()
```
    Overrides:
    
    getSoapBindingAnnot in class DescriptionBuilderComposite
    
    Returns:
    
    Returns the soapBindingAnnot.
  - getSuperClassName
```
public String getSuperClassName()
```
    Overrides:
    
    getSuperClassName in class DescriptionBuilderComposite
    
    Returns:
    
    Returns the super class name.
  - isInterface
```
public boolean isInterface()
```
    Overrides:
    
    isInterface in class DescriptionBuilderComposite
    
    Returns:
    
    Returns true if this is an interface
  - getWsdlDefinition
```
public javax.wsdl.Definition getWsdlDefinition()
```
    Overrides:
    
    getWsdlDefinition in class DescriptionBuilderComposite
    
    Returns:
    
    Returns the wsdlDefinition
  - getServiceQNames
```
public Set<QName> getServiceQNames()
```
    Description copied from class: DescriptionBuilderComposite
    
    Get the set of wsdl:service QNames represented by this DBC's metadata
    
    Overrides:
    
    getServiceQNames in class DescriptionBuilderComposite
    
    Returns:
  - getWsdlDefinition
```
public javax.wsdl.Definition getWsdlDefinition(QName serviceQName)
```
    Description copied from class: DescriptionBuilderComposite
    
    Retrive a WSDL Definition by a service QName
    
    Overrides:
    
    getWsdlDefinition in class DescriptionBuilderComposite
  - setServiceQNames
```
public void setServiceQNames(Set<QName> serviceQNames)
```
    Description copied from class: DescriptionBuilderComposite
    
    Add the set of wsdl:service QNames that are represented by this DBC's metadata
    
    Overrides:
    
    setServiceQNames in class DescriptionBuilderComposite
  - setWsdlDefinition
```
public void setWsdlDefinition(QName serviceQName,
                              javax.wsdl.Definition definition)
```
    Description copied from class: DescriptionBuilderComposite
    
    Store a WSDL Definition keyed by a service QName
    
    Overrides:
    
    setWsdlDefinition in class DescriptionBuilderComposite
  - setwsdlURL
```
public void setwsdlURL(QName serviceQName,
                       URL url)
```
    Description copied from class: DescriptionBuilderComposite
    
    Store a WSDL URL keyed by a service QName
    
    Overrides:
    
    setwsdlURL in class DescriptionBuilderComposite
  - getWsdlURL
```
public URL getWsdlURL(QName serviceQName)
```
    Description copied from class: DescriptionBuilderComposite
    
    Retrive a WSDL URL by a service QName
    
    Overrides:
    
    getWsdlURL in class DescriptionBuilderComposite
  - toString
```
public String toString()
```
    Description copied from class: DescriptionBuilderComposite
    
    Convenience method for unit testing. We will print all of the data members here.
    
    Overrides:
    
    toString in class DescriptionBuilderComposite

Class PortComposite

Constructor Summary

Method Summary

Methods inherited from class org.apache.axis2.jaxws.description.builder.DescriptionBuilderComposite

Methods inherited from class java.lang.Object

Constructor Detail

PortComposite

Method Detail

getCustomWsdlGenerator

getWebServiceAnnot

getWebServiceProviderAnnot

setCustomWsdlGenerator

setHandlerChainAnnot

setHandlerChainsType

setIsMTOMEnabled

setProperties

setWebServiceAnnot

setWebServiceProviderAnnot

getBindingTypeAnnot

getHandlerChainAnnot

getHandlerChainsType

isMTOMEnabled

setBindingTypeAnnot

getProperties

addPortComposite

getPortComposites

getCatalogManager

getClassLoader

getClassModifiers

getClassName

getCustomAnnotationInstances

getCustomAnnotationProcessors

getFieldDescriptionComposite

getInterfacesList

getMethodDescriptionComposite

getMethodDescriptionComposite

getMethodDescriptionsList

getPreferredPort

getPreferredPort

getServiceModeAnnot

getSoapBindingAnnot

getSuperClassName

isInterface

getWsdlDefinition

getServiceQNames

getWsdlDefinition

setServiceQNames

setWsdlDefinition

setwsdlURL

getWsdlURL

toString