NameID.java revision faab40680022acbfba28ce315c2fc28dfa99bab8
/**
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright (c) 2006 Sun Microsystems Inc. All Rights Reserved
*
* The contents of this file are subject to the terms
* of the Common Development and Distribution License
* (the License). You may not use this file except in
* compliance with the License.
*
* You can obtain a copy of the License at
* See the License for the specific language governing
* permission and limitations under the License.
*
* When distributing Covered Code, include this CDDL
* Header Notice in each file and include the License file
* at opensso/legal/CDDLv1.0.txt.
* If applicable, add the following below the CDDL Header,
* with the fields enclosed by brackets [] replaced by
* your own identifying information:
* "Portions Copyrighted [year] [name of copyright owner]"
*
* $Id: NameID.java,v 1.2 2008/06/25 05:47:41 qcheng Exp $
*
* Portions Copyrighted 2015 ForgeRock AS.
*/
/**
* The <code>NameID</code> is used in various SAML assertion constructs
* such as <code>Subject</code> and <code>SubjectConfirmation</code>
* elements, and in various protocol messages.
*
* @supported.all.api
*/
@JsonTypeInfo(include = JsonTypeInfo.As.PROPERTY, use = JsonTypeInfo.Id.CLASS, defaultImpl = NameIDImpl.class)
public interface NameID extends NameIDType {
/**
* Returns an <code>EncryptedID</code> object.
*
* @param recipientPublicKey Public key used to encrypt the data encryption
* (secret) key, it is the public key of the
* recipient of the XML document to be encrypted.
* @param dataEncAlgorithm Data encryption algorithm.
* @param dataEncStrength Data encryption strength.
* @param recipientEntityID Unique identifier of the recipient, it is used
* as the index to the cached secret key so that
* the key can be reused for the same recipient;
* It can be null in which case the secret key will
* be generated every time and will not be cached
* and reused. Note that the generation of a secret
* key is a relatively expensive operation.
* @return <code>EncryptedID</code> object
* @throws SAML2Exception if error occurs during the encryption process.
*/
public EncryptedID encrypt(
int dataEncStrength,
throws SAML2Exception;
}