|
Oracle Security Developer Tools Liberty 1.1 Java API Reference 11g (11.1.1) E10670-02 |
||||||||
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.liberty.v11.AuthnRequestEnvelope
public class AuthnRequestEnvelope
The AuthnRequestEnvelope element in the Liberty Single Sign-On and Federation protocol. An AuthnRequestEnvelope element wraps an AuthnRequest which allows for extra processing by an intermediary between the service provider and the identity provider in some Liberty profiles.
AuthnRequest
, AuthnResponse
, AuthnResponseEnvelope
, IDPList
Field Summary |
---|
Fields inherited from class oracle.security.xmlsec.util.XMLNode |
---|
node, systemId |
Constructor Summary | |
---|---|
AuthnRequestEnvelope(org.w3c.dom.Document owner) Creates a new AuthnRequestEnvelope instance within the specified XML Document. |
|
AuthnRequestEnvelope(org.w3c.dom.Document owner, java.lang.String providerId, java.lang.String acsURL) Creates a new AuthnRequestEnvelope instance within the specified XML Document. |
|
AuthnRequestEnvelope(org.w3c.dom.Element element) Creates a new AuthnRequestEnvelope instance from the given Element node. |
|
AuthnRequestEnvelope(org.w3c.dom.Element element, java.lang.String systemId) Creates a new AuthnRequestEnvelope instance from the given Element node. |
Method Summary | |
---|---|
java.lang.String |
getAssertionConsumerServiceURL() Returns the service provider's URL contained in the AssertionConsumerServiceURL child element of this AuthnRequestEnvelope. |
AuthnRequest |
getAuthnRequest() Gets the AuthnRequest element wrapped in this element. |
IDPList |
getIDPList() Gets the IDPList element contained in this element. |
boolean |
getIsPassive() Returns the boolen value contained in the IsPassive child element of this AuthnRequestEnvelope, or "true" by default if IsPassive child is not specified. |
java.lang.String |
getProviderID() Returns the requestor's URI based ideitifier contained in the ProviderID child element of this AuthnRequestEnvelope. |
java.lang.String |
getProviderName() Returns the identity provider's human-readable name contained in the ProviderName child element of this AuthnRequestEnvelope. |
void |
setAssertionConsumerServiceURL(java.lang.String serviceURL) Set the AssertionConsumerServiceURL child element in this AuthnRequestEnvelope element. |
void |
setAuthnRequest(AuthnRequest request) Sets the AuthnRequest child element of this element. |
void |
setIDPList(IDPList idpList) Sets the IDPList child element of this element. |
void |
setIsPassive(boolean isPassive) Set the IsPassive child element in this AuthnRequestEnvelope element. |
void |
setProviderID(java.lang.String providerID) Set the ProviderID child element in this AuthnRequestEnvelope element. |
void |
setProviderName(java.lang.String providerName) Set the ProviderName child element in this AuthnRequestEnvelope element. |
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 |
---|
public AuthnRequestEnvelope(org.w3c.dom.Element element) throws org.w3c.dom.DOMException
AuthnRequestEnvelope
instance from the given Element node.
element
- A Liberty AuthnRequestEnvelope XML element.org.w3c.dom.DOMException
public AuthnRequestEnvelope(org.w3c.dom.Element element, java.lang.String systemId) throws org.w3c.dom.DOMException
AuthnRequestEnvelope
instance from the given Element node.
element
- A Liberty AuthnRequestEnvelope XML element.systemId
- The URI string system ID for the AuthnRequestEnvelope
.org.w3c.dom.DOMException
public AuthnRequestEnvelope(org.w3c.dom.Document owner) throws org.w3c.dom.DOMException
AuthnRequestEnvelope
instance within the specified XML Document.
owner
- The owner document of the new Liberty AuthnRequestEnvelope element.org.w3c.dom.DOMException
public AuthnRequestEnvelope(org.w3c.dom.Document owner, java.lang.String providerId, java.lang.String acsURL) throws org.w3c.dom.DOMException
AuthnRequestEnvelope
instance within the specified XML Document.
owner
- The owner document of the new Liberty AuthnRequestEnvelope element.providerId
- The ProviderID
child element.acsURL
- The AssertionConsumerServiceURL
child element.org.w3c.dom.DOMException
Method Detail |
---|
public void setAuthnRequest(AuthnRequest request)
public AuthnRequest getAuthnRequest()
AuthnRequest
object.public void setProviderID(java.lang.String providerID)
providerID
- The URI-based identifier of the requestor.public java.lang.String getProviderID()
public void setProviderName(java.lang.String providerName)
providerName
- The requestor's human-readable name.public java.lang.String getProviderName()
public void setAssertionConsumerServiceURL(java.lang.String serviceURL)
serviceURL
- The service provider's URL.public java.lang.String getAssertionConsumerServiceURL()
public void setIDPList(IDPList idpList)
public IDPList getIDPList()
IDPList
object or null if not set.public void setIsPassive(boolean isPassive)
isPassive
- If true, the intermediary must not interact with the Principle; if false, the identity provider may interact with the Principle.public boolean getIsPassive()
|
Oracle Security Developer Tools Liberty 1.1 Java API Reference 11g (11.1.1) E10670-02 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |