com.openexchange.admin.rmi

Interface OXTaskMgmtInterface

All Superinterfaces:

java.rmi.Remote

public interface OXTaskMgmtInterface
extends java.rmi.Remote

This interface defines the methods of the task management which are accessibly through RMI.

Author:

Manuel Kraft, Carsten Hoeger, Dennis Sieben

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	RMI_NAME RMI name to be used in the naming lookup.

Method Summary

Methods

Modifier and Type	Method and Description
void	deleteJob(Context ctx, Credentials auth, int i) This method is used to delete finished jobs (jobs != running) from the list
void	flush(Context ctx, Credentials auth) Flushes all jobs from the queue which are finished ( != running)
java.lang.String	getJobList(Context ctx, Credentials cred)
java.lang.Object	getTaskResults(Context ctx, Credentials cred, int id) Gets the result from the task with the specified id

Field Detail

RMI_NAME

static final java.lang.String RMI_NAME

RMI name to be used in the naming lookup.

See Also:

Constant Field Values

Method Detail

getTaskResults

java.lang.Object getTaskResults(Context ctx,
                              Credentials cred,
                              int id)
                                throws java.rmi.RemoteException,
                                       InvalidCredentialsException,
                                       StorageException,
                                       java.lang.InterruptedException,
                                       java.util.concurrent.ExecutionException,
                                       InvalidDataException

Gets the result from the task with the specified id

Parameters:

ctx -

cred -

id -

Returns:

an object which has to be casted to the return value specified in the method which adds the job

Throws:

java.rmi.RemoteException

InvalidCredentialsException

StorageException

java.lang.InterruptedException

java.util.concurrent.ExecutionException

InvalidDataException

getJobList

java.lang.String getJobList(Context ctx,
                          Credentials cred)
                            throws java.rmi.RemoteException,
                                   InvalidDataException,
                                   InvalidCredentialsException,
                                   StorageException

Returns:

Throws:

java.rmi.RemoteException

InvalidDataException

StorageException

InvalidCredentialsException

deleteJob

void deleteJob(Context ctx,
             Credentials auth,
             int i)
               throws java.rmi.RemoteException,
                      InvalidDataException,
                      InvalidCredentialsException,
                      StorageException,
                      TaskManagerException

This method is used to delete finished jobs (jobs != running) from the list

Parameters:

ctx -

auth -

i -

Throws:

java.rmi.RemoteException

InvalidDataException

InvalidCredentialsException

StorageException

TaskManagerException

flush

void flush(Context ctx,
         Credentials auth)
           throws java.rmi.RemoteException,
                  InvalidDataException,
                  InvalidCredentialsException,
                  StorageException,
                  TaskManagerException

Flushes all jobs from the queue which are finished ( != running)

Parameters:

ctx -

auth -

Throws:

java.rmi.RemoteException

InvalidDataException

InvalidCredentialsException

StorageException

TaskManagerException