public abstract class LibResponseMessage extends ResponseType
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
NO_AVAILABLE_IDP
Second-level samlp:StatuesCode value used by an intermediary to indicate that none of the supported identity providers are available.
|
static java.lang.String |
NO_SUPPORTED_IDP
Second-level samlp:StatuesCode value used by an intermediary to indicate that none of the identity providers are supported by the intermediary.
|
static java.lang.String |
UNSUPPORTED_PROFILE
Second-level samlp:StatuesCode value used by an identity provider to indicate that the service provider should retry the request with a different profile.
|
Modifier | Constructor and Description |
---|---|
protected |
LibResponseMessage(org.w3c.dom.Document owner, java.lang.String nsURI, java.lang.String localName)
Creates a new
LibResponseMessage instance. |
protected |
LibResponseMessage(org.w3c.dom.Document owner, java.lang.String nsURI, java.lang.String localName, java.lang.String responseID, java.util.Date issueInstant)
Creates a new
LibResponseMessage instance. |
protected |
LibResponseMessage(org.w3c.dom.Element element)
Creates a new
LibResponseMessage instance from the given Element node. |
protected |
LibResponseMessage(org.w3c.dom.Element element, java.lang.String systemId)
Creates a new
LibResponseMessage instance from the given Element node. |
Modifier and Type | Method and Description |
---|---|
XSSignature |
addSignature(java.lang.String signatureMethod, java.lang.String c14nMethod)
Adds a dsig:Signature to this response, replacing any existing signature.
|
XSSignature |
addSignature(java.lang.String signatureMethod, java.lang.String c14nMethod, java.lang.String digestMethod)
Adds a dsig:Signature to this response, replacing any existing signature.
|
protected int |
getChildElementPosition(java.lang.String nsURI, java.lang.String localName) |
protected abstract java.lang.String[] |
getChildElementsLocalNames()
Returns the orderded set of the local names of the child elements specified in the schema for the XML element represented by the concrete subclass.
|
protected abstract java.lang.String[] |
getChildElementsNSURIs()
Returns the orderded set of the namespce URIs for the child elements specified in the schema for the XML element represented by the concrete subclass.
|
java.lang.String |
getId()
Returns the value of the id attribute of this Liberty response element.
|
static LibResponseMessage |
getInstance(org.w3c.dom.Element element)
Instantiates a concrete
LibResponseMessage subclass implementation to wrap the given Element . |
java.lang.String |
getProviderID()
Returns the provider's URI based ideitifier contained in the ProviderID child element of this
LibResponseMessage . |
java.lang.String |
getRelayState()
Returns the value contained in the RelayState child element of this rsponse element, or null if no RelayState element set.
|
Status |
getStatus()
Gets the status of this response.
|
void |
setId(java.lang.String id)
Sets the id attribute of this Liberty response element.
|
void |
setProviderID(java.lang.String providerID)
Sets the ProviderID child element in this element.
|
void |
setRelayState(java.lang.String value)
Sets the RelayState child element in this Liberty response element.
|
void |
setStatus(Status status)
Sets the samlp:Status child element in this Liberty response element.
|
getID, getInResponseTo, getIssueInstant, getLocalNamesPrecedeDSig, getNSURIsPrecedeDSig, getRecipient, getResponseID, setInResponseTo, setIssueInstant, setRecipient, setResponseID
clearSignature, getInstance, getMajorVersion, getMinorVersion, getSignature, isSigned, setVersion, sign, sign, verify, verify
addNSPrefixAttr, addNSPrefixAttr, addNSPrefixAttrDefault, addNSPrefixAttrDefault, getAttribute, getAttributeNode, getAttributeNodeNS, getAttributeNS, getChildElementsByTagName, getChildElementsByTagName, getChildElementsByTagNameNS, getChildElementsByTagNameNS, getDefaultNSPrefix, getElement, getElementsByTagName, getElementsByTagNameNS, getTagName, hasAttribute, hasAttributeNS, removeAttribute, removeAttributeNode, removeAttributeNS, setAttribute, setAttributeNode, setAttributeNodeNS, setAttributeNS, setDefaultNSPrefix
appendChild, appendChild, appendTo, cloneNode, getAttributes, getChildNodes, getFirstChild, getLastChild, getLocalName, getNamespaceURI, getNextSibling, getNode, getNodeName, getNodeType, getNodeValue, getOwnerDocument, getParentNode, getPrefix, getPreviousSibling, getSystemId, hasAttributes, hasChildNodes, insertBefore, insertBefore, isSupported, normalize, removeChild, removeChild, replaceChild, replaceChild, setNodeValue, setPrefix, setSystemId, toBytesXML, toStringXML
public static final java.lang.String NO_AVAILABLE_IDP
public static final java.lang.String NO_SUPPORTED_IDP
public static final java.lang.String UNSUPPORTED_PROFILE
protected LibResponseMessage(org.w3c.dom.Element element) throws org.w3c.dom.DOMException
LibResponseMessage
instance from the given Element node.element
- A Liberty response XML element.org.w3c.dom.DOMException
protected LibResponseMessage(org.w3c.dom.Element element, java.lang.String systemId) throws org.w3c.dom.DOMException
LibResponseMessage
instance from the given Element node.element
- A Liberty response XML element.systemId
- The URI string system ID for the LibResponseMessage
.org.w3c.dom.DOMException
protected LibResponseMessage(org.w3c.dom.Document owner, java.lang.String nsURI, java.lang.String localName) throws org.w3c.dom.DOMException
LibResponseMessage
instance.owner
- The owner document of the new LibResponseMessage.nsURI
- The namespace URI in which the new LibResponseMessage is to be created.localName
- The localName of the element represented by the class that extends this abstract class.org.w3c.dom.DOMException
protected LibResponseMessage(org.w3c.dom.Document owner, java.lang.String nsURI, java.lang.String localName, java.lang.String responseID, java.util.Date issueInstant) throws org.w3c.dom.DOMException
LibResponseMessage
instance.owner
- The owner document of the new LibResponseMessage.nsURI
- The namespace URI in which the new LibResponseMessage is to be created.localName
- The localName of the element represented by the class that extends this abstract class.responseID
- The ResponseID
attribute.issueInstant
- The IssueInstant
attribute.org.w3c.dom.DOMException
public static LibResponseMessage getInstance(org.w3c.dom.Element element) throws org.w3c.dom.DOMException
LibResponseMessage
subclass implementation to wrap the given Element
.element
- An Liberty response XML element.LibResponseMessage
, or null
if no appropriate implementation class could be found.org.w3c.dom.DOMException
public void setId(java.lang.String id) throws org.w3c.dom.DOMException
id
- The ID name of this element.org.w3c.dom.DOMException
public java.lang.String getId()
null
if the attribute is missing.public void setProviderID(java.lang.String providerID)
providerID
- The URI-based identifier of the provider.public java.lang.String getProviderID()
LibResponseMessage
.public void setStatus(Status status)
status
- A oracle.security.xmlsec.samlp.Status
object.public Status getStatus()
oracle.security.xmlsec.samlp.Status
object.public void setRelayState(java.lang.String value)
value
- The value for the Relay state.public java.lang.String getRelayState()
public XSSignature addSignature(java.lang.String signatureMethod, java.lang.String c14nMethod)
sign()
methods must be invoked on the returned oracle.security.xmlsec.dsig.XSSignature
object. The code>XSSignature can be used to add a dsig:KeyInfo containing, for example, the signer's public key certificate.
The default Reference digest algorithm is SHA-1. Use the addSignature(String signatureMethod, String c14nMethod, String digestMethod)
method to specify an alternative message digest algorithm. See XMLURI
for algorithm URI string constants.
Note: If this Response element has an "id" attribute, then its value is used as the target of the new signature's Reference element. If no "id" attribute is present, as would be the case for a samlp:Response, an XPath Filter transform is added to the signature Reference to identify the Response element to be signed.
addSignature
in class SAMLMessage
signatureMethod
- The URI identifying the signature algorithm to be used.c14nMethod
- The URI identifying the canonicalization algorithm to be used.XSSignature
, XSKeyInfo
, XMLURI
public XSSignature addSignature(java.lang.String signatureMethod, java.lang.String c14nMethod, java.lang.String digestMethod)
sign()
methods must be invoked on the returned oracle.security.xmlsec.dsig.XSSignature
object. The code>XSSignature can be used to add a dsig:KeyInfo containing, for example, the signer's public key certificate.
See XMLURI
for algorithm URI string constants.
Note: If this Response element has an "id" attribute, then its value is used as the target of the new signature's Reference element. If no "id" attribute is present, as would be the case for a samlp:Request, an XPath Filter transform is added to the signature Reference to identify the Response element to be signed.
addSignature
in class SAMLMessage
signatureMethod
- The URI identifying the signature algorithm to be used.c14nMethod
- The URI identifying the canonicalization algorithm to be used.digestMethod
- The URI identifying the message digest algorithm to be used.XSSignature
, XSKeyInfo
, XMLURI
protected abstract java.lang.String[] getChildElementsNSURIs()
protected abstract java.lang.String[] getChildElementsLocalNames()
protected int getChildElementPosition(java.lang.String nsURI, java.lang.String localName) throws org.w3c.dom.DOMException
org.w3c.dom.DOMException