com.ibm.itim.dataservices.model.pim
Class CredentialPool

java.lang.Object
  com.ibm.itim.dataservices.model.DirectoryEntry
      com.ibm.itim.dataservices.model.DirectoryObject
          com.ibm.itim.dataservices.model.pim.CredentialPool

All Implemented Interfaces:

CredentialComponent, ProtectedObject, com.ibm.itim.util.Sortable, com.ibm.itim.util.xml.objectstream.Importable, java.io.Serializable

public class CredentialPool
extends DirectoryObject
implements CredentialComponent

This value Object class holds the attribute information of a credential pool in the data model.

Since:

6.0

See Also:

Serialized Form

Field Summary

static java.lang.String	CRED_POOL_ATTR_GROUPS This is a constant for the service group attribute
static java.lang.String	CRED_POOL_ATTR_OWNER This is a constant for the owner attribute
static java.lang.String	CRED_POOL_ATTR_PARENT_CONTAINER This is a constant for the organizational container
static java.lang.String	CRED_POOL_ATTR_SERVICE This is a constant for the service attribute
static java.lang.String	PROFILE_NAME This is a constant for the credential pool profile name

Fields inherited from class com.ibm.itim.dataservices.model.DirectoryObject

ATTR_ACCESS_RIGHT, ATTR_LIFECYCLE_ENABLE, ATTR_URI, DESCRIPTION, NAME

Fields inherited from interface com.ibm.itim.dataservices.model.pim.CredentialComponent

CRED_ATTR_DESCRIPTION, CRED_ATTR_NAME, CRED_ATTR_PARENT, CRED_ATTR_PROFILE_NAME, CRED_USE_GLOBAL_SETTINGS

Fields inherited from interface com.ibm.itim.util.Sortable

ATTR_NAME

Constructor Summary

CredentialPool()
The default constructor.

CredentialPool(AttributeValues attrs)
Constructs object with attribute information.

CredentialPool(DirectoryObject dirObj)
Copy constructor for directory object

CredentialPool(java.lang.String name, Service service, OrganizationalContainer orgContainer, java.util.List<Group> groups, java.util.List<DistinguishedName> owners)
Constructs object with attribute information.

Method Summary

void	addGroups(java.util.Collection<DistinguishedName> groups) Adds groups to the credential pool definition.
boolean	equals(java.lang.Object obj) This API compares this credential pool with the passing object.
DistinguishedName	getBusinessUnitDN() This API returns the distinguished name of organizational container of the credential pool.
java.lang.String	getDescription() This API sets the lease expiration time.
java.util.Collection<DistinguishedName>	getGroupDNs() Returns the collection of DistinguishedName that are defined as the groups(s) for this credential pool
java.util.Collection<DistinguishedName>	getOwnerDNs() Returns the collection of DistinguishedName that are defined as the owner(s) for this credential pool
DistinguishedName	getServiceDN() This API returns the credential pool's service DN.
int	hashCode() Returns a hash value that can be used in hash tables.
boolean	isPool() This API always returns true.
void	removeGroups(java.util.Collection<DistinguishedName> groups) Removes group(s) from the credential pool definition.
void	removeOwnerDNs() Removes the owner(s) of the credential pool by removing the owner attribute.
void	setDescription(java.lang.String description) This API changes the description of the credential pool.
void	setGroups(java.util.Collection<DistinguishedName> groups) Sets the value of the owner attribute.
void	setName(java.lang.String name) This API sets the credential pool name.
void	setOwnerDNs(java.util.Collection<DistinguishedName> owners) Sets the value of the owner attribute.

Methods inherited from class com.ibm.itim.dataservices.model.DirectoryObject

addAttribute, addAttributeValues, getAccessRights, getAttribute, getAttributes, getAuthorizationOwners, getMapAttributeNames, getMappedAttributes, getName, getNameAttribute, getOldMappedAttributes, getProfileName, getRawAttributes, getSortValue, getTenantDN, isLifecycleDefined, removeAttribute, removeAttribute, setAccessRights, setAttribute, setAttributes, setAuthorizationOwners, setProfileName, setTenantDN, toString

Methods inherited from class com.ibm.itim.dataservices.model.DirectoryEntry

clearChange, clearChanges, getChanges, getDistinguishedName, getLastModified, getObjectClasses, getOldAttributes, setDistinguishedName

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.ibm.itim.dataservices.model.pim.CredentialComponent

getDistinguishedName, getName

Field Detail

PROFILE_NAME

public static java.lang.String PROFILE_NAME

This is a constant for the credential pool profile name

CRED_POOL_ATTR_GROUPS

public static java.lang.String CRED_POOL_ATTR_GROUPS

This is a constant for the service group attribute

CRED_POOL_ATTR_OWNER

public static java.lang.String CRED_POOL_ATTR_OWNER

This is a constant for the owner attribute

CRED_POOL_ATTR_PARENT_CONTAINER

public static java.lang.String CRED_POOL_ATTR_PARENT_CONTAINER

This is a constant for the organizational container

CRED_POOL_ATTR_SERVICE

public static java.lang.String CRED_POOL_ATTR_SERVICE

This is a constant for the service attribute

Constructor Detail

CredentialPool

public CredentialPool(AttributeValues attrs)

Constructs object with attribute information. Warning: the purpose of this constructor is to provide clients with the ability to create value objects for creation in the data store. Do not use this constructor to create value objects that represent existing entities. See the RoleSearch object for achieving that.

Parameters:

attrs - AttributeValues holding the attributes of the credential pool.

CredentialPool

public CredentialPool()

The default constructor.

CredentialPool

public CredentialPool(DirectoryObject dirObj)

Copy constructor for directory object

CredentialPool

public CredentialPool(java.lang.String name,
                      Service service,
                      OrganizationalContainer orgContainer,
                      java.util.List<Group> groups,
                      java.util.List<DistinguishedName> owners)

Constructs object with attribute information.
Warning: the purpose of this constructor is to provide clients with the ability to create value objects for creation in the data store. Do not use this constructor to create value objects that represent existing entities. See the CredentialPoolSearch object for achieving that.

Parameters:

name - String "name" attribute value for the credential pool

service - Service the service instance that the credential pool refers to

orgContainer - OrganizationContainer where the credential pool resides

groups - List service groups that defines the credential pool

owners - List the person owners and role owners of the credential pool

Method Detail

setName

public void setName(java.lang.String name)

This API sets the credential pool name.

Specified by:

setName in interface CredentialComponent

Parameters:

name - the user friendly name of the credential pool.

getDescription

public java.lang.String getDescription()

This API sets the lease expiration time.

Parameters:

time - Date the expiration time.

setDescription

public void setDescription(java.lang.String description)

This API changes the description of the credential pool.

Parameters:

description - string value of the description.

getBusinessUnitDN

public DistinguishedName getBusinessUnitDN()

This API returns the distinguished name of organizational container of the credential pool.

Returns:

DistinguishedName represents credential pool's organizational container DN.

getServiceDN

public DistinguishedName getServiceDN()

This API returns the credential pool's service DN.

Returns:

DistinguishedName represents credential pool's service DN.

getOwnerDNs

public java.util.Collection<DistinguishedName> getOwnerDNs()

Returns the collection of DistinguishedName that are defined as the owner(s) for this credential pool

Returns:

Collection of DistinguishedName that contains the owners that are defined for this credential pool. This collection contains a collection of role DNs and / or a collection of person DNs. There is no referential integrity checking for the DNs returned by this call.

setOwnerDNs

public void setOwnerDNs(java.util.Collection<DistinguishedName> owners)

Sets the value of the owner attribute. Only collections of Org Role DNs and/or collections of Person DNs should be used (can be a mix)

Parameters:

owners - The collection of DistinguishedName to set as the owners for this credential pool. If NULL is specified, all owners for the credential pool will be removed.

removeOwnerDNs

public void removeOwnerDNs()

Removes the owner(s) of the credential pool by removing the owner attribute.

getGroupDNs

public java.util.Collection<DistinguishedName> getGroupDNs()

Returns the collection of DistinguishedName that are defined as the groups(s) for this credential pool

Returns:

Collection of DistinguishedName that contains the groups that are defined for this credential pool. There is no referential integrity checking for the DNs returned by this call.

setGroups

public void setGroups(java.util.Collection<DistinguishedName> groups)

Sets the value of the owner attribute. Only collections of Group DNs should be used.

Parameters:

groups - The collection of DistinguishedNames to set as the groups for this credential pool. If NULL is specified, all groups for the credential pool will be removed.

removeGroups

public void removeGroups(java.util.Collection<DistinguishedName> groups)

Removes group(s) from the credential pool definition.

Parameters:

groups - specifies the DNS of the groups to be removed.

addGroups

public void addGroups(java.util.Collection<DistinguishedName> groups)

Adds groups to the credential pool definition.

Parameters:

groups - specifies the DNS of the groups to be added.

isPool

public boolean isPool()

This API always returns true.

Specified by:

isPool in interface CredentialComponent

Returns:

true if this is a credential pool; false otherwise.

equals

public boolean equals(java.lang.Object obj)

This API compares this credential pool with the passing object.

Overrides:

equals in class java.lang.Object

Returns:

This API returns true if they are equivalent; otherwise, it returns false

hashCode

public int hashCode()

Returns a hash value that can be used in hash tables.

Overrides:

hashCode in class java.lang.Object

Returns:

Hash value for the distinguished name.