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: EncryptedAttribute.java,v 1.2 2008/06/25 05:47:41 qcheng Exp $
026 *
027 */
028
029
030
031package com.sun.identity.saml2.assertion;
032
033import java.security.Key;
034
035import com.sun.identity.saml2.common.SAML2Exception;
036
037/**
038 * The <code>EncryptedAttribute</code> element represents a SAML attribute
039 * in encrypted fashion. It's of type <code>EncryptedElementType</code>.
040 * <p>
041 * <pre>
042 * &lt;element name="EncryptedAttribute" 
043 * type="{urn:oasis:names:tc:SAML:2.0:assertion}EncryptedElementType"/>
044 * </pre>
045 * @supported.all.api
046 */
047public interface EncryptedAttribute extends EncryptedElement {
048
049    /**
050     * Returns an instance of <code>Attribute</code> object.
051     *
052     * @param recipientPrivateKey Private key of the recipient used to
053     *                            decrypt the secret key
054     * @return <code>Attribute</code> object.
055     * @throws SAML2Exception if error occurs.
056     */
057    public Attribute decrypt(Key recipientPrivateKey)
058        throws SAML2Exception;
059
060}