public class ClientAccountManager extends atg.rmi.RemoteExceptionManager implements AccountManager
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
CLASS_VERSION |
ANY_ACCOUNT, GROUP_ACCOUNT, LOGIN_ACCOUNT, PRIVILEGE_ACCOUNT
Constructor and Description |
---|
ClientAccountManager(RemoteAccountManager pRemoteManager)
Wraps a client-side AccountManager object around a RemoteAccountManager
reference.
|
Modifier and Type | Method and Description |
---|---|
Account |
createAccount(java.lang.String pAccountName,
int pType,
java.util.Map pAttributes)
Creates a new account with a given set of attributes.
|
Account |
getAccount(java.lang.String pAccountName)
Retrieves the account object for the account with the given name.
|
int |
getCacheTimeout()
Returns the length of time, in seconds, an account object remains
valid in the cache.
|
java.lang.String |
getDescriptionAttribute()
Returns the name of the group or privilege account attribute that
describes the account in human-readable terms.
|
java.lang.String |
getFirstNameAttribute()
Returns the name of the attribute that contains the first name of
the owner of a login account.
|
java.lang.String |
getLastNameAttribute()
Returns the name of the attribute that contains the last name of
the owner of a login account.
|
java.lang.String |
getPasswordAttribute()
Returns the name of hte attribute that contains the password for
a login account.
|
PasswordHasher |
getPasswordHasher()
Returns the password hasher that should be used to encrypt the password
attribute of an account.
|
java.lang.String |
getPasswordHasherAttribute()
Returns the name of the attribute that contains the password hasher
component path for a login account.
|
atg.security.PasswordHasherConfigurer |
getPasswordHasherConfigurer()
Returns the password hasher configurer which provides different password
hasher based on crypto agility mechanism.
|
void |
invalidate()
Invalidates the account cache.
|
void |
invalidate(java.lang.String pAccountName)
Invalidates an account in the account cache.
|
java.util.Iterator |
listAccounts(int pType)
Returns an iterator of accounts with a particular set of types.
|
java.util.Iterator |
listMatchingAccounts(java.lang.String pExpression,
int pType)
Lists accounts that match a given expression.
|
void |
removeAccount(java.lang.String pAccountName)
Removes an account with the indicated name, if possible.
|
void |
setCacheTimeout(int pTimeout)
Changes the length of time an account object remains valid in the
cache.
|
void |
setPasswordHasherAttribute(java.lang.String pPasswordHasherAttribute) |
public ClientAccountManager(RemoteAccountManager pRemoteManager)
public int getCacheTimeout()
public void setCacheTimeout(int pTimeout)
public void invalidate()
public void invalidate(java.lang.String pAccountName)
public java.util.Iterator listAccounts(int pType) throws TooManyAccountsException
listAccounts
in interface AccountManager
type
- The account type(s) to list. You may logical-or
the types togeter to select a union.TooManyAccountsException
AccountTypes
public java.util.Iterator listMatchingAccounts(java.lang.String pExpression, int pType) throws TooManyAccountsException
listMatchingAccounts
in interface AccountManager
expression
- The expression to use to determine which accounts
to list. Currently the language used for the
expression is undefined.type
- The account type(s) to match against. You may logical-or
the types togeter to select a union.TooManyAccountsException
AccountTypes
public Account getAccount(java.lang.String pAccountName)
getAccount
in interface AccountManager
pAccountName
- The name of the account to retrieve.public Account createAccount(java.lang.String pAccountName, int pType, java.util.Map pAttributes) throws AccountExistsException, InvalidAttributeException, PermissionDeniedException
createAccount
in interface AccountManager
pAccountName
- The name of the account to create.pAttributes
- Set of attributes that should be set in the new
account. Usually at least "password" is required.
All attribute values must be strings.pType
- The type of the account to create.AccountExistsException
InvalidAttributeException
PermissionDeniedException
AccountTypes
public void removeAccount(java.lang.String pAccountName) throws NoSuchAccountException, PermissionDeniedException
removeAccount
in interface AccountManager
NoSuchAccountException
PermissionDeniedException
public java.lang.String getDescriptionAttribute()
getDescriptionAttribute
in interface AccountManager
public java.lang.String getFirstNameAttribute()
getFirstNameAttribute
in interface AccountManager
public java.lang.String getLastNameAttribute()
getLastNameAttribute
in interface AccountManager
public java.lang.String getPasswordAttribute()
getPasswordAttribute
in interface AccountManager
public PasswordHasher getPasswordHasher()
getPasswordHasher
in interface AccountManager
public atg.security.PasswordHasherConfigurer getPasswordHasherConfigurer()
getPasswordHasherConfigurer
in interface AccountManager
public java.lang.String getPasswordHasherAttribute()
getPasswordHasherAttribute
in interface AccountManager
public void setPasswordHasherAttribute(java.lang.String pPasswordHasherAttribute)