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: AMResource.java,v 1.4 2008/06/25 05:41:22 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 user. <code>AMResource</code> 035 * objects can be obtained by using <code>AMStoreConnection</code>. A handle 036 * to this object can be obtained by using the DN of the object. 037 * 038 * <PRE> 039 * 040 * AMStoreConnection amsc = new AMStoreConnection(ssotoken); if 041 * (amsc.doesEntryExist(rDN)) { AMResource res = amsc.getResource(rDN); } 042 * 043 * </PRE> 044 * 045 * @deprecated As of Sun Java System Access Manager 7.1. 046 * @supported.all.api 047 */ 048public interface AMResource extends AMObject { 049 /** 050 * Activates the user. 051 * 052 * @throws AMException 053 * if an error is encountered when trying to access/retrieve 054 * data from the data store 055 * @throws SSOException 056 * if the single sign on token is no longer valid 057 */ 058 public void activate() throws AMException, SSOException; 059 060 /** 061 * Deactivates the user. 062 * 063 * @throws AMException 064 * if an error is encountered when trying to access/retrieve 065 * data from the data store 066 * @throws SSOException 067 * if the single sign on token is no longer valid 068 */ 069 public void deactivate() throws AMException, SSOException; 070 071 /** 072 * Returns true if the user is activated. 073 * 074 * @return true if the user is activated. 075 * @throws AMException 076 * if an error is encountered when trying to access/retrieve 077 * data from the data store 078 * @throws SSOException 079 * if the single sign on token is no longer valid 080 */ 081 public boolean isActivated() throws AMException, SSOException; 082 083}
Copyright © 2010-2017, ForgeRock All Rights Reserved.