org.eclipse.smila.http.client

Class ResourceHelper

java.lang.Object

org.eclipse.smila.http.client.ResourceHelper

public class ResourceHelper
extends java.lang.Object

Helper class providing resources for the standard SMILA REST API to be used in the RestClient. All resulting resources will contain leading and trailing slashes.

Constructor Summary

Constructors

Constructor and Description
ResourceHelper() Create instance for default root context "/smila".
ResourceHelper(java.lang.String rootContextResource) Creates instance with a specific root context.

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getBucketResource(java.lang.String bucketName)
java.lang.String	getBucketsResource()
java.lang.String	getDataObjectTypeResource(java.lang.String dataObjectTypeName)
java.lang.String	getDataObjectTypesResource()
java.lang.String	getDeltaServiceResource(java.lang.String sourceName)
java.lang.String	getDeltaServicesResource()
java.lang.String	getImportingResource()
java.lang.String	getJobManagerResource()
java.lang.String	getJobResource(java.lang.String jobName)
java.lang.String	getJobRunCancelResource(java.lang.String jobName, java.lang.String jobRunId)
java.lang.String	getJobRunFinishResource(java.lang.String jobName, java.lang.String jobRunId)
java.lang.String	getJobRunResource(java.lang.String jobName, java.lang.String jobRunId)
java.lang.String	getJobsResource()
java.lang.String	getPipeletResource(java.lang.String pipeletClassName)
java.lang.String	getPipeletsRersource()
java.lang.String	getPipelineResource(java.lang.String pipelineName)
java.lang.String	getPipelinesResource()
java.lang.String	getPushBulkToJobResource(java.lang.String jobName)
java.lang.String	getPushRecordToJobResource(java.lang.String jobName)
java.lang.String	getPushToJobBaseResource(java.lang.String jobName)
java.lang.String	getStoreObjectResource(java.lang.String storeName, java.lang.String objectId)
java.lang.String	getStoreResource(java.lang.String storeName)
java.lang.String	getStoresResource()
java.lang.String	getTaskInProgressResource(java.lang.String workerName, java.lang.String taskName)
java.lang.String	getTasksForWorkerResource(java.lang.String workerName, java.lang.String taskType)
java.lang.String	getTasksInProgressForWorkerResource(java.lang.String workerName)
java.lang.String	getTasksResource()
java.lang.String	getTasksToDoForWorkerResource(java.lang.String workerName)
java.lang.String	getTaskToDoResource(java.lang.String workerName, java.lang.String taskName)
java.lang.String	getVisitedLinksResource()
java.lang.String	getVisitedLinksResource(java.lang.String sourceName)
java.lang.String	getWorkerResource(java.lang.String workerName)
java.lang.String	getWorkersResource()
java.lang.String	getWorkflowResource(java.lang.String workflowName)
java.lang.String	getWorkflowsResource()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ResourceHelper

public ResourceHelper()

Create instance for default root context "/smila".

ResourceHelper

public ResourceHelper(java.lang.String rootContextResource)

Creates instance with a specific root context.

Parameters:

rootContextResource - the root context for the SMILA handlers. (E.g. "/smila").

Method Detail

getPipeletsRersource

public java.lang.String getPipeletsRersource()

Returns:

the resource for the pipelets.

getPipeletResource

public java.lang.String getPipeletResource(java.lang.String pipeletClassName)

Returns:

the resource for the a given pipelet.

getPipelinesResource

public java.lang.String getPipelinesResource()

Returns:

the resource for the pipelines.

getPipelineResource

public java.lang.String getPipelineResource(java.lang.String pipelineName)

Returns:

the resource for the a given pipeline.

getJobManagerResource

public java.lang.String getJobManagerResource()

Returns:

the base resource for the JobManager.

getDataObjectTypesResource

public java.lang.String getDataObjectTypesResource()

Returns:

the resource for the DataObjectTypes.

getDataObjectTypeResource

public java.lang.String getDataObjectTypeResource(java.lang.String dataObjectTypeName)

Returns:

the resource for a given DataObjectType.

getBucketsResource

public java.lang.String getBucketsResource()

Returns:

the resource for the Buckets.

getBucketResource

public java.lang.String getBucketResource(java.lang.String bucketName)

Returns:

the resource for a given Bucket.

getWorkersResource

public java.lang.String getWorkersResource()

Returns:

the resource for the Workers.

getWorkerResource

public java.lang.String getWorkerResource(java.lang.String workerName)

Returns:

the resource for a given Worker.

getWorkflowsResource

public java.lang.String getWorkflowsResource()

Returns:

the resource for the Workflows.

getWorkflowResource

public java.lang.String getWorkflowResource(java.lang.String workflowName)

Returns:

the resource for a given Workflow.

getJobsResource

public java.lang.String getJobsResource()

Returns:

the resource for the Jobs.

getJobResource

public java.lang.String getJobResource(java.lang.String jobName)

Returns:

the resource for a given Job.

getJobRunResource

public java.lang.String getJobRunResource(java.lang.String jobName,
                                 java.lang.String jobRunId)

Returns:

the resource for a given Job Run.

getJobRunFinishResource

public java.lang.String getJobRunFinishResource(java.lang.String jobName,
                                       java.lang.String jobRunId)

Returns:

the resource to use to finish a given Job Run.

getJobRunCancelResource

public java.lang.String getJobRunCancelResource(java.lang.String jobName,
                                       java.lang.String jobRunId)

Returns:

the resource to use to cancel a given Job Run.

getPushToJobBaseResource

public java.lang.String getPushToJobBaseResource(java.lang.String jobName)

Returns:

the base resource for the Bulkbuilder push API for a given Job.

getPushRecordToJobResource

public java.lang.String getPushRecordToJobResource(java.lang.String jobName)

Returns:

the resource for the Bulkbuilder record push API for a given Job.

getPushBulkToJobResource

public java.lang.String getPushBulkToJobResource(java.lang.String jobName)

Returns:

the resource for the Bulkbuilder bulk push API for a given Job.

getTasksResource

public java.lang.String getTasksResource()

Returns:

the resource for the Task queues.

getTasksForWorkerResource

public java.lang.String getTasksForWorkerResource(java.lang.String workerName,
                                         java.lang.String taskType)

Returns:

the resource for the Task queue for a given type of a given Worker.

getTasksInProgressForWorkerResource

public java.lang.String getTasksInProgressForWorkerResource(java.lang.String workerName)

Returns:

the resource for the "inprogress" Task queue for a given Worker.

getTasksToDoForWorkerResource

public java.lang.String getTasksToDoForWorkerResource(java.lang.String workerName)

Returns:

the resource for the "todo" Task queue for a given Worker.

getTaskInProgressResource

public java.lang.String getTaskInProgressResource(java.lang.String workerName,
                                         java.lang.String taskName)

Returns:

the resource for a given "inprogress" Task for a given Worker.

getTaskToDoResource

public java.lang.String getTaskToDoResource(java.lang.String workerName,
                                   java.lang.String taskName)

Returns:

the resource for a given "todo" Task for a given Worker.

getImportingResource

public java.lang.String getImportingResource()

Returns:

the base resource for the importing framework.

getDeltaServicesResource

public java.lang.String getDeltaServicesResource()

Returns:

the resource for the delta service of the importing framework.

getDeltaServiceResource

public java.lang.String getDeltaServiceResource(java.lang.String sourceName)

Returns:

the resource the delta service for a given source.

getVisitedLinksResource

public java.lang.String getVisitedLinksResource()

Returns:

the resource for the visited links service of the importing framework.

getVisitedLinksResource

public java.lang.String getVisitedLinksResource(java.lang.String sourceName)

Returns:

the resource the visited links service for a given source.

getStoresResource

public java.lang.String getStoresResource()

Returns:

the resource for the object store service.

getStoreResource

public java.lang.String getStoreResource(java.lang.String storeName)

Returns:

the resource for a given object store.

getStoreObjectResource

public java.lang.String getStoreObjectResource(java.lang.String storeName,
                                      java.lang.String objectId)

Returns:

the resource for a given object in a given store.