Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance. Project price only 1 $
You can buy this project and download/modify it how often you want.
/*
* Licensed to The Apereo Foundation under one or more contributor license
* agreements. See the NOTICE file distributed with this work for additional
* information regarding copyright ownership.
*
*
* The Apereo Foundation licenses this file to you under the Educational
* Community License, Version 2.0 (the "License"); you may not use this file
* except in compliance with the License. You may obtain a copy of the License
* at:
*
* http://opensource.org/licenses/ecl2.txt
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*
*/
package org.opencastproject.job.api;
import java.net.URI;
import java.util.Date;
import java.util.List;
/**
* Represents a long running, asynchronous process. A Job may be used to track any task, whether it is queued to run in
* the future, currently running, or has run in the past.
*/
public interface Job {
/** The status of the job that this receipt represents */
enum Status {
QUEUED, PAUSED, RUNNING, FINISHED, FAILED, DELETED, INSTANTIATED, DISPATCHING, RESTART, CANCELLED, WAITING;
/** Return if the job is terminated. */
public boolean isTerminated() {
switch (this) {
case CANCELLED:
case DELETED:
case FAILED:
case FINISHED:
return true;
default:
return false;
}
}
/** Check if the job is still active, e.g. RUNNING or QUEUED. This is the negation of {@link #isTerminated()}. */
public boolean isActive() {
return !isTerminated();
}
}
/** Reason for failure */
enum FailureReason {
NONE, DATA, PROCESSING
}
/**
* Gets the job identifier.
*
* @return the identifier
*/
long getId();
/**
* Gets the username of the subject responsible for creating the job initially. This job will execute with this user's
* roles and permissions.
*
* @return the username that created the job
*/
String getCreator();
void setCreator(String creator);
/**
* Returns the identifier of the organization that the creator is associated with.
*
* @return the organization
*/
String getOrganization();
void setOrganization(String organization);
/**
* Gets the version of this job. Each time the job is updated, the version number is incremented. If a process
* attempts to save a job that has been updated in another thread or on another host while the job was in memory, an
* optimistic locking exception will be thrown.
*
* @return the version number of this job
*/
long getVersion();
/**
* Gets the job type, which determines the type of service that runs the job.
*
* @return the job type
*/
String getJobType();
void setJobType(String jobType);
/**
* The operation type, which can be used by the service responsible for the job to determine the service method to
* execute.
*
* @return The operation
*/
String getOperation();
void setOperation(String operation);
/**
* The arguments passed to the service and operation. Each argument must be serializable to a string.
*
* @return the arguments passed to the service operation
*/
List getArguments();
void setArguments(List arguments);
/**
* Gets the receipt's current {@link Status}
*
* @return the current status
*/
Status getStatus();
void setStatus(Status status);
/**
* Sets the receipt's current {@link Status} along with the {@link FailureReason} to indicate why - in the case of
* failure - the job failed.
*
* @param status
* the status to set
* @param reason
* failure reason
*/
void setStatus(Status status, FailureReason reason);
/**
* In the case of failure, returns whether the failure had to do with data or with processing. Depending on the
* reason, processing services might be marked not to accept new jobs.
*
* @return the failure reason
*/
FailureReason getFailureReason();
/**
* Gets the host that created this job.
*
* @return the server that originally created the job
*/
String getCreatedHost();
/**
* Gets the host responsible for running this job.
*
* @return the server running the job, or null if the job hasn't yet started
*/
String getProcessingHost();
void setProcessingHost(String processingHost);
/**
* The date this job was created.
*
* @return the date the job was created
*/
Date getDateCreated();
void setDateCreated(Date created);
/**
* The date this job was started. If the job was queued, this can be significantly later than the date created.
*
* @return the date the job was started
*/
Date getDateStarted();
void setDateStarted(Date started);
/**
* The number of milliseconds that this job has waited in a queue before execution. This value will be null if the job
* has not yet started execution.
*
* @return the total run time
*/
Long getQueueTime();
void setQueueTime(Long queueTime);
/**
* The number of milliseconds that this job took to execute. This value will be null if the job has not yet finished
* execution.
*
* @return the total run time
*/
Long getRunTime();
void setRunTime(Long runTime);
/**
* The date this job was completed
*
* @return the date completed
*/
Date getDateCompleted();
void setDateCompleted(Date dateCompleted);
/**
* Gets the serialized output that was produced by this job, or null if nothing was produced, or if it has yet to be
* produced.
*
* @return the output of the job
*/
String getPayload();
void setPayload(String payload);
/**
*
* @return
*/
int getSignature();
/**
* Gets the parent job identifier, or null if there is no parent.
*
* @return the parent identifier
*/
Long getParentJobId();
void setParentJobId(Long parentJobId);
/**
* Gets the root job identifier, or null if this is the root job.
*
* @return the root job identifier
*/
Long getRootJobId();
/**
* Gets whether this job may be dispatched.
*
* @return whether the job can be queued for dispatch or not
*/
boolean isDispatchable();
void setDispatchable(boolean dispatchable);
/**
* Gets the URI of this job, which can be used to check its status.
*
* @return the job's URI
*/
URI getUri();
/**
* Gets the job's load. For example, a job which uses four cores would have a load of 4.0. This should be roughly the
* number of cores that this job occupies while running.
*
* @return the job's load
*/
Float getJobLoad();
void setJobLoad(Float load);
}
