com.day.cq.dam.api.proxy.client

Interface JobService

Deprecated.

@Deprecated
public interface JobService

JobService Interface defines methods to add/remove job and to get status and result of an existing job

Since:

5.5

Field Summary

Fields

Modifier and Type	Field and Description
static String	DAM_PROXY_JOB_NAME Deprecated. This property defines the uniquie jobID for the proxy job.
static int	STATUS_ERROR Deprecated.
static int	STATUS_FINISHED Deprecated.
static int	STATUS_INPROGRESS Deprecated.

Method Summary

Modifier and Type	Method and Description
String	addJob(Hashtable properties, Asset[] dependencies) Deprecated. Posts a job to the Sling job queue.
String	addJob(Hashtable properties, Asset[] dependencies, String fileNameEncoding) Deprecated. Posts a job to the Sling job queue.
String	getJobStatus(String jobId) Deprecated. Get job status as string, implementation decided on the format.
InputStream	getResource(String jobId, String resourcePath) Deprecated. Get a single resource associated with the given job, either local or remote.
String	getResult(String jobId) Deprecated. Get result as a string, implementation decides on the format.
int	getStatus(String jobId) Deprecated. As of release 5.6, replaced by #getJobStatus() Get job status. Depending on the implementation, this will either search for the jobs in local or remote queue.
void	removeJob(String jobId) Deprecated. Remove job and cleanup all related resources for the given job.

Field Detail

STATUS_INPROGRESS

static final int STATUS_INPROGRESS

Deprecated.

See Also:

Constant Field Values

STATUS_FINISHED

static final int STATUS_FINISHED

Deprecated.

See Also:

Constant Field Values

STATUS_ERROR

static final int STATUS_ERROR

Deprecated.

See Also:

Constant Field Values

DAM_PROXY_JOB_NAME

static final String DAM_PROXY_JOB_NAME

Deprecated.

This property defines the uniquie jobID for the proxy job. This can later be used by proxy job processor to do job specific processing.

See Also:

Constant Field Values

Method Detail

addJob

String addJob(Hashtable properties,
              Asset[] dependencies)
       throws ProxyException

Deprecated.

Posts a job to the Sling job queue. Depending on the implementation either job is pushed in to a local queue or sent to the remote server to be added.

Parameters:

properties, - serializable properties to be added to the job

dependencies, - array or asset(s) to be attached to the job

Returns:

unique job id

Throws:

ProxyException - in case implementation is unable to process this request

addJob

String addJob(Hashtable properties,
              Asset[] dependencies,
              String fileNameEncoding)
       throws ProxyException

Deprecated.

Posts a job to the Sling job queue. Depending on the implementation either job is pushed in to a local queue or sent to the remote server to be added. It takes additional parameter to specify the multipart filename encoding.

Parameters:

properties, - serializable properties to be added to the job

dependencies, - array or asset(s) to be attached to the job

fileNameEncoding, - encoding scheme name for the filename

Returns:

unique job id

Throws:

ProxyException - in case implementation is unable to process this request

getStatus

@Deprecated
int getStatus(String jobId)
                   throws ProxyException

Deprecated. As of release 5.6, replaced by #getJobStatus() Get job status. Depending on the implementation, this will either search for the jobs in local or remote queue.

Parameters:

jobId, - for which status needs to be searched

Returns:

int status

Throws:

ProxyException - in case of any error

getJobStatus

String getJobStatus(String jobId)
             throws ProxyException

Deprecated.

Get job status as string, implementation decided on the format. Depending on the implementation, this will either search for the jobs in local or remote queue.

Parameters:

jobId, - for which status needs to be searched

Returns:

status as string

Throws:

ProxyException - in case of any error

getResult

String getResult(String jobId)
          throws ProxyException

Deprecated.

Get result as a string, implementation decides on the format. Responsibility of creating a result is delegated to the job processor.

Parameters:

jobId, - for which the result needs to be read

Returns:

result as string

Throws:

ProxyException - in case of any error

getResource

InputStream getResource(String jobId,
                        String resourcePath)
                 throws ProxyException

Deprecated.

Get a single resource associated with the given job, either local or remote.

Parameters:

jobId, - for which resource needs to be searched

resourcePath, - to be searched

Returns:

resource as stream

Throws:

ProxyException - in case of any error

removeJob

void removeJob(String jobId)
        throws ProxyException

Deprecated.

Remove job and cleanup all related resources for the given job.

Parameters:

jobId, - for which the job needs to be removed

Throws:

ProxyException - if the job cannot be removed