Package org.apache.axis2.jaxws.description.builder

Class DescriptionBuilderComposite

java.lang.Object
org.apache.axis2.jaxws.description.builder.DescriptionBuilderComposite
All Implemented Interfaces:
TMAnnotationComposite, TMFAnnotationComposite
Direct Known Subclasses:
PortComposite
public class DescriptionBuilderComposite extends Object implements TMAnnotationComposite, TMFAnnotationComposite

  • Constructor Details

    • DescriptionBuilderComposite

      public DescriptionBuilderComposite()

    • DescriptionBuilderComposite

      public DescriptionBuilderComposite(org.apache.axis2.context.ConfigurationContext configContext)

  • Method Details

    • setSparseComposite

      public void setSparseComposite(Object key, DescriptionBuilderComposite sparseComposite)

    • getSparseComposite

      public DescriptionBuilderComposite getSparseComposite(Object key)

    • setPreferredPort

      public void setPreferredPort(QName preferredPort)
      For a service requester, set the QName of the preferred port for this service. This indicates which port (i.e. which EndpointDescription) should be returned if a port QName isn't specified. This may be null, indicating the first valid port in the WSDL should be returned.
      Parameters:
      preferredPort -

    • getPreferredPort

      public QName getPreferredPort()
      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.
      Returns:

    • getPreferredPort

      public QName getPreferredPort(Object key)

    • setIsMTOMEnabled

      public void setIsMTOMEnabled(boolean isMTOMEnabled)

    • isMTOMEnabled

      public boolean isMTOMEnabled()

    • isMTOMEnabled

      public boolean isMTOMEnabled(Object key)

    • getWebServiceAnnot

      public WebServiceAnnot getWebServiceAnnot()

    • getClassModifiers

      public String[] getClassModifiers()
      Returns:
      Returns the classModifiers.

    • getClassName

      public String getClassName()
      Returns:
      Returns the className.

    • getSuperClassName

      public String getSuperClassName()
      Returns:
      Returns the super class name.

    • getInterfacesList

      public List<String> getInterfacesList()
      Returns:
      Returns the list of implemented interfaces.

    • getHandlerChainAnnot

      public HandlerChainAnnot getHandlerChainAnnot()
      Returns:
      Returns the handlerChainAnnotImpl.

    • getServiceModeAnnot

      public ServiceModeAnnot getServiceModeAnnot()
      Returns:
      Returns the serviceModeAnnot.

    • getSoapBindingAnnot

      public SoapBindingAnnot getSoapBindingAnnot()
      Returns:
      Returns the soapBindingAnnot.

    • getWebFaultAnnot

      public WebFaultAnnot getWebFaultAnnot()
      Returns:
      Returns the webFaultAnnot.

    • getWebServiceClientAnnot

      public WebServiceClientAnnot getWebServiceClientAnnot()
      Returns:
      Returns the webServiceClientAnnot.

    • getWebServiceClientAnnot

      public WebServiceClientAnnot getWebServiceClientAnnot(Object key)

    • getWebServiceProviderAnnot

      public WebServiceProviderAnnot getWebServiceProviderAnnot()
      Returns:
      Returns the webServiceProviderAnnot.

    • getAllWebServiceRefAnnots

      public List<WebServiceRefAnnot> getAllWebServiceRefAnnots()
      Returns:
      Returns the webServiceRefAnnot list.

    • getWebServiceRefAnnot

      public WebServiceRefAnnot getWebServiceRefAnnot(String name)
      Returns:
      Returns the webServiceRefAnnot.

    • getBindingTypeAnnot

      public BindingTypeAnnot getBindingTypeAnnot()
      Returns:
      Returns the webServiceRefAnnot.

    • getWebServiceFeatures

      public List<Annotation> getWebServiceFeatures()

    • setWebServiceFeatures

      public void setWebServiceFeatures(List<Annotation> list)

    • addWebServiceFeature

      public void addWebServiceFeature(Annotation a)

    • getWsdlDefinition

      public javax.wsdl.Definition getWsdlDefinition()
      Returns:
      Returns the wsdlDefinition

    • getWsdlURL

      public URL getWsdlURL()
      Returns:
      Returns the wsdlURL

    • getMethodDescriptionComposite

      public List<MethodDescriptionComposite> getMethodDescriptionComposite(String methodName)
      Returns a collection of all MethodDescriptionComposites that match the specified name

    • getMethodDescriptionComposite

      public MethodDescriptionComposite getMethodDescriptionComposite(String methodName, int occurence)
      Returns the nth occurence of this MethodComposite. Since method names are not unique, we have to account for multiple occurrences
      Parameters:
      methodName -
      occurence - The nth occurance to return; not this is NOT 0 based
      Returns:
      Returns the methodDescriptionComposite

    • getMethodDescriptionsList

      public List<MethodDescriptionComposite> getMethodDescriptionsList()

    • getFieldDescriptionComposite

      public FieldDescriptionComposite getFieldDescriptionComposite(String fieldName)
      Returns:
      Returns the methodDescriptionComposite..null if not found

    • getCustomWsdlGenerator

      public WsdlGenerator getCustomWsdlGenerator()
      Returns:
      Returns the ModuleClassType.

    • getClassLoader

      public ClassLoader getClassLoader()
      Returns:
      Returns the ClassLoader.

    • isInterface

      public boolean isInterface()
      Returns:
      Returns true if this is an interface

    • setWebServiceAnnot

      public void setWebServiceAnnot(WebServiceAnnot webServiceAnnot)

    • setClassModifiers

      public void setClassModifiers(String[] classModifiers)
      Parameters:
      classModifiers - The classModifiers to set.

    • setClassName

      public void setClassName(String className)
      Parameters:
      className - The className to set.

    • setSuperClassName

      public void setSuperClassName(String extendsClass)
      Parameters:
      extendsClass - The name of the super class to set.

    • setInterfacesList

      public void setInterfacesList(List<String> interfacesList)
      Parameters:
      interfacesList - The interfacesList to set.

    • setHandlerChainAnnot

      public void setHandlerChainAnnot(HandlerChainAnnot handlerChainAnnot)
      Specified by:
      setHandlerChainAnnot in interface TMFAnnotationComposite
      Parameters:
      handlerChainAnnot - The handlerChainAnnot to set.

    • setServiceModeAnnot

      public void setServiceModeAnnot(ServiceModeAnnot serviceModeAnnot)
      Parameters:
      serviceModeAnnot - The serviceModeAnnot to set.

    • setSoapBindingAnnot

      public void setSoapBindingAnnot(SoapBindingAnnot soapBindingAnnot)
      Specified by:
      setSoapBindingAnnot in interface TMAnnotationComposite
      Parameters:
      soapBindingAnnot - The soapBindingAnnot to set.

    • setWebFaultAnnot

      public void setWebFaultAnnot(WebFaultAnnot webFaultAnnot)
      Parameters:
      webFaultAnnot - The webFaultAnnot to set.

    • setWebServiceClientAnnot

      public void setWebServiceClientAnnot(WebServiceClientAnnot webServiceClientAnnot)
      Parameters:
      webServiceClientAnnot - The webServiceClientAnnot to set.

    • setWebServiceProviderAnnot

      public void setWebServiceProviderAnnot(WebServiceProviderAnnot webServiceProviderAnnot)
      Parameters:
      webServiceProviderAnnot - The webServiceProviderAnnot to set.

    • addWebServiceRefAnnot

      public void addWebServiceRefAnnot(WebServiceRefAnnot webServiceRefAnnot)
      Parameters:
      webServiceRefAnnot - The webServiceRefAnnot to add to the list.

    • setWebServiceRefAnnot

      public void setWebServiceRefAnnot(WebServiceRefAnnot webServiceRefAnnot)
      Specified by:
      setWebServiceRefAnnot in interface TMFAnnotationComposite

    • addCustomAnnotationProcessor

      public void addCustomAnnotationProcessor(CustomAnnotationProcessor processor)

    • getCustomAnnotationProcessors

      public Map<String,CustomAnnotationProcessor> getCustomAnnotationProcessors()

    • addCustomAnnotationInstance

      public void addCustomAnnotationInstance(CustomAnnotationInstance annotation)

    • getCustomAnnotationInstances

      public List<CustomAnnotationInstance> getCustomAnnotationInstances()

    • setWsdlDefinition

      public void setWsdlDefinition(javax.wsdl.Definition wsdlDef)
      Parameters:
      wsdlDefinition - The wsdlDefinition to set.

    • setwsdlURL

      public void setwsdlURL(URL wsdlURL)
      Parameters:
      wsdlURL - The wsdlURL to set.

    • setBindingTypeAnnot

      public void setBindingTypeAnnot(BindingTypeAnnot bindingTypeAnnot)
      Parameters:
      BindingTypeAnnot - The BindingTypeAnnot to set.

    • setIsInterface

      public void setIsInterface(boolean isInterface)
      Parameters:
      isInterface - Sets whether this composite represents a class or interface

    • addMethodDescriptionComposite

      public void addMethodDescriptionComposite(MethodDescriptionComposite methodDescription)
      Parameters:
      methodDescription - The methodDescription to add to the set.

    • addFieldDescriptionComposite

      public void addFieldDescriptionComposite(FieldDescriptionComposite fieldDescription)
      Parameters:
      methodDescription - The methodDescription to add to the set.

    • setCustomWsdlGenerator

      public void setCustomWsdlGenerator(WsdlGenerator wsdlGenerator)

    • setClassLoader

      public void setClassLoader(ClassLoader classLoader)

    • getHandlerChainsType

      public HandlerChainsType getHandlerChainsType()

    • setHandlerChainsType

      public void setHandlerChainsType(HandlerChainsType handlerChainsType)

    • isServiceProvider

      public boolean isServiceProvider()
      Answer does this composite represent a service requester (aka client) or a service provider (aka server).
      Returns:
      true if this is a service provider (aka an endpoint or a service implementation or a server)

    • setIsServiceProvider

      public void setIsServiceProvider(boolean value)
      Set the indication of whether this composite represents a service requester (aka client) or a service provider (aka server).

    • setCorrespondingClass

      public void setCorrespondingClass(Class theClass)
      Set the class associated with this composite. For a service requester, this could be the Service class or the SEI class. For a service provider this will be null (unless the deprecated service construction logic in DescriptionFactory is used)
      Parameters:
      theClass -

    • getCorrespondingClass

      public Class getCorrespondingClass()
      Returns the corresponding class associated with this composite, if any.
      Returns:

    • setCatalogManager

      public void setCatalogManager(JAXWSCatalogManager theCatalogManager)
      Set the Catalog Manager associated with this composite.
      Parameters:
      theCatalogManger -

    • getCatalogManager

      public JAXWSCatalogManager getCatalogManager()
      Returns the catalog manager associated with this composite, if any.
      Returns:

    • setProperties

      public void setProperties(Map<String,Object> properties)

    • getProperties

      public Map<String,Object> getProperties()

    • setWsdlDefinition

      public void setWsdlDefinition(QName serviceQName, javax.wsdl.Definition definition)
      Store a WSDL Definition keyed by a service QName

    • getWsdlDefinition

      public javax.wsdl.Definition getWsdlDefinition(QName serviceQName)
      Retrive a WSDL Definition by a service QName

    • setwsdlURL

      public void setwsdlURL(QName serviceQName, URL url)
      Store a WSDL URL keyed by a service QName

    • getWsdlURL

      public URL getWsdlURL(QName serviceQName)
      Retrive a WSDL URL by a service QName

    • setServiceQNames

      public void setServiceQNames(Set<QName> serviceQNames)
      Add the set of wsdl:service QNames that are represented by this DBC's metadata

    • getServiceQNames

      public Set<QName> getServiceQNames()
      Get the set of wsdl:service QNames represented by this DBC's metadata
      Returns:

    • toString

      public String toString()
      Convenience method for unit testing. We will print all of the data members here.
      Overrides:
      toString in class Object

    • getConfigurationContext

      public org.apache.axis2.context.ConfigurationContext getConfigurationContext()

    • addPortComposite

      public void addPortComposite(PortComposite portDBC)
      Adds a PortComposite to the generic list. This list of PortComposite objects is not keyed by wsdl:service QName.

    • addPortComposite

      public void addPortComposite(QName serviceQName, PortComposite portDBC)
      Adds a PortComposite to a list that is keyed by a wsdl:service QName.

    • getPortComposites

      public List<PortComposite> getPortComposites()
      Gets the generic PortComposite instances.

    • getPortComposites

      public List<PortComposite> getPortComposites(QName serviceQName)
      Gets all the PortComposite instances associated with a particular wsdl:service QName.
      Returns:

    • getServiceRefName

      public static String getServiceRefName(DescriptionBuilderComposite sparseComposite)
      Static utility method that, given a sparse composite, returns the SERVICE_REF_NAME value from the property on that sparse composite or null if the property was not specified.
      Parameters:
      sparseComposite - The sparse composite instance to get the SERVICE_REF_NAME parameter from
      Returns:
      A String containing the Service Ref Name or null if the parameter was not found.

    • getServiceRefName

      public String getServiceRefName(Object serviceDelegateKey)
      For the current composite, return the serivce ref name from the sparse composite associted with the service delegate key.
      Parameters:
      serviceDelegateKey - The instance of the service delegate associated with the sparse composite from which the service ref name is to be retrieved.
      Returns:
      The service ref name associated with the service delegate key or null if one was not found.