Package com.ibm.websphere.wsrf

This package describes the Web service Resource Framework (WS-RF) interfaces available to application programmers.

See: Description

  • Interface Summary 
    Interface Description
    BaseFaultBinderHelper
    The BaseFaultBinderHelper interface provides support for serializing and deserializing the data that is specific to a root BaseFault class, which all specialized BaseFault classes must extend.
    IOSerializableSOAPElement
    An IOSerializableSOAPElement object represents a java.io.Serializable form of a javax.xml.soap.SOAPElement.
  • Class Summary 
    Class Description
    Attribute
    The Attribute class represents an attribute of a BaseFault.
    BaseFaultBinderHelperFactory
    BaseFaultBinderHelperFactory is used to provide a singleton instance of BaseFaultBinderHelper.
    ErrorCode
    The ErrorCode class represents an ErrorCode of a BaseFault.
    FaultDescription
    The FaultDescription class represents a free form string description of a fault.
    IOSerializableSOAPElementFactory
    An instance of IOSerializableSOAPElementFactory is used to create IOSerializableSOAPElements, which represent a java.io.Serializable form of a javax.xml.soap.SOAPElement Web Services BaseFault implementations, which derive from java.lang.Exception, make use of this mechanism to allow any SOAPElement content to be java.io.Serializable as java.lang.Exceptions must themselves be java.io.Serializable.
    NewTerminationTime
    This class represents the XML element "wsrf-rl:NewTerminationTime" <xsd:element name="NewTerminationTime" nillable="true" type="xsd:dateTime" />
    RequestedTerminationTime
    This class represents the XML element "wsrf-rl:RequestedTerminationTime" <xsd:element name="RequestedTerminationTime" nillable="true" type="xsd:dateTime" />
    ResourcePropertyChangeFailure
    This class represents the XML complexType "wsrf-rp:ResourcePropertyChangeFailureType" <xsd:complexType name="ResourcePropertyChangeFailureType"> <xsd:sequence> <xsd:element name="CurrentValue" minOccurs="0" maxOccurs="1"> <xsd:complexType> <xsd:sequence> <xsd:any minOccurs="1" maxOccurs="unbounded" /> </xsd:sequence> </xsd:complexType> </xsd:element> <xsd:element name="RequestedValue" minOccurs="0" maxOccurs="1"> <xsd:complexType> <xsd:sequence> <xsd:any minOccurs="1" maxOccurs="unbounded" /> </xsd:sequence> </xsd:complexType> </xsd:element> </xsd:sequence> <xsd:attribute name="Restored" type="xsd:boolean"/> </xsd:complexType>
    SetTerminationTime
    This class represents the XML complexType "wsrf-rl:SetTerminationTime" <xsd:element name="SetTerminationTime"> <xsd:complexType> <xsd:choice> <xsd:element name="RequestedTerminationTime" nillable="true" type="xsd:dateTime" /> <xsd:element name="RequestedLifetimeDuration" type="xsd:duration" /> </xsd:choice> </xsd:complexType> </xsd:element>
    SetTerminationTimeResponse
    This class represents the XML complexType "wsrf-rl:SetTerminationTimeResponse" <xsd:element name="SetTerminationTimeResponse"> <xsd:complexType> <xsd:sequence> <xsd:element name="NewTerminationTime" nillable="true" type="xsd:dateTime" /> <xsd:element name="CurrentTime" type="xsd:dateTime" /> </xsd:sequence> </xsd:complexType> </xsd:element>
  • Exception Summary 
    Exception Description
    AddRefusedFault
    This class represents the XML complexType "wsrf-sg:AddRefusedFaultType" <xsd:complexType name="AddRefusedFaultType"> <xsd:complexContent> <xsd:extension base="wsrf-bf:BaseFaultType"/> </xsd:complexContent> </xsd:complexType>
    BaseFault
    This class represents the XML complexType "wsrf-bf:BaseFault" <xsd:complexType name="BaseFaultType"> <xsd:sequence> <xsd:any namespace="##other" processContents="lax" minOccurs="0" maxOccurs="unbounded"/> <xsd:element name="Timestamp" type="xsd:dateTime" minOccurs="1" maxOccurs="1"/> <xsd:element name="Originator" type="wsa:EndpointReferenceType" minOccurs="0" maxOccurs="1"/> <xsd:element name="ErrorCode" minOccurs="0" maxOccurs="1"> <xsd:complexType> <xsd:complexContent mixed="true"> <xsd:extension base="xsd:anyType"> <xsd:attribute name="dialect" type="xsd:anyURI" use="required"/> </xsd:extension> </xsd:complexContent> </xsd:complexType> </xsd:element> <xsd:element name="Description" minOccurs="0" maxOccurs="unbounded"> <xsd:complexType> <xsd:simpleContent> <xsd:extension base="xsd:string"> <xsd:attribute ref="xml:lang" use="optional"/> </xsd:extension> </xsd:simpleContent> </xsd:complexType> </xsd:element> <xsd:element name="FaultCause" minOccurs="0" maxOccurs="1"> <xsd:complexType> <xsd:sequence> <xsd:any namespace="##other" processContents="lax" minOccurs="1" maxOccurs="1"/> </xsd:sequence> </xsd:complexType> </xsd:element> </xsd:sequence> <xsd:anyAttribute namespace="##other" processContents="lax"/> </xsd:complexType>
    ContentCreationFailedFault
    This class represents the XML complexType "wsrf-sg:ContentCreationFailedFaultType" <xsd:complexType name="ContentCreationFailedFaultType"> <xsd:complexContent> <xsd:extension base="wsrf-bf:BaseFaultType"/> </xsd:complexContent> </xsd:complexType>
    DeleteResourcePropertiesRequestFailedFault
    This class represents the XML complexType "wsrf-rp:DeleteResourcePropertiesRequestFailedFaultType" <xsd:complexType name="DeleteResourcePropertiesRequestFailedFaultType"> <xsd:complexContent> <xsd:extension base="wsrf-bf:BaseFaultType"> <xsd:sequence> <xsd:element name="ResourcePropertyChangeFailure" type="wsrf-rp:ResourcePropertyChangeFailureType"/> </xsd:sequence> </xsd:extension> </xsd:complexContent> </xsd:complexType> <xsd:complexType name="ResourcePropertyChangeFailureType"> <xsd:sequence> <xsd:element name="CurrentValue" minOccurs="0" maxOccurs="1"> <xsd:complexType> <xsd:sequence> <xsd:any minOccurs="1" maxOccurs="unbounded" /> </xsd:sequence> </xsd:complexType> </xsd:element> <xsd:element name="RequestedValue" minOccurs="0" maxOccurs="1"> <xsd:complexType> <xsd:sequence> <xsd:any minOccurs="1" maxOccurs="unbounded" /> </xsd:sequence> </xsd:complexType> </xsd:element> </xsd:sequence> <xsd:attribute name="Restored" type="xsd:boolean"/> </xsd:complexType>
    InsertResourcePropertiesRequestFailedFault
    This class represents the XML complexType "wsrf-rp:InsertResourcePropertiesRequestFailedFaultType" <xsd:complexType name="InsertResourcePropertiesRequestFailedFaultType"> <xsd:complexContent> <xsd:extension base="wsrf-bf:BaseFaultType"> <xsd:sequence> <xsd:element name="ResourcePropertyChangeFailure" type="wsrf-rp:ResourcePropertyChangeFailureType"/> </xsd:sequence> </xsd:extension> </xsd:complexContent> </xsd:complexType> <xsd:complexType name="ResourcePropertyChangeFailureType"> <xsd:sequence> <xsd:element name="CurrentValue" minOccurs="0" maxOccurs="1"> <xsd:complexType> <xsd:sequence> <xsd:any minOccurs="1" maxOccurs="unbounded" /> </xsd:sequence> </xsd:complexType> </xsd:element> <xsd:element name="RequestedValue" minOccurs="0" maxOccurs="1"> <xsd:complexType> <xsd:sequence> <xsd:any minOccurs="1" maxOccurs="unbounded" /> </xsd:sequence> </xsd:complexType> </xsd:element> </xsd:sequence> <xsd:attribute name="Restored" type="xsd:boolean"/> </xsd:complexType>
    InvalidModificationFault
    This class represents the XML complexType "wsrf-rp:InvalidModificationFaultType" <xsd:complexType name="InvalidModificationFaultType"> <xsd:complexContent> <xsd:extension base="wsrf-bf:BaseFaultType"> <xsd:sequence> <xsd:element name="ResourcePropertyChangeFailure" type="wsrf-rp:ResourcePropertyChangeFailureType"/> </xsd:sequence> </xsd:extension> </xsd:complexContent> </xsd:complexType> <xsd:complexType name="ResourcePropertyChangeFailureType"> <xsd:sequence> <xsd:element name="CurrentValue" minOccurs="0" maxOccurs="1"> <xsd:complexType> <xsd:sequence> <xsd:any minOccurs="1" maxOccurs="unbounded" /> </xsd:sequence> </xsd:complexType> </xsd:element> <xsd:element name="RequestedValue" minOccurs="0" maxOccurs="1"> <xsd:complexType> <xsd:sequence> <xsd:any minOccurs="1" maxOccurs="unbounded" /> </xsd:sequence> </xsd:complexType> </xsd:element> </xsd:sequence> <xsd:attribute name="Restored" type="xsd:boolean"/> </xsd:complexType>
    InvalidQueryExpressionFault
    This class represents the XML complexType "wsrf-rp:InvalidQueryExpressionFaultType" <xsd:complexType name="InvalidQueryExpressionFaultType"> <xsd:complexContent> <xsd:extension base="wsrf-bf:BaseFaultType"/> </xsd:complexContent> </xsd:complexType>
    InvalidResourcePropertyQNameFault
    This class represents the XML complexType "wsrf-rp:InvalidResourcePropertyQNameFaultType" <xsd:complexType name="InvalidResourcePropertyQNameFaultType"> <xsd:complexContent> <xsd:extension base="wsrf-bf:BaseFaultType"/> </xsd:complexContent> </xsd:complexType>
    QueryEvaluationErrorFault
    This class represents the XML complexType "wsrf-rp:QueryEvaluationErrorFaultType" <xsd:complexType name="QueryEvaluationErrorFaultType"> <xsd:complexContent> <xsd:extension base="wsrf-bf:BaseFaultType"/> </xsd:complexContent> </xsd:complexType>
    ResourceNotDestroyedFault
    This class represents the XML complexType "wsrf-rl:ResourceNotDestroyedFaultType" <xsd:complexType name="ResourceNotDestroyedFaultType"> <xsd:complexContent> <xsd:extension base="wsrf-bf:BaseFaultType"/> </xsd:complexContent> </xsd:complexType>
    ResourceUnavailableFault
    This class represents the XML complexType "wsrf-r:ResourceUnavailableFaultType" <xsd:complexType name="ResourceUnavailableFaultType"> <xsd:complexContent> <xsd:extension base="wsrf-bf:BaseFaultType"/> </xsd:complexContent> </xsd:complexType>
    ResourceUnknownFault
    This class represents the XML complexType "wsrf-r:ResourceUnknownFaultType" <xsd:complexType name="ResourceUnknownFaultType"> <xsd:complexContent> <xsd:extension base="wsrf-bf:BaseFaultType"/> </xsd:complexContent> </xsd:complexType>
    SetResourcePropertyRequestFailedFault
    This class represents the XML complexType "wsrf-rp:SetResourcePropertyRequestFailedFaultType" <xsd:complexType name="SetResourcePropertyRequestFailedFaultType"> <xsd:complexContent> <xsd:extension base="wsrf-bf:BaseFaultType"> <xsd:sequence> <xsd:element name="ResourcePropertyChangeFailure" type="wsrf-rp:ResourcePropertyChangeFailureType"/> </xsd:sequence> </xsd:extension> </xsd:complexContent> </xsd:complexType> <xsd:complexType name="ResourcePropertyChangeFailureType"> <xsd:sequence> <xsd:element name="CurrentValue" minOccurs="0" maxOccurs="1"> <xsd:complexType> <xsd:sequence> <xsd:any minOccurs="1" maxOccurs="unbounded" /> </xsd:sequence> </xsd:complexType> </xsd:element> <xsd:element name="RequestedValue" minOccurs="0" maxOccurs="1"> <xsd:complexType> <xsd:sequence> <xsd:any minOccurs="1" maxOccurs="unbounded" /> </xsd:sequence> </xsd:complexType> </xsd:element> </xsd:sequence> <xsd:attribute name="Restored" type="xsd:boolean"/> </xsd:complexType>
    TerminationTimeChangeRejectedFault
    This class represents the XML complexType "wsrf-rl:TerminationTimeChangeRejectedFaultType" <xsd:complexType name="TerminationTimeChangeRejectedFaultType"> <xsd:complexContent> <xsd:extension base="wsrf-bf:BaseFaultType"/> </xsd:complexContent> </xsd:complexType>
    UnableToModifyResourcePropertyFault
    This class represents the XML complexType "wsrf-rp:UnableToModifyResourcePropertyFaultType" <xsd:complexType name="UnableToModifyResourcePropertyFaultType"> <xsd:complexContent> <xsd:extension base="wsrf-bf:BaseFaultType"> <xsd:sequence> <xsd:element name="ResourcePropertyChangeFailure" type="wsrf-rp:ResourcePropertyChangeFailureType"/> </xsd:sequence> </xsd:extension> </xsd:complexContent> </xsd:complexType> <xsd:complexType name="ResourcePropertyChangeFailureType"> <xsd:sequence> <xsd:element name="CurrentValue" minOccurs="0" maxOccurs="1"> <xsd:complexType> <xsd:sequence> <xsd:any minOccurs="1" maxOccurs="unbounded" /> </xsd:sequence> </xsd:complexType> </xsd:element> <xsd:element name="RequestedValue" minOccurs="0" maxOccurs="1"> <xsd:complexType> <xsd:sequence> <xsd:any minOccurs="1" maxOccurs="unbounded" /> </xsd:sequence> </xsd:complexType> </xsd:element> </xsd:sequence> <xsd:attribute name="Restored" type="xsd:boolean"/> </xsd:complexType>
    UnableToPutResourcePropertyDocumentFault
    This class represents the XML complexType "wsrf-rp:UnableToPutResourcePropertyDocumentFaultType" <xsd:complexType name="UnableToPutResourcePropertyDocumentFaultType"> <xsd:complexContent> <xsd:extension base="wsrf-bf:BaseFaultType"> <xsd:sequence> <xsd:element name="ResourcePropertyChangeFailure" type="wsrf-rp:ResourcePropertyChangeFailureType"/> </xsd:sequence> </xsd:extension> </xsd:complexContent> </xsd:complexType> <xsd:complexType name="ResourcePropertyChangeFailureType"> <xsd:sequence> <xsd:element name="CurrentValue" minOccurs="0" maxOccurs="1"> <xsd:complexType> <xsd:sequence> <xsd:any minOccurs="1" maxOccurs="unbounded" /> </xsd:sequence> </xsd:complexType> </xsd:element> <xsd:element name="RequestedValue" minOccurs="0" maxOccurs="1"> <xsd:complexType> <xsd:sequence> <xsd:any minOccurs="1" maxOccurs="unbounded" /> </xsd:sequence> </xsd:complexType> </xsd:element> </xsd:sequence> <xsd:attribute name="Restored" type="xsd:boolean"/> </xsd:complexType>
    UnableToSetTerminationTimeFault
    This class represents the XML complexType "wsrf-rl:UnableToSetTerminationTimeFaultType" <xsd:complexType name="UnableToSetTerminationTimeFaultType"> <xsd:complexContent> <xsd:extension base="wsrf-bf:BaseFaultType"/> </xsd:complexContent> </xsd:complexType>
    UnknownQueryExpressionDialectFault
    This class represents the XML complexType "wsrf-rp:UnknownQueryExpressionDialectFaultType" <xsd:complexType name="UnknownQueryExpressionDialectFaultType"> <xsd:complexContent> <xsd:extension base="wsrf-bf:BaseFaultType"/> </xsd:complexContent> </xsd:complexType>
    UnsupportedMemberInterfaceFault
    This class represents the XML complexType "wsrf-sg:UnsupportedMemberInterfaceFaultType" <xsd:complexType name="UnsupportedMemberInterfaceFaultType"> <xsd:complexContent> <xsd:extension base="wsrf-bf:BaseFaultType"/> </xsd:complexContent> </xsd:complexType>
    UpdateResourcePropertiesRequestFailedFault
    This class represents the XML complexType "wsrf-rp:UpdateResourcePropertiesRequestFailedFaultType" <xsd:complexType name="UpdateResourcePropertiesRequestFailedFaultType"> <xsd:complexContent> <xsd:extension base="wsrf-bf:BaseFaultType"> <xsd:sequence> <xsd:element name="ResourcePropertyChangeFailure" type="wsrf-rp:ResourcePropertyChangeFailureType"/> </xsd:sequence> </xsd:extension> </xsd:complexContent> </xsd:complexType> <xsd:complexType name="ResourcePropertyChangeFailureType"> <xsd:sequence> <xsd:element name="CurrentValue" minOccurs="0" maxOccurs="1"> <xsd:complexType> <xsd:sequence> <xsd:any minOccurs="1" maxOccurs="unbounded" /> </xsd:sequence> </xsd:complexType> </xsd:element> <xsd:element name="RequestedValue" minOccurs="0" maxOccurs="1"> <xsd:complexType> <xsd:sequence> <xsd:any minOccurs="1" maxOccurs="unbounded" /> </xsd:sequence> </xsd:complexType> </xsd:element> </xsd:sequence> <xsd:attribute name="Restored" type="xsd:boolean"/> </xsd:complexType>

Package com.ibm.websphere.wsrf Description

This package describes the Web service Resource Framework (WS-RF) interfaces available to application programmers. These interfaces should be used in conjunction with those in the com.ibm.websphere.wsaddressing package in order to develop WS-RF applications. In particular, the following WS-RF support is provided by this API:

  • Java implementations of the WS-RF Base Fault types.
  • For application-specific faults, custom binder support is provided through the BaseFaultBinderHelper and BaseFaultBinderHelperFactory classes, to simplify the development of application-specific custom binders.
  • A java.io.Serializable wrapper, IOSerializableSOAPElement, is provided to allow the supplied BaseFault implementations to be instantiated with Serializable data and also for application-specific faults containing xsd:any elements to be implemented and instantiated in a Serializable manner. A corresponding factory, IOSerializableSOAPElementFactory, is also provided.
Version:
1.1.0
IBM WebSphere Application ServerTM
Release 8.5