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: Scoping.java,v 1.2 2008/06/25 05:47:58 qcheng Exp $ 026 * 027 * Portions Copyrighted 2014 ForgeRock AS. 028 */ 029 030 031package com.sun.identity.saml2.protocol; 032 033import com.sun.identity.saml2.common.SAML2Exception; 034import java.util.List; 035 036 037/** 038 * This interface defines methods to retrieve Identity Providers and 039 * context/limitations related to proxying of the request message. 040 * 041 * @supported.all.api 042 */ 043public interface Scoping { 044 045 /** 046 * Returns the <code>IDPList</code> Object. 047 * 048 * @return the <code>IDPList</code> object. 049 * @see #setIDPList(IDPList) 050 */ 051 public IDPList getIDPList(); 052 053 /** 054 * Sets the <code>IDPList</code> Object. 055 * 056 * @param idpList the new <code>IDPList</code> object. 057 * @throws SAML2Exception if the object is immutable. 058 * @see #getIDPList 059 */ 060 public void setIDPList(IDPList idpList) throws SAML2Exception; 061 062 /** 063 * Returns a list of <code>RequesterID</code> Objects.. 064 * 065 * @return list of <code>RequesterID</code> objects. 066 * @see #setRequesterIDs(List) 067 */ 068 public List<RequesterID> getRequesterIDs(); 069 070 /** 071 * Sets a list of <code>RequesterID</code> Objects. 072 * 073 * @param requesterIDList the list of <code>RequesterID</code> object. 074 * @throws SAML2Exception if the object is immutable. 075 * @see #getRequesterIDs 076 */ 077 public void setRequesterIDs(List<RequesterID> requesterIDList) throws SAML2Exception; 078 079 /** 080 * Returns the value of <code>ProxyCount</code> attribute. 081 * 082 * @return the value of <code>ProxyCount</code> attribute. 083 * @see #setProxyCount(Integer) 084 */ 085 public Integer getProxyCount(); 086 087 /** 088 * Sets the value of <code>ProxyCount</code> attribute. 089 * 090 * @param proxyCount new value of <code>ProxyCount</code> attribute. 091 * @throws SAML2Exception if the object is immutable. 092 * @see #getProxyCount 093 */ 094 095 public void setProxyCount(Integer proxyCount) 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 String object cannot be created. 114 **/ 115 116 public String toXMLString(boolean includeNSPrefix,boolean declareNS) 117 throws SAML2Exception; 118 119 120 /** 121 * Makes this object immutable. 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.