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: NewEncryptedID.java,v 1.2 2008/06/25 05:47:57 qcheng Exp $ 026 * 027 * Portions Copyrighted 2015-2016 ForgeRock AS. 028 */ 029package com.sun.identity.saml2.protocol; 030 031import com.fasterxml.jackson.annotation.JsonTypeInfo; 032import com.sun.identity.saml2.assertion.EncryptedElement; 033import com.sun.identity.saml2.common.SAML2Exception; 034import com.sun.identity.saml2.protocol.impl.NewEncryptedIDImpl; 035import java.security.PrivateKey; 036import java.util.Set; 037 038/** 039 * Java content class for NewEncryptedID element declaration. 040 * <p>The following schema fragment specifies the expected 041 * content contained within this java content object. 042 * <p> 043 * <pre> 044 * <element name="NewEncryptedID" type="{urn:oasis:names:tc:SAML:2.0:assertion}EncryptedElementType"/> 045 * </pre> 046 * 047 * @supported.all.api 048 */ 049 050@JsonTypeInfo(include = JsonTypeInfo.As.PROPERTY, use = JsonTypeInfo.Id.CLASS, 051 defaultImpl = NewEncryptedIDImpl.class) 052public interface NewEncryptedID extends EncryptedElement { 053 /** 054 * Returns an instance of <code>NewID</code> object. 055 * 056 * @param privateKeys Private keys of the recipient used to decrypt the secret key. 057 * @return <code>NewID</code> object. 058 * @throws SAML2Exception if error occurs. 059 */ 060 NewID decrypt(Set<PrivateKey> privateKeys) throws SAML2Exception; 061}