Interface PwMessage
-
- All Known Implementing Classes:
Session
public interface PwMessage
Interface is implemented bySession
and prescribes methods used to return Fortress password messages to the caller.- Author:
- Apache Directory Project
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description int
getErrorId()
Return the error id that pertain to User's password.int
getExpirationSeconds()
Get the number of seconds until the User's password expires.int
getGraceLogins()
Get the grace count which indicates how many binds User can perform before password slips into expired state.String
getMsg()
Return the message that corresponds to last password check.String
getUserId()
Set theUser.userId
in entity.List<Warning>
getWarnings()
Set the warning id that pertain to User's password.boolean
isAuthenticated()
If set to true the user's password check out good.void
setAuthenticated(boolean isAuthenticated)
If set to true the user's password check out good.void
setErrorId(int error)
Set the error id that pertain to User's password.void
setExpirationSeconds(int expire)
The number of seconds until the User's password expires.void
setGraceLogins(int grace)
Grace count indicates how many binds User can perform before password slips into expired state.void
setMsg(String message)
Contains the message that corresponds to password.void
setUserId(String userId)
Return theUser.userId
from entity.void
setWarning(Warning warning)
Return the warning id that pertain to User's password.void
setWarnings(List<Warning> warnings)
-
-
-
Method Detail
-
setUserId
void setUserId(String userId)
Return theUser.userId
from entity.- Parameters:
userId
- maps touid
attribute on inetOrgPerson object class.
-
getUserId
String getUserId()
Set theUser.userId
in entity.- Returns:
- userId maps to
uid
attribute on inetOrgPerson object class.
-
setMsg
void setMsg(String message)
Contains the message that corresponds to password. These messages map toGlobalPwMsgIds.pwMsgs
- Parameters:
message
-
-
getMsg
String getMsg()
Return the message that corresponds to last password check.- Returns:
- message maps to
GlobalPwMsgIds.pwMsgs
-
setAuthenticated
void setAuthenticated(boolean isAuthenticated)
If set to true the user's password check out good.- Parameters:
isAuthenticated
-
-
isAuthenticated
boolean isAuthenticated()
If set to true the user's password check out good.- Returns:
- param isAuthenticated
-
setWarning
void setWarning(Warning warning)
Return the warning id that pertain to User's password. This attribute maps to values between 0 and 100 contained within hereGlobalPwMsgIds
- Parameters:
warning
- contains warning id.
-
getWarnings
List<Warning> getWarnings()
Set the warning id that pertain to User's password. This attribute maps to values between 0 and 100 contained within hereGlobalPwMsgIds
- Returns:
- warning contains warning id.
-
setErrorId
void setErrorId(int error)
Set the error id that pertain to User's password. This attribute maps to values greater than or equal to 100 contained within hereGlobalPwMsgIds
- Parameters:
error
- contains error id that maps toGlobalPwMsgIds.pwIds
-
getErrorId
int getErrorId()
Return the error id that pertain to User's password. This attribute maps to values greater than or equal to 100 contained within hereGlobalPwMsgIds
- Returns:
- error contains error id that maps to
GlobalPwMsgIds.pwIds
-
setGraceLogins
void setGraceLogins(int grace)
Grace count indicates how many binds User can perform before password slips into expired state.- Parameters:
grace
- integer containing number of binds allowed for user.
-
getGraceLogins
int getGraceLogins()
Get the grace count which indicates how many binds User can perform before password slips into expired state.- Returns:
- grace integer containing number of binds allowed for user.
-
setExpirationSeconds
void setExpirationSeconds(int expire)
The number of seconds until the User's password expires.- Parameters:
expire
- value is computed by ldap server and contains the number of seconds until password will expire.
-
getExpirationSeconds
int getExpirationSeconds()
Get the number of seconds until the User's password expires.- Returns:
- expire value is computed by ldap server and contains the number of seconds until password will expire.
-
-