public interface AccountManager extends AccountTypes
Account
,
UserAuthority
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
CLASS_VERSION |
ANY_ACCOUNT, GROUP_ACCOUNT, LOGIN_ACCOUNT, PRIVILEGE_ACCOUNT
Modifier and Type | Method and Description |
---|---|
Account |
createAccount(java.lang.String accountName,
int type,
java.util.Map attributes)
Creates a new account with a given set of attributes.
|
Account |
getAccount(java.lang.String accountName)
Retrieves the account object for the account with the given name.
|
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 the 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 key for
a login account.
|
atg.security.PasswordHasherConfigurer |
getPasswordHasherConfigurer()
Gets the password hasher configurer which provides different password hasher.
|
java.util.Iterator |
listAccounts(int type)
Returns an iterator of accounts with a particular set of types.
|
java.util.Iterator |
listMatchingAccounts(java.lang.String expression,
int type)
Lists accounts that match a given expression.
|
void |
removeAccount(java.lang.String accountName)
Removes an account with the indicated name, if possible.
|
static final java.lang.String CLASS_VERSION
java.util.Iterator listAccounts(int type) throws TooManyAccountsException
type
- The account type(s) to list. You may logical-or
the types togeter to select a union.TooManyAccountsException
AccountTypes
,
TooManyAccountsException
java.util.Iterator listMatchingAccounts(java.lang.String expression, int type) throws TooManyAccountsException
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
,
TooManyAccountsException
Account getAccount(java.lang.String accountName)
accountName
- The name of the account to retrieve.Account createAccount(java.lang.String accountName, int type, java.util.Map attributes) throws AccountExistsException, InvalidAttributeException, PermissionDeniedException
accountName
- The name of the account to create.type
- The type of the account to create.attributes
- Set of attributes that should be set in the new
account. Usually at least "password" is required.
All attribute values must be strings.AccountExistsException
InvalidAttributeException
PermissionDeniedException
AccountTypes
void removeAccount(java.lang.String accountName) throws NoSuchAccountException, PermissionDeniedException
java.lang.String getDescriptionAttribute()
java.lang.String getFirstNameAttribute()
java.lang.String getLastNameAttribute()
java.lang.String getPasswordAttribute()
java.lang.String getPasswordHasherAttribute()
PasswordHasher getPasswordHasher()
atg.security.PasswordHasherConfigurer getPasswordHasherConfigurer()