IdRepoJAXRPCObjectImpl (OpenAM Project 15.1.7-SNAPSHOT API)

java.lang.Object
- com.sun.identity.idm.server.IdRepoJAXRPCObjectImpl

All Implemented Interfaces:

DirectoryManagerIF, Remote

Direct Known Subclasses:

DirectoryManagerImpl
```
public abstract class IdRepoJAXRPCObjectImpl
extends Object
implements DirectoryManagerIF
```
Provides service side implementation of IdRepo for JAX-RPC interface DirectoryManagerIF. Does not provide implementation for deprecated AMSDK interfaces. Remote clients using openssoclientsdk.jar would be calling these methods using SOAP. Implements identity changes notifications via PLL and also stores notifications changes for polling clients.

Field Summary

Fields
Modifier and Type	Field and Description
`protected static int`	`cacheSize`
`protected static String`	`IDREPO_SERVICE`
`protected static Debug`	`idRepoDebug`
`protected static Map<String,URL>`	`idRepoNotificationURLs`
`protected static IdServices`	`idServices`
`protected static String`	`serverPort`
`protected static String`	`serverURL`
`protected static SSOTokenManager`	`tokenManager`
`protected static URL`	`urlServer`

Constructor Summary

Constructors
Constructor and Description

IdRepoJAXRPCObjectImpl()

Constructors
Constructor and Description
`IdRepoJAXRPCObjectImpl()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`assignService_idrepo(String token, String type, String name, String serviceName, String stype, Map attrMap, String amOrgName, String amsdkDN)`
`void`	`changePassword_idrepo(String token, String type, String name, String oldPassword, String newPassword, String amOrgName, String amsdkDN)`
`protected Set<String>`	`collectChangesFromCache(int time, ConcurrentSkipListMap<Long,Set<String>> cache)` Collects the notification XMLs for a given time period from the provided cache.
`String`	`create_idrepo(String token, String type, String name, Map attrMap, String amOrgName)`
`void`	`delete_idrepo(String token, String type, String name, String orgName, String amsdkDN)`
`void`	`deRegisterNotificationURL_idrepo(String notificationID)`
`Set`	`getAssignedServices_idrepo(String token, String type, String name, Map mapOfServiceNamesAndOCs, String amOrgName, String amsdkDN)`
`Map`	`getAttributes1_idrepo(String token, String type, String name, Set attrNames, String amOrgName, String amsdkDN)`
`Map`	`getAttributes2_idrepo(String token, String type, String name, String amOrgName, String amsdkDN)`
`Map<String,Set<String>>`	`getBinaryAttributes_idrepo(String token, String type, String name, Set<String> attrNames, String amOrgName, String amsdkDN)` Returns attributes in binary format for a given identity using the IdRepo API.
`Map`	`getBinaryServiceAttributes_idrepo(String token, String type, String name, String serviceName, Set attrNames, String amOrgName, String amsdkDN)`
`protected static Set<String>`	`getCachedValues(ConcurrentSkipListMap<Long,Set<String>> cache)` Returns the cached notification XMLs for the current cacheIndex.
`protected static long`	`getCacheIndex()`
`Set`	`getFullyQualifiedNames_idrepo(String token, String type, String name, String amOrgName)`
`Set`	`getMembers_idrepo(String token, String type, String name, String amOrgName, String membersType, String amsdkDN)`
`Set`	`getMemberships_idrepo(String token, String type, String name, String membershipType, String amOrgName, String amsdkDN)`
`Map`	`getServiceAttributes_idrepo(String token, String type, String name, String serviceName, Set attrNames, String amOrgName, String amsdkDN)`
`Map`	`getServiceAttributesAscending_idrepo(String token, String type, String name, String serviceName, Set attrNames, String amOrgName, String amsdkDN)` Non-javadoc, non-public methods Get the service attributes of the name identity.
`Map`	`getSpecialIdentities_idrepo(String token, String type, String amOrgName)`
`protected SSOToken`	`getSSOToken(String token)` Check if agent token ID is appended to the token string.
`Set`	`getSupportedOperations_idrepo(String token, String type, String amOrgName)`
`Set`	`getSupportedTypes_idrepo(String token, String amOrgName)`
`protected static void`	`initialize_idrepo()` Initializes this class with system properties.
`protected static void`	`initializeCacheSize()`
`boolean`	`isActive_idrepo(String token, String type, String name, String amOrgName, String amsdkDN)`
`protected boolean`	`isClientOnSameServer(String clientURL)`
`boolean`	`isExists_idrepo(String token, String type, String name, String amOrgName)`
`void`	`modifyMemberShip_idrepo(String token, String type, String name, Set members, String membersType, int operation, String amOrgName)`
`void`	`modifyService_idrepo(String token, String type, String name, String serviceName, String stype, Map attrMap, String amOrgName, String amsdkDN)`
`Set<String>`	`objectsChanged_idrepo(int time)` Returns the notification event XMLs for changed objects in the past N+2 minutes.
`protected static void`	`processEntryChanged_idrepo(String method, String name, int type, Set attrNames)`
`String`	`registerNotificationURL_idrepo(String url)`
`protected String`	`registerNotificationURL(String url, Map<String,URL> notificationURLs)`
`void`	`removeAttributes_idrepo(String token, String type, String name, Set attrNames, String amOrgName, String amsdkDN)`
`Map`	`search1_idrepo(String token, String type, String pattern, Map avPairs, boolean recursive, int maxResults, int maxTime, Set returnAttrs, String amOrgName)`
`Map`	`search2_idrepo(String token, String type, String pattern, int maxTime, int maxResults, Set returnAttrs, boolean returnAllAttrs, int filterOp, Map avPairs, boolean recursive, String amOrgName)`
`void`	`setActiveStatus_idrepo(String token, String type, String name, String amOrgName, String amsdkDN, boolean active)`
`void`	`setAttributes_idrepo(String token, String type, String name, Map attributes, boolean isAdd, String amOrgName, String amsdkDN)`
`void`	`setAttributes2_idrepo(String token, String type, String name, Map attributes, boolean isAdd, String amOrgName, String amsdkDN, boolean isString)`
`void`	`unassignService_idrepo(String token, String type, String name, String serviceName, Map attrMap, String amOrgName, String amsdkDN)`

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

Methods inherited from interface com.iplanet.am.sdk.remote.DirectoryManagerIF
changePassword, createAMTemplate, createEntry, deRegisterNotificationURL, doesEntryExists, getAMTemplateDN, getAttributes1, getAttributes2, getAttributes3, getAttributes4, getAttributesByteValues1, getAttributesByteValues2, getAttributesForSchema, getCreationTemplateName, getDCTreeAttributes, getDeletedObjectFilter, getExternalAttributes, getGroupFilterAndScope, getMembers, getNamingAttr, getObjectClassFromDS, getObjectType, getOrganizationDN, getOrgDNFromDomain, getOrgSearchFilter, getRegisteredServiceNames, getSearchFilterFromTemplate, getTopLevelContainers, isAncestorOrgDeleted, modifyMemberShip, objectsChanged, registerNotificationURL, registerService, removeAdminRole, removeEntry, renameEntry, search1, search2, search3, setAttributes, setGroupFilter, unRegisterService, updateUserAttribute, verifyAndDeleteObject, verifyAndGetOrgDN

Field Detail

idRepoDebug
```
protected static Debug idRepoDebug
```

tokenManager

protected static SSOTokenManager tokenManager

idServices
```
protected static IdServices idServices
```

IDREPO_SERVICE

protected static final String IDREPO_SERVICE

See Also:: Constant Field Values

cacheSize
```
protected static int cacheSize
```

idRepoNotificationURLs

protected static final Map<String,URL> idRepoNotificationURLs

serverURL
```
protected static String serverURL
```

urlServer
```
protected static URL urlServer
```

serverPort
```
protected static String serverPort
```

Constructor Detail
- IdRepoJAXRPCObjectImpl
```
public IdRepoJAXRPCObjectImpl()
```

Method Detail

initializeCacheSize

protected static void initializeCacheSize()

initialize_idrepo
```
protected static void initialize_idrepo()
```
Initializes this class with system properties. Called only by getSSOToken() method. Hence all other methods must call either getSSOToken() or initialize() directly.

isClientOnSameServer

protected boolean isClientOnSameServer(String clientURL)

assignService_idrepo

public void assignService_idrepo(String token,
                                 String type,
                                 String name,
                                 String serviceName,
                                 String stype,
                                 Map attrMap,
                                 String amOrgName,
                                 String amsdkDN)
                          throws RemoteException,
                                 IdRepoException,
                                 SSOException

Specified by:: assignService_idrepo in interface DirectoryManagerIF
Throws:: RemoteException; IdRepoException; SSOException

create_idrepo

public String create_idrepo(String token,
                            String type,
                            String name,
                            Map attrMap,
                            String amOrgName)
                     throws RemoteException,
                            IdRepoException,
                            SSOException

Specified by:: create_idrepo in interface DirectoryManagerIF
Throws:: RemoteException; IdRepoException; SSOException

delete_idrepo

public void delete_idrepo(String token,
                          String type,
                          String name,
                          String orgName,
                          String amsdkDN)
                   throws RemoteException,
                          IdRepoException,
                          SSOException

Specified by:: delete_idrepo in interface DirectoryManagerIF
Throws:: RemoteException; IdRepoException; SSOException

getAssignedServices_idrepo

public Set getAssignedServices_idrepo(String token,
                                      String type,
                                      String name,
                                      Map mapOfServiceNamesAndOCs,
                                      String amOrgName,
                                      String amsdkDN)
                               throws RemoteException,
                                      IdRepoException,
                                      SSOException

Specified by:: getAssignedServices_idrepo in interface DirectoryManagerIF
Throws:: RemoteException; IdRepoException; SSOException

getAttributes1_idrepo

public Map getAttributes1_idrepo(String token,
                                 String type,
                                 String name,
                                 Set attrNames,
                                 String amOrgName,
                                 String amsdkDN)
                          throws RemoteException,
                                 IdRepoException,
                                 SSOException

Specified by:: getAttributes1_idrepo in interface DirectoryManagerIF
Throws:: RemoteException; IdRepoException; SSOException

getAttributes2_idrepo

public Map getAttributes2_idrepo(String token,
                                 String type,
                                 String name,
                                 String amOrgName,
                                 String amsdkDN)
                          throws RemoteException,
                                 IdRepoException,
                                 SSOException

Specified by:: getAttributes2_idrepo in interface DirectoryManagerIF
Throws:: RemoteException; IdRepoException; SSOException

getBinaryAttributes_idrepo

public Map<String,Set<String>> getBinaryAttributes_idrepo(String token,
                                                          String type,
                                                          String name,
                                                          Set<String> attrNames,
                                                          String amOrgName,
                                                          String amsdkDN)
                                                   throws RemoteException,
                                                          IdRepoException,
                                                          SSOException

Description copied from interface: DirectoryManagerIF

Returns attributes in binary format for a given identity using the IdRepo API.

Specified by:: getBinaryAttributes_idrepo in interface DirectoryManagerIF
Parameters:: token - Token identifying the requester.; type - The identity type we need to query the attributes for.; name - The name of the identity.; attrNames - The attribute names that needs to be queried.; amOrgName - The realm identifier.; amsdkDN - The AM SDK DN, may be null.
Returns:: A map of attribute names and values, where the values are all in Base64 encoded format.
Throws:: RemoteException - If there was a communication problem.; IdRepoException - If there was a problem while retrieving the attributes from the identity repository.; SSOException - If there was an error with the provided token.

getMembers_idrepo

public Set getMembers_idrepo(String token,
                             String type,
                             String name,
                             String amOrgName,
                             String membersType,
                             String amsdkDN)
                      throws RemoteException,
                             IdRepoException,
                             SSOException

Specified by:: getMembers_idrepo in interface DirectoryManagerIF
Throws:: RemoteException; IdRepoException; SSOException

getMemberships_idrepo

public Set getMemberships_idrepo(String token,
                                 String type,
                                 String name,
                                 String membershipType,
                                 String amOrgName,
                                 String amsdkDN)
                          throws RemoteException,
                                 IdRepoException,
                                 SSOException

Specified by:: getMemberships_idrepo in interface DirectoryManagerIF
Throws:: RemoteException; IdRepoException; SSOException

getServiceAttributes_idrepo

public Map getServiceAttributes_idrepo(String token,
                                       String type,
                                       String name,
                                       String serviceName,
                                       Set attrNames,
                                       String amOrgName,
                                       String amsdkDN)
                                throws RemoteException,
                                       IdRepoException,
                                       SSOException

Specified by:: getServiceAttributes_idrepo in interface DirectoryManagerIF
Throws:: RemoteException; IdRepoException; SSOException

getBinaryServiceAttributes_idrepo

public Map getBinaryServiceAttributes_idrepo(String token,
                                             String type,
                                             String name,
                                             String serviceName,
                                             Set attrNames,
                                             String amOrgName,
                                             String amsdkDN)
                                      throws RemoteException,
                                             IdRepoException,
                                             SSOException

Specified by:: getBinaryServiceAttributes_idrepo in interface DirectoryManagerIF
Throws:: RemoteException; IdRepoException; SSOException

getServiceAttributesAscending_idrepo

public Map getServiceAttributesAscending_idrepo(String token,
                                                String type,
                                                String name,
                                                String serviceName,
                                                Set attrNames,
                                                String amOrgName,
                                                String amsdkDN)
                                         throws RemoteException,
                                                IdRepoException,
                                                SSOException

Description copied from interface: DirectoryManagerIF

Non-javadoc, non-public methods Get the service attributes of the name identity. Traverse to the global configuration if necessary until all attributes are found or reached the global area whichever occurs first.

Specified by:: getServiceAttributesAscending_idrepo in interface DirectoryManagerIF
Parameters:: token - is the sso token of the person performing this operation.; type - is the identity type of the name parameter.; name - is the identity we are interested in.; serviceName - is the service we are interested in; attrNames - are the name of the attributes wer are interested in.; amOrgName - is the orgname.; amsdkDN - is the amsdkDN.
Throws:: RemoteException - if there are problem connecting with remote site.; IdRepoException - if there are repository related error conditions.; SSOException - if user's single sign on token is invalid.

getSupportedOperations_idrepo

public Set getSupportedOperations_idrepo(String token,
                                         String type,
                                         String amOrgName)
                                  throws RemoteException,
                                         IdRepoException,
                                         SSOException

Specified by:: getSupportedOperations_idrepo in interface DirectoryManagerIF
Throws:: RemoteException; IdRepoException; SSOException

getSupportedTypes_idrepo

public Set getSupportedTypes_idrepo(String token,
                                    String amOrgName)
                             throws RemoteException,
                                    IdRepoException,
                                    SSOException

Specified by:: getSupportedTypes_idrepo in interface DirectoryManagerIF
Throws:: RemoteException; IdRepoException; SSOException

getFullyQualifiedNames_idrepo

public Set getFullyQualifiedNames_idrepo(String token,
                                         String type,
                                         String name,
                                         String amOrgName)
                                  throws RemoteException,
                                         IdRepoException,
                                         SSOException

Specified by:: getFullyQualifiedNames_idrepo in interface DirectoryManagerIF
Throws:: RemoteException; IdRepoException; SSOException

isExists_idrepo

public boolean isExists_idrepo(String token,
                               String type,
                               String name,
                               String amOrgName)
                        throws RemoteException,
                               SSOException,
                               IdRepoException

Specified by:: isExists_idrepo in interface DirectoryManagerIF
Throws:: RemoteException; SSOException; IdRepoException

isActive_idrepo

public boolean isActive_idrepo(String token,
                               String type,
                               String name,
                               String amOrgName,
                               String amsdkDN)
                        throws RemoteException,
                               IdRepoException,
                               SSOException

Specified by:: isActive_idrepo in interface DirectoryManagerIF
Throws:: RemoteException; IdRepoException; SSOException

setActiveStatus_idrepo

public void setActiveStatus_idrepo(String token,
                                   String type,
                                   String name,
                                   String amOrgName,
                                   String amsdkDN,
                                   boolean active)
                            throws RemoteException,
                                   IdRepoException,
                                   SSOException

Specified by:: setActiveStatus_idrepo in interface DirectoryManagerIF
Throws:: RemoteException; IdRepoException; SSOException

modifyMemberShip_idrepo

public void modifyMemberShip_idrepo(String token,
                                    String type,
                                    String name,
                                    Set members,
                                    String membersType,
                                    int operation,
                                    String amOrgName)
                             throws RemoteException,
                                    IdRepoException,
                                    SSOException

Specified by:: modifyMemberShip_idrepo in interface DirectoryManagerIF
Throws:: RemoteException; IdRepoException; SSOException

modifyService_idrepo

public void modifyService_idrepo(String token,
                                 String type,
                                 String name,
                                 String serviceName,
                                 String stype,
                                 Map attrMap,
                                 String amOrgName,
                                 String amsdkDN)
                          throws RemoteException,
                                 IdRepoException,
                                 SSOException

Specified by:: modifyService_idrepo in interface DirectoryManagerIF
Throws:: RemoteException; IdRepoException; SSOException

removeAttributes_idrepo

public void removeAttributes_idrepo(String token,
                                    String type,
                                    String name,
                                    Set attrNames,
                                    String amOrgName,
                                    String amsdkDN)
                             throws RemoteException,
                                    IdRepoException,
                                    SSOException

Specified by:: removeAttributes_idrepo in interface DirectoryManagerIF
Throws:: RemoteException; IdRepoException; SSOException

search1_idrepo

public Map search1_idrepo(String token,
                          String type,
                          String pattern,
                          Map avPairs,
                          boolean recursive,
                          int maxResults,
                          int maxTime,
                          Set returnAttrs,
                          String amOrgName)
                   throws RemoteException,
                          IdRepoException,
                          SSOException

Specified by:: search1_idrepo in interface DirectoryManagerIF
Throws:: RemoteException; IdRepoException; SSOException

search2_idrepo

public Map search2_idrepo(String token,
                          String type,
                          String pattern,
                          int maxTime,
                          int maxResults,
                          Set returnAttrs,
                          boolean returnAllAttrs,
                          int filterOp,
                          Map avPairs,
                          boolean recursive,
                          String amOrgName)
                   throws RemoteException,
                          IdRepoException,
                          SSOException

Specified by:: search2_idrepo in interface DirectoryManagerIF
Throws:: RemoteException; IdRepoException; SSOException

setAttributes_idrepo

public void setAttributes_idrepo(String token,
                                 String type,
                                 String name,
                                 Map attributes,
                                 boolean isAdd,
                                 String amOrgName,
                                 String amsdkDN)
                          throws RemoteException,
                                 IdRepoException,
                                 SSOException

Specified by:: setAttributes_idrepo in interface DirectoryManagerIF
Throws:: RemoteException; IdRepoException; SSOException

setAttributes2_idrepo

public void setAttributes2_idrepo(String token,
                                  String type,
                                  String name,
                                  Map attributes,
                                  boolean isAdd,
                                  String amOrgName,
                                  String amsdkDN,
                                  boolean isString)
                           throws RemoteException,
                                  IdRepoException,
                                  SSOException

Specified by:: setAttributes2_idrepo in interface DirectoryManagerIF
Throws:: RemoteException; IdRepoException; SSOException

changePassword_idrepo

public void changePassword_idrepo(String token,
                                  String type,
                                  String name,
                                  String oldPassword,
                                  String newPassword,
                                  String amOrgName,
                                  String amsdkDN)
                           throws RemoteException,
                                  IdRepoException,
                                  SSOException

Specified by:: changePassword_idrepo in interface DirectoryManagerIF
Throws:: RemoteException; IdRepoException; SSOException

unassignService_idrepo

public void unassignService_idrepo(String token,
                                   String type,
                                   String name,
                                   String serviceName,
                                   Map attrMap,
                                   String amOrgName,
                                   String amsdkDN)
                            throws RemoteException,
                                   IdRepoException,
                                   SSOException

Specified by:: unassignService_idrepo in interface DirectoryManagerIF
Throws:: RemoteException; IdRepoException; SSOException

deRegisterNotificationURL_idrepo

public void deRegisterNotificationURL_idrepo(String notificationID)
                                      throws RemoteException

Specified by:: deRegisterNotificationURL_idrepo in interface DirectoryManagerIF
Throws:: RemoteException

objectsChanged_idrepo
```
public Set<String> objectsChanged_idrepo(int time)
                                  throws RemoteException
```
Returns the notification event XMLs for changed objects in the past N+2 minutes.

Specified by:

objectsChanged_idrepo in interface DirectoryManagerIF

Parameters:

time - The number of minutes we should retrieve the changed objects for.

Returns:

Returns the notification XMLs for the current minute, for the requested N minute, and also for 2 additional minutes.

Throws:

RemoteException - If there was an error while collecting changed objects.

collectChangesFromCache
```
protected Set<String> collectChangesFromCache(int time,
                                              ConcurrentSkipListMap<Long,Set<String>> cache)
```
Collects the notification XMLs for a given time period from the provided cache.

Parameters:

time - The number of minutes we should retrieve the changed objects for.

cache - The cache we need to collect the notifications from.

Returns:

Returns the notification XMLs for the current minute, for the requested N minute, and also for 2 additional minutes.

registerNotificationURL_idrepo

public String registerNotificationURL_idrepo(String url)
                                      throws RemoteException

Specified by:: registerNotificationURL_idrepo in interface DirectoryManagerIF
Throws:: RemoteException

registerNotificationURL

protected String registerNotificationURL(String url,
                                         Map<String,URL> notificationURLs)

getSpecialIdentities_idrepo

public Map getSpecialIdentities_idrepo(String token,
                                       String type,
                                       String amOrgName)
                                throws RemoteException,
                                       IdRepoException,
                                       SSOException

Specified by:: getSpecialIdentities_idrepo in interface DirectoryManagerIF
Throws:: RemoteException; IdRepoException; SSOException

processEntryChanged_idrepo

protected static void processEntryChanged_idrepo(String method,
                                                 String name,
                                                 int type,
                                                 Set attrNames)

getCachedValues
```
protected static Set<String> getCachedValues(ConcurrentSkipListMap<Long,Set<String>> cache)
```
Returns the cached notification XMLs for the current cacheIndex. If there is nothing cached for this minute, this will create a new cache entry and return the corresponding Set.

Parameters:

cache - The cache that stores the notification XMLs per minute.

Returns:

A Set that corresponds to the current cacheIndex.

getCacheIndex
```
protected static long getCacheIndex()
```

getSSOToken
```
protected SSOToken getSSOToken(String token)
                        throws SSOException
```
Check if agent token ID is appended to the token string. if yes, we use it as a restriction context. This is meant for cookie hijacking feature where agent appends the agent token ID to the user sso token before sending it over to the server for validation.

Throws:

SSOException

Class IdRepoJAXRPCObjectImpl