Class WsdlCustom

  • All Implemented Interfaces:
    IApply

    public class WsdlCustom
    extends NestingBase
    implements IApply
    Global customization information for WSDL generation. This extends the binding customization model to include the information used for service definitions.
    Author:
    Dennis M. Sosnoski
    • Field Detail

      • s_allowedAttributes

        public static final StringArray s_allowedAttributes
        Enumeration of allowed attribute names
      • m_wsdlNamespace

        private java.lang.String m_wsdlNamespace
        Customization value from unmarshalling.
      • m_faultList

        private final java.util.ArrayList m_faultList
        List of Fault definitions.
      • m_faultMap

        private final java.util.Map m_faultMap
        Map from fully-qualified class name to Fault information.
      • m_serviceList

        private final java.util.ArrayList m_serviceList
        List of services, in order added.
      • m_serviceMap

        private final java.util.Map m_serviceMap
        Map from fully-qualified class name to service information.
      • m_formatCache

        private FormatterCache m_formatCache
        JavaDoc formatter instance cache.
    • Constructor Detail

      • WsdlCustom

        public WsdlCustom​(SharedNestingBase parent)
        Constructor.
        Parameters:
        parent -
    • Method Detail

      • preSet

        private void preSet​(IUnmarshallingContext uctx)
        Make sure all attributes are defined.
        Parameters:
        uctx - unmarshalling context
      • getWsdlNamespace

        public java.lang.String getWsdlNamespace()
        Get the namespace for WSDL definitions of services.
        Specified by:
        getWsdlNamespace in class NestingBase
        Returns:
        WSDL namespace (null if unspecified)
      • setWsdlNamespace

        public void setWsdlNamespace​(java.lang.String uri)
        Set the namespace for WSDL definitions of services.
        Parameters:
        uri - WSDL namespace (null if to be derived from service class name)
      • getFaults

        public java.util.List getFaults()
        Get list of Faults.
        Returns:
        fault list
      • getFaultCustomization

        public FaultCustom getFaultCustomization​(java.lang.String type)
        Get fault customization information. This method should only be used after the apply(IClassLocator) method is called.
        Parameters:
        type - fully qualified class name
        Returns:
        fault customization (null if none)
      • forceFaultCustomization

        public FaultCustom forceFaultCustomization​(java.lang.String type)
        Force fault customization information. This method should only be used after the apply(IClassLocator) method is called. If the fault customization information has not previously been created, it will be created by this call.
        Parameters:
        type - fully qualified exception class name
        Returns:
        fault customization (null if none)
      • getServices

        public java.util.List getServices()
        Get list of services.
        Returns:
        service list
      • getServiceCustomization

        public ServiceCustom getServiceCustomization​(java.lang.String type)
        Get service customization information. This method should only be used after the apply(IClassLocator) method is called.
        Parameters:
        type - fully qualified class name
        Returns:
        service customization (null if none)
      • addServiceCustomization

        public ServiceCustom addServiceCustomization​(java.lang.String type)
        Add new service customization. This creates the service customization, using defaults, and adds it to the internal structures. This method should only be used after first calling getServiceCustomization(String) and obtaining a null result.
        Parameters:
        type - fully qualified class name
        Returns:
        service customization
      • getFormatter

        public IDocumentFormatter getFormatter​(SharedNestingBase custom)
        Get a JavaDoc formatter instance for a class.
        Parameters:
        custom - customization information
        Returns:
        formatter
      • factory

        private static WsdlCustom factory​(IUnmarshallingContext ictx)
        Unmarshalling factory. This gets the containing element and the name so that the standard constructor can be used.
        Parameters:
        ictx -
        Returns:
        created instance
      • apply

        public void apply​(IClassLocator icl)
        Apply customizations to services to fill out members.
        Specified by:
        apply in interface IApply
        Parameters:
        icl - class locator