|
![]() |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface OXUtilInterface
This class defines the Open-Xchange API Version 2 for creating and
manipulating needed components of the system.
Example for initializing the system:
// Register database,server and a filestore. final OXUtilInterface iface = (OXUtilInterface)Naming.lookup("rmi:///oxhost/"+OXUtilInterface.RMI_NAME); final Credentials auth = new Credentials(); auth.setLogin("masteradmin"); auth.setPassword("secret"); Database client_db = new Database(); client_db.setName(name); client_db.setDriver("com.mysql.jdbc.Driver"); client_db.setLogin("openexchange"); client_db.setMaster(true); client_db.setMaxUnits(1000); client_db.setPassword("secret"); client_db.setPoolHardLimit(20); client_db.setPoolInitial(5); client_db.setPoolMax(100); client_db.setUrl("jdbc:mysql://localhost/?useUnicode=true&characterEncoding=UTF-8& autoReconnect=true&useUnicode=true&useServerPrepStmts=false&useTimezone=true& serverTimezone=UTC&connectTimeout=15000&socketTimeout=15000"); client_db.setClusterWeight(100); // Register database iface.registerDatabase(client_db,auth); // Register server Server srv = new Server(); srv.setName("local"); iface.registerServer(srv,auth); // Register filestore Filestore client_st = new Filestore(); client_st.setUrl("file:/var/ox/filestore"); client_st.setSize(100L); client_st.setMaxContexts(100); iface.registerFilestore(srv,auth);The system is now ready to be filled with 100 contexts.
OXContextInterface
for an example of creating a context.
Field Summary | |
---|---|
static int |
DEFAULT_DB_WEIGHT
|
static java.lang.String |
DEFAULT_DRIVER
|
static java.lang.String |
DEFAULT_HOSTNAME
|
static int |
DEFAULT_MAXUNITS
|
static boolean |
DEFAULT_POOL_HARD_LIMIT
|
static int |
DEFAULT_POOL_INITIAL
|
static int |
DEFAULT_POOL_MAX
|
static int |
DEFAULT_STORE_MAX_CTX
|
static long |
DEFAULT_STORE_SIZE
|
static java.lang.String |
DEFAULT_USER
|
static java.lang.String |
RMI_NAME
RMI name to be used in the naming lookup. |
Method Summary | |
---|---|
void |
changeDatabase(com.openexchange.admin.rmi.dataobjects.Database db,
com.openexchange.admin.rmi.dataobjects.Credentials auth)
Change parameters of a database registered in system |
void |
changeFilestore(com.openexchange.admin.rmi.dataobjects.Filestore fstore,
com.openexchange.admin.rmi.dataobjects.Credentials auth)
Change filestore. |
com.openexchange.admin.rmi.dataobjects.MaintenanceReason |
createMaintenanceReason(com.openexchange.admin.rmi.dataobjects.MaintenanceReason reason,
com.openexchange.admin.rmi.dataobjects.Credentials auth)
Add new maintenance reason. |
void |
deleteMaintenanceReason(com.openexchange.admin.rmi.dataobjects.MaintenanceReason[] reasons,
com.openexchange.admin.rmi.dataobjects.Credentials auth)
Deletes maintenance reason text. |
com.openexchange.admin.rmi.dataobjects.Database[] |
listAllDatabase(com.openexchange.admin.rmi.dataobjects.Credentials auth)
Convenience method for listing all databases registered in the system. |
com.openexchange.admin.rmi.dataobjects.Filestore[] |
listAllFilestore(com.openexchange.admin.rmi.dataobjects.Credentials auth)
Convenience method for listing all filestores. |
com.openexchange.admin.rmi.dataobjects.MaintenanceReason[] |
listAllMaintenanceReason(com.openexchange.admin.rmi.dataobjects.Credentials auth)
Get all maintenance reasons. |
com.openexchange.admin.rmi.dataobjects.Server[] |
listAllServer(com.openexchange.admin.rmi.dataobjects.Credentials auth)
Convenience method for listing all servers |
com.openexchange.admin.rmi.dataobjects.Database[] |
listDatabase(java.lang.String search_pattern,
com.openexchange.admin.rmi.dataobjects.Credentials auth)
Search for databases registered in the system. |
com.openexchange.admin.rmi.dataobjects.Filestore[] |
listFilestore(java.lang.String search_pattern,
com.openexchange.admin.rmi.dataobjects.Credentials auth)
List filestores. |
com.openexchange.admin.rmi.dataobjects.MaintenanceReason[] |
listMaintenanceReason(java.lang.String search_pattern,
com.openexchange.admin.rmi.dataobjects.Credentials auth)
Get all maintenance reasons which match the specified search_pattern |
com.openexchange.admin.rmi.dataobjects.Server[] |
listServer(java.lang.String search_pattern,
com.openexchange.admin.rmi.dataobjects.Credentials auth)
Search for server |
com.openexchange.admin.rmi.dataobjects.Database |
registerDatabase(com.openexchange.admin.rmi.dataobjects.Database db,
com.openexchange.admin.rmi.dataobjects.Credentials auth)
Register a new database to the system. |
com.openexchange.admin.rmi.dataobjects.Filestore |
registerFilestore(com.openexchange.admin.rmi.dataobjects.Filestore fstore,
com.openexchange.admin.rmi.dataobjects.Credentials auth)
Register new filestore to the system. |
com.openexchange.admin.rmi.dataobjects.Server |
registerServer(com.openexchange.admin.rmi.dataobjects.Server srv,
com.openexchange.admin.rmi.dataobjects.Credentials auth)
Register an OX Server in the system. |
void |
unregisterDatabase(com.openexchange.admin.rmi.dataobjects.Database dbhandle,
com.openexchange.admin.rmi.dataobjects.Credentials auth)
Unregister database identified by its ID from configdb. |
void |
unregisterFilestore(com.openexchange.admin.rmi.dataobjects.Filestore store,
com.openexchange.admin.rmi.dataobjects.Credentials auth)
Unregister filestore from system identified by its ID |
void |
unregisterServer(com.openexchange.admin.rmi.dataobjects.Server serv,
com.openexchange.admin.rmi.dataobjects.Credentials auth)
Delete an OX server from the system. |
Field Detail |
---|
static final int DEFAULT_DB_WEIGHT
static final java.lang.String DEFAULT_DRIVER
static final int DEFAULT_MAXUNITS
static final boolean DEFAULT_POOL_HARD_LIMIT
static final int DEFAULT_POOL_INITIAL
static final int DEFAULT_POOL_MAX
static final java.lang.String DEFAULT_USER
static final java.lang.String DEFAULT_HOSTNAME
static final long DEFAULT_STORE_SIZE
static final int DEFAULT_STORE_MAX_CTX
static final java.lang.String RMI_NAME
Method Detail |
---|
com.openexchange.admin.rmi.dataobjects.MaintenanceReason createMaintenanceReason(com.openexchange.admin.rmi.dataobjects.MaintenanceReason reason, com.openexchange.admin.rmi.dataobjects.Credentials auth) throws java.rmi.RemoteException, com.openexchange.admin.rmi.exceptions.StorageException, com.openexchange.admin.rmi.exceptions.InvalidCredentialsException, com.openexchange.admin.rmi.exceptions.InvalidDataException
reason
- MaintenanceReason.auth
- Credentials for authenticating against server.
com.openexchange.admin.rmi.exceptions.StorageException
- When an error in the subsystems occurred.
com.openexchange.admin.rmi.exceptions.InvalidCredentialsException
- When the supplied credentials were not correct or invalid.
com.openexchange.admin.rmi.exceptions.InvalidDataException
- If the data sent within the method contained invalid data.
java.rmi.RemoteException
- General RMI Exceptionvoid deleteMaintenanceReason(com.openexchange.admin.rmi.dataobjects.MaintenanceReason[] reasons, com.openexchange.admin.rmi.dataobjects.Credentials auth) throws java.rmi.RemoteException, com.openexchange.admin.rmi.exceptions.StorageException, com.openexchange.admin.rmi.exceptions.InvalidCredentialsException, com.openexchange.admin.rmi.exceptions.InvalidDataException
reasons
- Reasons which should be deleted!Currently ID must be set in each object!auth
- Credentials for authenticating against server.
com.openexchange.admin.rmi.exceptions.StorageException
- When an error in the subsystems occurred.
com.openexchange.admin.rmi.exceptions.InvalidCredentialsException
- When the supplied credentials were not correct or invalid.
com.openexchange.admin.rmi.exceptions.InvalidDataException
- If the data sent within the method contained invalid data.
java.rmi.RemoteException
- General RMI Exceptioncom.openexchange.admin.rmi.dataobjects.MaintenanceReason[] listMaintenanceReason(java.lang.String search_pattern, com.openexchange.admin.rmi.dataobjects.Credentials auth) throws java.rmi.RemoteException, com.openexchange.admin.rmi.exceptions.StorageException, com.openexchange.admin.rmi.exceptions.InvalidCredentialsException, com.openexchange.admin.rmi.exceptions.InvalidDataException
search_pattern
- A search pattern to list only those reason which match that patternauth
- Credentials for authenticating against server.
com.openexchange.admin.rmi.exceptions.StorageException
- When an error in the subsystems occurred.
com.openexchange.admin.rmi.exceptions.InvalidCredentialsException
- When the supplied credentials were not correct or invalid.
java.rmi.RemoteException
- General RMI Exception
com.openexchange.admin.rmi.exceptions.InvalidDataException
com.openexchange.admin.rmi.dataobjects.MaintenanceReason[] listAllMaintenanceReason(com.openexchange.admin.rmi.dataobjects.Credentials auth) throws java.rmi.RemoteException, com.openexchange.admin.rmi.exceptions.StorageException, com.openexchange.admin.rmi.exceptions.InvalidCredentialsException, com.openexchange.admin.rmi.exceptions.InvalidDataException
auth
- Credentials for authenticating against server.
com.openexchange.admin.rmi.exceptions.StorageException
- When an error in the subsystems occurred.
com.openexchange.admin.rmi.exceptions.InvalidCredentialsException
- When the supplied credentials were not correct or invalid.
java.rmi.RemoteException
- General RMI Exception
com.openexchange.admin.rmi.exceptions.InvalidDataException
com.openexchange.admin.rmi.dataobjects.Server registerServer(com.openexchange.admin.rmi.dataobjects.Server srv, com.openexchange.admin.rmi.dataobjects.Credentials auth) throws java.rmi.RemoteException, com.openexchange.admin.rmi.exceptions.StorageException, com.openexchange.admin.rmi.exceptions.InvalidCredentialsException, com.openexchange.admin.rmi.exceptions.InvalidDataException
srv
- Server object containing the server nameauth
- Credentials for authenticating against server.
com.openexchange.admin.rmi.exceptions.StorageException
- When an error in the subsystems occurred.
com.openexchange.admin.rmi.exceptions.InvalidCredentialsException
- When the supplied credentials were not correct or invalid.
com.openexchange.admin.rmi.exceptions.InvalidDataException
- If the data sent within the method contained invalid data.
java.rmi.RemoteException
- General RMI Exceptionvoid unregisterServer(com.openexchange.admin.rmi.dataobjects.Server serv, com.openexchange.admin.rmi.dataobjects.Credentials auth) throws java.rmi.RemoteException, com.openexchange.admin.rmi.exceptions.StorageException, com.openexchange.admin.rmi.exceptions.InvalidCredentialsException, com.openexchange.admin.rmi.exceptions.InvalidDataException
auth
- Credentials for authenticating against server.serv
- Server with id set.
com.openexchange.admin.rmi.exceptions.StorageException
- When an error in the subsystems occurred.
com.openexchange.admin.rmi.exceptions.InvalidCredentialsException
- When the supplied credentials were not correct or invalid.
com.openexchange.admin.rmi.exceptions.InvalidDataException
- If the data sent within the method contained invalid data.
java.rmi.RemoteException
- General RMI Exceptioncom.openexchange.admin.rmi.dataobjects.Database registerDatabase(com.openexchange.admin.rmi.dataobjects.Database db, com.openexchange.admin.rmi.dataobjects.Credentials auth) throws java.rmi.RemoteException, com.openexchange.admin.rmi.exceptions.StorageException, com.openexchange.admin.rmi.exceptions.InvalidCredentialsException, com.openexchange.admin.rmi.exceptions.InvalidDataException
Database client_db = new Database(); client_db.setDisplayname("mydb"); client_db.setDriver("com.mysql.jdbc.Driver"); client_db.setLogin("openexchange"); client_db.setMaster(true); client_db.setMaxUnits(1000); client_db.setPassword("xxx"); client_db.setPoolHardLimit(20); client_db.setPoolInitial(2); client_db.setPoolMax(100); client_db.setUrl("jdbc:mysql://localhost/?useUnicode=true&characterEncoding=UTF-8&" + "autoReconnect=true&useUnicode=true&useServerPrepStmts=false&useTimezone=true&" + "serverTimezone=UTC&connectTimeout=15000&socketTimeout=15000");
db
- The database to registerauth
- Credentials for authenticating against server.
com.openexchange.admin.rmi.exceptions.StorageException
- When an error in the subsystems occurred.
com.openexchange.admin.rmi.exceptions.InvalidCredentialsException
- When the supplied credentials were not correct or invalid.
com.openexchange.admin.rmi.exceptions.InvalidDataException
- If the data sent within the method contained invalid data.
java.rmi.RemoteException
- General RMI Exceptionvoid changeDatabase(com.openexchange.admin.rmi.dataobjects.Database db, com.openexchange.admin.rmi.dataobjects.Credentials auth) throws java.rmi.RemoteException, com.openexchange.admin.rmi.exceptions.StorageException, com.openexchange.admin.rmi.exceptions.InvalidCredentialsException, com.openexchange.admin.rmi.exceptions.InvalidDataException
Database client_db = ...load Database from server viasearchForDatabase
to make sure that the Object contains the correct Database id. client_db.setDisplayname(client_db.getDisplayname()+"changed"); client_db.setDriver(client_db.getDriver()+"changed"); client_db.setLogin(client_db.getLogin()+"changed"); client_db.setMaxUnits(2000); client_db.setPassword(client_db.getPassword()+"changed"); client_db.setPoolHardLimit(40); client_db.setPoolInitial(4); client_db.setPoolMax(200); client_db.setUrl(client_db.getUrl()+"changed"); ....change Database
db
- Database containing the information of the database to edit.auth
- Credentials for authenticating against server.
com.openexchange.admin.rmi.exceptions.StorageException
- When an error in the subsystems occurred.
com.openexchange.admin.rmi.exceptions.InvalidCredentialsException
- When the supplied credentials were not correct or invalid.
com.openexchange.admin.rmi.exceptions.InvalidDataException
- If the data sent within the method contained invalid data.
java.rmi.RemoteException
- General RMI Exceptionvoid unregisterDatabase(com.openexchange.admin.rmi.dataobjects.Database dbhandle, com.openexchange.admin.rmi.dataobjects.Credentials auth) throws java.rmi.RemoteException, com.openexchange.admin.rmi.exceptions.StorageException, com.openexchange.admin.rmi.exceptions.InvalidCredentialsException, com.openexchange.admin.rmi.exceptions.InvalidDataException
database
- Database with id set.auth
- Credentials for authenticating against server.
com.openexchange.admin.rmi.exceptions.StorageException
- When an error in the subsystems occurred.
com.openexchange.admin.rmi.exceptions.InvalidCredentialsException
- When the supplied credentials were not correct or invalid.
com.openexchange.admin.rmi.exceptions.InvalidDataException
- If the data sent within the method contained invalid data.
java.rmi.RemoteException
- General RMI Exceptioncom.openexchange.admin.rmi.dataobjects.Database[] listDatabase(java.lang.String search_pattern, com.openexchange.admin.rmi.dataobjects.Credentials auth) throws java.rmi.RemoteException, com.openexchange.admin.rmi.exceptions.StorageException, com.openexchange.admin.rmi.exceptions.InvalidCredentialsException, com.openexchange.admin.rmi.exceptions.InvalidDataException
search_pattern
- Search pattern e.g "*" "*my*".auth
- Credentials for authenticating against server.
com.openexchange.admin.rmi.exceptions.StorageException
- When an error in the subsystems occurred.
com.openexchange.admin.rmi.exceptions.InvalidCredentialsException
- When the supplied credentials were not correct or invalid.
com.openexchange.admin.rmi.exceptions.InvalidDataException
- If the data sent within the method contained invalid data.
java.rmi.RemoteException
- General RMI Exceptioncom.openexchange.admin.rmi.dataobjects.Database[] listAllDatabase(com.openexchange.admin.rmi.dataobjects.Credentials auth) throws java.rmi.RemoteException, com.openexchange.admin.rmi.exceptions.StorageException, com.openexchange.admin.rmi.exceptions.InvalidCredentialsException, com.openexchange.admin.rmi.exceptions.InvalidDataException
auth
- Credentials for authenticating against server.
com.openexchange.admin.rmi.exceptions.StorageException
- When an error in the subsystems occurred.
com.openexchange.admin.rmi.exceptions.InvalidCredentialsException
- When the supplied credentials were not correct or invalid.
com.openexchange.admin.rmi.exceptions.InvalidDataException
- If the data sent within the method contained invalid data.
java.rmi.RemoteException
- General RMI Exceptioncom.openexchange.admin.rmi.dataobjects.Server[] listServer(java.lang.String search_pattern, com.openexchange.admin.rmi.dataobjects.Credentials auth) throws java.rmi.RemoteException, com.openexchange.admin.rmi.exceptions.StorageException, com.openexchange.admin.rmi.exceptions.InvalidCredentialsException, com.openexchange.admin.rmi.exceptions.InvalidDataException
search_pattern
- Search pattern e.g "*" "*my*".auth
- Credentials for authenticating against server.
com.openexchange.admin.rmi.exceptions.StorageException
- When an error in the subsystems occurred.
com.openexchange.admin.rmi.exceptions.InvalidCredentialsException
- When the supplied credentials were not correct or invalid.
com.openexchange.admin.rmi.exceptions.InvalidDataException
- If the data sent within the method contained invalid data.
java.rmi.RemoteException
- General RMI Exceptioncom.openexchange.admin.rmi.dataobjects.Server[] listAllServer(com.openexchange.admin.rmi.dataobjects.Credentials auth) throws java.rmi.RemoteException, com.openexchange.admin.rmi.exceptions.StorageException, com.openexchange.admin.rmi.exceptions.InvalidCredentialsException, com.openexchange.admin.rmi.exceptions.InvalidDataException
auth
- Credentials for authenticating against server.
com.openexchange.admin.rmi.exceptions.StorageException
- When an error in the subsystems occurred.
com.openexchange.admin.rmi.exceptions.InvalidCredentialsException
- When the supplied credentials were not correct or invalid.
com.openexchange.admin.rmi.exceptions.InvalidDataException
- If the data sent within the method contained invalid data.
java.rmi.RemoteException
- General RMI Exceptioncom.openexchange.admin.rmi.dataobjects.Filestore registerFilestore(com.openexchange.admin.rmi.dataobjects.Filestore fstore, com.openexchange.admin.rmi.dataobjects.Credentials auth) throws java.rmi.RemoteException, com.openexchange.admin.rmi.exceptions.StorageException, com.openexchange.admin.rmi.exceptions.InvalidCredentialsException, com.openexchange.admin.rmi.exceptions.InvalidDataException
fstore
- Filestore to register with the store data.auth
- Credentials for authenticating against server.
com.openexchange.admin.rmi.exceptions.StorageException
- When an error in the subsystems occurred.
com.openexchange.admin.rmi.exceptions.InvalidCredentialsException
- When the supplied credentials were not correct or invalid.
com.openexchange.admin.rmi.exceptions.InvalidDataException
- If the data sent within the method contained invalid data.
java.rmi.RemoteException
- General RMI Exceptionvoid changeFilestore(com.openexchange.admin.rmi.dataobjects.Filestore fstore, com.openexchange.admin.rmi.dataobjects.Credentials auth) throws java.rmi.RemoteException, com.openexchange.admin.rmi.exceptions.StorageException, com.openexchange.admin.rmi.exceptions.InvalidCredentialsException, com.openexchange.admin.rmi.exceptions.InvalidDataException
fstore
- Contains store to change.auth
- Credentials for authenticating against server.
com.openexchange.admin.rmi.exceptions.StorageException
- When an error in the subsystems occurred.
com.openexchange.admin.rmi.exceptions.InvalidCredentialsException
- When the supplied credentials were not correct or invalid.
com.openexchange.admin.rmi.exceptions.InvalidDataException
- If the data sent within the method contained invalid data.
java.rmi.RemoteException
- General RMI Exceptioncom.openexchange.admin.rmi.dataobjects.Filestore[] listFilestore(java.lang.String search_pattern, com.openexchange.admin.rmi.dataobjects.Credentials auth) throws java.rmi.RemoteException, com.openexchange.admin.rmi.exceptions.StorageException, com.openexchange.admin.rmi.exceptions.InvalidCredentialsException, com.openexchange.admin.rmi.exceptions.InvalidDataException
search_pattern
- Search pattern e.g "*" "*file://%*"auth
- Credentials for authenticating against server.
com.openexchange.admin.rmi.exceptions.StorageException
- When an error in the subsystems occurred.
com.openexchange.admin.rmi.exceptions.InvalidCredentialsException
- When the supplied credentials were not correct or invalid.
com.openexchange.admin.rmi.exceptions.InvalidDataException
- If the data sent within the method contained invalid data.
java.rmi.RemoteException
- General RMI Exceptioncom.openexchange.admin.rmi.dataobjects.Filestore[] listAllFilestore(com.openexchange.admin.rmi.dataobjects.Credentials auth) throws java.rmi.RemoteException, com.openexchange.admin.rmi.exceptions.StorageException, com.openexchange.admin.rmi.exceptions.InvalidCredentialsException, com.openexchange.admin.rmi.exceptions.InvalidDataException
auth
- Credentials for authenticating against server.
com.openexchange.admin.rmi.exceptions.StorageException
- When an error in the subsystems occurred.
com.openexchange.admin.rmi.exceptions.InvalidCredentialsException
- When the supplied credentials were not correct or invalid.
com.openexchange.admin.rmi.exceptions.InvalidDataException
- If the data sent within the method contained invalid data.
java.rmi.RemoteException
- General RMI Exceptionvoid unregisterFilestore(com.openexchange.admin.rmi.dataobjects.Filestore store, com.openexchange.admin.rmi.dataobjects.Credentials auth) throws java.rmi.RemoteException, com.openexchange.admin.rmi.exceptions.StorageException, com.openexchange.admin.rmi.exceptions.InvalidCredentialsException, com.openexchange.admin.rmi.exceptions.InvalidDataException
store
- Filestore to unregister with id set.auth
- Credentials for authenticating against server.
com.openexchange.admin.rmi.exceptions.StorageException
- When an error in the subsystems occurred.
com.openexchange.admin.rmi.exceptions.InvalidCredentialsException
- When the supplied credentials were not correct or invalid.
com.openexchange.admin.rmi.exceptions.InvalidDataException
- If the data sent within the method contained invalid data.
java.rmi.RemoteException
- General RMI Exception
|
![]() |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |