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: BaseID.java,v 1.2 2008/06/25 05:47:40 qcheng Exp $
026 *
027 */
028
029
030package com.sun.identity.saml2.assertion;
031
032import com.sun.identity.saml2.common.SAML2Exception;
033
034/**
035 *  The <code>BaseID</code> is an extension point that allows 
036 *  applications to add new kinds of identifiers.
037 *  @supported.all.api
038 */
039public interface BaseID extends BaseIDAbstract {
040
041   /**
042    * Returns a String representation
043    * @param includeNSPrefix Determines whether or not the namespace 
044    *        qualifier is
045    *        prepended to the Element when converted
046    * @param declareNS Determines whether or not the namespace is declared
047    *        within the Element.
048    * @return A String representation
049    * @exception SAML2Exception if something is wrong during conversion
050     */
051    public String toXMLString(boolean includeNSPrefix, boolean declareNS)
052     throws SAML2Exception;
053
054   /**
055    * Returns a String representation
056    *
057    * @return A String representation
058    * @exception SAML2Exception if something is wrong during conversion
059    */
060    public String toXMLString() throws SAML2Exception;
061}