001/** 002 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER. 003 * 004 * Copyright (c) 2005 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: AMFilteredRole.java,v 1.4 2008/06/25 05:41:20 qcheng Exp $ 026 * 027 */ 028 029package com.iplanet.am.sdk; 030 031import com.iplanet.sso.SSOException; 032 033/** 034 * This interface provides methods to manage filtered role. 035 * <code>AMFilteredRole</code> objects can be obtained by using 036 * <code>AMStoreConnection</code>. A handle to this object can be obtained by 037 * using the DN of the object. 038 * 039 * <PRE> 040 * 041 * AMStoreConnection amsc = new AMStoreConnection(ssotoken); 042 * if (amsc.doesEntryExist(rDN)) { 043 * AMFilteredRole dg = amsc.getFileteredRole(rDN); 044 * } 045 * 046 * </PRE> 047 * 048 * @deprecated As of Sun Java System Access Manager 7.1. 049 * @supported.all.api 050 */ 051public interface AMFilteredRole extends AMRole { 052 /** 053 * Returns the search filter for the filtered role. 054 * 055 * @return The filter for the filtered role. 056 * @throws AMException 057 * if an error is encountered when trying to access/retrieve 058 * data from the data store. 059 * @throws SSOException 060 * if the single sign on token is no longer valid. 061 */ 062 public String getFilter() throws AMException, SSOException; 063 064 /** 065 * Sets the search filter for the filtered role. 066 * 067 * @param filter 068 * filter for the filtered role. 069 * @throws AMException 070 * if an error is encountered when trying to access/retrieve 071 * data from the data store 072 * @throws SSOException 073 * if the single sign on token is no longer valid. 074 */ 075 public void setFilter(String filter) throws AMException, SSOException; 076}
Copyright © 2010-2017, ForgeRock All Rights Reserved.