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: RequesterID.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 com.sun.identity.saml2.common.SAML2Exception;
034import org.w3c.dom.Element;
035
036/** 
037 * This interface identifies the requester in an <code>AuthnRequest</code> 
038 * message.
039 *
040 * @supported.all.api
041 */
042public interface RequesterID {
043            
044    /** 
045     * Returns the value of the <code>RequesterID</code> URI.
046     *
047     * @return value of the <code>RequesterID</code> URI.
048     * @see #setValue
049     */
050    public String getValue();
051    
052    /** 
053     * Sets the value of the <code>RequesterID</code> URI.
054     *
055     * @param value of the <code>RequesterID<code> URI.
056     * @throws SAML2Exception if the object is immutable.
057     * @see #getValue
058     */
059    public void setValue(String value) throws SAML2Exception;
060    
061    /** 
062     * Returns a String representation of this Object.
063     *
064     * @return a  String representation of this Object.
065     * @throws SAML2Exception if cannot convert to String.
066     */
067    public String toXMLString() throws SAML2Exception;
068    
069    /** 
070     * Returns a String representation of this Object.
071     *
072     * @param includeNSPrefix determines whether or not the namespace 
073     *        qualifier is prepended to the Element when converted
074     * @param declareNS determines whether or not the namespace is declared
075     *        within the Element.
076     * @throws SAML2Exception if cannot convert to String.
077     * @return a String representation of this Object.
078     **/
079            
080    public String toXMLString(boolean includeNSPrefix,boolean declareNS)
081        throws SAML2Exception;
082    
083    /** 
084     * Makes this object immutable. 
085     *
086     */
087    public void makeImmutable() ;
088    
089    /** 
090     * Returns value true if object is mutable.
091     *
092     * @return true if object is mutable.
093     */
094    public boolean isMutable();
095}