/**
* 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: Assertion.java,v 1.2 2008/06/25 05:47:39 qcheng Exp $
*
* Portions Copyrighted 2015 ForgeRock AS.
*/
package com.sun.identity.saml2.assertion;
import java.util.Date;
import java.util.List;
import java.security.Key;
import java.security.PrivateKey;
import java.security.cert.X509Certificate;
import java.util.Set;
import com.fasterxml.jackson.databind.annotation.JsonDeserialize;
import com.sun.identity.saml2.assertion.impl.AssertionImpl;
import com.sun.identity.saml2.common.SAML2Exception;
/**
* The Assertion element is a package of information
* that supplies one or more Statement made by an issuer.
* There are three kinds of assertions: Authentication, Authorization Decision,
* and Attribute assertions.
* @supported.all.api
*/
@JsonDeserialize(as=AssertionImpl.class)
public interface Assertion {
/**
* Returns the version number of the assertion.
*
* @return The version number of the assertion.
*/
String getVersion();
/**
* Sets the version number of the assertion.
*
* @param version the version number.
* @exception SAML2Exception if the object is immutable
*/
void setVersion(String version) throws SAML2Exception;
/**
* Returns the time when the assertion was issued
*
* @return the time of the assertion issued
*/
Date getIssueInstant();
/**
* Sets the time when the assertion was issued
*
* @param issueInstant the issue time of the assertion
* @exception SAML2Exception if the object is immutable
*/
void setIssueInstant(Date issueInstant) throws SAML2Exception;
/**
* Returns the subject of the assertion
*
* @return the subject of the assertion
*/
Subject getSubject();
/**
* Sets the subject of the assertion
*
* @param subject the subject of the assertion
* @exception SAML2Exception if the object is immutable
*/
void setSubject(Subject subject) throws SAML2Exception;
/**
* Returns the advice of the assertion
*
* @return the advice of the assertion
*/
Advice getAdvice();
/**
* Sets the advice of the assertion
*
* @param advice the advice of the assertion
* @exception SAML2Exception if the object is immutable
*/
void setAdvice(Advice advice) throws SAML2Exception;
/**
* Returns the signature of the assertion
*
* @return the signature of the assertion
*/
String getSignature();
/**
* Returns the conditions of the assertion
*
* @return the conditions of the assertion
*/
Conditions getConditions();
/**
* Sets the conditions of the assertion
*
* @param conditions the conditions of the assertion
* @exception SAML2Exception if the object is immutable
*/
void setConditions(Conditions conditions) throws SAML2Exception;
/**
* Returns the id of the assertion
*
* @return the id of the assertion
*/
String getID();
/**
* Sets the id of the assertion
*
* @param id the id of the assertion
* @exception SAML2Exception if the object is immutable
*/
void setID(String id) throws SAML2Exception;
/**
* Returns the statements of the assertion
*
* @return the statements of the assertion
*/
List