oracle.security.xmlsec.samlp

Class StatusCode

java.lang.Object

oracle.security.xmlsec.util.XMLNode

oracle.security.xmlsec.util.XMLElement

oracle.security.xmlsec.samlp.StatusCode

public class StatusCode
extends XMLElement

SAML element specifying one ore more nested codes representing the status of a request.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	REQUEST_DENIED Second-level status code meaning that the responder is able to process the request but has chosen not to respond.
static java.lang.String	REQUEST_VERSION_DEPRECATED Second-level status code meaning that the responder does not respond to any requests with the protocol version specified in the request.
static java.lang.String	REQUEST_VERSION_TOO_HIGH Second-level status code meaning that the protocol version specified in the request is a mjor upgrade from the highest protocol version supported by the responder.
static java.lang.String	REQUEST_VERSION_TOO_LOW Second-level status code meaning that the responder cannot respond to the particular request using the SAML version specified in the request because it is too low.
static java.lang.String	REQUESTER Top-level status code meaning that the request could not be performed due to an error in the sender or in the request.
static java.lang.String	RESOURCE_NOT_RECOGNIZED Second-level status code meaning that the responder does not wish to support resource specific attribute queries, or the resource value provided is invalid or unrecognized
static java.lang.String	RESPONDER Top-level status code meaning that the request could not be performed due to an error at the receiving end.
static java.lang.String	SUCCESS Top-level status code meaning that the request succeeded.
static java.lang.String	TOO_MANY_RESPONSES Second-level status code meaning that the response would contain more elements than the responder will return.
static java.lang.String	VERSION_MISMATCH Top-level status code meaning that the receiver could not process the request because the version was incorrect.

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

node, systemId

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
StatusCode	getStatusCode() Gest the subordinate status code.
QName	getStatusCodeValue() Gets the Value attribute of this status code element.
java.lang.String	getValue() Deprecated. Use getStatusCodeValue instead
void	setStatusCode(StatusCode statusCode) Sets the subordinate status code.
void	setStatusCodeValue(QName qname) Sets the Value attribute of this status code element as an XML QName.
void	setValue(java.lang.String value, java.lang.String namespace) Deprecated. Use setStatusCodeValue instead

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

Field Detail

SUCCESS

public static final java.lang.String SUCCESS

Top-level status code meaning that the request succeeded.

See Also:

Constant Field Values

VERSION_MISMATCH

public static final java.lang.String VERSION_MISMATCH

Top-level status code meaning that the receiver could not process the request because the version was incorrect.

See Also:

Constant Field Values

RESPONDER

public static final java.lang.String RESPONDER

Top-level status code meaning that the request could not be performed due to an error at the receiving end.

See Also:

Constant Field Values

REQUESTER

public static final java.lang.String REQUESTER

Top-level status code meaning that the request could not be performed due to an error in the sender or in the request.

See Also:

Constant Field Values

REQUEST_VERSION_TOO_HIGH

public static final java.lang.String REQUEST_VERSION_TOO_HIGH

Second-level status code meaning that the protocol version specified in the request is a mjor upgrade from the highest protocol version supported by the responder.

See Also:

Constant Field Values

REQUEST_VERSION_TOO_LOW

public static final java.lang.String REQUEST_VERSION_TOO_LOW

Second-level status code meaning that the responder cannot respond to the particular request using the SAML version specified in the request because it is too low.

See Also:

Constant Field Values

REQUEST_VERSION_DEPRECATED

public static final java.lang.String REQUEST_VERSION_DEPRECATED

Second-level status code meaning that the responder does not respond to any requests with the protocol version specified in the request.

See Also:

Constant Field Values

TOO_MANY_RESPONSES

public static final java.lang.String TOO_MANY_RESPONSES

Second-level status code meaning that the response would contain more elements than the responder will return.

See Also:

Constant Field Values

REQUEST_DENIED

public static final java.lang.String REQUEST_DENIED

Second-level status code meaning that the responder is able to process the request but has chosen not to respond.

See Also:

Constant Field Values

RESOURCE_NOT_RECOGNIZED

public static final java.lang.String RESOURCE_NOT_RECOGNIZED

Second-level status code meaning that the responder does not wish to support resource specific attribute queries, or the resource value provided is invalid or unrecognized

See Also:

Constant Field Values

Constructor Detail

StatusCode

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

Creates a new StatusCode instance from the given Element node.

Throws:

org.w3c.dom.DOMException

StatusCode

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

Creates a new StatusCode instance from the given Element node.

Parameters:

element - A StatusCode element.

systemId - The URI string system ID for the Status.

Throws:

org.w3c.dom.DOMException

StatusCode

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

Creates a new StatusCode instance.

Parameters:

owner - The owner document of the new StatusCode.

Throws:

org.w3c.dom.DOMException

Method Detail

setValue

public void setValue(java.lang.String value,
                     java.lang.String namespace)

Deprecated. Use setStatusCodeValue instead

Sets the Value attribute of this status code element as an XML QName.

Parameters:

localValue - The local name of the QName value of this Value attribute.

namespace - The namespace this status code value is in. If this parameter is not specified, the SAML protocol namespace is assumed.

getValue

public java.lang.String getValue()

Deprecated. Use getStatusCodeValue instead

Gets the Value attribute of this status code element.

setStatusCodeValue

public void setStatusCodeValue(QName qname)

Sets the Value attribute of this status code element as an XML QName.

Parameters:

qname - The QName value of this Value attribute.

getStatusCodeValue

public QName getStatusCodeValue()

Gets the Value attribute of this status code element.

setStatusCode

public void setStatusCode(StatusCode statusCode)

Sets the subordinate status code.

Parameters:

statusCode - A StatusCode that will provide more specific information on an error condition.

getStatusCode

public StatusCode getStatusCode()

Gest the subordinate status code.

Returns:

A StatusCode containing more specific information on an error condition.