|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.opends.server.types.AccountStatusNotification
@PublicAPI(stability=VOLATILE, mayInstantiate=false, mayExtend=false, mayInvoke=true) public final class AccountStatusNotification
This class defines a data type for storing information associated with an account status notification.
Constructor Summary | |
---|---|
AccountStatusNotification(AccountStatusNotificationType notificationType,
Entry userEntry,
Message message,
java.util.Map<AccountStatusNotificationProperty,java.util.List<java.lang.String>> notificationProperties)
Creates a new account status notification object with the provided information. |
Method Summary | |
---|---|
static java.util.Map<AccountStatusNotificationProperty,java.util.List<java.lang.String>> |
createProperties(PasswordPolicyState pwPolicyState,
boolean tempLocked,
int timeToExpiration,
java.util.List<AttributeValue> oldPasswords,
java.util.List<AttributeValue> newPasswords)
Creates a set of account status notification properties from the provided information. |
Message |
getMessage()
Retrieves a message that provides additional information for this account status notification. |
java.util.Map<AccountStatusNotificationProperty,java.util.List<java.lang.String>> |
getNotificationProperties()
Retrieves a set of properties that may provide additional information for this account status notification. |
java.util.List<java.lang.String> |
getNotificationProperty(AccountStatusNotificationProperty property)
Retrieves the set of values for the specified account status notification property. |
AccountStatusNotificationType |
getNotificationType()
Retrieves the notification type for this account status notification. |
DN |
getUserDN()
Retrieves the DN of the user entry to which this notification applies. |
Entry |
getUserEntry()
Retrieves user entry for whom this notification applies. |
java.lang.String |
toString()
Retrieves a string representation of this account status notification. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public AccountStatusNotification(AccountStatusNotificationType notificationType, Entry userEntry, Message message, java.util.Map<AccountStatusNotificationProperty,java.util.List<java.lang.String>> notificationProperties)
notificationType
- The type for this account status
notification.userEntry
- The entry for the user to whom
this notification applies.message
- The human-readable message for
this notification.notificationProperties
- A set of properties that may
include additional information
about this notification.Method Detail |
---|
public AccountStatusNotificationType getNotificationType()
public DN getUserDN()
public Entry getUserEntry()
public Message getMessage()
public java.util.Map<AccountStatusNotificationProperty,java.util.List<java.lang.String>> getNotificationProperties()
public java.util.List<java.lang.String> getNotificationProperty(AccountStatusNotificationProperty property)
property
- The account status notification property for
which to retrieve the associated values.
null
if the specified
property is not defined for this account status
notification.@PublicAPI(stability=PRIVATE, mayInstantiate=false, mayExtend=false, mayInvoke=false) public static java.util.Map<AccountStatusNotificationProperty,java.util.List<java.lang.String>> createProperties(PasswordPolicyState pwPolicyState, boolean tempLocked, int timeToExpiration, java.util.List<AttributeValue> oldPasswords, java.util.List<AttributeValue> newPasswords)
pwPolicyState
- The password policy state for the user
associated with the notification.tempLocked
- Indicates whether the user's account
has been temporarily locked.timeToExpiration
- The length of time in seconds until the
user's password expires, or -1 if it's
not about to expire.oldPasswords
- The set of old passwords for the user,
or null
if this is not
applicable.newPasswords
- The set of new passwords for the user,
or null
if this is not
applicable.
public java.lang.String toString()
toString
in class java.lang.Object
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |