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: EncryptedID.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>EncryptedID</code> carries the content of an unencrypted 038 * identifier in encrypted fasion. It contains an <code>EncryptedData</code> 039 * and zero or more <code>EncryptedKey</code>s. 040 * 041 * @supported.all.api 042 */ 043public interface EncryptedID extends EncryptedElement { 044 045 /** 046 * Decrypts the encrypted ID. 047 * 048 * @param recipientPrivateKey Private key of the recipient used to 049 * decrypt the secret key 050 * @return a <code>NameID</code> that is decrypted from this object 051 * @exception SAML2Exception if it could not decrypt the ID properly. 052 */ 053 public NameID decrypt(Key recipientPrivateKey) throws SAML2Exception; 054 055}