5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk/**
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk *
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk * Copyright (c) 2006 Sun Microsystems Inc. All Rights Reserved
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk *
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk * The contents of this file are subject to the terms
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk * of the Common Development and Distribution License
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk * (the License). You may not use this file except in
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk * compliance with the License.
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk *
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk * You can obtain a copy of the License at
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk * https://opensso.dev.java.net/public/CDDLv1.0.html or
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk * opensso/legal/CDDLv1.0.txt
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk * See the License for the specific language governing
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk * permission and limitations under the License.
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk *
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk * When distributing Covered Code, include this CDDL
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk * Header Notice in each file and include the License file
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk * at opensso/legal/CDDLv1.0.txt.
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk * If applicable, add the following below the CDDL Header,
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk * with the fields enclosed by brackets [] replaced by
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk * your own identifying information:
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk * "Portions Copyrighted [year] [name of copyright owner]"
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk *
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk * $Id: NameIDType.java,v 1.2 2008/06/25 05:47:41 qcheng Exp $
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk *
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk */
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenkpackage com.sun.identity.saml2.assertion;
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenkimport com.sun.identity.saml2.common.SAML2Exception;
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk/**
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk * The <code>NameIDType</code> is used when an element serves to represent
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk * an entity by a string-valued name. In addition to the string content
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk * containing the actual identifier, it provides the following optional
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk * attributes:
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk * <code>NameQualifier</code>
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk * <code>SPNameQualifier</code>
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk * <code>Format</code>
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk * <code>SPProvidedID</code>
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk * @supported.all.api
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk */
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenkpublic interface NameIDType {
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk /**
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk * Returns the string-valued identifier
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk *
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk * @return the string-valued identifier
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk */
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk public String getValue();
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk /**
dff2cc5646d4437ab9e0cb1dcb59da65462a5938jeff.schenk * Sets the string-valued identifier
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk *
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk * @param value the string-valued identifier
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk * @exception SAML2Exception if the object is immutable
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk */
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk public void setValue(String value) throws SAML2Exception;
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk /**
5b64d5d44892834ba97f003080f3467299b7c5c5jeff.schenk * Returns the name qualifier
*
* @return the name qualifier
*/
public String getNameQualifier();
/**
* Sets the name qualifier
*
* @param value the name qualifier
* @exception SAML2Exception if the object is immutable
*/
public void setNameQualifier(String value) throws SAML2Exception;
/**
* Returns the <code>SP</code> provided ID
*
* @return the <code>SP</code> provided ID
*/
public String getSPProvidedID();
/**
* Sets the <code>SP</code> provided ID
*
* @param value the <code>SP</code> provided ID
* @exception SAML2Exception if the object is immutable
*/
public void setSPProvidedID(String value) throws SAML2Exception;
/**
* Returns the <code>SP</code> name qualifier
*
* @return the <code>SP</code> name qualifier
*/
public String getSPNameQualifier();
/**
* Sets the <code>SP</code> name qualifier
*
* @param value the <code>SP</code> name qualifier
* @exception SAML2Exception if the object is immutable
*/
public void setSPNameQualifier(String value) throws SAML2Exception;
/**
* Returns the format
*
* @return the format
*/
public String getFormat();
/**
* Sets the format
*
* @param value the format
* @exception SAML2Exception if the object is immutable
*/
public void setFormat(String value) throws SAML2Exception;
/**
* Returns a String representation
* @param includeNSPrefix Determines whether or not the namespace qualifier
* is prepended to the Element when converted
* @param declareNS Determines whether or not the namespace is declared
* within the Element.
* @return A String representation
* @exception SAML2Exception if something is wrong during conversion
*/
public String toXMLString(boolean includeNSPrefix, boolean declareNS)
throws SAML2Exception;
/**
* Returns a String representation
*
* @return A String representation
* @exception SAML2Exception if something is wrong during conversion
*/
public String toXMLString() throws SAML2Exception;
/**
* Makes the object immutable
*/
public void makeImmutable();
/**
* Returns true if the object is mutable
*
* @return true if the object is mutable
*/
public boolean isMutable();
}