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