oracle.security.xmlsec.saml2.profiles.sso.ecp

Class Request

java.lang.Object

oracle.security.xmlsec.util.XMLNode

oracle.security.xmlsec.util.XMLElement

oracle.security.xmlsec.saml2.profiles.sso.ecp.Request

public class Request
extends XMLElement

Represents an ECP Request element.

Field Summary

Fields inherited from class oracle.security.xmlsec.util.XMLNode

node, systemId

Constructor Summary

Constructors

Modifier	Constructor and Description
	Request(org.w3c.dom.Document owner) Creates a new Request instance.
protected	Request(org.w3c.dom.Document owner, java.lang.String nsURI, java.lang.String localName) Creates a new Request instance.
	Request(org.w3c.dom.Element element) Creates a new Request instance from the given Element node.
	Request(org.w3c.dom.Element element, java.lang.String systemId) Creates a new Request instance from the given Element node.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getActor() Returns the SOAP actor attribute.
IDPList	getIDPList() Returns the SAML protocols extensions.
boolean	getIsPassive() Indicates if the identity provider and user agent are allowed to take control of the requester's user interface and interact with the presenter.
Issuer	getIssuer() Returns the name of this issuer of this request.
boolean	getMustUnderstand() Returns the SOAP mustUnderstand attribute.
java.lang.String	getProviderName() Returns the human-readable name of the requester.
void	setActor(java.lang.String actor) Sets the SOAP actor attribute.
void	setIDPList(IDPList list) Sets the SAML protocol extensions.
void	setIsPassive(boolean passive) Specifies if the identity provider and user agent are allowed to take control of the requester's user interface.
void	setIssuer(NameID issuer) Sets the name of the issuer of this request.
void	setMustUnderstand(boolean mu) Sets the SOAP mustUnderstand attribute.
void	setProviderName(java.lang.String name) Specifies the human-readable name of the requester.

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

Request

public Request(org.w3c.dom.Element element)
        throws org.w3c.dom.DOMException

Creates a new Request instance from the given Element node.

Parameters:

element - An Request element.

Throws:

org.w3c.dom.DOMException

Request

public Request(org.w3c.dom.Element element,
               java.lang.String systemId)
        throws org.w3c.dom.DOMException

Creates a new Request instance from the given Element node.

Parameters:

element - An Request element.

systemId - The URI string system ID for the Request.

Throws:

org.w3c.dom.DOMException

Request

public Request(org.w3c.dom.Document owner)
        throws org.w3c.dom.DOMException

Creates a new Request instance. This constructor is for use in subclass for extension of the Request element.

Parameters:

owner - The owner document of the new Request.

Throws:

org.w3c.dom.DOMException

Request

protected Request(org.w3c.dom.Document owner,
                  java.lang.String nsURI,
                  java.lang.String localName)
           throws org.w3c.dom.DOMException

Creates a new Request instance. This constructor is for use in subclass for extension of the Request element.

Parameters:

owner - The owner document of the new Request.

nsURI - The namespace URI in which the new Request is to be created.

localName - The localName of the element represented by the class that extends this class.

Throws:

org.w3c.dom.DOMException

Method Detail

setMustUnderstand

public void setMustUnderstand(boolean mu)

Sets the SOAP mustUnderstand attribute.

Parameters:

mu - A boolean value.

getMustUnderstand

public boolean getMustUnderstand()

Returns the SOAP mustUnderstand attribute.

Returns:

A boolean value.

setActor

public void setActor(java.lang.String actor)

Sets the SOAP actor attribute.

Parameters:

actor - A boolean value.

getActor

public java.lang.String getActor()

Returns the SOAP actor attribute.

Returns:

A boolean value.

setIsPassive

public void setIsPassive(boolean passive)

Specifies if the identity provider and user agent are allowed to take control of the requester's user interface.

Parameters:

passive - A boolean value.

getIsPassive

public boolean getIsPassive()

Indicates if the identity provider and user agent are allowed to take control of the requester's user interface and interact with the presenter.

Returns:

If true, the taking control of the user interface and noticeable interaction is not allowed.

setProviderName

public void setProviderName(java.lang.String name)

Specifies the human-readable name of the requester.

Parameters:

name - The name of the requester.

getProviderName

public java.lang.String getProviderName()

Returns the human-readable name of the requester.

Returns:

The requester name String.

setIssuer

public void setIssuer(NameID issuer)

Sets the name of the issuer of this request.

Parameters:

issuer - The issuer's name identifier.

getIssuer

public Issuer getIssuer()

Returns the name of this issuer of this request.

Returns:

The Issuer of the issuer or null if none has been set.

setIDPList

public void setIDPList(IDPList list)

Sets the SAML protocol extensions.

Parameters:

list - A Extension object.

getIDPList

public IDPList getIDPList()

Returns the SAML protocols extensions.

Returns:

A Extension object or null if none has been set.