org.opensaml.saml1.core
Interface Assertion

All Superinterfaces:

Evidentiary, SAMLObject, SignableSAMLObject, SignableXMLObject, ValidatingXMLObject, XMLObject

All Known Implementing Classes:

AssertionImpl

public interface Assertion
extends SignableSAMLObject, Evidentiary

This interface defines how the object representing a SAML 1 Assertion element behaves.

Field Summary

static String	ASSERTIONID_ATTRIB_NAME Name for the attribute which defines Assertion ID
static String	DEFAULT_ELEMENT_LOCAL_NAME Element name, no namespace.
static QName	DEFAULT_ELEMENT_NAME Default element name
static String	ID_ATTRIB_NAME Name for the attribute which defines the Issue Instant.
static String	ISSUEINSTANT_ATTRIB_NAME Name for the attribute which defines the issue instant
static String	ISSUER_ATTRIB_NAME Name for the attribute which defines Issuer
static String	MAJORVERSION_ATTRIB_NAME Name for the attribute which defines Major Version (attribute's value must be 1)
static String	MINORVERSION_ATTRIB_NAME Name for the attribute which defines Minor Version.
static String	TYPE_LOCAL_NAME Local name of the XSI type
static QName	TYPE_NAME QName of the XSI type

Method Summary

Advice	getAdvice() advice is a (singleton) Object, representing the Advice sub element
List<AttributeStatement>	getAttributeStatements() Return all the AttributeStatement elements
List<AuthenticationStatement>	getAuthenticationStatements() Return the List representing all the AuthenticationStatement sub elements.
List<AuthorizationDecisionStatement>	getAuthorizationDecisionStatements() Return the List representing all the AuthorizationStatement sub elements.
Conditions	getConditions() Return the (singleton) Object, representing the Conditions sub element.
String	getID() Set the ID
org.joda.time.DateTime	getIssueInstant() Get the IssueInstant (attribute).
String	getIssuer() Get the Issuer (which is an attribute) .
int	getMajorVersion() Get the MajorVersion attribute.
int	getMinorVersion() Get the MinorVersion attribute.
List<Statement>	getStatements() Return the List representing all the Statement sub elements.
List<Statement>	getStatements(QName typeOrName) Return the List representing all the Statement sub elements with a given schema type or element name.
List<SubjectStatement>	getSubjectStatements() Return the List representing all the SubjectStatement sub elements.
void	setAdvice(Advice advice) Set the Object representing the Advice sub element.
void	setConditions(Conditions conditions) Set the Object representing the Conditions Sub element.
void	setID(String id) Get the ID
void	setIssueInstant(org.joda.time.DateTime issueInstant) Set the IssueInstance (attribute).
void	setIssuer(String Issuer) Set the Issuer (attribute).
void	setVersion(SAMLVersion version) Sets the SAML version of this assertion.

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

DEFAULT_ELEMENT_LOCAL_NAME

static final String DEFAULT_ELEMENT_LOCAL_NAME

Element name, no namespace.

See Also:

Constant Field Values

DEFAULT_ELEMENT_NAME

static final QName DEFAULT_ELEMENT_NAME

Default element name

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

MAJORVERSION_ATTRIB_NAME

static final String MAJORVERSION_ATTRIB_NAME

Name for the attribute which defines Major Version (attribute's value must be 1)

See Also:

Constant Field Values

MINORVERSION_ATTRIB_NAME

static final String MINORVERSION_ATTRIB_NAME

Name for the attribute which defines Minor Version.

See Also:

Constant Field Values

ASSERTIONID_ATTRIB_NAME

static final String ASSERTIONID_ATTRIB_NAME

Name for the attribute which defines Assertion ID

See Also:

Constant Field Values

ISSUER_ATTRIB_NAME

static final String ISSUER_ATTRIB_NAME

Name for the attribute which defines Issuer

See Also:

Constant Field Values

ISSUEINSTANT_ATTRIB_NAME

static final String ISSUEINSTANT_ATTRIB_NAME

Name for the attribute which defines the issue instant

See Also:

Constant Field Values

ID_ATTRIB_NAME

static final String ID_ATTRIB_NAME

Name for the attribute which defines the Issue Instant.

See Also:

Constant Field Values

Method Detail

getMajorVersion

int getMajorVersion()

Get the MajorVersion attribute.

Returns:

The stored MajorVersion

getMinorVersion

int getMinorVersion()

Get the MinorVersion attribute.

Returns:

The stored MinorVersion

setVersion

void setVersion(SAMLVersion version)

Sets the SAML version of this assertion.

Parameters:

version - the SAML version of this assertion

getIssuer

String getIssuer()

Get the Issuer (which is an attribute) .

Returns:

the Issuer

setIssuer

void setIssuer(String Issuer)

Set the Issuer (attribute).

Parameters:

Issuer - the value to set

getIssueInstant

org.joda.time.DateTime getIssueInstant()

Get the IssueInstant (attribute).

Returns:

the Issue Instant (as a Date)

getID

String getID()

Set the ID

setID

void setID(String id)

Get the ID

setIssueInstant

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

Set the IssueInstance (attribute).

Parameters:

issueInstant - the issue instant value to set

getConditions

Conditions getConditions()

Return the (singleton) Object, representing the Conditions sub element.

Returns:

the Conditions object.

setConditions

void setConditions(Conditions conditions)
                   throws IllegalArgumentException

Set the Object representing the Conditions Sub element.

Parameters:

conditions - the condition to List

Throws:

IllegalArgumentException - if the condition has already been set into another object

getAdvice

Advice getAdvice()

advice is a (singleton) Object, representing the Advice sub element

Returns:

the advice object in this assertion

setAdvice

void setAdvice(Advice advice)
               throws IllegalArgumentException

Set the Object representing the Advice sub element.

Parameters:

advice - the object to set

Throws:

IllegalArgumentException - if the object has already been put into another SAMLObject

getStatements

List<Statement> getStatements()

Return the List representing all the Statement sub elements.

Returns:

the List representing all the statements

getStatements

List<Statement> getStatements(QName typeOrName)

Return the List representing all the Statement sub elements with a given schema type or element name.

Parameters:

typeOrName - the schema type or element name

Returns:

the List representing all the statements

getSubjectStatements

List<SubjectStatement> getSubjectStatements()

Return the List representing all the SubjectStatement sub elements.

Returns:

all the SubjectStatements

getAuthenticationStatements

List<AuthenticationStatement> getAuthenticationStatements()

Return the List representing all the AuthenticationStatement sub elements.

Returns:

all the AuthenticationStatements

getAuthorizationDecisionStatements

List<AuthorizationDecisionStatement> getAuthorizationDecisionStatements()

Return the List representing all the AuthorizationStatement sub elements.

Returns:

all the authorizationDecisionStatements.

getAttributeStatements

List<AttributeStatement> getAttributeStatements()

Return all the AttributeStatement elements

Returns:

all the attributeStatements