org.opensaml.saml2.core
Interface StatusResponseType

All Superinterfaces:

SAMLObject, SignableSAMLObject, SignableXMLObject, ValidatingXMLObject, XMLObject

All Known Subinterfaces:

ArtifactResponse, LogoutResponse, ManageNameIDResponse, NameIDMappingResponse, Response

All Known Implementing Classes:

ArtifactResponseImpl, LogoutResponseImpl, ManageNameIDResponseImpl, NameIDMappingResponseImpl, ResponseImpl, StatusResponseTypeImpl

public interface StatusResponseType
extends SignableSAMLObject

SAML 2.0 Core StatusResponseType.

Field Summary

static String	CONSENT_ATTRIB_NAME Consent attribute name.
static String	DESTINATION_ATTRIB_NAME Destination attribute name.
static String	EXPLICIT_CONSENT Explicit consent URI.
static String	ID_ATTRIB_NAME ID attribute name.
static String	IMPLICIT_CONSENT Implicit consent URI.
static String	IN_RESPONSE_TO_ATTRIB_NAME InResponseTo attribute name.
static String	INAPPLICABLE_CONSENT Inapplicable consent URI.
static String	ISSUE_INSTANT_ATTRIB_NAME IssueInstant attribute name.
static String	OBTAINED_CONSENT Obtained consent URI.
static String	PRIOR_CONSENT Prior consent URI.
static String	TYPE_LOCAL_NAME Local name of the XSI type.
static QName	TYPE_NAME QName of the XSI type.
static String	UNAVAILABLE_CONSENT Unavailable consent URI.
static String	UNSPECIFIED_CONSENT Unspecified consent URI.
static String	VERSION_ATTRIB_NAME Version attribute name.

Method Summary

String	getConsent() Gets the consent obtained from the principal for sending this response.
String	getDestination() Gets the URI of the destination of the response.
Extensions	getExtensions() Gets the Extensions of this response.
String	getID() Gets the unique identifier of the response.
String	getInResponseTo() Gets the unique request identifier for which this is a response
org.joda.time.DateTime	getIssueInstant() Gets the date/time the response was issued.
Issuer	getIssuer() Gets the issuer of this response.
Status	getStatus() Gets the Status of this response.
SAMLVersion	getVersion() Gets the SAML Version of this response.
void	setConsent(String newConsent) Sets the consent obtained from the principal for sending this response.
void	setDestination(String newDestination) Sets the URI of the destination of the response.
void	setExtensions(Extensions newExtensions) Sets the Extensions of this response.
void	setID(String newID) Sets the unique identifier of the response.
void	setInResponseTo(String newInResponseTo) Sets the unique request identifier for which this is a response
void	setIssueInstant(org.joda.time.DateTime newIssueInstant) Sets the date/time the response was issued.
void	setIssuer(Issuer newIssuer) Sets the issuer of this response.
void	setStatus(Status newStatus) Sets the Status of this response.
void	setVersion(SAMLVersion newVersion) Sets the SAML Version of this response.

Methods inherited from interface org.opensaml.common.SignableSAMLObject

getSignatureReferenceID

Methods inherited from interface org.opensaml.xml.signature.SignableXMLObject

getSignature, isSigned, setSignature

Methods inherited from interface org.opensaml.xml.validation.ValidatingXMLObject

deregisterValidator, getValidators, registerValidator, validate

Methods inherited from interface org.opensaml.xml.XMLObject

addNamespace, detach, getDOM, getElementQName, getIDIndex, getNamespaceManager, getNamespaces, getNoNamespaceSchemaLocation, getOrderedChildren, getParent, getSchemaLocation, getSchemaType, hasChildren, hasParent, isNil, isNilXSBoolean, releaseChildrenDOM, releaseDOM, releaseParentDOM, removeNamespace, resolveID, resolveIDFromRoot, setDOM, setNil, setNil, setNoNamespaceSchemaLocation, setParent, setSchemaLocation

Field Detail

TYPE_LOCAL_NAME

static final String TYPE_LOCAL_NAME

Local name of the XSI type.

See Also:

Constant Field Values

TYPE_NAME

static final QName TYPE_NAME

QName of the XSI type.

ID_ATTRIB_NAME

static final String ID_ATTRIB_NAME

ID attribute name.

See Also:

Constant Field Values

IN_RESPONSE_TO_ATTRIB_NAME

static final String IN_RESPONSE_TO_ATTRIB_NAME

InResponseTo attribute name.

See Also:

Constant Field Values

VERSION_ATTRIB_NAME

static final String VERSION_ATTRIB_NAME

Version attribute name.

See Also:

Constant Field Values

ISSUE_INSTANT_ATTRIB_NAME

static final String ISSUE_INSTANT_ATTRIB_NAME

IssueInstant attribute name.

See Also:

Constant Field Values

DESTINATION_ATTRIB_NAME

static final String DESTINATION_ATTRIB_NAME

Destination attribute name.

See Also:

Constant Field Values

CONSENT_ATTRIB_NAME

static final String CONSENT_ATTRIB_NAME

Consent attribute name.

See Also:

Constant Field Values

UNSPECIFIED_CONSENT

static final String UNSPECIFIED_CONSENT

Unspecified consent URI.

See Also:

Constant Field Values

OBTAINED_CONSENT

static final String OBTAINED_CONSENT

Obtained consent URI.

See Also:

Constant Field Values

PRIOR_CONSENT

static final String PRIOR_CONSENT

Prior consent URI.

See Also:

Constant Field Values

IMPLICIT_CONSENT

static final String IMPLICIT_CONSENT

Implicit consent URI.

See Also:

Constant Field Values

EXPLICIT_CONSENT

static final String EXPLICIT_CONSENT

Explicit consent URI.

See Also:

Constant Field Values

UNAVAILABLE_CONSENT

static final String UNAVAILABLE_CONSENT

Unavailable consent URI.

See Also:

Constant Field Values

INAPPLICABLE_CONSENT

static final String INAPPLICABLE_CONSENT

Inapplicable consent URI.

See Also:

Constant Field Values

Method Detail

getVersion

SAMLVersion getVersion()

Gets the SAML Version of this response.

Returns:

the SAML Version of this response.

setVersion

void setVersion(SAMLVersion newVersion)

Sets the SAML Version of this response.

Parameters:

newVersion - the SAML Version of this response

getID

String getID()

Gets the unique identifier of the response.

Returns:

the unique identifier of the response

setID

void setID(String newID)

Sets the unique identifier of the response.

Parameters:

newID - the unique identifier of the response

getInResponseTo

String getInResponseTo()

Gets the unique request identifier for which this is a response

Returns:

the unique identifier of the originating request

setInResponseTo

void setInResponseTo(String newInResponseTo)

Sets the unique request identifier for which this is a response

Parameters:

newInResponseTo - the unique identifier of the originating request

getIssueInstant

org.joda.time.DateTime getIssueInstant()

Gets the date/time the response was issued.

Returns:

the date/time the response was issued

setIssueInstant

void setIssueInstant(org.joda.time.DateTime newIssueInstant)

Sets the date/time the response was issued. param newIssueInstant the date/time the response was issued

getDestination

String getDestination()

Gets the URI of the destination of the response.

Returns:

the URI of the destination of the response

setDestination

void setDestination(String newDestination)

Sets the URI of the destination of the response.

Parameters:

newDestination - the URI of the destination of the response

getConsent

String getConsent()

Gets the consent obtained from the principal for sending this response.

Returns:

the consent obtained from the principal for sending this response

setConsent

void setConsent(String newConsent)

Sets the consent obtained from the principal for sending this response.

Parameters:

newConsent - the consent obtained from the principal for sending this response

getIssuer

Issuer getIssuer()

Gets the issuer of this response.

Returns:

the issuer of this response

setIssuer

void setIssuer(Issuer newIssuer)

Sets the issuer of this response.

Parameters:

newIssuer - the issuer of this response

getStatus

Status getStatus()

Gets the Status of this response.

Returns:

the Status of this response

setStatus

void setStatus(Status newStatus)

Sets the Status of this response.

Parameters:

newStatus - the Status of this response

getExtensions

Extensions getExtensions()

Gets the Extensions of this response.

Returns:

the Status of this response

setExtensions

void setExtensions(Extensions newExtensions)

Sets the Extensions of this response.

Parameters:

newExtensions - the Extensions of this response