@PublicAPI(stability=VOLATILE, mayInstantiate=false, mayExtend=false, mayInvoke=true) public final class AccountStatusNotification extends Object
Constructor and Description |
---|
AccountStatusNotification(AccountStatusNotificationType notificationType,
Entry userEntry,
LocalizableMessage message,
Map<AccountStatusNotificationProperty,List<String>> notificationProperties)
Creates a new account status notification object with the provided information.
|
Modifier and Type | Method and Description |
---|---|
static Map<AccountStatusNotificationProperty,List<String>> |
createProperties(PasswordPolicyState pwPolicyState,
boolean tempLocked,
int timeToExpiration,
List<ByteString> oldPasswords,
List<ByteString> newPasswords)
Creates a set of account status notification properties from the provided information.
|
LocalizableMessage |
getMessage()
Retrieves a message that provides additional information for this account status notification.
|
Map<AccountStatusNotificationProperty,List<String>> |
getNotificationProperties()
Retrieves a set of properties that may provide additional information for this account status notification.
|
List<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.
|
String |
toString()
Retrieves a string representation of this account status notification.
|
public AccountStatusNotification(AccountStatusNotificationType notificationType, Entry userEntry, LocalizableMessage message, Map<AccountStatusNotificationProperty,List<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.public AccountStatusNotificationType getNotificationType()
public Dn getUserDN()
public Entry getUserEntry()
public LocalizableMessage getMessage()
public Map<AccountStatusNotificationProperty,List<String>> getNotificationProperties()
public List<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 Map<AccountStatusNotificationProperty,List<String>> createProperties(PasswordPolicyState pwPolicyState, boolean tempLocked, int timeToExpiration, List<ByteString> oldPasswords, List<ByteString> 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.Copyright 2010-2020 ForgeRock AS.