org.openliberty.xmltooling.soapbinding

Class EndpointUpdate

java.lang.Object

org.opensaml.core.xml.AbstractXMLObject

org.opensaml.xmlsec.signature.AbstractSignableXMLObject

org.openliberty.xmltooling.wsa.EndpointReference

org.openliberty.xmltooling.soapbinding.EndpointUpdate

All Implemented Interfaces:

org.opensaml.core.xml.ElementExtensibleXMLObject, org.opensaml.core.xml.XMLObject, org.opensaml.xmlsec.signature.SignableXMLObject

public class EndpointUpdate
extends EndpointReference

It may be necessary for an entity receiving an ID-* message to indicate that messages from the sender should be directed to a different endpoint, or that they wish a different credential to be used than was originally specified by the entity for access to the requested resource. The <EndpointUpdate> response header allows a message receiver to indicate that a new endpoint or new credentials should be employed by the sender of the message on any subsequent messages. This header block may be used in conjunction with the <sb:InappropriateCredentials> and <sb:EndpointUpdated> faults, to indicate that the current message processing failed for those reasons, and should be submitted with the changes noted in any accompanying <EndpointUpdate> header block.

Note: The use of this header block allows the sender of the message to convey updates to security tokens, essentially providing a token renewal mechanism. This is not discussed further in this specification.

     <xs:complexType name="EndpointUpdateType">
         <xs:complexContent>
             <xs:extension base="wsa:EndpointReferenceType">
                 <xs:attribute name="updateType" type="xs:anyURI" use="optional"/>
             </xs:extension>
         </xs:complexContent>
     </xs:complexType>
    
     <xs:element name="EndpointUpdate" type="EndpointUpdateType"/>
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	EndpointUpdate.Builder Internal Builder
static class	EndpointUpdate.Marshaller Internal Marshaller
static class	EndpointUpdate.Unmarshaller Internal Unmarshaller
static class	EndpointUpdate.UpdateType

Field Summary

Fields

Modifier and Type	Field and Description
static String	ATT_UPDATE_TYPE
static String	LOCAL_NAME
static String	NO_ADDRESS_CHANGE If updateType has the value urn:liberty:sb:2006-08:EndpointUpdate:Partial, the MAY omit any direct children of or that have not changed from the original endpoint reference used to send the current request.
private EndpointUpdate.UpdateType	updateType

Fields inherited from class org.openliberty.xmltooling.wsa.EndpointReference

ATT_ID, ATT_NOT_ON_OR_AFTER

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	EndpointUpdate()
protected	EndpointUpdate(String namespaceURI, String elementLocalName, String namespacePrefix)

Method Summary

Methods

Modifier and Type	Method and Description
EndpointUpdate.UpdateType	getUpdateType()
boolean	isNoAddressChange() This method indicates to the caller that there is no address change in the EndpointUpdate
void	setUpdateType(EndpointUpdate.UpdateType updateType)

Methods inherited from class org.openliberty.xmltooling.wsa.EndpointReference

freshEndpointReference, getAddress, getId, getMetadata, getNotOnOrAfter, getOrderedChildren, getReferenceParameters, getUnknownXMLObjects, getUnknownXMLObjects, securityMechIDStringsFromEPR, setAddress, setId, setMetadata, setNotOnOrAfter, setReferenceParameters, simplePrettyDescription, toString

Methods inherited from class org.opensaml.xmlsec.signature.AbstractSignableXMLObject

getSignature, isSigned, setSignature

Methods inherited from class org.opensaml.core.xml.AbstractXMLObject

detach, getDOM, getElementQName, getIDIndex, getNamespaceManager, getNamespaces, getNoNamespaceSchemaLocation, getObjectMetadata, getParent, getSchemaLocation, getSchemaType, hasChildren, hasParent, isNil, isNilXSBoolean, manageQualifiedAttributeNamespace, prepareAttributeValueForAssignment, prepareElementContentForAssignment, prepareForAssignment, prepareForAssignment, prepareForAssignment, registerOwnID, releaseChildrenDOM, releaseDOM, releaseParentDOM, releaseThisAndChildrenDOM, releaseThisandParentDOM, resolveID, resolveIDFromRoot, setDOM, setElementNamespacePrefix, setElementQName, setNil, setNil, setNoNamespaceSchemaLocation, setParent, setSchemaLocation, setSchemaType

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.opensaml.core.xml.XMLObject

detach, getDOM, getElementQName, getIDIndex, getNamespaceManager, getNamespaces, getNoNamespaceSchemaLocation, getObjectMetadata, getParent, getSchemaLocation, getSchemaType, hasChildren, hasParent, isNil, isNilXSBoolean, releaseChildrenDOM, releaseDOM, releaseParentDOM, resolveID, resolveIDFromRoot, setDOM, setNil, setNil, setNoNamespaceSchemaLocation, setParent, setSchemaLocation

Field Detail

LOCAL_NAME

public static final String LOCAL_NAME

See Also:

Constant Field Values

updateType

private EndpointUpdate.UpdateType updateType

ATT_UPDATE_TYPE

public static final String ATT_UPDATE_TYPE

See Also:

Constant Field Values

NO_ADDRESS_CHANGE

public static final String NO_ADDRESS_CHANGE

If updateType has the value urn:liberty:sb:2006-08:EndpointUpdate:Partial, the MAY omit any direct children of or that have not changed from the original endpoint reference used to send the current request. Similarly, any extension elements that have not changed MAY be omitted. If the address has not changed, then the URI urn:liberty:sb:2006-08:EndpointUpdate:NoChange

See Also:

Constant Field Values

Constructor Detail

EndpointUpdate

protected EndpointUpdate()

EndpointUpdate

protected EndpointUpdate(String namespaceURI,
              String elementLocalName,
              String namespacePrefix)

Method Detail

isNoAddressChange

public boolean isNoAddressChange()

This method indicates to the caller that there is no address change in the EndpointUpdate

Returns:

getUpdateType

public EndpointUpdate.UpdateType getUpdateType()

setUpdateType

public void setUpdateType(EndpointUpdate.UpdateType updateType)