001/**
002 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
003 *
004 * Copyright (c) 2008 Sun Microsystems Inc. All Rights Reserved
005 *
006 * The contents of this file are subject to the terms
007 * of the Common Development and Distribution License
008 * (the License). You may not use this file except in
009 * compliance with the License.
010 *
011 * You can obtain a copy of the License at
012 * https://opensso.dev.java.net/public/CDDLv1.0.html or
013 * opensso/legal/CDDLv1.0.txt
014 * See the License for the specific language governing
015 * permission and limitations under the License.
016 *
017 * When distributing Covered Code, include this CDDL
018 * Header Notice in each file and include the License file
019 * at opensso/legal/CDDLv1.0.txt.
020 * If applicable, add the following below the CDDL Header,
021 * with the fields enclosed by brackets [] replaced by
022 * your own identifying information:
023 * "Portions Copyrighted [year] [name of copyright owner]"
024 *
025 * $Id: AuthnQuery.java,v 1.2 2008/06/25 05:47:56 qcheng Exp $
026 *
027 * Portions Copyrighted 2016 ForgeRock AS.
028 */
029
030
031package com.sun.identity.saml2.protocol;
032
033import com.fasterxml.jackson.annotation.JsonTypeInfo;
034import com.sun.identity.saml2.common.SAML2Exception;
035import com.sun.identity.saml2.protocol.impl.AuthnQueryImpl;
036
037
038/**
039 * This class represents the AuthnQueryType complex type.
040 * <p>The following schema fragment specifies the expected        
041 * content contained within this java content object.   
042 * <p>
043 * <pre>
044 * &lt;complexType name="AuthnQueryType">
045 *   &lt;complexContent>
046 *     &lt;extension base="{urn:oasis:names:tc:SAML:2.0:protocol}SubjectQueryAbstractType">
047 *       &lt;sequence>
048 *         &lt;element ref="{urn:oasis:names:tc:SAML:2.0:protocol}RequestedAuthnContext" minOccurs="0"/>
049 *       &lt;/sequence>
050 *       &lt;attribute name="SessionIndex" type="string" use="optional"/>
051 *     &lt;/extension>
052 *   &lt;/complexContent>
053 * &lt;/complexType>
054 * </pre>
055 * 
056 * @supported.all.api
057 */
058
059@JsonTypeInfo(include = JsonTypeInfo.As.PROPERTY, use = JsonTypeInfo.Id.CLASS,
060        defaultImpl = AuthnQueryImpl.class)
061public interface AuthnQuery extends SubjectQueryAbstract {
062
063    /**
064     * Returns the <code>RequestedAuthnContext</code> object.
065     *
066     * @return the <code>RequestedAuthnContext</code> object.
067     * @see #setRequestedAuthnContext(RequestedAuthnContext)
068     */
069    public RequestedAuthnContext getRequestedAuthnContext();
070    
071    /**
072     * Sets the <code>RequestedAuthnContext</code> object.
073     *
074     * @param requestedAuthnContext the new <code>RequestedAuthnContext</code>
075     *     object.
076     * @throws SAML2Exception if the object is immutable.
077     * @see #getRequestedAuthnContext
078     */
079    public void setRequestedAuthnContext(
080        RequestedAuthnContext requestedAuthnContext) throws SAML2Exception;
081
082    /**
083     * Returns the value of the <code>SessionIndex</code> attribute.
084     *
085     * @return value of <code>SessionIndex</code> attribute.
086     * @see #setSessionIndex(String)
087     */
088    public String getSessionIndex();
089
090    /**
091     * Sets the value of <code>SessionIndex</code> attribute.
092     *
093     * @param sessionIndex new value of the <code>SessionIndex</code> attribute.
094     * @throws SAML2Exception if the object is immutable.
095     * @see #getSessionIndex
096     */
097    public void setSessionIndex(String sessionIndex) throws SAML2Exception;
098
099}