AuthnStatement.
*
* The AuthnStatement element describes a statement by the
* SAML authority asserting that the assertion subject was authenticated
* by a particular means at a particular time. It is of type
* AuthnStatementType.
* *
* <complexType name="AuthnStatementType">
* <complexContent>
* <extension base="{urn:oasis:names:tc:SAML:2.0:assertion}
* StatementAbstractType">
* <sequence>
* <element ref="{urn:oasis:names:tc:SAML:2.0:assertion}
* SubjectLocality" minOccurs="0"/>
* <element ref="{urn:oasis:names:tc:SAML:2.0:assertion}
* AuthnContext"/>
* </sequence>
* <attribute name="AuthnInstant" use="required"
* type="{http://www.w3.org/2001/XMLSchema}dateTime" />
* <attribute name="SessionIndex"
* type="{http://www.w3.org/2001/XMLSchema}string" />
* <attribute name="SessionNotOnOrAfter"
* type="{http://www.w3.org/2001/XMLSchema}dateTime" />
* </extension>
* </complexContent>
* </complexType>
*
*/
public class AuthnStatementImpl implements AuthnStatement {
private AuthnContext authnContext = null;
private SubjectLocality subjectLocality = null;
private Date authnInstant = null;
private String sessionIndex = null;
private Date sessionNotOnOrAfter = null;
private boolean mutable = true;
// verifies data according to the schema.
private void validateData()
throws SAML2Exception
{
if (authnContext == null) {
if (SAML2SDKUtils.debug.messageEnabled()) {
SAML2SDKUtils.debug.message("AuthnStatementImpl.validateData: "
+ "missing Element AuthnContext.");
}
throw new SAML2Exception(
SAML2SDKUtils.bundle.getString("missingElement"));
}
if (authnInstant == null) {
if (SAML2SDKUtils.debug.messageEnabled()) {
SAML2SDKUtils.debug.message("AuthnStatementImpl.validateData: "
+ "missing attribute AuthnInstant.");
}
throw new SAML2Exception(
SAML2SDKUtils.bundle.getString("missingAttribute"));
}
}
// used by the constructors.
private void parseElement(Element element)
throws SAML2Exception
{
// make sure that the input xml block is not null
if (element == null) {
if (SAML2SDKUtils.debug.messageEnabled()) {
SAML2SDKUtils.debug.message("AuthnStatementImpl.parseElement: "
+ "Input is null.");
}
throw new SAML2Exception(
SAML2SDKUtils.bundle.getString("nullInput"));
}
// Make sure this is an AuthnStatement.
if (!SAML2SDKUtils.checkStatement(element, "AuthnStatement")) {
if (SAML2SDKUtils.debug.messageEnabled()) {
SAML2SDKUtils.debug.message("AuthnStatementImpl.parseElement: "
+ "not AuthnStatement.");
}
throw new SAML2Exception(
SAML2SDKUtils.bundle.getString("wrongInput"));
}
// handle the attributes of AuthnStatement in
* Element format.
*/
public AuthnStatementImpl(org.w3c.dom.Element element)
throws com.sun.identity.saml2.common.SAML2Exception
{
parseElement(element);
}
/**
* Class constructor with AuthnStatement in xml string format.
*/
public AuthnStatementImpl(String xmlString)
throws com.sun.identity.saml2.common.SAML2Exception
{
Document doc = XMLUtils.toDOMDocument(xmlString, SAML2SDKUtils.debug);
if (doc == null) {
throw new SAML2Exception(
SAML2SDKUtils.bundle.getString("errorObtainingElement"));
}
parseElement(doc.getDocumentElement());
}
/**
* Returns the value of the AuthnContext property.
*
* @return AuthnContext of the statement.
* @see #setAuthnContext(AuthnContext)
*/
public AuthnContext getAuthnContext() {
return authnContext;
}
/**
* Sets the value of the AuthnContext property.
*
* @param value new AuthnContext.
* @throws SAML2Exception if the object is immutable.
* @see #getAuthnContext()
*/
public void setAuthnContext(AuthnContext value)
throws SAML2Exception
{
if (!mutable) {
throw new SAML2Exception(
SAML2SDKUtils.bundle.getString("objectImmutable"));
}
authnContext = value;
}
/**
* Returns the value of the AuthnInstant attribute.
*
* @return the value of the AuthnInstant attribute.
* @see #setAuthnInstant(Date)
*/
public Date getAuthnInstant() {
return authnInstant;
}
/**
* Sets the value of the AuthnInstant attribute.
*
* @param value new value of AuthnInstant attribute.
* @throws SAML2Exception if the object is immutable.
* @see #getAuthnInstant
*/
public void setAuthnInstant(Date value)
throws SAML2Exception
{
if (!mutable) {
throw new SAML2Exception(
SAML2SDKUtils.bundle.getString("objectImmutable"));
}
authnInstant = value;
}
/**
* Returns the value of the SubjectLocality property.
*
* @return SubjectLocality of the statement.
* @see #setSubjectLocality(SubjectLocality)
*/
public SubjectLocality getSubjectLocality() {
return subjectLocality;
}
/**
* Sets the value of the SubjectLocality property.
*
* @param value the new value of SubjectLocality.
* @throws SAML2Exception if the object is immutable.
* @see #getSubjectLocality()
*/
public void setSubjectLocality(SubjectLocality value)
throws SAML2Exception
{
if (!mutable) {
throw new SAML2Exception(
SAML2SDKUtils.bundle.getString("objectImmutable"));
}
subjectLocality = value;
}
/**
* Returns the value of the SessionIndex attribute.
*
* @return the value of the SessionIndex attribute.
* @see #setSessionIndex(String)
*/
public String getSessionIndex() {
return sessionIndex;
}
/**
* Sets the value of the SessionIndex attribute.
*
* @param value new value of SessionIndex attribute.
* @throws SAML2Exception if the object is immutable.
* @see #getSessionIndex()
*/
public void setSessionIndex(String value)
throws SAML2Exception
{
if (!mutable) {
throw new SAML2Exception(
SAML2SDKUtils.bundle.getString("objectImmutable"));
}
sessionIndex = value;
}
/**
* Returns the value of the SessionNotOnOrAfter attribute.
*
* @return the value of SessionNotOnOrAfter attribute.
* @see #setSessionNotOnOrAfter(Date)
*/
public Date getSessionNotOnOrAfter() {
return sessionNotOnOrAfter;
}
/**
* Sets the value of the SessionNotOnOrAfter attribute.
*
* @param value new SessionNotOnOrAfter attribute.
* @throws SAML2Exception if the object is immutable.
* @see #getSessionNotOnOrAfter()
*/
public void setSessionNotOnOrAfter(Date value)
throws SAML2Exception
{
if (!mutable) {
throw new SAML2Exception(
SAML2SDKUtils.bundle.getString("objectImmutable"));
}
sessionNotOnOrAfter = value;
}
/**
* Makes the object immutable.
*/
public void makeImmutable() {
if (mutable) {
if (subjectLocality != null) {
subjectLocality.makeImmutable();
}
if (authnContext != null) {
authnContext.makeImmutable();
}
mutable = false;
}
}
/**
* Returns the mutability of the object.
*
* @return true if the object is mutable;
* false otherwise.
*/
public boolean isMutable() {
return mutable;
}
/**
* Returns a String representation of the element.
*
* @return A string containing the valid XML for this element.
* By default name space name is prepended to the element name.
* @throws SAML2Exception if the object does not conform to the schema.
*/
public java.lang.String toXMLString()
throws SAML2Exception
{
return this.toXMLString(true, false);
}
/**
* Returns a String representation of the element.
*
* @param includeNS Determines whether or not the namespace qualifier is
* prepended to the Element when converted
* @param declareNS Determines whether or not the namespace is declared
* within the Element.
* @return A string containing the valid XML for this element
* @throws SAML2Exception if the object does not conform to the schema.
*/
public java.lang.String toXMLString(boolean includeNS, boolean declareNS)
throws SAML2Exception
{
validateData();
StringBuffer result = new StringBuffer(1000);
String prefix = "";
String uri = "";
if (includeNS) {
prefix = SAML2Constants.ASSERTION_PREFIX;
}
if (declareNS) {
uri = SAML2Constants.ASSERTION_DECLARE_STR;
}
result.append("<").append(prefix).append("AuthnStatement").
append(uri).append(" AuthnInstant=\"").
append(DateUtils.toUTCDateFormat(authnInstant)).append("\"");
if (sessionIndex != null && sessionIndex.trim().length() != 0) {
result.append(" SessionIndex=\"").append(sessionIndex).append("\"");
}
if (sessionNotOnOrAfter != null) {
result.append(" SessionNotOnOrAfter=\"").
append(DateUtils.toUTCDateFormat(sessionNotOnOrAfter)).
append("\"");
}
result.append(">");
if (subjectLocality != null) {
result.append(subjectLocality.toXMLString(includeNS, declareNS));
}
result.append(authnContext.toXMLString(includeNS, declareNS));
result.append("");
return result.toString();
}
}