AMStoreConnection (OpenSSO Public API)

概要

パッケージ

クラス

階層ツリー

非推奨 API

索引

ヘルプ

前のクラス 次のクラス

フレームあり フレームなし

概要: 入れ子 | フィールド | コンストラクタ | メソッド

詳細: フィールド | コンストラクタ | メソッド

com.iplanet.am.sdk
クラス AMStoreConnection

java.lang.Object
  com.iplanet.am.sdk.AMStoreConnection

すべての実装されたインタフェース:: AMConstants

推奨されていません。 As of Sun Java System Access Manager 7.1.

public final class AMStoreConnection
extends Object
implements AMConstants
extends Object
implements AMConstants

The AMStoreConnection class represents a connection to the Sun Java System Access Manager data store. It provides methods to create, remove and get different type of Sun Java System Access Manager SDK objects in the data tore. AMStoreConnection controls and manages access to the data store.

An instance of AMStoreConnection object should always be obtained by anyone using the AM SDK since this object is the entry point to all other AM SDK managed objects. The constructor takes the SSO token of the user. Here is some sample code on how to get a user's attributes, using AM SDK:

 
 AMStoreConnection amsc = new AMStoreConnection(ssotoken); AMUser user =
 amsc.getUser(ssotoken.getPrincipal()); Map attributes = user.getAttributes();

AMStoreConnection also has other helper methods which are very useful. Some examples below:

 
 int otype = amsc.getAMObjectType(fullDN);

otype returned is one of the managed AMObject types, like AMObject.USER, AMObject.ROLE, AMObject.ORGANIZATION. If the entry being checked in not of the type managed by AM SDK, then an AMException is thrown.

 
 boolean exists = amsc.isValidEntry(fullDN);

If there is a fullDN that you want to know if it exists or not in the data store, then use the above method. The typical use of this method is in the case when you know that you need to get a managed object from amsc, but you want to verify that it exists before you create the managed object instance:

 
 if (amsc.isValidEntry(userDN)) { AMUser user = amsc.getUser(userDN); - More
 code here - }

Helper method getOrganizationDN(): Use this method to perform a subtree scoped search for organization,based on various attribute values.

 
 String orgDN = amsc.getOrganizationDN("sun.com", null);

The above method will return the DN of a organization, which matches the search criterias of having either domain name of sun.com, Domain alias name of sun.com or it's naming attribute value is sun.com. More examples of how to use this method are provided in the Javadocs of the method below.

フィールドの概要
`protected static com.sun.identity.shared.debug.Debug`	`debug` 推奨されていません。
`protected static String`	`defaultOrg` 推奨されていません。
`protected static Map`	`orgMapCache` 推奨されていません。
`static String`	`rootSuffix` 推奨されていません。

インタフェース 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

インタフェース 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

コンストラクタの概要
`AMStoreConnection(SSOToken ssoToken)` 推奨されていません。 Gets the connection to the Sun Java System Access Manager data store if the Session is valid.

メソッドの概要
`protected static void`	`addToOrgMapCache(SSOToken stoken, String dn)` 推奨されていません。 Protected method to update the `orgMapCache`
`AMOrganization`	`createTopOrganization(String orgName, Map avPairs)` 推奨されていません。 Bootstraps the Organization tree by creating the Top Organization tree.
`protected static int`	`daysSinceModified(SSOToken stoken, String entryDN)` 推奨されていません。 Protected method to obtain the number of days since this DN was last modified.
`String`	`getAMObjectName(int type)` 推奨されていません。 Take a supported type, and returns the matching name of the supported managed type.
`int`	`getAMObjectType(String dn)` 推奨されていません。 Returns the type of the object given its DN.
`static String`	`getAMSdkBaseDN()` 推奨されていません。 Returns the root suffix for user management node.
`AMAssignableDynamicGroup`	`getAssignableDynamicGroup(String assignableDynamicGroupDN)` 推奨されていません。 Returns the handle to the `AMAssignableDynamicGroup` object represented by DN.
`Set`	`getAttributeNames(String serviceName, AMSchema.Type schemaType)` 推奨されていません。 use `com.sun.identity.sm.ServiceSchemaManager. getServiceAttributeNames(com.sun.identity.sm.SchemaType)`
`protected String`	`getBaseDN(com.sun.identity.sm.ServiceConfig sc)` 推奨されていません。
`AMDynamicGroup`	`getDynamicGroup(String dynamicGroupDN)` 推奨されていません。 Returns the handle to the `AMDynamicGroup` object represented by DN.
`AMEntity`	`getEntity(String eDN)` 推奨されていません。 Returns the handle to the `AMEntity` object represented by DN.
`Set`	`getEntityTypes()` 推奨されていません。 Returns a set of `com.iplanet.am.sdk.AMEntityType` objects, which is the set of objects which are supported by the `com.iplanet.am.sdk.AMEntity` APIs.
`AMFilteredRole`	`getFilteredRole(String roleDN)` 推奨されていません。 Returns the handle to the `AMFilteredRole` object represented by DN.
`static String`	`getFilteredRoleNamingAttribute()` 推奨されていません。 This method is deprecated. Use `getNamingAttribute(int objectType)`
`AMGroupContainer`	`getGroupContainer(String groupContainerDN)` 推奨されていません。 Returns the handle to the `AMGroupContainer` object represented by DN.
`static String`	`getGroupContainerNamingAttribute()` 推奨されていません。 This method is deprecated. Use `getNamingAttribute(int objectType)`
`static String`	`getGroupNamingAttribute()` 推奨されていません。 This method is deprecated. Use `getNamingAttribute(int objectType)`
`String`	`getI18NPropertiesFileName(String serviceName)` 推奨されていません。 Returns the I18N properties file name that contains the internationalized messages.
`static String`	`getNamingAttribute(int objectType)` 推奨されていません。 Returns the naming attribute of an object type.
`static String`	`getObjectName(int type)` 推奨されていません。 Take a supported type, and returns the matching name of the supported managed type.
`AMOrganization`	`getOrganization(String orgDN)` 推奨されていません。 Returns the handle to the `AMOrganization` object represented by DN.
`AMOrganizationalUnit`	`getOrganizationalUnit(String orgUnitDN)` 推奨されていません。 Returns the handle to the `AMOrganizationalUnit` object represented by DN.
`static String`	`getOrganizationalUnitNamingAttribute()` 推奨されていません。 This method is deprecated. Use `getNamingAttribute(int objectType)`
`String`	`getOrganizationDN(String domainname, String orgSearchTemplate)` 推奨されていません。 Returns the DN of the organization, using the `domainname` provided and the `searchTemplate` (if provided).
`static String`	`getOrganizationNamingAttribute()` 推奨されていません。 This method is deprecated. Use `getNamingAttribute(int objectType)`
`AMPeopleContainer`	`getPeopleContainer(String peopleContainerDN)` 推奨されていません。 Returns the handle to the `AMPeopleContainer` object represented by DN.
`static String`	`getPeopleContainerNamingAttribute()` 推奨されていません。 This method is deprecated. Use `getNamingAttribute(int objectType)`
`AMTemplate`	`getPolicyTemplate(String templateDN)` 推奨されていません。
`String`	`getPropertiesViewBeanURL(String serviceName)` 推奨されていません。 Returns the URL of the view bean for the service
`AMResource`	`getResource(String resourceDN)` 推奨されていません。 Returns the handle to the `AMResource` object represented by DN.
`AMRole`	`getRole(String roleDN)` 推奨されていません。 Returns the handle to the `AMRole` object represented by DN.
`static String`	`getRoleNamingAttribute()` 推奨されていません。 This method is deprecated. Use `getNamingAttribute(int objectType)`
`AMSchema`	`getSchema(String serviceName, AMSchema.Type schemaType)` 推奨されていません。 This method has been deprecated. Please use `com.sun.identity.sm.ServiceSchemaManager.getSchema()`.
`Set`	`getSchemaTypes(String serviceName)` 推奨されていません。 This method has been deprecated. Please use `com.sun.identity.sm.ServiceSchemaManager.getSchemaTypes()`.
`Set`	`getServiceHierarchy()` 推奨されていません。 Returns the service hierarchy for all registered services.
`Set`	`getServiceNames()` 推奨されていません。 Returns the set of name of services that have been loaded to the data store.
`AMStaticGroup`	`getStaticGroup(String groupDN)` 推奨されていません。 Returns the handle to the `AMStaticGroup` object represented by DN.
`Set`	`getTopLevelContainers()` 推奨されていません。 Returns the top level containers (Organizations, People Containers, Roles, etc) for the particular user based on single sign on token as the starting point in the tree.
`Set`	`getTopLevelOrganizations()` 推奨されていません。 Returns the "real" or "physical" top level organizations as the starting point in the tree.
`AMUser`	`getUser(String userDN)` 推奨されていません。 Returns the handle to the `AMUser` object represented by DN.
`static String`	`getUserNamingAttribute()` 推奨されていません。 This method is deprecated. Use `getNamingAttribute(int objectType)`
`protected boolean`	`isRFC2247(com.sun.identity.sm.ServiceConfig sc)` 推奨されていません。
`boolean`	`isValidEntry(String dn)` 推奨されていません。 Checks if the entry exists in the directory or not.
`void`	`purge(String domainName, int graceperiod)` 推奨されていません。 This method takes an organization DN and purges all objects marked for deletion.
`void`	`purgeGroup(String gid, String domainName, int graceperiod)` 推奨されていません。 This method takes a group name and a domain name, It uses default search templates to search for the organization and uses the deleted objects search filter for Groups as defined in the Administration Service of Access Manager.
`void`	`purgeResource(String rid, String domainName, int graceperiod)` 推奨されていません。 This method takes a resource ID and a domain name, It uses default search templates to search for the organization and uses the deleted objects search filter for Resources as defined in the Administration Service of Access Manager.
`void`	`purgeUser(String uid, String domainName, int graceperiod)` 推奨されていません。 This method takes a user ID and a domain name, It uses default search templates to search for the organization and uses the deleted objects search filter for Users as defined in the Administration Service of Access Manager.
`protected static void`	`updateCache(String dn, int eventType)` 推奨されていません。 Protected method to update `orgMapCache`.

フィールドの詳細

rootSuffix

public static String rootSuffix

推奨されていません。

defaultOrg

protected static String defaultOrg

推奨されていません。

orgMapCache

protected static Map orgMapCache

推奨されていません。

debug

protected static com.sun.identity.shared.debug.Debug debug

推奨されていません。

コンストラクタの詳細

AMStoreConnection

public AMStoreConnection(SSOToken ssoToken)
                  throws SSOException

推奨されていません。

Gets the connection to the Sun Java System Access Manager data store if the Session is valid.

パラメータ:: ssoToken - a valid SSO token object to authenticate before getting the connection
例外:: SSOException - if single sign on token is invalid or expired.

メソッドの詳細

getAMSdkBaseDN

public static String getAMSdkBaseDN()

推奨されていません。

Returns the root suffix for user management node.

戻り値:: root suffix for user management node.

getFilteredRoleNamingAttribute

public static String getFilteredRoleNamingAttribute()

推奨されていません。 This method is deprecated. Use getNamingAttribute(int objectType)

Returns the filtered role naming attribute.

戻り値:: filtered role naming attribute

getGroupContainerNamingAttribute

public static String getGroupContainerNamingAttribute()

推奨されていません。 This method is deprecated. Use getNamingAttribute(int objectType)

Returns the group container naming attribute.

戻り値:: group container naming attribute

getGroupNamingAttribute

public static String getGroupNamingAttribute()

推奨されていません。 This method is deprecated. Use getNamingAttribute(int objectType)

Returns the group naming attribute.

戻り値:: group naming attribute

getNamingAttribute

public static String getNamingAttribute(int objectType)
                                 throws AMException

推奨されていません。

Returns the naming attribute of an object type.

パラメータ:

objectType - Object type can be one of the following:

戻り値:

the naming attribute corresponding to the objectType

例外:

AMException - if an error occurred in obtaining the naming attribute

getOrganizationNamingAttribute

public static String getOrganizationNamingAttribute()

推奨されていません。 This method is deprecated. Use getNamingAttribute(int objectType)

Returns the organization naming attribute.

戻り値:: organization naming attribute

getOrganizationalUnitNamingAttribute

public static String getOrganizationalUnitNamingAttribute()

推奨されていません。 This method is deprecated. Use getNamingAttribute(int objectType)

Returns the organizational unit naming attribute.

戻り値:: organizational unit naming attribute

getPeopleContainerNamingAttribute

public static String getPeopleContainerNamingAttribute()

推奨されていません。 This method is deprecated. Use getNamingAttribute(int objectType)

Returns the people container naming attribute.

戻り値:: people container naming attribute

getRoleNamingAttribute

public static String getRoleNamingAttribute()

推奨されていません。 This method is deprecated. Use getNamingAttribute(int objectType)

Returns the role naming attribute.

戻り値:: role naming attribute

getUserNamingAttribute

public static String getUserNamingAttribute()

推奨されていません。 This method is deprecated. Use getNamingAttribute(int objectType)

Returns the user naming attribute.

戻り値:: user naming attribute

getAMObjectType

public int getAMObjectType(String dn)
                    throws AMException,
                           SSOException

推奨されていません。

Returns the type of the object given its DN.

パラメータ:: dn - DN of the object whose type is to be known.
戻り値:: the type of the object given its DN.
例外:: AMException - if the data store is unavailable or if the object type is unknown.; SSOException - if single sign on token is invalid or expired.

getAMObjectName

public String getAMObjectName(int type)

推奨されていません。

Take a supported type, and returns the matching name of the supported managed type. For example, if AMObject.USER is passed in, it will return "user" (one of the basic supported types in AM SDK. But this method (and configuration in the service DAI) can be used to extend the basic supported types to include customer-specific entities, like "agents", "printers" etc.

パラメータ:: type - Integer type (as returned by getAMObjectType)
戻り値:: identifier for the above type. Returns null if type is unknown.

getObjectName

public static String getObjectName(int type)

推奨されていません。

パラメータ:: type - Integer type (as returned by getAMObjectType)
戻り値:: identifier for the above type. Returns null if type is unknown.

getAssignableDynamicGroup

public AMAssignableDynamicGroup getAssignableDynamicGroup(String assignableDynamicGroupDN)
                                                   throws SSOException

推奨されていません。

Returns the handle to the AMAssignableDynamicGroup object represented by DN. However, the validity of the handle returned by this method cannot be guaranteed, since the object is created in memory, and not instantiated from the data store. Using the AMAssignableDynamicGroup returned from this method may result in exceptions thrown in the later part of the application, if the DN is not valid or represents an entry that does not exist.

Validity of the DN can be verified is using isValidEntry() method of the object returned.

パラメータ:: assignableDynamicGroupDN - assignable dynamic group DN
戻り値:: AMAssignableDynamicGroup object represented by DN.
例外:: SSOException - if single sign on token is invalid or expired.
関連項目:: AMStoreConnection.isValidEntry(java.lang.String)

getAttributeNames

public Set getAttributeNames(String serviceName,
                             AMSchema.Type schemaType)
                      throws AMException

推奨されていません。 use com.sun.identity.sm.ServiceSchemaManager. getServiceAttributeNames(com.sun.identity.sm.SchemaType)

Returns the service attribute names for a given service name and schema type.

パラメータ:: serviceName - the name of the service; schemaType - the type of service schema
戻り値:: Set of service attribute names
例外:: AMException - if an error is encountered while retrieving information.

getDynamicGroup

public AMDynamicGroup getDynamicGroup(String dynamicGroupDN)
                               throws SSOException

推奨されていません。

Returns the handle to the AMDynamicGroup object represented by DN. However, the validity of the handle returned by this method cannot be guaranteed, since the object is created in memory, and not instantiated from the data store. Using the AMDynamicGroup returned from this method may result in exceptions thrown in the later part of the application, if the DN is not valid or represents an entry that does not exist.

Validity of the DN can be verified is using isValidEntry() method of the object returned.

パラメータ:: dynamicGroupDN - group DN
戻り値:: AMDynamicGroup object represented by DN.
例外:: SSOException - if single sign on token is invalid or expired.
関連項目:: AMStoreConnection.isValidEntry(java.lang.String)

getFilteredRole

public AMFilteredRole getFilteredRole(String roleDN)
                               throws SSOException

推奨されていません。

Returns the handle to the AMFilteredRole object represented by DN. However, the validity of the handle returned by this method cannot be guaranteed, since the object is created in memory, and not instantiated from the data store. Using the AMFilteredRole returned from this method may result in exceptions thrown in the later part of the application, if the DN is not valid or represents an entry that does not exist.

Validity of the DN can be verified is using isValidEntry() method of the object returned.

パラメータ:: roleDN - role DN.
戻り値:: AMFilteredRole object represented by DN.
例外:: SSOException - if single sign on token is invalid or expired.
関連項目:: AMStoreConnection.isValidEntry(java.lang.String)

getGroupContainer

public AMGroupContainer getGroupContainer(String groupContainerDN)
                                   throws SSOException

推奨されていません。

Returns the handle to the AMGroupContainer object represented by DN. However, the validity of the handle returned by this method cannot be guaranteed, since the object is created in memory, and not instantiated from the data store. Using the AMGroupContainer returned from this method may result in exceptions thrown in the later part of the application, if the DN is not valid or represents an entry that does not exist.

Validity of the DN can be verified is using isValidEntry() method of the object returned.

パラメータ:: groupContainerDN - group container DN.
戻り値:: AMGroupContainer object represented by DN.
例外:: SSOException - if single sign on token is invalid or expired.
関連項目:: AMStoreConnection.isValidEntry(java.lang.String)

getI18NPropertiesFileName

public String getI18NPropertiesFileName(String serviceName)
                                 throws AMException

推奨されていません。

Returns the I18N properties file name that contains the internationalized messages.

パラメータ:: serviceName - the service name
戻り値:: String String representing i18N properties file name
例外:: AMException - if an error is encountered while retrieving information

getOrganization

public AMOrganization getOrganization(String orgDN)
                               throws SSOException

推奨されていません。

Returns the handle to the AMOrganization object represented by DN. However, the validity of the handle returned by this method cannot be guaranteed, since the object is created in memory, and not instantiated from the data store. Using the AMOrganization returned from this method may result in exceptions thrown in the later part of the application, if the DN is not valid or represents an entry that does not exist.

Validity of the DN can be verified is using isValidEntry() method of the object returned.

パラメータ:: orgDN - organization DN
戻り値:: AMOrganization object represented by DN.
例外:: SSOException - if single sign on token is invalid or expired.
関連項目:: AMStoreConnection.isValidEntry(java.lang.String)

getOrganizationDN

public String getOrganizationDN(String domainname,
                                String orgSearchTemplate)
                         throws AMException,
                                SSOException

推奨されていません。

Returns the DN of the organization, using the domainname provided and the searchTemplate (if provided). If searchTemplate is null, SDK uses the default searchTemplate to perform the orgDN search. If the DC tree global flag is enabled, the DC tree is used to obtain the organization DN, otherwise an LDAP search is conducted using the searchfilter in the searchtemplate. All %V in the filter are replaced with domainname. If the search returns more than one entries, then an Exception is thrown. Otherwise the DN obtained is returned.

パラメータ:: domainname - Organization identifier passed. It can be a domain name (example: sun.com) or it could be a full DN or it could be null or * "/". A full DN is verified to be an organization and returned as is. A "/" is assumed to be a request for the root DN and the root DN is returned. A "/" separated string is assumed to represent an existing organization DN in the DIT. For example: /iplanet/sun is converted to a DN (o=iplanet,o=sun,<base DN>) and the validity of this DN is checked and returned. Any other string is assumed to be either a domain or an associated domain or the organization name. The search filter is created accordingly.; orgSearchTemplate - template to use for the search.
戻り値:: The full organization DN
例外:: AMException - If there is a problem connecting or searching the data store.; SSOException - If the user has an invalid SSO token.

getOrganizationalUnit

public AMOrganizationalUnit getOrganizationalUnit(String orgUnitDN)
                                           throws SSOException

推奨されていません。

Returns the handle to the AMOrganizationalUnit object represented by DN. However, the validity of the handle returned by this method cannot be guaranteed, since the object is created in memory, and not instantiated from the data store. Using the AMOrganizationialUnit returned from this method may result in exceptions thrown in the later part of the application, if the DN is not valid or represents an entry that does not exist.

Validity of the DN can be verified is using isValidEntry() method of the object returned.

パラメータ:: orgUnitDN - organizational unit DN
戻り値:: AMOrganizationalUnit object represented by DN.
例外:: SSOException - if single sign on token is invalid or expired.
関連項目:: AMStoreConnection.isValidEntry(java.lang.String)

getPeopleContainer

public AMPeopleContainer getPeopleContainer(String peopleContainerDN)
                                     throws SSOException

推奨されていません。

Returns the handle to the AMPeopleContainer object represented by DN. However, the validity of the handle returned by this method cannot be guaranteed, since the object is created in memory, and not instantiated from the data store. Using the AMPeopleContainer returned from this method may result in exceptions thrown in the later part of the application, if the DN is not valid or represents an entry that does not exist.

Validity of the DN can be verified is using isValidEntry() method of the object returned.

パラメータ:: peopleContainerDN - people container DN
戻り値:: AMPeopleContainer object represented by DN.
例外:: SSOException - if single sign on token is invalid or expired.
関連項目:: AMStoreConnection.isValidEntry(java.lang.String)

getPolicyTemplate

public AMTemplate getPolicyTemplate(String templateDN)
                             throws AMException,
                                    SSOException

推奨されていません。

Returns the handle to the AMTemplate object represented by DN. However, the validity of the handle returned by this method cannot be guaranteed, since the object is created in memory, and not instantiated from the data store. Using the AMTemplate returned from this method may result in exceptions thrown in the later part of the application, if the DN is not valid or represents an entry that does not exist.

Validity of the DN can be verified is using isValidEntry() method of the object returned.

パラメータ:: templateDN - a policy template DN.
戻り値:: AMTemplate object represented by DN.
例外:: AMException - if the DN does not represent a Policy template DN; SSOException - if single sign on token is invalid or expired.
関連項目:: AMStoreConnection.isValidEntry(java.lang.String)

getPropertiesViewBeanURL

public String getPropertiesViewBeanURL(String serviceName)
                                throws AMException

推奨されていません。

Returns the URL of the view bean for the service

パラメータ:: serviceName - the service name
戻り値:: String URL of the view bean for the service
例外:: AMException - if an error is encountered while retrieving information

getResource

public AMResource getResource(String resourceDN)
                       throws SSOException

推奨されていません。

Returns the handle to the AMResource object represented by DN. However, the validity of the handle returned by this method cannot be guaranteed, since the object is created in memory, and not instantiated from the data store. Using the AMResource returned from this method may result in exceptions thrown in the later part of the application, if the DN is not valid or represents an entry that does not exist.

Validity of the DN can be verified is using isValidEntry() method of the object returned.

パラメータ:: resourceDN - resource DN.
戻り値:: AMResource object represented by DN.
例外:: SSOException - if single sign on token is invalid or expired.
関連項目:: AMStoreConnection.isValidEntry(java.lang.String)

getRole

public AMRole getRole(String roleDN)
               throws SSOException

推奨されていません。

Returns the handle to the AMRole object represented by DN. However, the validity of the handle returned by this method cannot be guaranteed, since the object is created in memory, and not instantiated from the data store. Using the AMRole returned from this method may result in exceptions thrown in the later part of the application, if the DN is not valid or represents an entry that does not exist.

Validity of the DN can be verified is using isValidEntry() method of the object returned.

パラメータ:: roleDN - role DN
戻り値:: AMRole object represented by DN.
例外:: SSOException - if single sign on token is invalid or expired.
関連項目:: AMStoreConnection.isValidEntry(java.lang.String)

getSchema

public AMSchema getSchema(String serviceName,
                          AMSchema.Type schemaType)
                   throws AMException

推奨されていません。 This method has been deprecated. Please use com.sun.identity.sm.ServiceSchemaManager.getSchema().

Returns the AMSchema for the given service name and service type.

パラメータ:: serviceName - the name of the service; schemaType - the type of service schema that needs to be retrieved.
戻り値:: AMSchema corresponding to the given service name and schema type.
例外:: AMException - if an error is encountered in retrieving the AMSchema.

getSchemaTypes

public Set getSchemaTypes(String serviceName)
                   throws AMException

推奨されていません。 This method has been deprecated. Please use com.sun.identity.sm.ServiceSchemaManager.getSchemaTypes().

Returns the schema types available for a particular service.

パラメータ:: serviceName - the name of the service whose schema types needs to be retrieved
戻り値:: Set of AMSchema.Type objects
例外:: AMException - if an error is encountered in retrieving the schemaTypes.

getServiceHierarchy

public Set getServiceHierarchy()
                        throws AMException

推奨されていません。

Returns the service hierarchy for all registered services.

戻り値:: the service hierarchy for all registered services.
例外:: AMException - if an error is encountered in retrieving the service hierarchy. The return value is a Set of strings in slash format.

getServiceNames

public Set getServiceNames()
                    throws AMException

推奨されていません。

Returns the set of name of services that have been loaded to the data store.

戻り値:: set of name of services.
例外:: AMException - if an error is encountered in retrieving the names of the services

getStaticGroup

public AMStaticGroup getStaticGroup(String groupDN)
                             throws SSOException

推奨されていません。

Returns the handle to the AMStaticGroup object represented by DN. However, the validity of the handle returned by this method cannot be guaranteed, since the object is created in memory, and not instantiated from the data store. Using the AMStaticGroup returned from this method may result in exceptions thrown in the later part of the application, if the DN is not valid or represents an entry that does not exist.

Validity of the DN can be verified is using isValidEntry() method of the object returned.

パラメータ:: groupDN - group DN
戻り値:: AMStaticGroup object represented by DN.
例外:: SSOException - if single sign on token is invalid or expired.
関連項目:: AMStoreConnection.isValidEntry(java.lang.String)

getTopLevelContainers

public Set getTopLevelContainers()
                          throws AMException,
                                 SSOException

推奨されていません。

Returns the top level containers (Organizations, People Containers, Roles, etc) for the particular user based on single sign on token as the starting point in the tree.

戻り値:: set of DBObjects that are top level containers for the signed in user.
例外:: AMException - if an error occurred when retrieving the information from the data store.; SSOException - if single sign on token is invalid or expired.

getTopLevelOrganizations

public Set getTopLevelOrganizations()
                             throws AMException,
                                    SSOException

推奨されていません。

Returns the "real" or "physical" top level organizations as the starting point in the tree.

戻り値:: Set Set of DN Strings for top level Organizations
例外:: AMException - if an error occurred when retrieving the information from the data store.; SSOException - if single sign on token is invalid or expired.

getUser

public AMUser getUser(String userDN)
               throws SSOException

推奨されていません。

Returns the handle to the AMUser object represented by DN. However, the validity of the handle returned by this method cannot be guaranteed, since the object is created in memory, and not instantiated from the data store. Using the AMUser returned from this method may result in exceptions thrown in the later part of the application, if the DN is not valid or represents an entry that does not exist.

Validity of the DN can be verified is using isValidEntry() method of the object returned.

パラメータ:: userDN - user DN
戻り値:: AMUser object represented by DN
例外:: SSOException - if single sign on token is invalid or expired.
関連項目:: AMStoreConnection.isValidEntry(java.lang.String)

getEntity

public AMEntity getEntity(String eDN)
                   throws SSOException

推奨されていません。

Returns the handle to the AMEntity object represented by DN. However, the validity of the handle returned by this method cannot be guaranteed, since the object is created in memory, and not instantiated from the data store. Using the AMEntity returned from this method may result in exceptions thrown in the later part of the application, if the DN is not valid or represents an entry that does not exist.

Validity of the DN can be verified is using isValidEntry() method of the object returned.

パラメータ:: eDN - entity DN.
戻り値:: AMEntity object represented by DN.
例外:: SSOException - if single sign on token is invalid or expired.
関連項目:: AMStoreConnection.isValidEntry(java.lang.String)

isValidEntry

public boolean isValidEntry(String dn)
                     throws SSOException

推奨されていません。

Checks if the entry exists in the directory or not. First a syntax check is done on the DN string corresponding to the entry. If the DN syntax is valid, a directory call will be made to check for the existence of the entry.

NOTE: This method internally invokes a call to the directory to verify the existence of the entry. There could be a performance overhead. Hence, please use your discretion while using this method.

パラメータ:: dn - DN of the entry that needs to be validated.
戻り値:: false if the entry does not have a valid DN syntax or if the entry does not exists in the Directory. True otherwise.
例外:: SSOException - if the single sign on token is no longer valid.

createTopOrganization

public AMOrganization createTopOrganization(String orgName,
                                            Map avPairs)
                                     throws AMException,
                                            SSOException

推奨されていません。

Bootstraps the Organization tree by creating the Top Organization tree.

パラメータ:: orgName - name of the top organization; avPairs - Attribute-Value pairs for the top organization
戻り値:: Top Organization object.
例外:: AMException - if an error occurred during the process of creation.; SSOException - if single sign on token is invalid or expired.

purge

public void purge(String domainName,
                  int graceperiod)
           throws AMException,
                  SSOException

推奨されていません。

This method takes an organization DN and purges all objects marked for deletion. If the organization itself is marked for deletion, then a recursive delete of everything under the organization is called, followed by the organization deletion. This method works in the mode where soft-delete option in Access Manager is turned on. The Pre/Post callbacks for users are executed during this method.

パラメータ:: domainName - domain to be purged; graceperiod - time in days which should have passed since the entry was last modified before it can be deleted from the system.
例外:: AMException - if an error occurred when retrieving the information from the data store.; SSOException - if single sign on token is invalid or expired.

purgeUser

public void purgeUser(String uid,
                      String domainName,
                      int graceperiod)
               throws AMException,
                      SSOException

推奨されていません。

This method takes a user ID and a domain name, It uses default search templates to search for the organization and uses the deleted objects search filter for Users as defined in the Administration Service of Access Manager. This filter is used to search for the deleted user under the organization. If the user is marked for deletion and the grace period is passed then the user is purged. The pre-delete call backs as listed in the Administration service, are called before the user is deleted. If any of the callbacks throw an exception the delete operation is aborted.

パラメータ:: uid - user ID; domainName - domain in which the user belongs.; graceperiod - time in days which should have passed before this user can be deleted.
例外:: AMException - if there is an error in deleting the user, or if the user callbacks thrown an exception; SSOException

purgeResource

public void purgeResource(String rid,
                          String domainName,
                          int graceperiod)
                   throws AMException,
                          SSOException

推奨されていません。

This method takes a resource ID and a domain name, It uses default search templates to search for the organization and uses the deleted objects search filter for Resources as defined in the Administration Service of Access Manager. This filter is used to search for the deleted resource under the organization. If the resource is marked for deletion and the grace period is passed then the resource is purged. The pre-delete call backs as listed in the Administration service, are called before the user is deleted. If any of the callbacks throw an exception the delete operation is aborted.

パラメータ:: rid - resource ID; domainName - domain in which the user belongs.; graceperiod - time in days which should have passed before this user can be deleted.
例外:: AMException - if there is an error in deleting the user, or if the user callbacks thrown an exception; SSOException

purgeGroup

public void purgeGroup(String gid,
                       String domainName,
                       int graceperiod)
                throws AMException,
                       SSOException

推奨されていません。

This method takes a group name and a domain name, It uses default search templates to search for the organization and uses the deleted objects search filter for Groups as defined in the Administration Service of Access Manager. This filter is used to search for the deleted user under the organization. If the group is marked for deletion and the grace period is passed then the group is purged. The pre-delete call backs as listed in the Administration service, are called before the group is deleted. If any of the callbacks throw an exception the delete operation is aborted.

パラメータ:: gid - group name; domainName - domain in which the group belongs.; graceperiod - time in days which should have passed before this user can be deleted. If a -1 is passed, group is deleted right away without check on graceperiod.
例外:: AMException - if there is an error in deleting the group, or if the callbacks thrown an exception; SSOException

getEntityTypes

public Set getEntityTypes()

推奨されていません。

Returns a set of com.iplanet.am.sdk.AMEntityType objects, which is the set of objects which are supported by the com.iplanet.am.sdk.AMEntity APIs.

戻り値:: Set of AMEntityType objects.

getBaseDN

protected String getBaseDN(com.sun.identity.sm.ServiceConfig sc)

推奨されていません。

isRFC2247

protected boolean isRFC2247(com.sun.identity.sm.ServiceConfig sc)

推奨されていません。

addToOrgMapCache

protected static void addToOrgMapCache(SSOToken stoken,
                                       String dn)
                                throws AMException,
                                       SSOException

推奨されていません。

Protected method to update the orgMapCache

例外:: AMException; SSOException

daysSinceModified

protected static int daysSinceModified(SSOToken stoken,
                                       String entryDN)
                                throws AMException,
                                       SSOException

推奨されていません。

Protected method to obtain the number of days since this DN was last modified.

例外:: AMException; SSOException

updateCache

protected static void updateCache(String dn,
                                  int eventType)

推奨されていません。

Protected method to update orgMapCache.

概要

パッケージ

クラス

階層ツリー

非推奨 API

索引

ヘルプ

前のクラス 次のクラス

フレームあり フレームなし

概要: 入れ子 | フィールド | コンストラクタ | メソッド

詳細: フィールド | コンストラクタ | メソッド

com.iplanet.am.sdk クラス AMStoreConnection

rootSuffix

defaultOrg

orgMapCache

debug

AMStoreConnection

getAMSdkBaseDN

getFilteredRoleNamingAttribute

getGroupContainerNamingAttribute

getGroupNamingAttribute

getNamingAttribute

getOrganizationNamingAttribute

getOrganizationalUnitNamingAttribute

getPeopleContainerNamingAttribute

getRoleNamingAttribute

getUserNamingAttribute

getAMObjectType

getAMObjectName

getObjectName

getAssignableDynamicGroup

getAttributeNames

getDynamicGroup

getFilteredRole

getGroupContainer

getI18NPropertiesFileName

getOrganization

getOrganizationDN

getOrganizationalUnit

getPeopleContainer

getPolicyTemplate

getPropertiesViewBeanURL

getResource

getRole

getSchema

getSchemaTypes

getServiceHierarchy

getServiceNames

getStaticGroup

getTopLevelContainers

getTopLevelOrganizations

getUser

getEntity

isValidEntry

createTopOrganization

purge

purgeUser

purgeResource

purgeGroup

getEntityTypes

getBaseDN

isRFC2247

addToOrgMapCache

daysSinceModified

updateCache

com.iplanet.am.sdk
クラス AMStoreConnection