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 */ 028 029 030package com.sun.identity.saml2.assertion; 031 032import java.security.Key; 033 034import com.sun.identity.saml2.common.SAML2Exception; 035 036/** 037 * The <code>NameID</code> is used in various SAML assertion constructs 038 * such as <code>Subject</code> and <code>SubjectConfirmation</code> 039 * elements, and in various protocol messages. 040 * 041 * @supported.all.api 042 */ 043public interface NameID extends NameIDType { 044 /** 045 * Returns an <code>EncryptedID</code> object. 046 * 047 * @param recipientPublicKey Public key used to encrypt the data encryption 048 * (secret) key, it is the public key of the 049 * recipient of the XML document to be encrypted. 050 * @param dataEncAlgorithm Data encryption algorithm. 051 * @param dataEncStrength Data encryption strength. 052 * @param recipientEntityID Unique identifier of the recipient, it is used 053 * as the index to the cached secret key so that 054 * the key can be reused for the same recipient; 055 * It can be null in which case the secret key will 056 * be generated every time and will not be cached 057 * and reused. Note that the generation of a secret 058 * key is a relatively expensive operation. 059 * @return <code>EncryptedID</code> object 060 * @throws SAML2Exception if error occurs during the encryption process. 061 */ 062 public EncryptedID encrypt( 063 Key recipientPublicKey, 064 String dataEncAlgorithm, 065 int dataEncStrength, 066 String recipientEntityID) 067 throws SAML2Exception; 068 069}