com.iplanet.am.sdk
Interface AMStaticGroup

All Superinterfaces:

AMConstants, AMGroup, AMObject

public interface AMStaticGroup

extends AMGroup

This interface provides methods to manage static group. AMStaticGroup object 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(sDN)) {
              AMStaticGroup sg = amsc.getStaticGroup(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	addUsers(java.util.Set users) Adds users to the static group.
boolean	isSubscribable() Returns true if the group is subscribable.
void	removeUsers(java.util.Set users) Removes users from the static group.
void	setSubscribable(boolean subscribable) Sets subscribe-ability of the group.

Methods inherited from interface com.iplanet.am.sdk.AMGroup

addNestedGroups, createAssignableDynamicGroups, createAssignableDynamicGroups, createDynamicGroups, createDynamicGroups, createStaticGroups, createStaticGroups, deleteAssignableDynamicGroups, deleteDynamicGroups, deleteStaticGroups, getGroupDNs, getNestedGroupDNs, getNumberOfGroups, getNumberOfUsers, getUserAndGroupDNs, getUserDNs, removeNestedGroups, searchGroups, searchGroups, searchGroups, searchUsers, searchUsers, searchUsers

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

addUsers

public void addUsers(java.util.Set users)
              throws AMException,
                     SSOException

Adds users to the static group.

Parameters:

users - The set of user DN's to be added to the static group.

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

removeUsers

public void removeUsers(java.util.Set users)
                 throws AMException,
                        SSOException

Removes users from the static group.

Parameters:

users - The set of user DN's to be removed from the static group.

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

isSubscribable

public boolean isSubscribable()
                       throws AMException,
                              SSOException

Returns true if the group is subscribable.

Returns:

true if the group is subscribable.

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

setSubscribable

public void setSubscribable(boolean subscribable)
                     throws AMException,
                            SSOException

Sets subscribe-ability of the group.

Parameters:

subscribable - true if the group is subscribable.

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