001/**
002 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
003 *
004 * Copyright (c) 2006 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: NameID.java,v 1.2 2008/06/25 05:47:41 qcheng Exp $
026 *
027 * Portions Copyrighted 2015 ForgeRock AS.
028 */
029package com.sun.identity.saml2.assertion;
030
031import java.security.Key;
032
033import com.fasterxml.jackson.annotation.JsonTypeInfo;
034import com.sun.identity.saml2.assertion.impl.NameIDImpl;
035import com.sun.identity.saml2.common.SAML2Exception;
036
037/**
038 *  The <code>NameID</code> is used in various SAML assertion constructs
039 *  such as <code>Subject</code> and <code>SubjectConfirmation</code>
040 *  elements, and in various protocol messages.
041 *
042 *  @supported.all.api  
043 */
044@JsonTypeInfo(include = JsonTypeInfo.As.PROPERTY, use = JsonTypeInfo.Id.CLASS, defaultImpl = NameIDImpl.class)
045public interface NameID extends NameIDType {
046    /**
047     * Returns an <code>EncryptedID</code> object.
048     *
049     * @param recipientPublicKey Public key used to encrypt the data encryption
050     *                           (secret) key, it is the public key of the
051     *                           recipient of the XML document to be encrypted.
052     * @param dataEncAlgorithm Data encryption algorithm.
053     * @param dataEncStrength Data encryption strength.
054     * @param recipientEntityID Unique identifier of the recipient, it is used
055     *                          as the index to the cached secret key so that
056     *                          the key can be reused for the same recipient;
057     *                          It can be null in which case the secret key will
058     *                          be generated every time and will not be cached
059     *                          and reused. Note that the generation of a secret
060     *                          key is a relatively expensive operation.
061     * @return <code>EncryptedID</code> object
062     * @throws SAML2Exception if error occurs during the encryption process.
063     */
064    public EncryptedID encrypt(
065        Key recipientPublicKey,
066        String dataEncAlgorithm,
067        int dataEncStrength,
068        String recipientEntityID)
069        throws SAML2Exception;
070
071}