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

java.lang.Object
  com.ibm.itim.dataservices.model.pim.CredentialSetting

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

GlobalCredentialSetting

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

This class holds the credential settings for a credential object in the data model.

Since:

6.0

See Also:

Crdential, Serialized Form

Constructor Summary

CredentialSetting(Credential.AccessMode accessMode)
This Constructor is intended for the non-shared credential.

CredentialSetting(Credential.AccessMode accessMode, java.lang.Boolean passwordViewable)
This Constructor is intended for non-exclusive credential.

CredentialSetting(Credential.AccessMode accessMode, java.lang.Boolean resetPassword, int checkoutDuration, java.lang.Boolean searchEnabled, java.lang.Boolean passwordViewable)
This Constructor is intended for the exclusive credential.

Method Summary

Credential.AccessMode	getAccessMode() This API returns the credential access mode, which can be AccessMode.NOT_SET, AccessMode.EXCLUSIVE, AccessMode.NONEXCLUSIVE, or AccessMode.NONSHARED.
int	getCheckoutDuration() This API returns the maximum checkout time.
java.lang.Boolean	isCheckoutSearchEnable() This API returns a boolean value represent if the credential is defined to be searchable during checkout.
boolean	isExclusive() This API returns true if the access mode is AccessModel.EXCLSUIVE and returns false otherwise.
boolean	isHidePasswordEnable() This API returns true if checkout is required for the credential.
java.lang.Boolean	isPasswordViewable() This API returns true if the password can be displayed to user after the checkout and return false otherwise.
java.lang.Boolean	isResetPasswordAtCheckin() This API returns a boolean value representing if the password will be reset upon checkin.
void	setAccessMode(Credential.AccessMode accessMode) This API sets the credential access mode, which can be AccessMode.NOT_SET, AccessMode.EXCLUSIVE, AccessMode.NONEXCLUSIVE, or AccessMode.NONSHARED.
void	setCheckoutDuration(int checkoutDuration) This API sets the maximum checkout time.
void	setIsCheckoutSearchEnable(java.lang.Boolean isSearchEnabled) This API sets a boolean value represent if the credential is defined to be searchable during checkout.
void	setIsPasswordViewable(java.lang.Boolean isPasswordViewable) This API set if the password can be displayed to user after the checkout and return false otherwise.
void	setIsResetPasswordAtCheckin(java.lang.Boolean isResetPasswordAtCheckin) This API sets a boolean value representing if the password will be reset upon checkin.

Methods inherited from class java.lang.Object

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

Constructor Detail

CredentialSetting

public CredentialSetting(Credential.AccessMode accessMode,
                         java.lang.Boolean resetPassword,
                         int checkoutDuration,
                         java.lang.Boolean searchEnabled,
                         java.lang.Boolean passwordViewable)

This Constructor is intended for the exclusive credential.

Parameters:

accessMode - Credential.AccessMode This parameter specifies the enum constant. Refer to Credential.CRED_ATTR_IS_EXCLUSIVE.

resetPassword - boolean This parameter specifies the boolean value that decides whether the password needs to be reset during checkin.

checkoutDuration - int This parameter specifies the maximum checkout time in hours.

searchEnabled - boolean This parameter specifies the boolean value that decides whether the credential is searchable during the checkout process.

passwordViewable - boolean This parameter specifies the boolean value that decides whether the password can be displayed to user after the checkout.

CredentialSetting

public CredentialSetting(Credential.AccessMode accessMode,
                         java.lang.Boolean passwordViewable)

This Constructor is intended for non-exclusive credential.

Parameters:

accessMode - Credential.AccessMode This parameter specifies the enum constant. Refer to Credential.CRED_ATTR_IS_EXCLUSIVE.

passwordViewable - boolean This parameter specifies the boolean value that decides whether the password can be displayed to user after the checkout.

CredentialSetting

public CredentialSetting(Credential.AccessMode accessMode)

This Constructor is intended for the non-shared credential.

Parameters:

accessMode - Credential.AccessMode This parameter specifies the enum constant.

Method Detail

isCheckoutSearchEnable

public java.lang.Boolean isCheckoutSearchEnable()

This API returns a boolean value represent if the credential is defined to be searchable during checkout.

Returns:

true if the credential is searchable during checkout,
false otherwise.
null if the value is not set

setIsCheckoutSearchEnable

public void setIsCheckoutSearchEnable(java.lang.Boolean isSearchEnabled)

This API sets a boolean value represent if the credential is defined to be searchable during checkout.

Parameters:

true - if the credential is searchable during checkout,
false otherwise.

isResetPasswordAtCheckin

public java.lang.Boolean isResetPasswordAtCheckin()

This API returns a boolean value representing if the password will be reset upon checkin.

Returns:

true if the password will be after the checkin
false otherwise.
null if the value is not set, caller need to obtain value from global credential setting

setIsResetPasswordAtCheckin

public void setIsResetPasswordAtCheckin(java.lang.Boolean isResetPasswordAtCheckin)

This API sets a boolean value representing if the password will be reset upon checkin.

Parameters:

true - if the password will be after the checkin
false otherwise.

getCheckoutDuration

public int getCheckoutDuration()

This API returns the maximum checkout time.

Returns:

int value represents the maximum checkout time allowed in hours.

setCheckoutDuration

public void setCheckoutDuration(int checkoutDuration)

This API sets the maximum checkout time.

Parameters:

int - value represents the maximum checkout time allowed in hours.

isPasswordViewable

public java.lang.Boolean isPasswordViewable()

This API returns true if the password can be displayed to user after the checkout and return false otherwise.
null if the value is not set, caller need to obtain value from global credential setting

setIsPasswordViewable

public void setIsPasswordViewable(java.lang.Boolean isPasswordViewable)

This API set if the password can be displayed to user after the checkout and return false otherwise.

getAccessMode

public Credential.AccessMode getAccessMode()

This API returns the credential access mode, which can be AccessMode.NOT_SET, AccessMode.EXCLUSIVE, AccessMode.NONEXCLUSIVE, or AccessMode.NONSHARED. If the access mode is NOT_SET, use global credential setting to determine access mode

Returns:

The API returns the enum constant of the credential access mode.

setAccessMode

public void setAccessMode(Credential.AccessMode accessMode)

This API sets the credential access mode, which can be AccessMode.NOT_SET, AccessMode.EXCLUSIVE, AccessMode.NONEXCLUSIVE, or AccessMode.NONSHARED.

isExclusive

public boolean isExclusive()

This API returns true if the access mode is AccessModel.EXCLSUIVE and returns false otherwise.

isHidePasswordEnable

public boolean isHidePasswordEnable()

This API returns true if checkout is required for the credential. It returns false otherwise. When true, the user cannot enter a password during a change or reset password task. Also, the user cannot enter a password during any restore account tasks that require a password.
In each of these cases:
1) a password is generated by the system,
2) the user is not allowed to view the generated password, and
3) the account owner does not receive email notification for the new password.

The user must check out the credential to retrieve the current password of the credential.

Since:

6.0