com.openexchange.admin.rmi.impl
Class OXUtil

java.lang.Object
  extended by com.openexchange.admin.rmi.impl.OXCommonImpl
      extended by com.openexchange.admin.rmi.impl.OXUtil
All Implemented Interfaces:
OXUtilInterface, java.rmi.Remote

public class OXUtil
extends com.openexchange.admin.rmi.impl.OXCommonImpl
implements OXUtilInterface

Implementation class for the RMI interface for util

Author:
d7

Field Summary
 
Fields inherited from interface com.openexchange.admin.rmi.OXUtilInterface
DEFAULT_DB_WEIGHT, DEFAULT_DRIVER, DEFAULT_HOSTNAME, DEFAULT_MAXUNITS, DEFAULT_POOL_HARD_LIMIT, DEFAULT_POOL_INITIAL, DEFAULT_POOL_MAX, DEFAULT_STORE_MAX_CTX, DEFAULT_STORE_SIZE, DEFAULT_USER, RMI_NAME
 
Constructor Summary
OXUtil()
           
 
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.
 void createDatabase(com.openexchange.admin.rmi.dataobjects.Database db, com.openexchange.admin.rmi.dataobjects.Credentials auth)
           
 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 deleteDatabase(com.openexchange.admin.rmi.dataobjects.Database db, com.openexchange.admin.rmi.dataobjects.Credentials auth)
           
 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.MaintenanceReason[] listMaintenanceReasons(com.openexchange.admin.rmi.dataobjects.Credentials auth)
           
 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 database, 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 server, com.openexchange.admin.rmi.dataobjects.Credentials auth)
          Delete an OX server from the system.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

OXUtil

public OXUtil()
       throws java.rmi.RemoteException,
              com.openexchange.admin.rmi.exceptions.StorageException
Throws:
java.rmi.RemoteException
com.openexchange.admin.rmi.exceptions.StorageException
Method Detail

registerFilestore

public com.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
Description copied from interface: OXUtilInterface
Register new filestore to the system.

Specified by:
registerFilestore in interface OXUtilInterface
Parameters:
fstore - Filestore to register with the store data.
auth - Credentials for authenticating against server.
Returns:
Contains the new filestore id.
Throws:
java.rmi.RemoteException - General RMI Exception
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.

changeFilestore

public void 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
Description copied from interface: OXUtilInterface
Change filestore.

Specified by:
changeFilestore in interface OXUtilInterface
Parameters:
fstore - Contains store to change.
auth - Credentials for authenticating against server.
Throws:
java.rmi.RemoteException - General RMI Exception
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.

listFilestore

public com.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
Description copied from interface: OXUtilInterface
List filestores.

Specified by:
listFilestore in interface OXUtilInterface
Parameters:
search_pattern - Search pattern e.g "*" "*file://%*"
auth - Credentials for authenticating against server.
Returns:
Containing result objects.
Throws:
java.rmi.RemoteException - General RMI Exception
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.

listAllFilestore

public com.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
Description copied from interface: OXUtilInterface
Convenience method for listing all filestores.

Specified by:
listAllFilestore in interface OXUtilInterface
Parameters:
auth - Credentials for authenticating against server.
Returns:
Containing result objects.
Throws:
java.rmi.RemoteException - General RMI Exception
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.

unregisterFilestore

public void 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
Description copied from interface: OXUtilInterface
Unregister filestore from system identified by its ID

Specified by:
unregisterFilestore in interface OXUtilInterface
Parameters:
store - Filestore to unregister with id set.
auth - Credentials for authenticating against server.
Throws:
java.rmi.RemoteException - General RMI Exception
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.

createMaintenanceReason

public 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
Description copied from interface: OXUtilInterface
Add new maintenance reason.

Specified by:
createMaintenanceReason in interface OXUtilInterface
Parameters:
reason - MaintenanceReason.
auth - Credentials for authenticating against server.
Returns:
int containing the new id of the added maintenance reason.
Throws:
java.rmi.RemoteException - General RMI Exception
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.

listMaintenanceReasons

public com.openexchange.admin.rmi.dataobjects.MaintenanceReason[] listMaintenanceReasons(com.openexchange.admin.rmi.dataobjects.Credentials auth)
                                                                                  throws java.rmi.RemoteException,
                                                                                         com.openexchange.admin.rmi.exceptions.StorageException,
                                                                                         com.openexchange.admin.rmi.exceptions.InvalidCredentialsException
Throws:
java.rmi.RemoteException
com.openexchange.admin.rmi.exceptions.StorageException
com.openexchange.admin.rmi.exceptions.InvalidCredentialsException

listMaintenanceReason

public com.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
Description copied from interface: OXUtilInterface
Get all maintenance reasons which match the specified search_pattern

Specified by:
listMaintenanceReason in interface OXUtilInterface
Parameters:
search_pattern - A search pattern to list only those reason which match that pattern
auth - Credentials for authenticating against server.
Returns:
MaintenanceReason[] containing MaintenanceReason objects.
Throws:
java.rmi.RemoteException - General RMI Exception
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

listAllMaintenanceReason

public 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
Description copied from interface: OXUtilInterface
Get all maintenance reasons. Same as calling listMaintenanceReasons with a search_pattern "*"

Specified by:
listAllMaintenanceReason in interface OXUtilInterface
Parameters:
auth - Credentials for authenticating against server.
Returns:
MaintenanceReason[] containing MaintenanceReason objects.
Throws:
java.rmi.RemoteException - General RMI Exception
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

createDatabase

public void createDatabase(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
Throws:
java.rmi.RemoteException
com.openexchange.admin.rmi.exceptions.StorageException
com.openexchange.admin.rmi.exceptions.InvalidCredentialsException
com.openexchange.admin.rmi.exceptions.InvalidDataException

deleteDatabase

public void deleteDatabase(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
Throws:
java.rmi.RemoteException
com.openexchange.admin.rmi.exceptions.StorageException
com.openexchange.admin.rmi.exceptions.InvalidCredentialsException
com.openexchange.admin.rmi.exceptions.InvalidDataException

registerDatabase

public com.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
Description copied from interface: OXUtilInterface
Register a new database to the system. HINT: Use unregisterDatabase to remove/unregister. DONT use deleteDatabase, cause this method performs a real "drop" for its specified Database!

 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");
 

Specified by:
registerDatabase in interface OXUtilInterface
Parameters:
db - The database to register
auth - Credentials for authenticating against server.
Returns:
Contains the new database id.
Throws:
java.rmi.RemoteException - General RMI Exception
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.

registerServer

public 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
Description copied from interface: OXUtilInterface
Register an OX Server in the system.

Specified by:
registerServer in interface OXUtilInterface
Parameters:
srv - Server object containing the server name
auth - Credentials for authenticating against server.
Returns:
Contains the new generated server id.
Throws:
java.rmi.RemoteException - General RMI Exception
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.

unregisterDatabase

public void unregisterDatabase(com.openexchange.admin.rmi.dataobjects.Database database,
                               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
Description copied from interface: OXUtilInterface
Unregister database identified by its ID from configdb.

Specified by:
unregisterDatabase in interface OXUtilInterface
auth - Credentials for authenticating against server.
Throws:
java.rmi.RemoteException - General RMI Exception
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.

unregisterServer

public void unregisterServer(com.openexchange.admin.rmi.dataobjects.Server server,
                             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
Description copied from interface: OXUtilInterface
Delete an OX server from the system.

Specified by:
unregisterServer in interface OXUtilInterface
Parameters:
server - Server with id set.
auth - Credentials for authenticating against server.
Throws:
java.rmi.RemoteException - General RMI Exception
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.

listDatabase

public com.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
Description copied from interface: OXUtilInterface
Search for databases registered in the system.

Specified by:
listDatabase in interface OXUtilInterface
Parameters:
search_pattern - Search pattern e.g "*" "*my*".
auth - Credentials for authenticating against server.
Returns:
Containing the databases found by the search.
Throws:
java.rmi.RemoteException - General RMI Exception
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.

listAllDatabase

public com.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
Description copied from interface: OXUtilInterface
Convenience method for listing all databases registered in the system.

Specified by:
listAllDatabase in interface OXUtilInterface
Parameters:
auth - Credentials for authenticating against server.
Returns:
Containing the databases found by the search.
Throws:
java.rmi.RemoteException - General RMI Exception
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.

listServer

public com.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
Description copied from interface: OXUtilInterface
Search for server

Specified by:
listServer in interface OXUtilInterface
Parameters:
search_pattern - Search pattern e.g "*" "*my*".
auth - Credentials for authenticating against server.
Returns:
Containing Server Object found by the search.
Throws:
java.rmi.RemoteException - General RMI Exception
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.

listAllServer

public com.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
Description copied from interface: OXUtilInterface
Convenience method for listing all servers

Specified by:
listAllServer in interface OXUtilInterface
Parameters:
auth - Credentials for authenticating against server.
Returns:
Containing Server Object found by the search.
Throws:
java.rmi.RemoteException - General RMI Exception
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.

changeDatabase

public void 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
Description copied from interface: OXUtilInterface
Change parameters of a database registered in system

     Database client_db = ...load Database from server via
 
 searchForDatabase
 
  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 
 

Specified by:
changeDatabase in interface OXUtilInterface
Parameters:
db - Database containing the information of the database to edit.
auth - Credentials for authenticating against server.
Throws:
java.rmi.RemoteException - General RMI Exception
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.

deleteMaintenanceReason

public void 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
Description copied from interface: OXUtilInterface
Deletes maintenance reason text.

Specified by:
deleteMaintenanceReason in interface OXUtilInterface
Parameters:
reasons - Reasons which should be deleted!Currently ID must be set in each object!
auth - Credentials for authenticating against server.
Throws:
java.rmi.RemoteException - General RMI Exception
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.