Package org.apache.sling.event.jobs
Class NotificationConstants
- java.lang.Object
-
- org.apache.sling.event.jobs.NotificationConstants
-
public abstract class NotificationConstants extends java.lang.Object
This class contains constants for event notifications. Notifications for jobs can only be received on the instance where the job action is taking place. They are not send to other instances using remove events.- Since:
- 1.3
-
-
Field Summary
Fields Modifier and Type Field Description static java.lang.String
NOTIFICATION_PROPERTY_JOB_ID
Property containing the unique job ID.static java.lang.String
NOTIFICATION_PROPERTY_JOB_TOPIC
Property containing the job topic.static java.lang.String
TOPIC_JOB_ADDED
Asynchronous notification event when a job is added.static java.lang.String
TOPIC_JOB_CANCELLED
Asynchronous notification event when a job is cancelled.static java.lang.String
TOPIC_JOB_FAILED
Asynchronous notification event when a job failed.static java.lang.String
TOPIC_JOB_FINISHED
Asynchronous notification event when a job is finished.static java.lang.String
TOPIC_JOB_REMOVED
Asynchronous notification event when a job is permanently removed.static java.lang.String
TOPIC_JOB_STARTED
Asynchronous notification event when a job is started.
-
-
-
Field Detail
-
TOPIC_JOB_STARTED
public static final java.lang.String TOPIC_JOB_STARTED
Asynchronous notification event when a job is started. The propertyNOTIFICATION_PROPERTY_JOB_TOPIC
contains the job topic, the propertyNOTIFICATION_PROPERTY_JOB_ID
contains the unique job id. The time stamp of the event (as a Long) is available from the propertyEventConstants.TIMESTAMP
. The payload of the job is available as additional job specific properties.- See Also:
- Constant Field Values
-
TOPIC_JOB_FINISHED
public static final java.lang.String TOPIC_JOB_FINISHED
Asynchronous notification event when a job is finished. The propertyNOTIFICATION_PROPERTY_JOB_TOPIC
contains the job topic, the propertyNOTIFICATION_PROPERTY_JOB_ID
contains the unique job id. The time stamp of the event (as a Long) is available from the propertyEventConstants.TIMESTAMP
. The payload of the job is available as additional job specific properties.- See Also:
- Constant Field Values
-
TOPIC_JOB_FAILED
public static final java.lang.String TOPIC_JOB_FAILED
Asynchronous notification event when a job failed. If a job execution fails, it is rescheduled for another try. The propertyNOTIFICATION_PROPERTY_JOB_TOPIC
contains the job topic, the propertyNOTIFICATION_PROPERTY_JOB_ID
contains the unique job id. The time stamp of the event (as a Long) is available from the propertyEventConstants.TIMESTAMP
. The payload of the job is available as additional job specific properties.- See Also:
- Constant Field Values
-
TOPIC_JOB_CANCELLED
public static final java.lang.String TOPIC_JOB_CANCELLED
Asynchronous notification event when a job is cancelled. If a job execution is cancelled it is not rescheduled. The propertyNOTIFICATION_PROPERTY_JOB_TOPIC
contains the job topic, the propertyNOTIFICATION_PROPERTY_JOB_ID
contains the unique job id. The time stamp of the event (as a Long) is available from the propertyEventConstants.TIMESTAMP
. The payload of the job is available as additional job specific properties.- See Also:
- Constant Field Values
-
TOPIC_JOB_REMOVED
public static final java.lang.String TOPIC_JOB_REMOVED
Asynchronous notification event when a job is permanently removed. The propertyNOTIFICATION_PROPERTY_JOB_TOPIC
contains the job topic, the propertyNOTIFICATION_PROPERTY_JOB_ID
contains the unique job id. The payload of the job is available as additional job specific properties.- See Also:
- Constant Field Values
-
TOPIC_JOB_ADDED
public static final java.lang.String TOPIC_JOB_ADDED
Asynchronous notification event when a job is added. The propertyNOTIFICATION_PROPERTY_JOB_TOPIC
contains the job topic, the propertyNOTIFICATION_PROPERTY_JOB_ID
contains the unique job id.- Since:
- 1.6
- See Also:
- Constant Field Values
-
NOTIFICATION_PROPERTY_JOB_TOPIC
public static final java.lang.String NOTIFICATION_PROPERTY_JOB_TOPIC
Property containing the job topic. Value is of type String.- See Also:
Job.getTopic()
, Constant Field Values
-
NOTIFICATION_PROPERTY_JOB_ID
public static final java.lang.String NOTIFICATION_PROPERTY_JOB_ID
Property containing the unique job ID. Value is of type String.- See Also:
Job.getId()
, Constant Field Values
-
-