AMCommonUtils (OpenAM Project 15.1.7-SNAPSHOT API)

java.lang.Object
- com.iplanet.am.sdk.AMCommonUtils

All Implemented Interfaces:

AMConstants

Deprecated.
As of Sun Java System Access Manager 7.1.
```
public class AMCommonUtils
extends Object
implements AMConstants
```
This class contains all the miscellaneous utility methods used in the com.iplanet.am.sdk package.

Field Summary

Fields
Modifier and Type	Field and Description
`protected static Map`	`creationtemplateMap` Deprecated.
`protected static boolean`	`integrateLocale` Deprecated.
`protected static Map`	`statusAttributeMap` Deprecated.
`protected static Map`	`supportedEntitiesBasedOnName` Deprecated.
`protected static Map`	`supportedEntitiesBasedOnType` Deprecated.
`protected static Map`	`supportedNames` Deprecated.
`protected static Map`	`supportedTypes` Deprecated.

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

Constructor Summary

Constructors
Constructor and Description

AMCommonUtils()
Deprecated.

Constructors
Constructor and Description
`AMCommonUtils()` Deprecated.

Method Summary

All Methods Static Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`protected static Map`	`attrSetToMap(AttrSet attrSet)` Deprecated.
`protected static Map`	`attrSetToMap(AttrSet attrSet, boolean fetchByteValues)` Deprecated. Method to convert a AttrSet object to Map.
`protected static AttrSet`	`combineAttrSets(AttrSet attrSet1, AttrSet attrSet2)` Deprecated. Combines 2 AttrSets and returns the result set.
`static Set`	`combineOCs(Set one, Set two)` Deprecated. Combines two sets which contains objectclass values of an entry in a case insensitive manner.
`protected static String`	`getPrincipalDN(SSOToken token)` Deprecated. Gets the principal DN String in RFC lowercase format from the SSOToken
`protected static Set`	`getSetCopy(Set values)` Deprecated.
`protected static Set`	`getSupportedEntityTypes()` Deprecated. Returns a Set of supported entity types
`protected static String`	`getUserLocale(SSOToken token)` Deprecated. Method to get the user locale.
`protected static boolean`	`isExternalGetAttributesEnabled(String orgDN)` Deprecated. Method to check if the CallBack plugins are enabled for reading external attributes.
`protected static boolean`	`isObjectClassPresent(Set objectClasses, String objectClass)` Deprecated. Method to compare all the object classes in the Set with the specfied object class.
`protected static String`	`mapByteToString(Map map)` Deprecated.
`protected static String`	`mapSetToString(Map map)` Deprecated.
`protected static AttrSet`	`mapToAttrSet(Map map)` Deprecated. Method to convert a Map to AttrSet.
`protected static AttrSet`	`mapToAttrSet(Map map, boolean byteValues)` Deprecated. Method to convert a Map to AttrSet.
`protected static Map`	`mergeMaps(Map mapA, Map mapB)` Deprecated. Merge the values in two maps and return the result map.
`protected static boolean`	`populateManagedObjects()` Deprecated.
`protected static void`	`populateManagedObjectsWithDefaults()` Deprecated.
`static Map`	`removeEmptyValues(Map attrMap)` Deprecated. Removes Empty sets from attribute-value maps.
`protected static Set`	`stringArrayToSet(String[] strs)` Deprecated. Method to convert a String array to a set
`static Set`	`updateAndGetRemovableOCs(Set origSet, Set removeOCs)` Deprecated. Method which removes the specified object class from original set and returns the set of object classes that were removed.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - supportedTypes
```
protected static Map supportedTypes
```
    Deprecated.
  - supportedEntitiesBasedOnType
```
protected static Map supportedEntitiesBasedOnType
```
    Deprecated.
  - supportedEntitiesBasedOnName
```
protected static Map supportedEntitiesBasedOnName
```
    Deprecated.
  - supportedNames
```
protected static Map supportedNames
```
    Deprecated.
  - creationtemplateMap
```
protected static Map creationtemplateMap
```
    Deprecated.
  - statusAttributeMap
```
protected static Map statusAttributeMap
```
    Deprecated.
  - integrateLocale
```
protected static boolean integrateLocale
```
    Deprecated.
- Constructor Detail
  - AMCommonUtils
```
public AMCommonUtils()
```
    Deprecated.
- Method Detail
  - getUserLocale
```
protected static String getUserLocale(SSOToken token)
```
    Deprecated.
    
    Method to get the user locale.
    
    Parameters:
    
    token - SSOToken of the authenticated user
    
    Returns:
    
    a String value representing the user locale
  - combineAttrSets
```
protected static AttrSet combineAttrSets(AttrSet attrSet1,
                                         AttrSet attrSet2)
```
    Deprecated.
    
    Combines 2 AttrSets and returns the result set. The original sets are not modified.
    
    Parameters:
    
    attrSet1 - the first AttrSet
    
    attrSet2 - the second AttrSet
    
    Returns:
    
    an AttrSet which has combined values of attrSet1 & attrSet2
  - mergeMaps
```
protected static Map mergeMaps(Map mapA,
                               Map mapB)
```
    Deprecated.
    
    Merge the values in two maps and return the result map. The values in the smaller map are merged with the larger map and the larger map is returned.
    
    Parameters:
    
    mapA - the first map
    
    mapB - the second map
    
    Returns:
    
    a result map which the biggest of the two maps with values merged from the smaller one.
  - mapSetToString
```
protected static String mapSetToString(Map map)
```
    Deprecated.
  - mapByteToString
```
protected static String mapByteToString(Map map)
```
    Deprecated.
  - getSetCopy
```
protected static Set getSetCopy(Set values)
```
    Deprecated.
  - stringArrayToSet
```
protected static Set stringArrayToSet(String[] strs)
```
    Deprecated.
    
    Method to convert a String array to a set
    
    Parameters:
    
    strs - the String array
    
    Returns:
    
    a Set representing the String array
  - attrSetToMap
```
protected static Map attrSetToMap(AttrSet attrSet)
```
    Deprecated.
  - attrSetToMap
```
protected static Map attrSetToMap(AttrSet attrSet,
                                  boolean fetchByteValues)
```
    Deprecated.
    
    Method to convert a AttrSet object to Map.
    
    Parameters:
    
    attrSet - the AttrSet to be converted to a Map
    
    fetchByteValues - if false stringValues are added, if true byteValues are added.
    
    Returns:
    
    a Map containing attribute names as key's and a Set of attribute values or byte Values
  - mapToAttrSet
```
protected static AttrSet mapToAttrSet(Map map)
```
    Deprecated.
    
    Method to convert a Map to AttrSet.
    
    Parameters:
    
    map - a map contaning attribute names as keys and a Set of attribute values corresponding to each map key.
    
    Returns:
    
    an AttrSet having the contents of the supplied map
  - mapToAttrSet
```
protected static AttrSet mapToAttrSet(Map map,
                                      boolean byteValues)
```
    Deprecated.
    
    Method to convert a Map to AttrSet.
    
    Parameters:
    
    map - a map contaning attribute names as keys and a Set of attribute values corresponding to each map key.
    
    byteValues - if true then values are bytes otherwise strings
    
    Returns:
    
    an AttrSet having the contents of the supplied map
  - getPrincipalDN
```
protected static String getPrincipalDN(SSOToken token)
                                throws SSOException
```
    Deprecated.
    
    Gets the principal DN String in RFC lowercase format from the SSOToken
    
    Parameters:
    
    token - a valid SSOToken
    
    Returns:
    
    a principal DN corresponding to token
    
    Throws:
    
    SSOException - if the token is not valid
  - combineOCs
```
public static Set combineOCs(Set one,
                             Set two)
```
    Deprecated.
    
    Combines two sets which contains objectclass values of an entry in a case insensitive manner. OC values are sometimes returned by LDAP in mixed case and when duplicate values for Objectclass exists in a mixed case, there is a Object class violation Note: there is a possibility that this method will return null
  - isObjectClassPresent
```
protected static boolean isObjectClassPresent(Set objectClasses,
                                              String objectClass)
```
    Deprecated.
    
    Method to compare all the object classes in the Set with the specfied object class. Will do a case insensitive comparision.
    
    Parameters:
    
    objectClasses - Set of object classes
    
    objectClass - the specified object class
    
    Returns:
    
    true if the specified object class is present. False otherwise.
  - updateAndGetRemovableOCs
```
public static Set updateAndGetRemovableOCs(Set origSet,
                                           Set removeOCs)
```
    Deprecated.
    
    Method which removes the specified object class from original set and returns the set of object classes that were removed.
    
    Parameters:
    
    origSet - the original Set
    
    removeOCs - the Set of object classes to be removed
    
    Returns:
    
    the Set of object classes that were removed.
  - removeEmptyValues
```
public static Map removeEmptyValues(Map attrMap)
```
    Deprecated.
    
    Removes Empty sets from attribute-value maps. So that SDK does not try to remove these attributes from newly created entries. Such empty sets should be ignored, when entry is being created.
    
    Parameters:
    
    attrMap -
    
    Returns:
    
    map without empty set.
  - populateManagedObjects
```
protected static boolean populateManagedObjects()
```
    Deprecated.
  - getSupportedEntityTypes
```
protected static Set getSupportedEntityTypes()
```
    Deprecated.
    
    Returns a Set of supported entity types
  - isExternalGetAttributesEnabled
```
protected static boolean isExternalGetAttributesEnabled(String orgDN)
```
    Deprecated.
    
    Method to check if the CallBack plugins are enabled for reading external attributes.
  - populateManagedObjectsWithDefaults
```
protected static void populateManagedObjectsWithDefaults()
```
    Deprecated.

Class AMCommonUtils

Field Summary

Fields inherited from interface com.iplanet.am.sdk.AMConstants

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

supportedTypes

supportedEntitiesBasedOnType

supportedEntitiesBasedOnName

supportedNames

creationtemplateMap

statusAttributeMap

integrateLocale

Constructor Detail

AMCommonUtils

Method Detail

getUserLocale

combineAttrSets

mergeMaps

mapSetToString

mapByteToString

getSetCopy

stringArrayToSet

attrSetToMap

attrSetToMap

mapToAttrSet

mapToAttrSet

getPrincipalDN

combineOCs

isObjectClassPresent

updateAndGetRemovableOCs

removeEmptyValues

populateManagedObjects

getSupportedEntityTypes

isExternalGetAttributesEnabled

populateManagedObjectsWithDefaults