8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * Copyright (c) 2005 Sun Microsystems Inc. All Rights Reserved
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * The contents of this file are subject to the terms
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * of the Common Development and Distribution License
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * (the License). You may not use this file except in
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * compliance with the License.
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * You can obtain a copy of the License at
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * https://opensso.dev.java.net/public/CDDLv1.0.html or
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * See the License for the specific language governing
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * permission and limitations under the License.
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * When distributing Covered Code, include this CDDL
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * Header Notice in each file and include the License file
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * If applicable, add the following below the CDDL Header,
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * with the fields enclosed by brackets [] replaced by
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * your own identifying information:
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * "Portions Copyrighted [year] [name of copyright owner]"
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * $Id: AMFilteredRole.java,v 1.4 2008/06/25 05:41:20 qcheng Exp $
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * This interface provides methods to manage filtered role.
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * <code>AMFilteredRole</code> objects can be obtained by using
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * <code>AMStoreConnection</code>. A handle to this object can be obtained by
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * using the DN of the object.
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * AMStoreConnection amsc = new AMStoreConnection(ssotoken);
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * if (amsc.doesEntryExist(rDN)) {
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * AMFilteredRole dg = amsc.getFileteredRole(rDN);
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * @deprecated As of Sun Java System Access Manager 7.1.
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * @supported.all.api
8af80418ba1ec431c8027fa9668e5678658d3611Allan Fosterpublic interface AMFilteredRole extends AMRole {
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * Returns the search filter for the filtered role.
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * @return The filter for the filtered role.
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * @throws AMException
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * if an error is encountered when trying to access/retrieve
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * data from the data store.
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * @throws SSOException
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * if the single sign on token is no longer valid.
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster public String getFilter() throws AMException, SSOException;
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * Sets the search filter for the filtered role.
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * @param filter
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * filter for the filtered role.
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * @throws AMException
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * if an error is encountered when trying to access/retrieve
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * data from the data store
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * @throws SSOException
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster * if the single sign on token is no longer valid.
8af80418ba1ec431c8027fa9668e5678658d3611Allan Foster public void setFilter(String filter) throws AMException, SSOException;