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-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.ScopingImpl; 036import java.util.List; 037 038 039/** 040 * This interface defines methods to retrieve Identity Providers and 041 * context/limitations related to proxying of the request message. 042 * 043 * @supported.all.api 044 */ 045@JsonTypeInfo(include = JsonTypeInfo.As.PROPERTY, use = JsonTypeInfo.Id.CLASS, 046 defaultImpl = ScopingImpl.class) 047public interface Scoping { 048 049 /** 050 * Returns the <code>IDPList</code> Object. 051 * 052 * @return the <code>IDPList</code> object. 053 * @see #setIDPList(IDPList) 054 */ 055 public IDPList getIDPList(); 056 057 /** 058 * Sets the <code>IDPList</code> Object. 059 * 060 * @param idpList the new <code>IDPList</code> object. 061 * @throws SAML2Exception if the object is immutable. 062 * @see #getIDPList 063 */ 064 public void setIDPList(IDPList idpList) throws SAML2Exception; 065 066 /** 067 * Returns a list of <code>RequesterID</code> Objects.. 068 * 069 * @return list of <code>RequesterID</code> objects. 070 * @see #setRequesterIDs(List) 071 */ 072 public List<RequesterID> getRequesterIDs(); 073 074 /** 075 * Sets a list of <code>RequesterID</code> Objects. 076 * 077 * @param requesterIDList the list of <code>RequesterID</code> object. 078 * @throws SAML2Exception if the object is immutable. 079 * @see #getRequesterIDs 080 */ 081 public void setRequesterIDs(List<RequesterID> requesterIDList) throws SAML2Exception; 082 083 /** 084 * Returns the value of <code>ProxyCount</code> attribute. 085 * 086 * @return the value of <code>ProxyCount</code> attribute. 087 * @see #setProxyCount(Integer) 088 */ 089 public Integer getProxyCount(); 090 091 /** 092 * Sets the value of <code>ProxyCount</code> attribute. 093 * 094 * @param proxyCount new value of <code>ProxyCount</code> attribute. 095 * @throws SAML2Exception if the object is immutable. 096 * @see #getProxyCount 097 */ 098 099 public void setProxyCount(Integer proxyCount) 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 String object cannot be created. 118 **/ 119 120 public String toXMLString(boolean includeNSPrefix,boolean declareNS) 121 throws SAML2Exception; 122 123 124 /** 125 * Makes this object immutable. 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}