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