com.ibm.itim.apps

Class RequestManager

java.lang.Object

com.ibm.itim.apps.RequestManager

public class RequestManager
extends java.lang.Object

Provides an interface for retrieving requests from the provisioning platform.

See Also:

Request

Constructor Summary

Constructors

Constructor and Description
RequestManager(PlatformContext platform, javax.security.auth.Subject subject) Constructs with a platform and subject.

Method Summary

Modifier and Type	Method and Description
int	getActivitiesCount(java.lang.String status) Returns count of activities for the user
int	getActivitiesCount(java.lang.String status, java.util.Locale locale)
com.ibm.itim.apps.ejb.request.RequestAuditDataActivity	getManualActivity(long activityId, int maxParticipants) Looks up a manual activity by it's identifier.
com.ibm.itim.apps.ejb.request.ActivityAuditDataFilterSelections	getManualActivityFilterSelections(com.ibm.itim.apps.ejb.search.SearchRequest searchRequest, com.ibm.ldap.filter.ISearchFilterExpression searchFilterExpression) Returns selections available for filtering manual activities based on the specified filter.
java.util.Collection	getPendingRequests() Returns all pending requests that were submitted by the user identified by the Subject used to construct this RequestManager.
Request	getRequest(long id) Returns a Request for the given ID.
com.ibm.itim.apps.ejb.request.RequestAuditData	getRequestAuditData(long id) Returns audit data for the request having the specified identifier.
com.ibm.itim.apps.ejb.request.RequestAuditDataFilterSelections	getRequestAuditDataFilterSelections(com.ibm.itim.apps.ejb.search.SearchRequest searchRequest, com.ibm.ldap.filter.ISearchFilterExpression searchFilterExpression) Returns selections available for filtering audit data based on the specified filter.
java.util.List<com.ibm.itim.apps.ejb.request.RequestAuditDataActivity>	searchManualActivities(com.ibm.itim.apps.ejb.search.SearchRequest searchRequest, com.ibm.ldap.filter.ISearchFilterExpression searchFilterExpression, int maxParticipants) Returns manual activities for the authenticated user
java.util.List<com.ibm.itim.apps.ejb.request.RequestAuditData>	searchRequestAuditData(com.ibm.itim.apps.ejb.search.SearchRequest searchRequest, com.ibm.ldap.filter.ISearchFilterExpression searchFilterExpression) Searches audit data.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

RequestManager

public RequestManager(PlatformContext platform,
                      javax.security.auth.Subject subject)

Constructs with a platform and subject.

Parameters:

platform - PlatformContext holding platform connection information.

subject - Authenticated user.

Method Detail

getRequest

public Request getRequest(long id)

Returns a Request for the given ID.

Parameters:

id - Unique ID of the request.

Returns:

Request with the given ID.

getManualActivity

public com.ibm.itim.apps.ejb.request.RequestAuditDataActivity getManualActivity(long activityId,
                                                                                int maxParticipants)
                                                                         throws ApplicationException,
                                                                                java.rmi.RemoteException

Looks up a manual activity by it's identifier.

Parameters:

activityId - Activity identifier

maxParticipants - Maximum number of participants

Returns:

RequestAuditDataActivity

Throws:

AuditingException - if an auditing error occurs.

ApplicationException

java.rmi.RemoteException

getManualActivityFilterSelections

public com.ibm.itim.apps.ejb.request.ActivityAuditDataFilterSelections getManualActivityFilterSelections(com.ibm.itim.apps.ejb.search.SearchRequest searchRequest,
                                                                                                         com.ibm.ldap.filter.ISearchFilterExpression searchFilterExpression)
                                                                                                  throws ApplicationException,
                                                                                                         java.rmi.RemoteException

Returns selections available for filtering manual activities based on the specified filter.

Parameters:

searchRequest - - Specifies the search criteria.

searchFilterExpression - - Specifies the search filter.

Returns:

ActivityAuditDataFilterSelections

Throws:

ApplicationException, - RemoteException

ApplicationException

java.rmi.RemoteException

searchManualActivities

public java.util.List<com.ibm.itim.apps.ejb.request.RequestAuditDataActivity> searchManualActivities(com.ibm.itim.apps.ejb.search.SearchRequest searchRequest,
                                                                                                     com.ibm.ldap.filter.ISearchFilterExpression searchFilterExpression,
                                                                                                     int maxParticipants)
                                                                                              throws ApplicationException,
                                                                                                     java.rmi.RemoteException

Returns manual activities for the authenticated user

Parameters:

searchRequest - - Specifies the search criteria.

searchFilterExpression - - Specifies the search filter.

maxParticipants - Maximum number of participants per activity

Returns:

List of RequestAuditDataActivity

Throws:

ApplicationException, - RemoteException

ApplicationException

java.rmi.RemoteException

getRequestAuditData

public com.ibm.itim.apps.ejb.request.RequestAuditData getRequestAuditData(long id)
                                                                   throws ApplicationException,
                                                                          java.rmi.RemoteException

Returns audit data for the request having the specified identifier.

Parameters:

id - - Identifier of the request for which audit data should be returned.

Returns:

RequestAuditData representing the audit data for the request having the specified identifier.

Throws:

ApplicationException - if an applications error occurs.

java.rmi.RemoteException - if a communication error occurs.

searchRequestAuditData

public java.util.List<com.ibm.itim.apps.ejb.request.RequestAuditData> searchRequestAuditData(com.ibm.itim.apps.ejb.search.SearchRequest searchRequest,
                                                                                             com.ibm.ldap.filter.ISearchFilterExpression searchFilterExpression)
                                                                                      throws ApplicationException,
                                                                                             java.rmi.RemoteException

Searches audit data.

Parameters:

searchRequest - - Specifies the search criteria.

searchFilterExpression - - Specifies the search filter.

Throws:

ApplicationException - if an application error occurs.

java.rmi.RemoteException - if a communication error occurs.

getRequestAuditDataFilterSelections

public com.ibm.itim.apps.ejb.request.RequestAuditDataFilterSelections getRequestAuditDataFilterSelections(com.ibm.itim.apps.ejb.search.SearchRequest searchRequest,
                                                                                                          com.ibm.ldap.filter.ISearchFilterExpression searchFilterExpression)
                                                                                                   throws ApplicationException,
                                                                                                          java.rmi.RemoteException

Returns selections available for filtering audit data based on the specified filter.

Parameters:

searchRequest - - Specifies the search criteria.

searchFilterExpression - - Specifies the search filter.

Returns:

RequestAuditDataFilterSelections representing the selections available for filtering request audit data based on the specified filter.

Throws:

ApplicationException - if an application error occurs.

java.rmi.RemoteException - if a communication error occurs.

getPendingRequests

public java.util.Collection getPendingRequests()
                                        throws ApplicationException

Returns all pending requests that were submitted by the user identified by the Subject used to construct this RequestManager.

Returns:

Collection of the user's pending requests.

Throws:

java.rmi.RemoteException - thrown if a communications-related error prevents returning all pending requests.

ApplicationException - thrown if an applications-level error prevents returning all pending requests.

getActivitiesCount

public int getActivitiesCount(java.lang.String status)
                       throws java.rmi.RemoteException,
                              ApplicationException

Returns count of activities for the user

Parameters:

status - status of activity -PENDING, FULFILLED etc

Returns:

Count of users activities.

Throws:

java.rmi.RemoteException - thrown if a communications-related error prevents returning all pending requests.

ApplicationException - thrown if an applications-level error prevents returning all pending requests.

getActivitiesCount

public int getActivitiesCount(java.lang.String status,
                              java.util.Locale locale)
                       throws java.rmi.RemoteException,
                              ApplicationException

Throws:

java.rmi.RemoteException

ApplicationException