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: EncryptedElement.java,v 1.2 2008/06/25 05:47:41 qcheng Exp $
026 *
027 */
028package com.sun.identity.saml2.assertion;
029
030import com.sun.identity.saml2.common.SAML2Exception;
031
032/**
033 * The <code>EncryptedElement</code> carries the content of an unencrypted
034 * identifier in encrypted fasion. It contains an <code>EncryptedData</code>
035 * and zero or more <code>EncryptedKey</code>s.
036 * @supported.all.api 
037 */
038public interface EncryptedElement {
039
040   /**
041    * Returns a String representation
042    * @param includeNSPrefix Determines whether or not the namespace qualifier
043    *        is prepended to the Element when converted
044    * @param declareNS Determines whether or not the namespace is declared
045    *        within the Element.
046    * @return A String representation
047    * @exception SAML2Exception if something is wrong during conversion
048    */
049    public String toXMLString(boolean includeNSPrefix, boolean declareNS)
050     throws SAML2Exception;
051
052   /**
053    * Returns a String representation
054    *
055    * @return A String representation
056    * @exception SAML2Exception if something is wrong during conversion
057    */
058    public String toXMLString() throws SAML2Exception;
059}