com.ibm.itim.dataservices.model.pim

Class CredentialLease

java.lang.Object

com.ibm.itim.dataservices.model.DirectoryEntry

com.ibm.itim.dataservices.model.DirectoryObject

com.ibm.itim.dataservices.model.pim.CredentialLease

All Implemented Interfaces:

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

public class CredentialLease
extends DirectoryObject

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

Since:

6.0

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CredentialLease.STATUS Enumeration of status

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	LEASE_ATTR_CREATE_TIME This is a constant for the lease creation time attribute for expired lease
static java.lang.String	LEASE_ATTR_CREDENTIAL This is a constant for the credential attribute.
static java.lang.String	LEASE_ATTR_CUSTOM_ATTRIBUTE_1 This is a constant for the custom attribute 1
static java.lang.String	LEASE_ATTR_CUSTOM_ATTRIBUTE_2 This is a constant for the custom attribute 2
static java.lang.String	LEASE_ATTR_CUSTOM_ATTRIBUTE_3 This is a constant for the custom attribute 3
static java.lang.String	LEASE_ATTR_CUSTOM_ATTRIBUTE_4 This is a constant for the custom attribute 4
static java.lang.String	LEASE_ATTR_CUSTOM_ATTRIBUTE_5 This is a constant for the custom attribute 5
static java.lang.String	LEASE_ATTR_EXPIRATION_TIME This is a constant for the lease expiration time attribute name.
static java.lang.String	LEASE_ATTR_JUSTIFICATION This is a constant for the business justification attribute
static java.lang.String	LEASE_ATTR_LAST_NOTIFICATION This is a constant for the last notification time attribute for expired lease
static java.lang.String	LEASE_ATTR_LESSEE This is a constant for the lessee attribute
static java.lang.String	LEASE_ATTR_LESSEE_NAME This is a constant for the lessee name attribute
static java.lang.String	LEASE_ATTR_POOL_DN This is a constant for the pool DN
static java.lang.String	LEASE_ATTR_STATUS This is a constant for the lease status
static java.lang.String	PROFILE_NAME This is a constant for the lease 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.util.Sortable

ATTR_NAME

Constructor Summary

Constructors

Constructor and Description
CredentialLease() This is the default constructor
CredentialLease(AttributeValues attrs) This constructor creates the object with the attribute information.
CredentialLease(DirectoryObject dirObj) This is a copy constructor for directory object

Method Summary

Methods

Modifier and Type	Method and Description
java.util.Date	getCreateTime() This API returns the creation time of the lease.
DistinguishedName	getCredentialDN() This API returns the credential Distinguished Name.
java.util.Date	getExpirationTime() This API returns the expiration time of the lease.
java.lang.String	getJustification() This API returns business justification for the lease.
java.util.Date	getLastNotification() This API returns the time when the expiration was last notified.
DistinguishedName	getLesseeDN() Returns the lessee Distinguished Name.
java.lang.String	getName() The lease does not have a name.
boolean	isActive() This API returns the status of the lease.
void	setCreateTime(java.util.Date time) This API sets the lease creation time.
void	setExpirationTime(java.util.Date time) This API sets the lease expiration time.
void	setJustification(java.lang.String justification) This API sets the business justification for the lease.
void	setLastNotification(java.util.Date time) This API sets the the time when the expiration was last notified.

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

addAttribute, addAttributeValues, getAccessRights, getAttribute, getAttributes, getAuthorizationOwners, getMapAttributeNames, getMappedAttributes, 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

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

Field Detail

PROFILE_NAME

public static java.lang.String PROFILE_NAME

This is a constant for the lease profile name

LEASE_ATTR_CREDENTIAL

public static java.lang.String LEASE_ATTR_CREDENTIAL

This is a constant for the credential attribute.

LEASE_ATTR_EXPIRATION_TIME

public static java.lang.String LEASE_ATTR_EXPIRATION_TIME

This is a constant for the lease expiration time attribute name.

LEASE_ATTR_LESSEE

public static java.lang.String LEASE_ATTR_LESSEE

This is a constant for the lessee attribute

LEASE_ATTR_LESSEE_NAME

public static java.lang.String LEASE_ATTR_LESSEE_NAME

This is a constant for the lessee name attribute

LEASE_ATTR_JUSTIFICATION

public static java.lang.String LEASE_ATTR_JUSTIFICATION

This is a constant for the business justification attribute

LEASE_ATTR_CUSTOM_ATTRIBUTE_1

public static java.lang.String LEASE_ATTR_CUSTOM_ATTRIBUTE_1

This is a constant for the custom attribute 1

LEASE_ATTR_CUSTOM_ATTRIBUTE_2

public static java.lang.String LEASE_ATTR_CUSTOM_ATTRIBUTE_2

This is a constant for the custom attribute 2

LEASE_ATTR_CUSTOM_ATTRIBUTE_3

public static java.lang.String LEASE_ATTR_CUSTOM_ATTRIBUTE_3

This is a constant for the custom attribute 3

LEASE_ATTR_CUSTOM_ATTRIBUTE_4

public static java.lang.String LEASE_ATTR_CUSTOM_ATTRIBUTE_4

This is a constant for the custom attribute 4

LEASE_ATTR_CUSTOM_ATTRIBUTE_5

public static java.lang.String LEASE_ATTR_CUSTOM_ATTRIBUTE_5

This is a constant for the custom attribute 5

LEASE_ATTR_POOL_DN

public static java.lang.String LEASE_ATTR_POOL_DN

This is a constant for the pool DN

LEASE_ATTR_STATUS

public static java.lang.String LEASE_ATTR_STATUS

This is a constant for the lease status

LEASE_ATTR_LAST_NOTIFICATION

public static java.lang.String LEASE_ATTR_LAST_NOTIFICATION

This is a constant for the last notification time attribute for expired lease

LEASE_ATTR_CREATE_TIME

public static java.lang.String LEASE_ATTR_CREATE_TIME

This is a constant for the lease creation time attribute for expired lease

Constructor Detail

CredentialLease

public CredentialLease()

This is the default constructor

CredentialLease

public CredentialLease(AttributeValues attrs)

This constructor creates the object with the attribute information. Warning: the purpose of this constructor is to provide the clients with the ability to create value objects in the data store. Do not use this constructor to create value objects that represent the existing entities. Use the CredentialLeaseSearch class for retrieving the existing entities.

Parameters:

attrs - AttributeValues that hold the attributes of the role.

CredentialLease

public CredentialLease(DirectoryObject dirObj)

This is a copy constructor for directory object

Method Detail

getName

public java.lang.String getName()

The lease does not have a name. It returns an empty String.

Overrides:

getName in class DirectoryObject

Returns:

an empty String.

getJustification

public java.lang.String getJustification()

This API returns business justification for the lease.

Returns:

String value of the business justification.

setJustification

public void setJustification(java.lang.String justification)

This API sets the business justification for the lease.

Parameters:

justification - String value.

getExpirationTime

public java.util.Date getExpirationTime()

This API returns the expiration time of the lease.

Returns:

the lease expiration time.

setExpirationTime

public void setExpirationTime(java.util.Date time)

This API sets the lease expiration time.

Parameters:

time - Date the expiration time.

getCredentialDN

public DistinguishedName getCredentialDN()

This API returns the credential Distinguished Name.

Returns:

the DistinguishedName of the credential.

getLesseeDN

public DistinguishedName getLesseeDN()

Returns the lessee Distinguished Name.

Returns:

the DistinguishedName of the lessee.

isActive

public boolean isActive()

This API returns the status of the lease. In asynchronous mode, when a credential is checked out and is pending in workflow, the lease is inactive. Lease is made active upon completion of check out.

Returns:

boolean indicates if the lease is active

getLastNotification

public java.util.Date getLastNotification()

This API returns the time when the expiration was last notified.

Returns:

Date containing the last time when a notification was sent by the system.

setLastNotification

public void setLastNotification(java.util.Date time)

This API sets the the time when the expiration was last notified.

Parameters:

time - a Date object represeting the last notification was sent.

getCreateTime

public java.util.Date getCreateTime()

This API returns the creation time of the lease.

Returns:

the lease creation time.

setCreateTime

public void setCreateTime(java.util.Date time)

This API sets the lease creation time.

Parameters:

time - Date the creation time.