com.openexchange.admin.storage.interfaces
Class OXContextStorageInterface

java.lang.Object
  extended by com.openexchange.admin.storage.interfaces.OXContextStorageInterface
Direct Known Subclasses:
OXContextSQLStorage

public abstract class OXContextStorageInterface
extends java.lang.Object

This interface provides an abstraction to the storage of the context information

Author:
d7

Constructor Summary
OXContextStorageInterface()
           
 
Method Summary
abstract  void change(com.openexchange.admin.rmi.dataobjects.Context ctx)
           
abstract  void changeStorageData(com.openexchange.admin.rmi.dataobjects.Context ctx)
           
abstract  com.openexchange.admin.rmi.dataobjects.Context create(com.openexchange.admin.rmi.dataobjects.Context ctx, com.openexchange.admin.rmi.dataobjects.User admin_user, com.openexchange.admin.rmi.dataobjects.UserModuleAccess access)
           
abstract  void delete(com.openexchange.admin.rmi.dataobjects.Context ctx)
           
abstract  void disable(com.openexchange.admin.rmi.dataobjects.Context ctx, com.openexchange.admin.rmi.dataobjects.MaintenanceReason reason)
           
abstract  void disableAll(com.openexchange.admin.rmi.dataobjects.MaintenanceReason reason)
           
abstract  void disableAll(com.openexchange.admin.rmi.dataobjects.MaintenanceReason reason, java.lang.String additionaltable, java.lang.String sqlconjunction)
           
abstract  void downgrade(com.openexchange.admin.rmi.dataobjects.Context ctx)
          This method deletes all inaccessible data in a context.
abstract  void enable(com.openexchange.admin.rmi.dataobjects.Context ctx)
           
abstract  void enableAll()
           
abstract  void enableAll(java.lang.String additionaltable, java.lang.String sqlconjunction)
           
abstract  com.openexchange.admin.rmi.dataobjects.Context getData(com.openexchange.admin.rmi.dataobjects.Context ctx)
           
abstract  com.openexchange.admin.rmi.dataobjects.Context[] getData(com.openexchange.admin.rmi.dataobjects.Context[] ctx)
           
static OXContextStorageInterface getInstance()
          Creates a new instance implementing the group storage interface.
abstract  com.openexchange.admin.rmi.dataobjects.Context[] listContext(java.lang.String search_pattern)
           
abstract  com.openexchange.admin.rmi.dataobjects.Context[] listContext(java.lang.String search_pattern, java.lang.String additionaltable, java.lang.String sqlconjunction)
           
abstract  java.lang.String moveContextFilestore(com.openexchange.admin.rmi.dataobjects.Context ctx, com.openexchange.admin.rmi.dataobjects.Filestore dst_filestore_id, com.openexchange.admin.rmi.dataobjects.MaintenanceReason reason)
           
abstract  void moveDatabaseContext(com.openexchange.admin.rmi.dataobjects.Context ctx, com.openexchange.admin.rmi.dataobjects.Database target_database_id, com.openexchange.admin.rmi.dataobjects.MaintenanceReason reason)
          Move data of context to target database
abstract  com.openexchange.admin.rmi.dataobjects.Context[] searchContextByDatabase(com.openexchange.admin.rmi.dataobjects.Database db_host)
           
abstract  com.openexchange.admin.rmi.dataobjects.Context[] searchContextByFilestore(com.openexchange.admin.rmi.dataobjects.Filestore filestore)
           
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

OXContextStorageInterface

public OXContextStorageInterface()
Method Detail

getInstance

public static OXContextStorageInterface getInstance()
                                             throws com.openexchange.admin.rmi.exceptions.StorageException
Creates a new instance implementing the group storage interface.

Returns:
an instance implementing the group storage interface.
Throws:
com.openexchange.admin.rmi.exceptions.StorageException - Storage exception

moveDatabaseContext

public abstract void moveDatabaseContext(com.openexchange.admin.rmi.dataobjects.Context ctx,
                                         com.openexchange.admin.rmi.dataobjects.Database target_database_id,
                                         com.openexchange.admin.rmi.dataobjects.MaintenanceReason reason)
                                  throws com.openexchange.admin.rmi.exceptions.StorageException
Move data of context to target database

Parameters:
ctx -
target_database_id -
reason -
Throws:
com.openexchange.admin.rmi.exceptions.StorageException

moveContextFilestore

public abstract java.lang.String moveContextFilestore(com.openexchange.admin.rmi.dataobjects.Context ctx,
                                                      com.openexchange.admin.rmi.dataobjects.Filestore dst_filestore_id,
                                                      com.openexchange.admin.rmi.dataobjects.MaintenanceReason reason)
                                               throws com.openexchange.admin.rmi.exceptions.StorageException
Parameters:
ctx -
dst_filestore_id -
reason -
Returns:
Throws:
com.openexchange.admin.rmi.exceptions.StorageException

changeStorageData

public abstract void changeStorageData(com.openexchange.admin.rmi.dataobjects.Context ctx)
                                throws com.openexchange.admin.rmi.exceptions.StorageException
Parameters:
ctx - Context with Filestore data set!
Throws:
com.openexchange.admin.rmi.exceptions.StorageException

getData

public abstract com.openexchange.admin.rmi.dataobjects.Context getData(com.openexchange.admin.rmi.dataobjects.Context ctx)
                                                                throws com.openexchange.admin.rmi.exceptions.StorageException
Parameters:
ctx -
Returns:
a context object
Throws:
com.openexchange.admin.rmi.exceptions.StorageException

getData

public abstract com.openexchange.admin.rmi.dataobjects.Context[] getData(com.openexchange.admin.rmi.dataobjects.Context[] ctx)
                                                                  throws com.openexchange.admin.rmi.exceptions.StorageException
Parameters:
ctx -
Returns:
a context object
Throws:
com.openexchange.admin.rmi.exceptions.StorageException

change

public abstract void change(com.openexchange.admin.rmi.dataobjects.Context ctx)
                     throws com.openexchange.admin.rmi.exceptions.StorageException
Parameters:
ctx -
Throws:
com.openexchange.admin.rmi.exceptions.StorageException

create

public abstract com.openexchange.admin.rmi.dataobjects.Context create(com.openexchange.admin.rmi.dataobjects.Context ctx,
                                                                      com.openexchange.admin.rmi.dataobjects.User admin_user,
                                                                      com.openexchange.admin.rmi.dataobjects.UserModuleAccess access)
                                                               throws com.openexchange.admin.rmi.exceptions.StorageException,
                                                                      com.openexchange.admin.rmi.exceptions.InvalidDataException
Parameters:
ctx -
admin_user -
access -
Throws:
com.openexchange.admin.rmi.exceptions.StorageException
com.openexchange.admin.rmi.exceptions.InvalidDataException

delete

public abstract void delete(com.openexchange.admin.rmi.dataobjects.Context ctx)
                     throws com.openexchange.admin.rmi.exceptions.StorageException
Parameters:
ctx -
Throws:
com.openexchange.admin.rmi.exceptions.StorageException

listContext

public abstract com.openexchange.admin.rmi.dataobjects.Context[] listContext(java.lang.String search_pattern)
                                                                      throws com.openexchange.admin.rmi.exceptions.StorageException
Parameters:
search_pattern -
Returns:
Throws:
com.openexchange.admin.rmi.exceptions.StorageException

listContext

public abstract com.openexchange.admin.rmi.dataobjects.Context[] listContext(java.lang.String search_pattern,
                                                                             java.lang.String additionaltable,
                                                                             java.lang.String sqlconjunction)
                                                                      throws com.openexchange.admin.rmi.exceptions.StorageException
Parameters:
search_pattern -
additionaltable -
sqlconjunction -
Returns:
Throws:
com.openexchange.admin.rmi.exceptions.StorageException

disable

public abstract void disable(com.openexchange.admin.rmi.dataobjects.Context ctx,
                             com.openexchange.admin.rmi.dataobjects.MaintenanceReason reason)
                      throws com.openexchange.admin.rmi.exceptions.StorageException
Parameters:
ctx -
reason -
Throws:
com.openexchange.admin.rmi.exceptions.StorageException

enable

public abstract void enable(com.openexchange.admin.rmi.dataobjects.Context ctx)
                     throws com.openexchange.admin.rmi.exceptions.StorageException
Parameters:
ctx -
Throws:
com.openexchange.admin.rmi.exceptions.StorageException

disableAll

public abstract void disableAll(com.openexchange.admin.rmi.dataobjects.MaintenanceReason reason)
                         throws com.openexchange.admin.rmi.exceptions.StorageException
Parameters:
reason -
Throws:
com.openexchange.admin.rmi.exceptions.StorageException

enableAll

public abstract void enableAll()
                        throws com.openexchange.admin.rmi.exceptions.StorageException
Throws:
com.openexchange.admin.rmi.exceptions.StorageException

searchContextByDatabase

public abstract com.openexchange.admin.rmi.dataobjects.Context[] searchContextByDatabase(com.openexchange.admin.rmi.dataobjects.Database db_host)
                                                                                  throws com.openexchange.admin.rmi.exceptions.StorageException
Parameters:
db_host -
Returns:
Throws:
com.openexchange.admin.rmi.exceptions.StorageException

searchContextByFilestore

public abstract com.openexchange.admin.rmi.dataobjects.Context[] searchContextByFilestore(com.openexchange.admin.rmi.dataobjects.Filestore filestore)
                                                                                   throws com.openexchange.admin.rmi.exceptions.StorageException
Parameters:
filestore -
Returns:
Throws:
com.openexchange.admin.rmi.exceptions.StorageException

downgrade

public abstract void downgrade(com.openexchange.admin.rmi.dataobjects.Context ctx)
                        throws com.openexchange.admin.rmi.exceptions.StorageException
This method deletes all inaccessible data in a context.

Parameters:
ctx - Context.
Throws:
com.openexchange.admin.rmi.exceptions.StorageException - if some problem occurs.

disableAll

public abstract void disableAll(com.openexchange.admin.rmi.dataobjects.MaintenanceReason reason,
                                java.lang.String additionaltable,
                                java.lang.String sqlconjunction)
                         throws com.openexchange.admin.rmi.exceptions.StorageException
Parameters:
reason -
additionaltable -
sqlconjunction -
Throws:
com.openexchange.admin.rmi.exceptions.StorageException

enableAll

public abstract void enableAll(java.lang.String additionaltable,
                               java.lang.String sqlconjunction)
                        throws com.openexchange.admin.rmi.exceptions.StorageException
Parameters:
additionaltable -
sqlconjunction -
Throws:
com.openexchange.admin.rmi.exceptions.StorageException