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