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: IDPEntry.java,v 1.2 2008/06/25 05:47:56 qcheng Exp $
026 *
027 */
028
029
030package com.sun.identity.saml2.protocol;
031
032import com.sun.identity.saml2.common.SAML2Exception;
033import org.w3c.dom.Element;
034
035/** 
036 * This interface defines methods to set/retrieve single identity provider
037 * information trusted by the request issuer to authenticate the presenter.
038 *
039 * @supported.all.api
040 */
041
042public interface IDPEntry {
043    
044    /** 
045     * Returns the <code>ProviderID</code> attribute value.
046     *
047     * @return value of the <code>ProviderID</code> attribute.
048     * @see #setProviderID(String)
049     */
050    public String getProviderID();
051    
052    /** 
053     * Sets the <code>ProviderID</code> attribute value.
054     *
055     * @param uri new value of <code>ProviderID</code> attribute.
056     * @throws SAML2Exception if the object is immutable. 
057     * @see #getProviderID
058     */
059    public void setProviderID(String uri) throws SAML2Exception;
060    
061    /** 
062     * Returns the value of <code>Name</code> attribute.
063     *
064     * @return value of the <code>Name</code> attribute.
065     * @see #setName(String)
066     */
067    
068    public String getName();
069    
070    /** 
071     * Sets the value of <code>Name</code> attribute.
072     *
073     * @param name new value of <code>Name</code> attribute.
074     * @throws SAML2Exception if the object is immutable.
075     * @see #getName
076     */
077    public void setName(String name) throws SAML2Exception;
078    
079    /** 
080     * Return the value of <code>Loc</code> attribute.
081     *
082     * @return value of <code>Loc</code> attribute.
083     * @see #setLoc(String)
084     */
085    public String getLoc();
086    
087    /** 
088     * Sets the value of <code>Loc</code> attribute.
089     *
090     * @param locationURI value of <code>Loc</code> attribute.
091     * @throws SAML2Exception if the object is immutable. 
092     * @see #getLoc
093     */
094    
095    public void setLoc(String locationURI) throws SAML2Exception;
096    
097    /** 
098     * Returns a String representation of this Object.
099     *
100     * @return a String representation of this Object.
101     * @throws SAML2Exception if cannot create String object.
102     */
103    public String toXMLString() throws SAML2Exception;
104    
105    /** 
106     * Returns a String representation of this Object.
107     *
108     * @param includeNSPrefix determines whether or not the namespace
109     *        qualifier is prepended to the Element when converted
110     * @param declareNS determines whether or not the namespace is declared
111     *        within the Element.
112     * @return the String representation of this Object.
113     * @throws SAML2Exception if cannot create String object.
114     **/
115    
116    public String toXMLString(boolean includeNSPrefix,boolean declareNS)
117           throws SAML2Exception;
118
119    /** 
120     * Makes this object immutable. 
121     *
122     */
123    public void makeImmutable() ;
124    
125    /** 
126     * Returns  true if object is mutable.
127     *
128     * @return true if object is mutable.
129     */
130    public boolean isMutable();
131}




























































Copyright © 2010-2017, ForgeRock All Rights Reserved.