/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright (c) 2006 Sun Microsystems Inc. All Rights Reserved
*
* The contents of this file are subject to the terms
* of the Common Development and Distribution License
* (the License). You may not use this file except in
* compliance with the License.
*
* You can obtain a copy of the License at
* https://opensso.dev.java.net/public/CDDLv1.0.html or
* opensso/legal/CDDLv1.0.txt
* See the License for the specific language governing
* permission and limitations under the License.
*
* When distributing Covered Code, include this CDDL
* Header Notice in each file and include the License file
* at opensso/legal/CDDLv1.0.txt.
* If applicable, add the following below the CDDL Header,
* with the fields enclosed by brackets [] replaced by
* your own identifying information:
* "Portions Copyrighted [year] [name of copyright owner]"
*
* $Id: AuthnStatement.java,v 1.2 2008/06/25 05:47:40 qcheng Exp $
*
* Portions Copyrighted 2015-2016 ForgeRock AS.
*/
package com.sun.identity.saml2.assertion;
import java.util.Date;
import com.fasterxml.jackson.databind.annotation.JsonDeserialize;
import com.sun.identity.saml2.assertion.impl.AuthnStatementImpl;
import com.sun.identity.saml2.common.SAML2Exception;
/**
* 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> ** @supported.all.api */ @JsonDeserialize(as=AuthnStatementImpl.class) public interface AuthnStatement extends Statement { /** * Returns the value of the
AuthnContext
property.
*
* @return AuthnContext
of the statement.
* @see #setAuthnContext(AuthnContext)
*/
AuthnContext getAuthnContext();
/**
* Sets the value of the AuthnContext
property.
*
* @param value new AuthnContext
.
* @throws SAML2Exception if the object is immutable.
* @see #getAuthnContext()
*/
void setAuthnContext(AuthnContext value)
throws SAML2Exception;
/**
* Returns the value of the AuthnInstant
attribute.
*
* @return the value of the AuthnInstant
attribute.
* @see #setAuthnInstant(Date)
*/
Date getAuthnInstant();
/**
* Sets the value of the AuthnInstant
attribute.
*
* @param value new value of AuthnInstant
attribute.
* @throws SAML2Exception if the object is immutable.
* @see #getAuthnInstant()
*/
void setAuthnInstant(Date value)
throws SAML2Exception;
/**
* Returns the value of the SubjectLocality
property.
*
* @return SubjectLocality
of the statement.
* @see #setSubjectLocality(SubjectLocality)
*/
SubjectLocality getSubjectLocality();
/**
* Sets the value of the SubjectLocality
property.
*
* @param value the new value of SubjectLocality
.
* @throws SAML2Exception if the object is immutable.
* @see #getSubjectLocality()
*/
void setSubjectLocality(SubjectLocality value)
throws SAML2Exception;
/**
* Returns the value of the SessionIndex
attribute.
*
* @return the value of the SessionIndex
attribute.
* @see #setSessionIndex(String)
*/
String getSessionIndex();
/**
* Sets the value of the SessionIndex
attribute.
*
* @param value new value of SessionIndex
attribute.
* @throws SAML2Exception if the object is immutable.
* @see #getSessionIndex()
*/
void setSessionIndex(String value)
throws SAML2Exception;
/**
* Returns the value of the SessionNotOnOrAfter
attribute.
*
* @return the value of SessionNotOnOrAfter
attribute.
* @see #setSessionNotOnOrAfter(Date)
*/
Date getSessionNotOnOrAfter();
/**
* Sets the value of the SessionNotOnOrAfter
attribute.
*
* @param value new SessionNotOnOrAfter
attribute.
* @throws SAML2Exception if the object is immutable.
* @see #getSessionNotOnOrAfter()
*/
void setSessionNotOnOrAfter(Date value)
throws SAML2Exception;
}