public interface OXSecondaryAccountInterface
extends java.rmi.Remote
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
RMI_NAME
RMI name to be used in the naming lookup.
|
Modifier and Type | Method and Description |
---|---|
void |
create(AccountDataOnCreate accountData,
Context context,
User[] users,
Group[] groups,
Credentials auth)
Creates given secondary account and makes it available to given users in specified context.
|
boolean |
delete(java.lang.String primaryAddress,
Context context,
User[] users,
Group[] groups,
Credentials auth)
Deletes the account identified through given primary E-Mail address from given users in specified context.
|
Account[] |
list(Context context,
User[] users,
Group[] groups,
Credentials auth)
Lists the accounts identified for given users in specified context.
|
boolean |
update(java.lang.String primaryAddress,
AccountData accountData,
Context context,
User[] users,
Group[] groups,
Credentials auth)
Updates the account identified through given primary E-Mail address from given users in specified context.
|
static final java.lang.String RMI_NAME
void create(AccountDataOnCreate accountData, Context context, User[] users, Group[] groups, Credentials auth) throws java.rmi.RemoteException, StorageException, InvalidCredentialsException, NoSuchContextException, NoSuchUserException, InvalidDataException, DatabaseUpdateException
Note: If both are absent - users and groups - secondary account is assumed being made available to all users in specified context.
accountData
- The account datacontext
- The context to which the user belongusers
- One or more users to which the secondary account is made availablegroups
- One or more groups to which the secondary account is made availableauth
- The credentialsjava.rmi.RemoteException
- If a general remote exception occursStorageException
- If a general storage exception occursInvalidCredentialsException
- If provided credentials are invalidNoSuchContextException
- If specified context does not existNoSuchUserException
- If specified user does not existInvalidDataException
- If given account data is invalidDatabaseUpdateException
- If database is currently updatingboolean update(java.lang.String primaryAddress, AccountData accountData, Context context, User[] users, Group[] groups, Credentials auth) throws java.rmi.RemoteException, StorageException, InvalidCredentialsException, NoSuchContextException, NoSuchUserException, InvalidDataException, DatabaseUpdateException
Note: If both are absent - users and groups - secondary account is assumed being updated for all users in specified context.
primaryAddress
- The primary E-Mail address identifying the account to deletecontext
- The context to which the user belongusers
- One or more users from which the secondary account is removedgroups
- One or more groups to which the secondary account is removedauth
- The credentialstrue
if such a secondary account has been deleted; otherwise false
java.rmi.RemoteException
- If a general remote exception occursStorageException
- If a general storage exception occursInvalidCredentialsException
- If provided credentials are invalidNoSuchContextException
- If specified context does not existNoSuchUserException
- If specified user does not existInvalidDataException
- If given account data is invalidDatabaseUpdateException
- If database is currently updatingboolean delete(java.lang.String primaryAddress, Context context, User[] users, Group[] groups, Credentials auth) throws java.rmi.RemoteException, StorageException, InvalidCredentialsException, NoSuchContextException, NoSuchUserException, InvalidDataException, DatabaseUpdateException
Note: If both are absent - users and groups - secondary account is assumed being deleted for all users in specified context.
primaryAddress
- The primary E-Mail address identifying the account to deletecontext
- The context to which the user belongusers
- One or more users from which the secondary account is removedgroups
- One or more groups to which the secondary account is removedauth
- The credentialstrue
if such a secondary account has been deleted; otherwise false
java.rmi.RemoteException
- If a general remote exception occursStorageException
- If a general storage exception occursInvalidCredentialsException
- If provided credentials are invalidNoSuchContextException
- If specified context does not existNoSuchUserException
- If specified user does not existInvalidDataException
- If given account data is invalidDatabaseUpdateException
- If database is currently updatingAccount[] list(Context context, User[] users, Group[] groups, Credentials auth) throws java.rmi.RemoteException, StorageException, InvalidCredentialsException, NoSuchContextException, NoSuchUserException, InvalidDataException, DatabaseUpdateException
Note: If both are absent - users and groups - secondary account is listed for all users in specified context.
context
- The context to which the user belongusers
- One or more users for which secondary accounts shall be listedgroups
- One or more groups for which secondary accounts shall be listedauth
- The credentialsjava.rmi.RemoteException
- If a general remote exception occursStorageException
- If a general storage exception occursInvalidCredentialsException
- If provided credentials are invalidNoSuchContextException
- If specified context does not existNoSuchUserException
- If specified user does not existInvalidDataException
- If given account data is invalidDatabaseUpdateException
- If database is currently updating