public interface OXResellerInterface
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 |
change(ResellerAdmin adm,
Credentials creds)
Change ResellerAdmin parameters
|
void |
changeSelf(ResellerAdmin admin,
Credentials credentials)
Allows a reseller admin to change his own capabilities, properties and taxonomies
|
ResellerAdmin |
create(ResellerAdmin adm,
Credentials creds)
Creates a ResellerAdmin subadmin account in the database.
|
void |
delete(ResellerAdmin adm,
Credentials creds)
Delete ResellerAdmin from database If any objects still belong to this subadmin, the deletion will fail
|
Restriction[] |
getAvailableRestrictions(Credentials creds)
Retrieve a list of all currently available
Restriction objects |
java.util.Set<java.lang.String> |
getCapabilities(ResellerAdmin admin,
Credentials credentials)
Retrieves all capabilities for the reseller with the specified identifier
|
ResellerAdmin |
getData(ResellerAdmin adm,
Credentials creds)
Get complete data from subadmin object.
|
ResellerAdmin[] |
getMultipleData(ResellerAdmin[] admins,
Credentials creds)
Get complete data from all subadmin objects contained in array.
|
Restriction[] |
getRestrictionsFromContext(Context ctx,
Credentials creds)
Retrieve a list of all restrictions applied to given
Context |
void |
initDatabaseRestrictions(Credentials creds)
Initialize the database with all currently possible restrictions.
|
ResellerAdmin[] |
list(java.lang.String search_pattern,
Credentials creds)
Search for specific or all subadmins in the database
|
void |
removeDatabaseRestrictions(Credentials creds)
Remove all restrictions from database
|
void |
updateDatabaseModuleAccessRestrictions(Credentials creds)
Update all restrictions based on module access combinations in case of changes to
/opt/open-xchange/etc/admindaemon/ModuleAccessDefinitions.properties
|
void |
updateDatabaseRestrictions(Credentials creds)
Update list of restrictions.
|
static final java.lang.String RMI_NAME
ResellerAdmin create(ResellerAdmin adm, Credentials creds) throws java.rmi.RemoteException, InvalidDataException, StorageException, InvalidCredentialsException, OXResellerException
final ResellerAdmin ra = new ResellerAdmin("reselleradm"); ra.setDisplayname("Reseller Admin"); ra.setPassword("secret"); HashSetrss = new HashSet (); rss.add(new Restriction(Restriction.MAX_CONTEXT_PER_SUBADMIN, "100")); rss.add(new Restriction(Restriction.MAX_OVERALL_USER_PER_SUBADMIN,"1000"));
adm
- ResellerAdmin
objectcreds
- Credentials
of the master adminResellerAdmin
objectjava.rmi.RemoteException
InvalidDataException
StorageException
InvalidCredentialsException
OXResellerException
void delete(ResellerAdmin adm, Credentials creds) throws java.rmi.RemoteException, InvalidDataException, StorageException, OXResellerException, InvalidCredentialsException
adm
- ResellerAdmin
objectcreds
- Credentials
of the master adminjava.rmi.RemoteException
InvalidDataException
StorageException
OXResellerException
InvalidCredentialsException
void change(ResellerAdmin adm, Credentials creds) throws java.rmi.RemoteException, InvalidDataException, StorageException, OXResellerException, InvalidCredentialsException
adm
- ResellerAdmin
objectcreds
- Credentials
of the master adminjava.rmi.RemoteException
InvalidDataException
StorageException
OXResellerException
InvalidCredentialsException
void changeSelf(ResellerAdmin admin, Credentials credentials) throws java.rmi.RemoteException, InvalidDataException, StorageException, OXResellerException, InvalidCredentialsException
admin
- The ResellerAdmin
objectcredentials
- Credentials
of the reseller adminjava.rmi.RemoteException
InvalidDataException
StorageException
OXResellerException
InvalidCredentialsException
ResellerAdmin[] list(java.lang.String search_pattern, Credentials creds) throws java.rmi.RemoteException, InvalidDataException, StorageException, InvalidCredentialsException
search_pattern
- search pattern like e.g. "*foo*"creds
- Credentials
of the master adminResellerAdmin
array containing search resultjava.rmi.RemoteException
InvalidDataException
StorageException
InvalidCredentialsException
ResellerAdmin[] getMultipleData(ResellerAdmin[] admins, Credentials creds) throws java.rmi.RemoteException, InvalidDataException, InvalidCredentialsException, StorageException, OXResellerException
Array
- containing ResellerAdmin
objectscreds
- Credentials
of the master adminResellerAdmin
array containing complete datajava.rmi.RemoteException
InvalidDataException
InvalidCredentialsException
StorageException
OXResellerException
ResellerAdmin getData(ResellerAdmin adm, Credentials creds) throws java.rmi.RemoteException, InvalidDataException, InvalidCredentialsException, StorageException, OXResellerException
{@link
- ResellerAdmin} objectcreds
- Credentials
of the master adminResellerAdmin
containing complete datajava.rmi.RemoteException
OXResellerException
StorageException
InvalidCredentialsException
InvalidDataException
Restriction[] getAvailableRestrictions(Credentials creds) throws java.rmi.RemoteException, InvalidCredentialsException, StorageException, OXResellerException
Restriction
objectscreds
- Credentials
of the master adminHashSet
of available restrictionsjava.rmi.RemoteException
InvalidCredentialsException
StorageException
OXResellerException
Restriction[] getRestrictionsFromContext(Context ctx, Credentials creds) throws java.rmi.RemoteException, InvalidDataException, OXResellerException, StorageException, InvalidCredentialsException
Context
{@link
- Context} objectcreds
- Credentials
of the master adminHashSet
of restrictions applied to contextjava.rmi.RemoteException
InvalidDataException
OXResellerException
StorageException
InvalidCredentialsException
void initDatabaseRestrictions(Credentials creds) throws java.rmi.RemoteException, StorageException, InvalidCredentialsException, OXResellerException
Restriction
) as
well as every such restriction per defined module access combination from
/opt/open-xchange/etc/admindaemon/ModuleAccessDefinitions.propertiescreds
- Credentials
of the master adminStorageException
InvalidCredentialsException
OXResellerException
java.rmi.RemoteException
void removeDatabaseRestrictions(Credentials creds) throws java.rmi.RemoteException, InvalidCredentialsException, StorageException, OXResellerException
creds
- Credentials
of the master adminjava.rmi.RemoteException
InvalidCredentialsException
StorageException
OXResellerException
void updateDatabaseModuleAccessRestrictions(Credentials creds) throws java.rmi.RemoteException, StorageException, InvalidCredentialsException, OXResellerException
creds
- Credentials
of the master adminjava.rmi.RemoteException
StorageException
InvalidCredentialsException
OXResellerException
void updateDatabaseRestrictions(Credentials creds) throws java.rmi.RemoteException, StorageException, InvalidCredentialsException, OXResellerException
creds
- Credentials
of the master adminjava.rmi.RemoteException
StorageException
InvalidCredentialsException
OXResellerException
java.util.Set<java.lang.String> getCapabilities(ResellerAdmin admin, Credentials credentials) throws java.rmi.RemoteException, StorageException, InvalidDataException, InvalidCredentialsException, OXResellerException
admin
- the reseller admincredentials
- Credentials
of the reseller adminjava.rmi.RemoteException
StorageException
InvalidCredentialsException
OXResellerException
InvalidDataException