SMILA (incubation) API documentation

org.eclipse.smila.jobmanager.persistence
Class DefinitionAccessor

java.lang.Object
  extended by org.eclipse.smila.jobmanager.persistence.DefinitionAccessor

public class DefinitionAccessor
extends java.lang.Object

Handles read operations of jobmanager definitions.


Constructor Summary
DefinitionAccessor()
           
 
Method Summary
 BucketDefinition getBucket(java.lang.String name)
          get a bucket from configuration (try first) or storage (if not found in configuration).
 java.util.Collection<java.lang.String> getBuckets()
           
 java.util.Map<java.lang.String,BucketDefinition> getConfiguredBuckets()
           
 java.util.Map<java.lang.String,WorkflowDefinition> getConfiguredWorkflows()
           
 DataObjectTypeDefinition getDataObjectType(java.lang.String name)
           
 java.util.Collection<java.lang.String> getDataObjectTypes()
           
 JobDefinition getJob(java.lang.String name)
          get a job name from configuration or storage.
 java.util.Collection<java.lang.String> getJobs()
           
 WorkerDefinition getWorker(java.lang.String name)
           
 java.util.Collection<java.lang.String> getWorkers()
           
 WorkflowDefinition getWorkflow(java.lang.String name)
          get a workflow definition from configuration (try first) or storage (if not found in configuration).
 java.util.Collection<java.lang.String> getWorkflows()
           
 void setConfiguredBuckets(java.util.Map<java.lang.String,BucketDefinition> configuredBuckets)
           
 void setConfiguredDataObjectTypes(java.util.Map<java.lang.String,DataObjectTypeDefinition> configuredDataObjectTypes)
           
 void setConfiguredWorkers(java.util.Map<java.lang.String,WorkerDefinition> configuredWorkers)
           
 void setConfiguredWorkflows(java.util.Map<java.lang.String,WorkflowDefinition> configuredWorkflows)
           
 void setStorage(DefinitionStorage storage)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

DefinitionAccessor

public DefinitionAccessor()
Method Detail

setStorage

public void setStorage(DefinitionStorage storage)
Parameters:
storage -

getDataObjectTypes

public java.util.Collection<java.lang.String> getDataObjectTypes()
Returns:
all data object type names.

getDataObjectType

public DataObjectTypeDefinition getDataObjectType(java.lang.String name)
Parameters:
name - the name of the data object type definition
Returns:
the data object type definition for the given name, or null if not found

getWorkers

public java.util.Collection<java.lang.String> getWorkers()
Returns:
all worker names.

getWorker

public WorkerDefinition getWorker(java.lang.String name)
Parameters:
name - the name of the worker definition
Returns:
returns the worker definition with the given name, or null if not found

getBuckets

public java.util.Collection<java.lang.String> getBuckets()
                                                  throws PersistenceException
Returns:
names of preconfigured and user-defined buckets.
Throws:
PersistenceException - error reading from storage.

getBucket

public BucketDefinition getBucket(java.lang.String name)
                           throws PersistenceException
get a bucket from configuration (try first) or storage (if not found in configuration).

Parameters:
name - bucket name
Returns:
bucket definition.
Throws:
PersistenceException - error reading from storage.

getJobs

public java.util.Collection<java.lang.String> getJobs()
                                               throws PersistenceException
Returns:
names of defined jobs.
Throws:
PersistenceException - error reading from storage

getJob

public JobDefinition getJob(java.lang.String name)
                     throws PersistenceException
get a job name from configuration or storage.

Parameters:
name - job name
Returns:
job definition.
Throws:
PersistenceException - error reading from storage.

getWorkflows

public java.util.Collection<java.lang.String> getWorkflows()
                                                    throws PersistenceException
Returns:
(unique) names of defined workflows.
Throws:
PersistenceException - error reading from storage

getWorkflow

public WorkflowDefinition getWorkflow(java.lang.String name)
                               throws PersistenceException
get a workflow definition from configuration (try first) or storage (if not found in configuration).

Parameters:
name - workflow name
Returns:
workflow definition.
Throws:
PersistenceException - error reading from storage.

setConfiguredDataObjectTypes

public void setConfiguredDataObjectTypes(java.util.Map<java.lang.String,DataObjectTypeDefinition> configuredDataObjectTypes)
Parameters:
configuredDataObjectTypes -

setConfiguredWorkers

public void setConfiguredWorkers(java.util.Map<java.lang.String,WorkerDefinition> configuredWorkers)
Parameters:
configuredWorkers -

getConfiguredBuckets

public java.util.Map<java.lang.String,BucketDefinition> getConfiguredBuckets()
Returns:
configured buckets

setConfiguredBuckets

public void setConfiguredBuckets(java.util.Map<java.lang.String,BucketDefinition> configuredBuckets)
Parameters:
configuredBuckets -

getConfiguredWorkflows

public java.util.Map<java.lang.String,WorkflowDefinition> getConfiguredWorkflows()
Returns:
configured workflows

setConfiguredWorkflows

public void setConfiguredWorkflows(java.util.Map<java.lang.String,WorkflowDefinition> configuredWorkflows)
Parameters:
configuredWorkflows -

SMILA (incubation) API documentation