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 */
028
029
030package com.sun.identity.saml2.protocol;
031
032import java.util.List;
033import com.sun.identity.saml2.common.SAML2Exception;
034
035
036/**
037 * This class represents the AuthnQueryType complex type.
038 * <p>The following schema fragment specifies the expected        
039 * content contained within this java content object.   
040 * <p>
041 * <pre>
042 * &lt;complexType name="AuthnQueryType">
043 *   &lt;complexContent>
044 *     &lt;extension base="{urn:oasis:names:tc:SAML:2.0:protocol}SubjectQueryAbstractType">
045 *       &lt;sequence>
046 *         &lt;element ref="{urn:oasis:names:tc:SAML:2.0:protocol}RequestedAuthnContext" minOccurs="0"/>
047 *       &lt;/sequence>
048 *       &lt;attribute name="SessionIndex" type="string" use="optional"/>
049 *     &lt;/extension>
050 *   &lt;/complexContent>
051 * &lt;/complexType>
052 * </pre>
053 * 
054 * @supported.all.api
055 */
056public interface AuthnQuery extends SubjectQueryAbstract {
057
058    /**
059     * Returns the <code>RequestedAuthnContext</code> object.
060     *
061     * @return the <code>RequestedAuthnContext</code> object.
062     * @see #setRequestedAuthnContext(RequestedAuthnContext)
063     */
064    public RequestedAuthnContext getRequestedAuthnContext();
065    
066    /**
067     * Sets the <code>RequestedAuthnContext</code> object.
068     *
069     * @param requestedAuthnContext the new <code>RequestedAuthnContext</code>
070     *     object.
071     * @throws SAML2Exception if the object is immutable.
072     * @see #getRequestedAuthnContext
073     */
074    public void setRequestedAuthnContext(
075        RequestedAuthnContext requestedAuthnContext) throws SAML2Exception;
076
077    /**
078     * Returns the value of the <code>SessionIndex</code> attribute.
079     *
080     * @return value of <code>SessionIndex</code> attribute.
081     * @see #setSessionIndex(String)
082     */
083    public String getSessionIndex();
084
085    /**
086     * Sets the value of <code>SessionIndex</code> attribute.
087     *
088     * @param sessionIndex new value of the <code>SessionIndex</code> attribute.
089     * @throws SAML2Exception if the object is immutable.
090     * @see #getSessionIndex
091     */
092    public void setSessionIndex(String sessionIndex) throws SAML2Exception;
093
094}




























































Copyright © 2010-2017, ForgeRock All Rights Reserved.