com.ibm.itim.dataservices.model.domain

Class AccountTable

java.lang.Object

com.ibm.itim.dataservices.model.domain.AccountTable

public class AccountTable
extends java.lang.Object

Class that provides an interface for searching and performing operations on accounts within the context of a defining service. Given the context of a service, single operations can be made against all accounts for that service.

Constructor Summary

Constructors

Constructor and Description
AccountTable(ServiceEntity service) Constructs the AccountTable with a service as its context.

Method Summary

Modifier and Type	Method and Description
SearchResults	getAll() Returns all accounts hosted by the service including account on concrete and hosted services.
SearchResults	getByFilter(java.lang.String filter) Returns all accounts matching the given filter.
SearchResults	getByFilter(java.lang.String filter, boolean useServiceTypeOptimization)
SearchResults	getByOwner(DistinguishedName ownerDN) Returns all accounts owned by the specified person.
SearchResults	getByUserID(java.lang.String userID) Returns all accounts hosted by the service with the given user id.
SearchResults	getFlaggedNoncompliant() Returns all accounts hosted by the service including account on concrete and hosted services that have been flagged as non-compliant.
SearchResults	getOrphaned() Returns all orphaned accounts hosted by the service.
SearchResults	getOrphansByFilter(java.lang.String filter, SearchParameters params) Returns all orphaned accounts hosted by the service with the given user id.
SearchResults	getOrphansByUserID(java.lang.String userID) Returns all orphaned accounts hosted by the service with the given user id.
SearchResults	getOwned() Returns all owned accounts hosted by the service.
void	removeAll() Removes all accounts hosted by the service.
void	removeOrphaned() Removes all orphaned accounts hosted by the service.

Methods inherited from class java.lang.Object

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

Constructor Detail

AccountTable

public AccountTable(ServiceEntity service)

Constructs the AccountTable with a service as its context.

Parameters:

service - ServiceEntity for context.

Method Detail

getAll

public SearchResults getAll()
                     throws ModelCommunicationException,
                            ObjectNotFoundException

Returns all accounts hosted by the service including account on concrete and hosted services.

Returns:

SearchResults holding AccountEntities hosted by the service.

Throws:

ModelCommunicationException - Thrown if unable to communicate with the data store.

ObjectNotFoundException - Thrown if unable to locate the service in the data store. This may be due to an invalid distinguished name, or the entity may have been removed by another client.

getFlaggedNoncompliant

public SearchResults getFlaggedNoncompliant()
                                     throws ModelCommunicationException,
                                            ObjectNotFoundException

Returns all accounts hosted by the service including account on concrete and hosted services that have been flagged as non-compliant.

Returns:

SearchResults holding AccountEntities hosted by the service.

Throws:

ModelCommunicationException - Thrown if unable to communicate with the data store.

ObjectNotFoundException - Thrown if unable to locate the service in the data store. This may be due to an invalid distinguished name, or the entity may have been removed by another client.

getOwned

public SearchResults getOwned()
                       throws ModelCommunicationException,
                              ObjectNotFoundException

Returns all owned accounts hosted by the service.

Returns:

SearchResults holding owned AccountEntities hosted by the service.

Throws:

ModelCommunicationException - Thrown if unable to communicate with the data store.

ObjectNotFoundException - Thrown if unable to locate the service in the data store. This may be due to an invalid distinguished name, or the entity may have been removed by another client.

getOrphaned

public SearchResults getOrphaned()
                          throws ModelCommunicationException,
                                 ObjectNotFoundException

Returns all orphaned accounts hosted by the service.

Returns:

SearchResults holding orphaned AccountEntities hosted by the service.

Throws:

ModelCommunicationException - Thrown if unable to communicate with the data store.

ObjectNotFoundException - Thrown if unable to locate the service in the data store. This may be due to an invalid distinguished name, or the entity may have been removed by another client.

removeAll

public void removeAll()
               throws ModelCommunicationException,
                      ObjectNotFoundException,
                      ModelRemoveException

Removes all accounts hosted by the service. This operation is not "best effort", if an error occurs while removing accounts, the operation will stop, possibly leaving the remainder of accounts still in tact. This operation also removes all accounts on hosted service.

Throws:

ModelCommunicationException - Thrown if unable to communicate with the data store.

ModelRemoveException - Thrown if unable to remove an object of the data store.

ObjectNotFoundException - Thrown if unable to locate the service in the data store. This may be due to an invalid distinguished name, or the entity may have been removed by another client.

removeOrphaned

public void removeOrphaned()
                    throws ModelCommunicationException,
                           ModelRemoveException,
                           ObjectNotFoundException

Removes all orphaned accounts hosted by the service. This operation is not "best effort", if an error occurs while removing accounts, the operation will stop, possibly leaving the remainder of accounts still in tact.

Throws:

ModelCommunicationException - Thrown if unable to communicate with the data store.

ModelRemoveException - Thrown if unable to remove an object of the data store.

ObjectNotFoundException - Thrown if unable to locate the service in the data store. This may be due to an invalid distinguished name, or the entity may have been removed by another client.

getByOwner

public SearchResults getByOwner(DistinguishedName ownerDN)
                         throws ModelCommunicationException,
                                ObjectNotFoundException

Returns all accounts owned by the specified person.

Parameters:

ownerDN - DistinguishedName of the Person who owns the returned accounts.

Returns:

SearchResults holding AccountEntities for the given owner.

Throws:

ModelCommunicationException - Thrown if unable to communicate with the data store.

ObjectNotFoundException - Thrown if unable to locate the service in the data store. This may be due to an invalid distinguished name, or the entity may have been removed by another client.

getByFilter

public SearchResults getByFilter(java.lang.String filter)
                          throws ModelCommunicationException,
                                 ObjectNotFoundException

Returns all accounts matching the given filter.

Parameters:

filter - Filter that defines the criteria for returned AccountEntity to meet.

Returns:

SearchResults holding AccountEntities matching filter.

Throws:

ModelCommunicationException - Thrown if unable to communicate with the data store.

ObjectNotFoundException - Thrown if unable to locate the service in the data store. This may be due to an invalid distinguished name, or the entity may have been removed by another client.

getByFilter

public SearchResults getByFilter(java.lang.String filter,
                                 boolean useServiceTypeOptimization)
                          throws ModelCommunicationException,
                                 ObjectNotFoundException

Throws:

ModelCommunicationException

ObjectNotFoundException

getByUserID

public SearchResults getByUserID(java.lang.String userID)
                          throws ModelCommunicationException,
                                 ObjectNotFoundException

Returns all accounts hosted by the service with the given user id.

Parameters:

userID - User id to match.

Returns:

SearchResults holding matching AccountEntities hosted by the service.

Throws:

ModelCommunicationException - Thrown if unable to communicate with the data store.

ObjectNotFoundException - Thrown if unable to locate the service in the data store. This may be due to an invalid distinguished name, or the entity may have been removed by another client.

getOrphansByUserID

public SearchResults getOrphansByUserID(java.lang.String userID)
                                 throws ModelCommunicationException,
                                        ObjectNotFoundException

Returns all orphaned accounts hosted by the service with the given user id.

Parameters:

userID - User id to match.

Returns:

SearchResults holding matching orphaned AccountEntities hosted by the service.

Throws:

ModelCommunicationException - Thrown if unable to communicate with the data store.

ObjectNotFoundException - Thrown if unable to locate the service in the data store. This may be due to an invalid distinguished name, or the entity may have been removed by another client.

getOrphansByFilter

public SearchResults getOrphansByFilter(java.lang.String filter,
                                        SearchParameters params)
                                 throws ModelCommunicationException,
                                        ObjectNotFoundException

Returns all orphaned accounts hosted by the service with the given user id.

Parameters:

filter - Filter that defines the criteria for returned DynamicRoleEntities to meet. The filter must be in the format defined by RFC2254.

params - SearchParameters that provide additional context for how the search should be performed. Scope and size limit is not supported in this search. Only attribute lists can be provided.

Returns:

SearchResults holding matching orphaned AccountEntities hosted by the service.

Throws:

ModelCommunicationException - Thrown if unable to communicate with the data store.

ObjectNotFoundException - Thrown if unable to locate the service in the data store. This may be due to an invalid distinguished name, or the entity may have been removed by another client.