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: IDPList.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.IDPListImpl;
036import java.util.List;
037
038
039/** 
040 * This interface specifies the identity providers trusted by the requester
041 * to authenticate the presenter.
042 *
043 * @supported.all.api
044 */
045
046@JsonTypeInfo(include = JsonTypeInfo.As.PROPERTY, use = JsonTypeInfo.Id.CLASS,
047        defaultImpl = IDPListImpl.class)
048public interface IDPList {
049    
050    /** 
051     * Returns the list of <code>IDPEntry</code> Objects.
052     *
053     * @return the list <code>IDPEntry</code> objects.
054     * @see #setIDPEntries(List)
055     */
056    public List getIDPEntries();
057    
058    /** 
059     * Sets the <code>IDPEntry</code> Object.
060     *
061     * @param idpEntryList  the  list of <code>IDPEntry</code> objects.
062     * @throws SAML2Exception if the object is immutable.
063     * @see #getIDPEntries
064     */
065    public void setIDPEntries(List idpEntryList) throws SAML2Exception;
066    
067    /** 
068     * Returns the <code>GetComplete</code> Object.
069     *
070     * @return the <code>GetComplete</code> object.
071     * @see #setGetComplete(GetComplete)
072     */
073    public GetComplete getGetComplete();
074    
075    /** 
076     * Sets the <code>GetComplete</code> Object.
077     *
078     * @param getComplete the new <code>GetComplete</code> object.
079     * @throws SAML2Exception if the object is immutable.
080     * @see #getGetComplete
081     */
082    
083    public void setGetComplete(GetComplete getComplete) throws SAML2Exception;
084    
085    /** 
086     * Returns a String representation of this Object.
087     *
088     * @return a String representation of this Object.
089     * @throws SAML2Exception cannot create String object.
090     */
091    public String toXMLString() throws SAML2Exception;
092    
093    /** 
094     * Returns a String representation of this Object.
095     *
096     * @param includeNSPrefix determines whether or not the namespace
097     *        qualifier is prepended to the Element when converted
098     * @param declareNS determines whether or not the namespace is declared
099     *        within the Element.
100     * @return the String representation of this Object.
101     * @throws SAML2Exception cannot create String object.
102     **/
103    
104    public String toXMLString(boolean includeNSPrefix,boolean declareNS)
105           throws SAML2Exception;
106    
107        
108    /** 
109     * Makes this object immutable. 
110     */
111    public void makeImmutable() ;
112    
113    /** 
114     * Returns true if object is mutable.
115     *
116     * @return true if the object is mutable.
117     */
118    public boolean isMutable();
119}