atg.security
Interface RemoteAccountManager

All Superinterfaces:

java.rmi.Remote

All Known Implementing Classes:

RemoteAccountManagerImpl

public interface RemoteAccountManager
extends java.rmi.Remote

An interface to expose the AccountManager interface via RMI.

See Also:

AccountManager

Field Summary

static java.lang.String

CLASS_VERSION

Method Summary

RemoteAccount	createAccount(java.lang.String accountName, int type, java.util.Map attributes) Creates a new account with a given set of attributes.
RemoteAccount	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.
atg.rmi.RemoteIterator	listAccounts(int type) Returns an iterator of accounts with a particular set of types.
atg.rmi.RemoteIterator	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.

Field Detail

CLASS_VERSION

static final java.lang.String CLASS_VERSION

See Also:

Constant Field Values

Method Detail

listAccounts

atg.rmi.RemoteIterator listAccounts(int type)
                                    throws TooManyAccountsException,
                                           java.rmi.RemoteException

Returns an iterator of accounts with a particular set of types. You may logical-or the account types together to select a union.

Parameters:

type - The account type(s) to list. You may logical-or the types togeter to select a union.

Throws:

TooManyAccountsException

java.rmi.RemoteException

See Also:

AccountTypes

listMatchingAccounts

atg.rmi.RemoteIterator listMatchingAccounts(java.lang.String expression,
                                            int type)
                                            throws TooManyAccountsException,
                                                   java.rmi.RemoteException

Lists accounts that match a given expression.

Parameters:

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.

Throws:

TooManyAccountsException

java.rmi.RemoteException

See Also:

AccountTypes

getAccount

RemoteAccount getAccount(java.lang.String accountName)
                         throws java.rmi.RemoteException

Retrieves the account object for the account with the given name.

Parameters:

accountName - The name of the account to retrieve.

Throws:

java.rmi.RemoteException

createAccount

RemoteAccount createAccount(java.lang.String accountName,
                            int type,
                            java.util.Map attributes)
                            throws AccountExistsException,
                                   InvalidAttributeException,
                                   PermissionDeniedException,
                                   java.rmi.RemoteException

Creates a new account with a given set of attributes.

Parameters:

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.

Throws:

AccountExistsException

InvalidAttributeException

PermissionDeniedException

java.rmi.RemoteException

removeAccount

void removeAccount(java.lang.String accountName)
                   throws NoSuchAccountException,
                          PermissionDeniedException,
                          java.rmi.RemoteException

Removes an account with the indicated name, if possible.

Throws:

NoSuchAccountException

PermissionDeniedException

java.rmi.RemoteException

getDescriptionAttribute

java.lang.String getDescriptionAttribute()
                                         throws java.rmi.RemoteException

Returns the name of the group or privilege account attribute that describes the account in human-readable terms.

Throws:

java.rmi.RemoteException

getFirstNameAttribute

java.lang.String getFirstNameAttribute()
                                       throws java.rmi.RemoteException

Returns the name of the attribute that contains the first name of the owner of a login account.

Throws:

java.rmi.RemoteException

getLastNameAttribute

java.lang.String getLastNameAttribute()
                                      throws java.rmi.RemoteException

Returns the name of the attribute that contains the last name of the owner of a login account.

Throws:

java.rmi.RemoteException

getPasswordAttribute

java.lang.String getPasswordAttribute()
                                      throws java.rmi.RemoteException

Returns the name of the attribute that contains the password for a login account.

Throws:

java.rmi.RemoteException

getPasswordHasher

PasswordHasher getPasswordHasher()
                                 throws java.rmi.RemoteException

Returns the password hasher that should be used to encrypt the password attribute of an account.

Throws:

java.rmi.RemoteException