jakarta.resource.spi.work.WorkEvent Maven / Gradle / Ivy
Go to download
This artifact provides a single jar that contains all classes required to use remote EJB and JMS, including
all dependencies. It is intended for use by those not using maven, maven users should just import the EJB and
JMS BOM's instead (shaded JAR's cause lots of problems with maven, as it is very easy to inadvertently end up
with different versions on classes on the class path).
/*
* Copyright (c) 1997, 2020 Oracle and/or its affiliates. All rights reserved.
*
* This program and the accompanying materials are made available under the
* terms of the Eclipse Public License v. 2.0, which is available at
* http://www.eclipse.org/legal/epl-2.0.
*
* This Source Code may also be made available under the following Secondary
* Licenses when the conditions for such availability set forth in the
* Eclipse Public License v. 2.0 are satisfied: GNU General Public License,
* version 2 with the GNU Classpath Exception, which is available at
* https://www.gnu.org/software/classpath/license.html.
*
* SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
*/
package jakarta.resource.spi.work;
import java.util.EventObject;
/**
* This class models the various events that occur during the processing of
* a Work instance.
*
* @version 1.0
* @author Ram Jeyaraman
*/
public class WorkEvent extends EventObject {
/**
* Indicates Work instance has been accepted.
*/
public static final int WORK_ACCEPTED = 1;
/**
* Indicates Work instance has been rejected.
*/
public static final int WORK_REJECTED = 2;
/**
* Indicates Work instance has started execution.
*/
public static final int WORK_STARTED = 3;
/**
* Indicates Work instance has completed execution.
*/
public static final int WORK_COMPLETED = 4;
/**
* The event type.
*/
private int type;
/**
* The Work object on which the event occured.
*/
private Work work;
/**
* The exception that occured during Work processing.
*/
private WorkException exc;
/**
* The start delay duration (in milliseconds).
*/
private long startDuration = WorkManager.UNKNOWN;
/**
* Constructor.
*
* @param source The object on which the event initially
* occurred.
*
* @param type The event type.
*
* @param work The Work object on which
* the event occured.
*
* @param exc The exception that occured during
* Work processing.
*/
public WorkEvent(Object source, int type, Work work, WorkException exc) {
super(source);
this.type = type;
this.work = work;
this.exc = exc;
}
/**
* Constructor.
*
* @param source The object on which the event initially
* occurred.
*
* @param type The event type.
*
* @param work The Work object on which
* the event occured.
*
* @param exc The exception that occured during
* Work processing.
*
* @param startDuration The start delay duration
* (in milliseconds).
*/
public WorkEvent(Object source, int type, Work work, WorkException exc,
long startDuration) {
this(source, type, work, exc);
this.startDuration = startDuration;
}
/**
* Return the type of this event.
*
* @return the event type.
*/
public int getType() { return this.type; }
/**
* Return the Work instance which is the cause of the event.
*
* @return the Work instance.
*/
public Work getWork() { return this.work; }
/**
* Return the start interval duration.
*
* @return the time elapsed (in milliseconds) since the Work
* was accepted, until the Work execution started. Note,
* this does not offer real-time guarantees. It is valid to return -1, if
* the actual start interval duration is unknown.
*/
public long getStartDuration() { return this.startDuration; }
/**
* Return the WorkException. The actual
* WorkException subtype returned depends on the type of the
* event.
*
* @return a WorkRejectedException or a
* WorkCompletedException, if any.
*/
public WorkException getException() { return this.exc; }
}