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: NewID.java,v 1.2 2008/06/25 05:47:57 qcheng Exp $
026 *
027 */
028
029
030package com.sun.identity.saml2.protocol;
031
032
033import java.security.Key;
034
035import com.sun.identity.saml2.common.SAML2Exception;
036
037/** 
038 * This interface identifies the new identifier in an 
039 * <code>ManageNameIDRequest</code> message.
040 *
041 * @supported.all.api
042 */
043public interface NewID {
044    /** 
045     * Returns the value of the <code>NewID</code> URI.
046     *
047     * @return value of the <code>NewID</code> URI.
048     */
049    public String getValue();
050    
051    /** 
052     * Returns a String representation of this Object.
053     *
054     * @return a  String representation of this Object.
055     * @throws SAML2Exception if cannot convert to String.
056     */
057    public String toXMLString() throws SAML2Exception;
058    
059    /** 
060     * Returns a String representation of this Object.
061     *
062     * @param includeNSPrefix determines whether or not the namespace 
063     *        qualifier is prepended to the Element when converted
064     * @param declareNS determines whether or not the namespace is declared
065     *        within the Element.
066     * @throws SAML2Exception if cannot convert to String.
067     * @return a String representation of this Object.
068     **/
069            
070    public String toXMLString(boolean includeNSPrefix,boolean declareNS)
071        throws SAML2Exception;
072    
073    /**
074     * Returns an <code>NewEncryptedID</code> object.
075     *
076     * @param recipientPublicKey Public key used to encrypt the data encryption
077     *                           (secret) key, it is the public key of the
078     *                           recipient of the XML document to be encrypted.
079     * @param dataEncAlgorithm Data encryption algorithm.
080     * @param dataEncStrength Data encryption strength.
081     * @param recipientEntityID Unique identifier of the recipient, it is used
082     *                          as the index to the cached secret key so that
083     *                          the key can be reused for the same recipient;
084     *                          It can be null in which case the secret key will
085     *                          be generated every time and will not be cached
086     *                          and reused. Note that the generation of a secret
087     *                          key is a relatively expensive operation.
088     * @return <code>NewEncryptedID</code> object
089     * @throws SAML2Exception if error occurs during the encryption process.
090     */
091    public NewEncryptedID encrypt(
092        Key recipientPublicKey,
093        String dataEncAlgorithm,
094        int dataEncStrength,
095        String recipientEntityID) throws SAML2Exception;
096}