Package javax.wsdl

Interface PortType

  • All Superinterfaces:
    AttributeExtensible, ElementExtensible, java.io.Serializable, WSDLElement
    All Known Implementing Classes:
    PortTypeImpl

    public interface PortType
    extends WSDLElement
    This interface represents a port type. It contains information about operations associated with this port type.
    Author:
    Paul Fremantle, Nirmal Mukhi, Matthew J. Duftler
    • Method Detail

      • setQName

        void setQName​(javax.xml.namespace.QName name)
        Set the name of this port type.
        Parameters:
        name - the desired name
      • getQName

        javax.xml.namespace.QName getQName()
        Get the name of this port type.
        Returns:
        the port type name
      • addOperation

        void addOperation​(Operation operation)
        Add an operation to this port type.
        Parameters:
        operation - the operation to be added
      • getOperation

        Operation getOperation​(java.lang.String name,
                               java.lang.String inputName,
                               java.lang.String outputName)
        Get the specified operation. Note that operation names can be overloaded within a PortType. In case of overloading, the names of the input and output messages can be used to further refine the search.

        The search criteria will be the operation name parameter and any non-null input or output message name parameters. To exclude the input or output message name from the search criteria, specify a null value for the input or output message name parameter. To search for operations with unnamed input or output messages (i.e. <input> or <output> elements with the 'name' attribute omitted), specify the string ":none" for the input or output message name parameter.

        Note: the use of a string value ":none" rather than null to search for unnamed input or output messages is necessary to retain backward compatibility with earlier versions of the JWSDL API, which defined a null value to mean 'ignore this parameter'. The colon in ":none" is to avoid name clashes with input or output message names, which must be of type NCName (i.e. they cannot contain colons).

        Parameters:
        name - the name of the desired operation.
        inputName - the name of the input message; if this is null it will be ignored, if this is ":none" it means search for an input message without a name.
        outputName - the name of the output message; if this is null it will be ignored, if this is ":none" it means search for an output message without a name.
        Returns:
        the corresponding operation, or null if there wasn't any matching operation
        Throws:
        java.lang.IllegalArgumentException - if duplicate operations are found.
      • getOperations

        java.util.List getOperations()
        Get all the operations defined here.
      • removeOperation

        Operation removeOperation​(java.lang.String name,
                                  java.lang.String inputName,
                                  java.lang.String outputName)
        Remove the specified operation. Note that operation names can be overloaded within a PortType. In case of overloading, the names of the input and output messages can be used to further refine the search.

        Usage of the input and output message name parameters is as described for the getOperation method.

        Parameters:
        name - the name of the desired operation.
        inputName - the name of the input message; if this is null it will be ignored, if this is ":none" it means search for an input message without a name.
        outputName - the name of the output message; if this is null it will be ignored, if this is ":none" it means search for an output message without a name.
        Returns:
        the operation which was removed, or null if there wasn't any matching operation
        Throws:
        java.lang.IllegalArgumentException - if duplicate operations are found.
        See Also:
        getOperation(String, String, String)
      • setUndefined

        void setUndefined​(boolean isUndefined)
      • isUndefined

        boolean isUndefined()