Package org.opensaml.saml.saml1.core
Interface Assertion
-
- All Superinterfaces:
Evidentiary
,SAMLObject
,SignableSAMLObject
,org.opensaml.xmlsec.signature.SignableXMLObject
,org.opensaml.core.xml.XMLObject
public interface Assertion extends SignableSAMLObject, Evidentiary
This interface defines how the object representing a SAML 1Assertion
element behaves.
-
-
Field Summary
Fields Modifier and Type Field Description 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 QName
ISSUEINSTANT_ATTRIB_QNAME
QName 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
All Methods Instance Methods Abstract Methods Modifier and Type Method Description Advice
getAdvice()
advice is a (singleton) Object, representing theAdvice
sub element.List<AttributeStatement>
getAttributeStatements()
Return all theAttributeStatement
elements.List<AuthenticationStatement>
getAuthenticationStatements()
Return the List representing all theAuthenticationStatement
sub elements.List<AuthorizationDecisionStatement>
getAuthorizationDecisionStatements()
Return the List representing all theAuthorizationStatement
sub elements.Conditions
getConditions()
Return the (singleton) Object, representing theConditions
sub element.String
getID()
Set the ID.Instant
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 theStatement
sub elements.List<Statement>
getStatements(QName typeOrName)
Return the List representing all theStatement
sub elements with a given schema type or element name.List<SubjectStatement>
getSubjectStatements()
Return the List representing all theSubjectStatement
sub elements.void
setAdvice(Advice advice)
Set the Object representing theAdvice
sub element.void
setConditions(Conditions conditions)
Set the Object representing theConditions
Sub element.void
setID(String id)
Get the ID.void
setIssueInstant(Instant issueInstant)
Set the IssueInstance (attribute).void
setIssuer(String issuer)
Set the Issuer (attribute).void
setVersion(SAMLVersion version)
Set the SAML version of this assertion.-
Methods inherited from interface org.opensaml.saml.common.SignableSAMLObject
getSignatureReferenceID
-
Methods inherited from interface org.opensaml.xmlsec.signature.SignableXMLObject
getSignature, isSigned, setSignature
-
Methods inherited from interface org.opensaml.core.xml.XMLObject
detach, getDOM, getElementQName, getIDIndex, getNamespaceManager, getNamespaces, getNoNamespaceSchemaLocation, getObjectMetadata, getOrderedChildren, getParent, getSchemaLocation, getSchemaType, hasChildren, hasParent, isNil, isNilXSBoolean, releaseChildrenDOM, releaseDOM, releaseParentDOM, resolveID, resolveIDFromRoot, setDOM, setNil, setNil, setNoNamespaceSchemaLocation, setParent, setSchemaLocation
-
-
-
-
Field Detail
-
DEFAULT_ELEMENT_LOCAL_NAME
@Nonnull @NotEmpty static final String DEFAULT_ELEMENT_LOCAL_NAME
Element name, no namespace.- See Also:
- Constant Field Values
-
DEFAULT_ELEMENT_NAME
@Nonnull static final QName DEFAULT_ELEMENT_NAME
Default element name.
-
TYPE_LOCAL_NAME
@Nonnull @NotEmpty static final String TYPE_LOCAL_NAME
Local name of the XSI type.- See Also:
- Constant Field Values
-
TYPE_NAME
@Nonnull static final QName TYPE_NAME
QName of the XSI type.
-
MAJORVERSION_ATTRIB_NAME
@Nonnull @NotEmpty 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
@Nonnull @NotEmpty static final String MINORVERSION_ATTRIB_NAME
Name for the attribute which defines Minor Version.- See Also:
- Constant Field Values
-
ASSERTIONID_ATTRIB_NAME
@Nonnull @NotEmpty static final String ASSERTIONID_ATTRIB_NAME
Name for the attribute which defines Assertion ID.- See Also:
- Constant Field Values
-
ISSUER_ATTRIB_NAME
@Nonnull @NotEmpty static final String ISSUER_ATTRIB_NAME
Name for the attribute which defines Issuer.- See Also:
- Constant Field Values
-
ISSUEINSTANT_ATTRIB_NAME
@Nonnull @NotEmpty static final String ISSUEINSTANT_ATTRIB_NAME
Name for the attribute which defines the issue instant.- See Also:
- Constant Field Values
-
ISSUEINSTANT_ATTRIB_QNAME
@Nonnull static final QName ISSUEINSTANT_ATTRIB_QNAME
QName for the attribute which defines the issue instant.
-
ID_ATTRIB_NAME
@Nonnull @NotEmpty static final String ID_ATTRIB_NAME
Name for the attribute which defines the Issue Instant.- See Also:
- Constant Field Values
-
-
Method Detail
-
getID
@Nullable String getID()
Set the ID.- Returns:
- the ID
-
setID
void setID(@Nullable String id)
Get the ID.- Parameters:
id
- what to set
-
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(@Nullable SAMLVersion version)
Set the SAML version of this assertion.- Parameters:
version
- the SAML version of this assertion
-
getIssuer
@Nullable String getIssuer()
Get the Issuer (which is an attribute) .- Returns:
- the Issuer
-
setIssuer
void setIssuer(@Nullable String issuer)
Set the Issuer (attribute).- Parameters:
issuer
- the value to set
-
getIssueInstant
@Nullable Instant getIssueInstant()
Get the IssueInstant (attribute).- Returns:
- the Issue Instant (as a Date)
-
setIssueInstant
void setIssueInstant(@Nullable Instant issueInstant)
Set the IssueInstance (attribute).- Parameters:
issueInstant
- the issue instant value to set
-
getConditions
@Nullable Conditions getConditions()
Return the (singleton) Object, representing theConditions
sub element.- Returns:
- the Conditions object.
-
setConditions
void setConditions(@Nullable Conditions conditions)
Set the Object representing theConditions
Sub element.- Parameters:
conditions
- the condition to List
-
getAdvice
@Nullable Advice getAdvice()
advice is a (singleton) Object, representing theAdvice
sub element.- Returns:
- the advice object in this assertion
-
setAdvice
void setAdvice(@Nullable Advice advice)
Set the Object representing theAdvice
sub element.- Parameters:
advice
- the object to set
-
getStatements
@Nonnull @NonnullElements List<Statement> getStatements()
Return the List representing all theStatement
sub elements.- Returns:
- the List representing all the statements
-
getStatements
@Nonnull @NonnullElements List<Statement> getStatements(@Nonnull QName typeOrName)
Return the List representing all theStatement
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
@Nonnull @NonnullElements List<SubjectStatement> getSubjectStatements()
Return the List representing all theSubjectStatement
sub elements.- Returns:
- all the SubjectStatements
-
getAuthenticationStatements
@Nonnull @NonnullElements List<AuthenticationStatement> getAuthenticationStatements()
Return the List representing all theAuthenticationStatement
sub elements.- Returns:
- all the AuthenticationStatements
-
getAuthorizationDecisionStatements
@Nonnull @NonnullElements List<AuthorizationDecisionStatement> getAuthorizationDecisionStatements()
Return the List representing all theAuthorizationStatement
sub elements.- Returns:
- all the authorizationDecisionStatements.
-
getAttributeStatements
@Nonnull @NonnullElements List<AttributeStatement> getAttributeStatements()
Return all theAttributeStatement
elements.- Returns:
- all the attributeStatements
-
-