org.figure8.join.services.remoting
Interface CronService

All Superinterfaces:

AuthenticatedService, java.rmi.Remote

All Known Implementing Classes:

CronServiceImpl

public interface CronService
extends AuthenticatedService

Remote service interface definition. This service allows to interact with server-side crons : retrieving them, saving them (thus activation / deactivation) and removing them. All this services require authentication through the usage of the login() method. The security token returned by this method should then be used as a parameter of every service call.

Version:

$Revision: 1.2 $

Author:

Jerome Evrard

Method Summary

RemoteQuartzCronInfo[]	getQuartzCronInfo(java.lang.String token) Retrieve the list of all existing cron on server-side
RemoteQuartzCronInfo	getQuartzCronInfo(java.lang.String token, java.lang.String name) Retrieve information onto a specified cron
void	removeCron(java.lang.String token, RemoteQuartzCronInfo cron) Remove an existing cron from cron table
void	saveCron(java.lang.String token, RemoteQuartzCronInfo cron) Save a new cron on server-side.

Methods inherited from interface org.figure8.join.services.remoting.AuthenticatedService

login, logout

Method Detail

saveCron

void saveCron(java.lang.String token,
              RemoteQuartzCronInfo cron)
              throws InvalidSessionException,
                     InvalidParameterException,
                     DuplicateEntityException,
                     java.rmi.RemoteException

Save a new cron on server-side. This is a crete or update method.

Parameters:

token - Authentication token provided earlier by login() method

cron - Informations about cron to save

Throws:

InvalidSessionException - if user has no valid session on server-side

InvalidParameterException - if a property of RemoteQuartzCronInfo is not valid

DuplicateEntityException - if a cron with same name already exists

java.rmi.RemoteException - if an exception occurs during the remote conversation

removeCron

void removeCron(java.lang.String token,
                RemoteQuartzCronInfo cron)
                throws InvalidSessionException,
                       java.rmi.RemoteException

Remove an existing cron from cron table

Parameters:

token - Authentication token provided earlier by login() method

cron - Information about cron to remove

Throws:

InvalidSessionException - if user has no valid session on server-side

java.rmi.RemoteException - if an exception occurs during the remote conversation

getQuartzCronInfo

RemoteQuartzCronInfo getQuartzCronInfo(java.lang.String token,
                                       java.lang.String name)
                                       throws InvalidSessionException,
                                              java.rmi.RemoteException

Retrieve information onto a specified cron

Parameters:

token - Authentication token provided earlier by login() method

name - Name of cron to retrieve information for

Returns:

The bean representing information onto specified cron, or null if no one matches name

Throws:

InvalidSessionException - if user has no valid session on server-side

java.rmi.RemoteException - if an exception occurs during the remote conversation

getQuartzCronInfo

RemoteQuartzCronInfo[] getQuartzCronInfo(java.lang.String token)
                                         throws InvalidSessionException,
                                                java.rmi.RemoteException

Retrieve the list of all existing cron on server-side

Parameters:

token - Authentication token provided earlier by login() method

Returns:

An array of beans representing information onto all existing cron

Throws:

InvalidSessionException - if user has no valid session on server-side

java.rmi.RemoteException - if an exception occurs during the remote conversation