|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface Job
A job
Property Types
In general all scalar types and all serializable classes are supported as
property types. However, in order for deseralizing classes these must be
exported. Serializable classes are not searchable in the query either.
Due to the above to potential problems, it is advisable to not use
custom classes as job properties, but rather use out of the box supported
types in combination with collections.
A resource provider might convert numbers to a different type, JCR is well-known
for this behavior as it only supports long but neither integer nor short.
Therefore if you are dealing with numbers, use the getProperty(String, Class)
method to get the correct type instead of directly casting it.
Field Summary | |
---|---|
static String |
PROPERTY_JOB_CREATED
This property is set by the job handling and contains a calendar object specifying the date and time when this job has been created. |
static String |
PROPERTY_JOB_CREATED_INSTANCE
This property is set by the job handling and contains the Sling instance ID of the instance where this job has been created. |
static String |
PROPERTY_JOB_PRIORITY
This property is set by the job handling to define the priority of this job execution. |
static String |
PROPERTY_JOB_QUEUE_NAME
The name of the job queue processing this job. |
static String |
PROPERTY_JOB_RETRIES
The property to track the retry maximum retry count for jobs. |
static String |
PROPERTY_JOB_RETRY_COUNT
The property to track the retry count for jobs. |
static String |
PROPERTY_JOB_RETRY_DELAY
The property to set a retry delay. |
static String |
PROPERTY_JOB_STARTED_TIME
This property is set by the job handling and contains a calendar object specifying the date and time when this job has been started. |
static String |
PROPERTY_JOB_TARGET_INSTANCE
This property is set by the job handling and contains the Sling instance ID of the instance where this job should be processed. |
Method Summary | ||
---|---|---|
Calendar |
getCreated()
This property is set by the job handling and contains a calendar object specifying the date and time when this job has been created. |
|
String |
getCreatedInstance()
This property is set by the job handling and contains the Sling instance ID of the instance where this job has been created. |
|
String |
getId()
Unique job ID. |
|
JobUtil.JobPriority |
getJobPriority()
This property is set by the job handling to define the priority of this job execution. |
|
String |
getName()
Optional job name |
|
int |
getNumberOfRetries()
The property to track the retry maximum retry count for jobs. |
|
Calendar |
getProcessingStarted()
This property is set by the job handling and contains a calendar object specifying the date and time when this job has been started. |
|
Object |
getProperty(String name)
Get the value of a property. |
|
|
getProperty(String name,
Class<T> type)
Get a named property and convert it into the given type. |
|
|
getProperty(String name,
T defaultValue)
Get a named property and convert it into the given type. |
|
Set<String> |
getPropertyNames()
Get all property names. |
|
String |
getQueueName()
The name of the job queue processing this job. |
|
int |
getRetryCount()
On first execution the value of this property is zero. |
|
String |
getTargetInstance()
This property is set by the job handling and contains the Sling instance ID of the instance where this job should be processed. |
|
String |
getTopic()
The job topic. |
Field Detail |
---|
static final String PROPERTY_JOB_QUEUE_NAME
static final String PROPERTY_JOB_PRIORITY
JobConsumer
and sets the priority of the thread accordingly.
For possible values see JobUtil.JobPriority
.
If this property is set by the client creating the job it's value is ignored
static final String PROPERTY_JOB_RETRY_COUNT
static final String PROPERTY_JOB_RETRIES
static final String PROPERTY_JOB_CREATED
static final String PROPERTY_JOB_CREATED_INSTANCE
static final String PROPERTY_JOB_TARGET_INSTANCE
static final String PROPERTY_JOB_STARTED_TIME
static final String PROPERTY_JOB_RETRY_DELAY
Method Detail |
---|
String getTopic()
String getName()
null
String getId()
Object getProperty(String name)
name
- The property name
null
Set<String> getPropertyNames()
<T> T getProperty(String name, Class<T> type)
null
in this
case.
name
- The name of the propertytype
- The class of the type
null
if
non existing or can't be converted.<T> T getProperty(String name, T defaultValue)
name
- The name of the propertydefaultValue
- The default value to use if the named property does
not exist or cannot be converted to the requested type. The
default value is also used to define the type to convert the
value to. If this is null
any existing property is
not converted.
JobUtil.JobPriority getJobPriority()
JobConsumer
and sets the priority of the thread accordingly.
For possible values see JobUtil.JobPriority
.
int getRetryCount()
int getNumberOfRetries()
String getQueueName()
null
String getTargetInstance()
null
Calendar getProcessingStarted()
Calendar getCreated()
String getCreatedInstance()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |