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: NameIDMappingResponse.java,v 1.2 2008/06/25 05:47:57 qcheng Exp $
026 *
027 */
028
029
030package com.sun.identity.saml2.protocol;
031
032import com.sun.identity.saml2.assertion.EncryptedID;
033import com.sun.identity.saml2.assertion.NameID;
034import com.sun.identity.saml2.common.SAML2Exception;
035import com.sun.identity.saml2.protocol.StatusResponse;
036
037/**
038 * This class represents the NameIDMappingResponseType complex type.
039 * <p>The following schema fragment specifies the expected        
040 * content contained within this java content object.   
041 * <p>
042 * <pre>
043 * &lt;complexType name="NameIDMappingResponseType">
044 *   &lt;complexContent>
045 *     &lt;extension base="{urn:oasis:names:tc:SAML:2.0:protocol}StatusResponseType">
046 *       &lt;choice>
047 *         &lt;element ref="{urn:oasis:names:tc:SAML:2.0:assertion}NameID"/>
048 *         &lt;element ref="{urn:oasis:names:tc:SAML:2.0:assertion}EncryptedID"/>
049 *       &lt;/choice>
050 *     &lt;/extension>
051 *   &lt;/complexContent>
052 * &lt;/complexType>
053 * </pre>
054 *
055 * @supported.all.api
056 */
057public interface NameIDMappingResponse extends StatusResponse {   
058    /**
059     * Returns the value of the <code>encryptedID</code> property.
060     *
061     * @return the value of the <code>encryptedID</code> property.
062     */
063    EncryptedID getEncryptedID();
064
065    /**
066     * Sets the value of the <code>encryptedID</code> property.
067     *
068     * @param value the value of the <code>encryptedID</code> property.
069     * @throws SAML2Exception if <code>Object</code> is immutable.
070     */
071    void setEncryptedID(EncryptedID value) throws SAML2Exception;
072
073    /**
074     * Returns the value of the <code>nameID</code> property.
075     *
076     * @return the value of the <code>nameID</code> property.
077     */
078    NameID getNameID();
079
080    /**
081     * Sets the value of the <code>nameID</code> property.
082     *
083     * @param value the value of the <code>nameID</code> property.
084     * @throws SAML2Exception if <code>Object</code> is immutable.
085     */
086    void setNameID(NameID value) throws SAML2Exception;
087}