com.iplanet.am.sdk
Interface AMResource

All Superinterfaces:
AMConstants, AMObject

public interface AMResource
extends AMObject

This interface provides methods to manage user. AMResource objects can be obtained by using AMStoreConnection. A handle to this object can be obtained by using the DN of the object.

          AMStoreConnection amsc = new AMStoreConnection(ssotoken);
          if (amsc.doesEntryExist(rDN)) {
              AMResource res = amsc.getResource(rDN);
          }
 


Fields inherited from interface com.iplanet.am.sdk.AMObject
ACTIVE, ACTIVE_VALUE, ASSIGNABLE_DYNAMIC_GROUP, DELETED, DELETED_VALUE, DYNAMIC_GROUP, FILTERED_ROLE, GROUP, GROUP_CONTAINER, GROUP_PROFILE, INACTIVE, INACTIVE_VALUE, MANAGED_ROLE, ORGANIZATION, ORGANIZATIONAL_UNIT, PEOPLE_CONTAINER, POLICY, RESOURCE, ROLE, ROLE_PROFILE, SERVICE, STATIC_GROUP, TEMPLATE, UNDETERMINED_OBJECT_TYPE, UNKNOWN_OBJECT_TYPE, USER
 
Fields inherited from interface com.iplanet.am.sdk.AMConstants
ADD_MEMBER, ADMIN_GROUPS_ENABLED_ATTR, ADMIN_ROLE_ATTR, ADMINISTRATION_SERVICE, CACHE_ENABLED_DISABLED_KEY, CACHE_MAX_SIZE_KEY, COMPLIANCE_SPECIAL_FILTER_ATTR, COMPLIANCE_USER_DELETION_ATTR, CONTAINER_DEFAULT_TEMPLATE_ROLE, CONTAINER_SUPPORTED_TYPES_ATTRIBUTE, DCT_ATTRIBUTE_LIST_ATTR, DCT_ENABLED_ATTR, DOMAIN_ADMINISTRATORS, DOMAIN_HELP_DESK_ADMINISTRATORS, EMAIL_ATTRIBUTE, FILTER_ATTR_NAME, INET_ADMIN_OBJECT_CLASS, INET_DOMAIN_STATUS_ATTR, INET_DOMAIN_STATUS_ATTRIBUTE, INVALID_USERID_CHARACTERS, OTHER_COSATTR_TYPE, POLICY_COSATTR_TYPE, POLICY_SUFFIX, PRE_POST_PROCESSING_MODULES_ATTR, REMOVE_ATTRIBUTE, REMOVE_MEMBER, REQUIRED_SERVICES_ATTR, ROLE_MANAGED_CONTAINER_DN_ATTRIBUTE, SCOPE_BASE, SCOPE_ONE, SCOPE_SUB, SERVICE_STATUS_ATTRIBUTE, STATIC_GROUP_DN_ATTRIBUTE, SUBSCRIBABLE_ATTRIBUTE, UNIQUE_ATTRIBUTE_LIST_ATTRIBUTE, UNIQUE_MEMBER_ATTRIBUTE, USER_CREATE_NOTIFICATION_LIST, USER_DELETE_NOTIFICATION_LIST, USER_ENCRYPTED_PASSWORD_ATTRIBUTE, USER_ENTRY_PROCESSING_IMPL, USER_MODIFY_NOTIFICATION_LIST, USER_PASSWORD_ATTRIBUTE, USER_SEARCH_RETURN_ATTR, USERID_PASSWORD_VALIDATION_CLASS
 
Method Summary
 void activate()
          Activates the user.
 void deactivate()
          Deactivates the user.
 boolean isActivated()
          Returns true if the user is activated.
 
Methods inherited from interface com.iplanet.am.sdk.AMObject
addEventListener, assignPolicies, assignServices, createPolicyTemplate, createPolicyTemplate, createTemplate, createTemplate, delete, delete, getAssignedServices, getAttribute, getAttributeByteArray, getAttributes, getAttributes, getAttributesByteArray, getAttributesByteArray, getAttributesFromDataStore, getAttributesFromDataStore, getDN, getOrganizationDN, getParentDN, getPolicy, getPolicyTemplate, getServiceAttributes, getServiceStatus, getStringAttribute, getTemplate, isExists, modifyService, purge, removeAttributes, removeEventListener, search, setAttributeByteArray, setAttributes, setAttributesByteArray, setServiceStatus, setStringAttribute, store, store, unassignPolicies, unassignServices
 

Method Detail

activate

public void activate()
              throws AMException,
                     SSOException
Activates the user.
Throws:
AMException - if an error is encountered when trying to access/retrieve data from the data store
SSOException - if the single sign on token is no longer valid

deactivate

public void deactivate()
                throws AMException,
                       SSOException
Deactivates the user.
Throws:
AMException - if an error is encountered when trying to access/retrieve data from the data store
SSOException - if the single sign on token is no longer valid

isActivated

public boolean isActivated()
                    throws AMException,
                           SSOException
Returns true if the user is activated.
Returns:
true if the user is activated.
Throws:
AMException - if an error is encountered when trying to access/retrieve data from the data store
SSOException - if the single sign on token is no longer valid


Copyright 2005 Sun Microsystems, Inc. All rights reserved. Use is subject to license terms.