com.ibm.able.platform
Interface AbleEServerJobService

All Superinterfaces:
AblePlatformService, AblePlatformServiceEventGenerator, javax.agent.service.Service
All Known Implementing Classes:
RmiAbleEServerJobServiceProxy

public interface AbleEServerJobService
extends javax.agent.service.Service, AblePlatformService

The AbleEServerJobService interface defines the operations that can be requested of Job service objects.

A Job Service is used to register and deregister platform jobs.

The iSeries startup code uses it to keep track of the jobs so the platform can easily be brought back down.


Field Summary
static java.lang.String[] COLUMN_NAMES
          The column names and types of the table that this service will persist to.
static java.lang.String[] COLUMN_TYPES
           
static java.lang.String SERVICE_PATH
           
static java.lang.String SERVICE_TYPE
          The well-known service type.
 
Method Summary
 void deregisterJob(AbleEServerJobIfc job, AbleSecureKey key)
          This is the method that is used to deregister a job from the Job Service.
 AbleEServerJobIfc getJobInfo(java.lang.String theJobKey)
          Returns the AbleEServerJobIfc that is registered to job key theJobKey.
 void registerJob(AbleEServerJobIfc job, AbleSecureKey key)
          This is the method that is used to register a job to the Job Service.
 
Methods inherited from interface javax.agent.service.Service
getServiceProperties, setServiceProperties
 
Methods inherited from interface com.ibm.able.platform.AblePlatformService
getState, terminateService
 
Methods inherited from interface com.ibm.able.platform.AblePlatformServiceEventGenerator
addAblePlatformServiceEventListener, getAblePlatformServiceEventListeners, removeAblePlatformServiceEventListener
 

Field Detail

SERVICE_TYPE

public static final java.lang.String SERVICE_TYPE
The well-known service type.

SERVICE_PATH

public static final java.lang.String SERVICE_PATH

COLUMN_NAMES

public static final java.lang.String[] COLUMN_NAMES
The column names and types of the table that this service will persist to.

COLUMN_TYPES

public static final java.lang.String[] COLUMN_TYPES
Method Detail

registerJob

public void registerJob(AbleEServerJobIfc job,
                        AbleSecureKey key)
                 throws AbleEServerJobException
This is the method that is used to register a job to the Job Service.

Parameters:
job - The AbleEServerJobIfc job that is to be registered.

key - AbleSecureKey to secure communication

Throws:
AbleEServerJobException -

If the caller is not authenticated.

If attempting to register an invalid AbleEServerJobIfc Object.

If there is an existing job registered to the job key of job.


deregisterJob

public void deregisterJob(AbleEServerJobIfc job,
                          AbleSecureKey key)
                   throws AbleEServerJobException
This is the method that is used to deregister a job from the Job Service.

If the platform is running secure, the caller must have an authority level equal to or greater than the one who originally registered the job that is to be reomoved.

Calls to this method may be delegated, but the VerifiableAgentName at every hop along the way must be authenticated and authorized.

Parameters:
job - The AbleEServerJobIfc job that is to be deregistered.

key - AbleSecureKey to secure communication

Throws:
AbleEServerJobException -

If the caller is not authenticated.

If attempting to deregister an invalid AbleEServerJobIfc Object.

If there is not an existing job registered to the job key of job.

If the caller is not authorized.


getJobInfo

public AbleEServerJobIfc getJobInfo(java.lang.String theJobKey)
                             throws AbleEServerJobException
Returns the AbleEServerJobIfc that is registered to job key theJobKey.

Parameters:
theJobKey - The job key of the AbleEServerJobIfc that is to be returned.

Returns:
AbleEServerJobIfc Object registered to job key theJobKey.

Throws:
AbleEServerJobException -

If theJobKey is null.

If no Job is registered to key theJobKey.