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