|
Oracle Fusion Middleware Liberty 1.2 Java API Reference for Oracle Security Developer Tools 11g Release 1 (11.1.1) E10671-03 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object
oracle.security.xmlsec.util.XMLNode
oracle.security.xmlsec.util.XMLElement
oracle.security.xmlsec.saml.SAMLMessage
oracle.security.xmlsec.samlp.ResponseType
oracle.security.xmlsec.liberty.v12.LibResponseMessage
public abstract class LibResponseMessage
This is an abstract base class which holds the common features of the various Liberty protocols response messages.
Field Summary |
---|
Fields inherited from class oracle.security.xmlsec.util.XMLNode |
---|
node, systemId |
Constructor Summary | |
---|---|
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. |
Method Summary | |
---|---|
oracle.security.xmlsec.dsig.XSSignature |
addSignature(java.lang.String signatureMethod, java.lang.String c14nMethod) Adds a ds:Signature to this response, replacing any existing signature. |
oracle.security.xmlsec.dsig.XSSignature |
addSignature(java.lang.String signatureMethod, java.lang.String c14nMethod, java.lang.String digestMethod) Adds a ds: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. |
protected java.lang.String |
getID() |
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 , or null if no ProviderID element is present. |
java.lang.String |
getRelayState() Returns the value contained in the RelayState child element of this response element, or null if no RelayState element is present. |
oracle.security.xmlsec.samlp.Status |
getStatus() Gets the status of this response, or null if no samlp:Status child element is present. |
void |
setProviderID(java.lang.String providerID) Sets the value of the ProviderID child element in this element. |
void |
setRelayState(java.lang.String value) Sets the value of the RelayState child element in this Liberty response element. |
void |
setStatus(oracle.security.xmlsec.samlp.Status status) Sets the samlp:Status child element in this Liberty response element. |
Methods inherited from class oracle.security.xmlsec.samlp.ResponseType |
---|
getInResponseTo, getIssueInstant, getLocalNamesPrecedeDSig, getNSURIsPrecedeDSig, getRecipient, getResponseID, setInResponseTo, setIssueInstant, setRecipient, setResponseID |
Methods inherited from class oracle.security.xmlsec.saml.SAMLMessage |
---|
clearSignature, getInstance, getMajorVersion, getMinorVersion, getSignature, isSigned, setVersion, sign, sign, verify, verify |
Methods inherited from class oracle.security.xmlsec.util.XMLElement |
---|
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 |
Methods inherited from class oracle.security.xmlsec.util.XMLNode |
---|
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 |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
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
Method Detail |
---|
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 setProviderID(java.lang.String providerID)
providerID
- The URI-based identifier of the provider.public java.lang.String getProviderID()
LibResponseMessage
, or null
if no ProviderID element is present.public void setStatus(oracle.security.xmlsec.samlp.Status status)
status
- A oracle.security.xmlsec.samlp.Status
object.public oracle.security.xmlsec.samlp.Status getStatus()
null
if no samlp:Status child element is present.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()
null
if no RelayState element is present.public oracle.security.xmlsec.dsig.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 XSSignature
can be used to add a ds: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 oracle.security.xmlsec.saml.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 oracle.security.xmlsec.dsig.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 XSSignature
can be used to add a ds: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 oracle.security.xmlsec.saml.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 java.lang.String getID()
getID
in class oracle.security.xmlsec.samlp.ResponseType
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
|
Oracle Fusion Middleware Liberty 1.2 Java API Reference for Oracle Security Developer Tools 11g Release 1 (11.1.1) E10671-03 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |