001/**
002 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
003 *
004 * Copyright (c) 2007 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: SubjectQueryAbstract.java,v 1.2 2008/06/25 05:47:58 qcheng Exp $
026 *
027 */
028
029
030package com.sun.identity.saml2.protocol;
031
032import com.fasterxml.jackson.annotation.JsonTypeInfo;
033import com.sun.identity.saml2.assertion.Subject;
034import com.sun.identity.saml2.common.SAML2Exception;
035
036/**
037 * This class represents the SubjectQueryAbstractType 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="SubjectQueryAbstractType">
043 *   &lt;complexContent>
044 *     &lt;extension base="{urn:oasis:names:tc:SAML:2.0:protocol}RequestAbstractType">
045 *       &lt;sequence>
046 *         &lt;element ref="{urn:oasis:names:tc:SAML:2.0:assertion}Subject"/>
047 *       &lt;/sequence>
048 *     &lt;/extension>
049 *   &lt;/complexContent>
050 * &lt;/complexType>
051 * </pre>
052 * 
053 * @supported.all.api
054 */
055
056@JsonTypeInfo(include = JsonTypeInfo.As.PROPERTY, use = JsonTypeInfo.Id.CLASS)
057public interface SubjectQueryAbstract extends RequestAbstract {
058    /** 
059     * Returns the <code>Subject</code> object. 
060     *
061     * @return the <code>Subject</code> object. 
062     * @see #setSubject(Subject)
063     */
064    public Subject getSubject();
065    
066    /** 
067     * Sets the <code>Subject</code> object. 
068     *
069     * @param subject the new <code>Subject</code> object. 
070     * @throws SAML2Exception if the object is immutable.
071     * @see #getSubject
072     */
073    public void setSubject(Subject subject) throws SAML2Exception;
074}