com.ibm.itim.apps.pim

Class CredentialLeaseMO

java.lang.Object

com.ibm.itim.apps.pim.CredentialLeaseMO

All Implemented Interfaces:

java.io.Serializable

public class CredentialLeaseMO
extends java.lang.Object
implements java.io.Serializable

This is a managed object that represents a credential lease. A credential lease is created by a checkout operation, and removed by a checkin operation.

Since:

6.0

See Also:

CredentialLease, CredentialLeaseManager, Serialized Form

Constructor Summary

Constructors

Constructor and Description
CredentialLeaseMO(PlatformContext platform, javax.security.auth.Subject subject, DistinguishedName name) This API constructs the the managed object with a platform context, a subject, and the distinguished name of the object to manage.

Method Summary

Methods

Modifier and Type	Method and Description
Request	checkin() This API provides the credential checkin function.
CredentialMO	getCredential() This API returns the credential that this lease presents.
CredentialLease	getData() This API returns a current snapshot of the credential lease.
DistinguishedName	getDistinguishedName() This API returns the distinguished name of the managed object
PersonMO	getLessee() This API returns the person who holds this lease.

Methods inherited from class java.lang.Object

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

Constructor Detail

CredentialLeaseMO

public CredentialLeaseMO(PlatformContext platform,
                 javax.security.auth.Subject subject,
                 DistinguishedName name)

This API constructs the the managed object with a platform context, a subject, and the distinguished name of the object to manage.

Parameters:

platform - This parameter specifies the PlatformContext that holds platform connection information.

subject - This parameter specifies the Subject that represents the authenticated caller.

name - This parameter specifies the DistinguishedName of the credential lease.

Method Detail

getDistinguishedName

public DistinguishedName getDistinguishedName()

This API returns the distinguished name of the managed object

getData

public CredentialLease getData()
                        throws java.rmi.RemoteException,
                               ApplicationException

This API returns a current snapshot of the credential lease.

Returns:

CredentialLease object that holds the attribute information.

Throws:

java.rmi.RemoteException - This exception is thrown if the API cannot communicate with the platform.

ApplicationException - This exception is thrown if the API cannot retrieve data.

getCredential

public CredentialMO getCredential()
                           throws java.rmi.RemoteException,
                                  ApplicationException

This API returns the credential that this lease presents.

Returns:

CredentialMO that represents the credential.

Throws:

java.rmi.RemoteException - This exception is thrown if the API is unable to communicate with platform.

ApplicationException - This exception is thrown if the API is unable to retrieve the credential. The exception can possibly be caused by the credential being removed by another client before this call.

getLessee

public PersonMO getLessee()
                   throws java.rmi.RemoteException,
                          ApplicationException

This API returns the person who holds this lease.

Returns:

PersonMO that represents the person.

Throws:

java.rmi.RemoteException - This exception is thrown if the API is unable to communicate with platform.

ApplicationException - This exception is thrown if the API is unable to retrieve the person. The exception can possibly be caused by the person being removed by another client before this call.

checkin

public Request checkin()
                throws java.rmi.RemoteException,
                       ApplicationException

This API provides the credential checkin function. If password reset is required for the credential, the credential password will be reset and the lease object will be removed from the data store. If the checkin request fails to be submitted, the ApplicationException will be thrown.

Returns:

Request that represents the checkin operation status.

Throws:

java.rmi.RemoteException - This Exception is thrown if the API is unable to communicate with platform.

ApplicationException - This Exception is thrown if the system is unable to submit the request. The problem can be caused by the fact that the authenticated user is not the person who checked out the credential, or the credential being checked in is removed by another client before this call.