fb3fb4f3d76d55b64440afd0af72775dfad3bd1dtomee * CDDL HEADER START
fb3fb4f3d76d55b64440afd0af72775dfad3bd1dtomee * The contents of this file are subject to the terms of the
fb3fb4f3d76d55b64440afd0af72775dfad3bd1dtomee * Common Development and Distribution License (the "License").
fb3fb4f3d76d55b64440afd0af72775dfad3bd1dtomee * You may not use this file except in compliance with the License.
fb3fb4f3d76d55b64440afd0af72775dfad3bd1dtomee * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
fb3fb4f3d76d55b64440afd0af72775dfad3bd1dtomee * See the License for the specific language governing permissions
fb3fb4f3d76d55b64440afd0af72775dfad3bd1dtomee * and limitations under the License.
fb3fb4f3d76d55b64440afd0af72775dfad3bd1dtomee * When distributing Covered Code, include this CDDL HEADER in each
fb3fb4f3d76d55b64440afd0af72775dfad3bd1dtomee * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
fb3fb4f3d76d55b64440afd0af72775dfad3bd1dtomee * If applicable, add the following below this CDDL HEADER, with the
fb3fb4f3d76d55b64440afd0af72775dfad3bd1dtomee * fields enclosed by brackets "[]" replaced with your own identifying
fb3fb4f3d76d55b64440afd0af72775dfad3bd1dtomee * information: Portions Copyright [yyyy] [name of copyright owner]
fb3fb4f3d76d55b64440afd0af72775dfad3bd1dtomee * CDDL HEADER END
91cfa10a8e55050a5103c4b2e83b0bf8d783a7cbtomee * Copyright 2007 Sun Microsystems, Inc. All rights reserved.
fb3fb4f3d76d55b64440afd0af72775dfad3bd1dtomee * Use is subject to license terms.
fb3fb4f3d76d55b64440afd0af72775dfad3bd1dtomee * ident "%Z%%M% %I% %E% SMI"
fb3fb4f3d76d55b64440afd0af72775dfad3bd1dtomee * State of a target process designated by {@link
fb3fb4f3d76d55b64440afd0af72775dfad3bd1dtomee * Consumer#createProcess(String command)} or {@link
fb3fb4f3d76d55b64440afd0af72775dfad3bd1dtomee * Consumer#grabProcess(int pid)}.
fb3fb4f3d76d55b64440afd0af72775dfad3bd1dtomee * Immutable. Supports persistence using {@link java.beans.XMLEncoder}.
fb3fb4f3d76d55b64440afd0af72775dfad3bd1dtomee * @see ConsumerListener#processStateChanged(ProcessEvent e)
fb3fb4f3d76d55b64440afd0af72775dfad3bd1dtomee * @author Tom Erickson
fb3fb4f3d76d55b64440afd0af72775dfad3bd1dtomeepublic final class ProcessState implements Serializable {
fb3fb4f3d76d55b64440afd0af72775dfad3bd1dtomee static final long serialVersionUID = -3395911213431317292L;
fb3fb4f3d76d55b64440afd0af72775dfad3bd1dtomee BeanInfo info = Introspector.getBeanInfo(ProcessState.class);
fb3fb4f3d76d55b64440afd0af72775dfad3bd1dtomee * Need to prevent DefaultPersistenceDelegate from using
fb3fb4f3d76d55b64440afd0af72775dfad3bd1dtomee * overridden equals() method, resulting in a
fb3fb4f3d76d55b64440afd0af72775dfad3bd1dtomee * StackOverFlowError. Revert to PersistenceDelegate
fb3fb4f3d76d55b64440afd0af72775dfad3bd1dtomee * implementation. See
fb3fb4f3d76d55b64440afd0af72775dfad3bd1dtomee * 477019&tstart=135
fb3fb4f3d76d55b64440afd0af72775dfad3bd1dtomee protected boolean
fb3fb4f3d76d55b64440afd0af72775dfad3bd1dtomee return new Expression(oldInstance, oldInstance.getClass(),
fb3fb4f3d76d55b64440afd0af72775dfad3bd1dtomee d.setValue("persistenceDelegate", persistenceDelegate);
fb3fb4f3d76d55b64440afd0af72775dfad3bd1dtomee * State of a target process.
fb3fb4f3d76d55b64440afd0af72775dfad3bd1dtomee /** Process is running. */
fb3fb4f3d76d55b64440afd0af72775dfad3bd1dtomee /** Process is stopped. */
fb3fb4f3d76d55b64440afd0af72775dfad3bd1dtomee /** Process is lost to control. */
fb3fb4f3d76d55b64440afd0af72775dfad3bd1dtomee /** Process is terminated (zombie). */
fb3fb4f3d76d55b64440afd0af72775dfad3bd1dtomee /** Process is terminated (core file). */
fb3fb4f3d76d55b64440afd0af72775dfad3bd1dtomee /** @serial */
fb3fb4f3d76d55b64440afd0af72775dfad3bd1dtomee /** @serial */
fb3fb4f3d76d55b64440afd0af72775dfad3bd1dtomee /** @serial */
fb3fb4f3d76d55b64440afd0af72775dfad3bd1dtomee /** @serial */
fb3fb4f3d76d55b64440afd0af72775dfad3bd1dtomee /** @serial */
fb3fb4f3d76d55b64440afd0af72775dfad3bd1dtomee /** @serial */
fb3fb4f3d76d55b64440afd0af72775dfad3bd1dtomee * Creates a {@code ProcessState} instance with the given state.
fb3fb4f3d76d55b64440afd0af72775dfad3bd1dtomee * @param pid non-negative target process ID
fb3fb4f3d76d55b64440afd0af72775dfad3bd1dtomee * @param processState target process state
fb3fb4f3d76d55b64440afd0af72775dfad3bd1dtomee * @param processTerminationSignal signal that terminated the target
fb3fb4f3d76d55b64440afd0af72775dfad3bd1dtomee * process, {@code -1} if the process was not terminated by a signal
fb3fb4f3d76d55b64440afd0af72775dfad3bd1dtomee * or if the terminating signal is unknown
fb3fb4f3d76d55b64440afd0af72775dfad3bd1dtomee * @param processTerminationSignalName name of the signal that
fb3fb4f3d76d55b64440afd0af72775dfad3bd1dtomee * terminated the target process, {@code null} if the process was
fb3fb4f3d76d55b64440afd0af72775dfad3bd1dtomee * not terminated by a signal or if the terminating signal is
fb3fb4f3d76d55b64440afd0af72775dfad3bd1dtomee * @param processExitStatus target process exit status, {@code null}
fb3fb4f3d76d55b64440afd0af72775dfad3bd1dtomee * if the process has not exited or the exit status is unknown
fb3fb4f3d76d55b64440afd0af72775dfad3bd1dtomee * @param msg message included by DTrace, if any
fb3fb4f3d76d55b64440afd0af72775dfad3bd1dtomee * @throws NullPointerException if the given process state is {@code
fb3fb4f3d76d55b64440afd0af72775dfad3bd1dtomee * @throws IllegalArgumentException if the given process ID is negative
fb3fb4f3d76d55b64440afd0af72775dfad3bd1dtomee * Supports XML persistence.
fb3fb4f3d76d55b64440afd0af72775dfad3bd1dtomee * @see #ProcessState(int pid, State processState, int
fb3fb4f3d76d55b64440afd0af72775dfad3bd1dtomee * processTerminationSignal, String processTerminationSignalName,
fb3fb4f3d76d55b64440afd0af72775dfad3bd1dtomee * Integer processExitStatus, String msg)
fb3fb4f3d76d55b64440afd0af72775dfad3bd1dtomee * @throws IllegalArgumentException if there is no {@link
fb3fb4f3d76d55b64440afd0af72775dfad3bd1dtomee * ProcessState.State} value with the given state name.
91cfa10a8e55050a5103c4b2e83b0bf8d783a7cbtomee private final void
fb3fb4f3d76d55b64440afd0af72775dfad3bd1dtomee throw new IllegalArgumentException("pid is negative");
fb3fb4f3d76d55b64440afd0af72775dfad3bd1dtomee throw new NullPointerException("process state is null");
fb3fb4f3d76d55b64440afd0af72775dfad3bd1dtomee * Gets the process ID.
fb3fb4f3d76d55b64440afd0af72775dfad3bd1dtomee * @return non-negative target process ID
fb3fb4f3d76d55b64440afd0af72775dfad3bd1dtomee * Gets the process state.
fb3fb4f3d76d55b64440afd0af72775dfad3bd1dtomee * @return non-null target process state
fb3fb4f3d76d55b64440afd0af72775dfad3bd1dtomee * Gets the signal that terminated the process.
fb3fb4f3d76d55b64440afd0af72775dfad3bd1dtomee * @return termination signal, {@code -1} if the process was not
fb3fb4f3d76d55b64440afd0af72775dfad3bd1dtomee * terminated by a signal or if the terminating signal is unknown
fb3fb4f3d76d55b64440afd0af72775dfad3bd1dtomee * Gets the name of the signal that terminated the process.
fb3fb4f3d76d55b64440afd0af72775dfad3bd1dtomee * @return termination signal name, {@code null} if the process was
fb3fb4f3d76d55b64440afd0af72775dfad3bd1dtomee * not terminated by a signal or if the terminating signal is
fb3fb4f3d76d55b64440afd0af72775dfad3bd1dtomee * Gets the process exit status.
fb3fb4f3d76d55b64440afd0af72775dfad3bd1dtomee * @return exit status, or {@code null} if the process has not
fb3fb4f3d76d55b64440afd0af72775dfad3bd1dtomee * exited or the exit status is unknown
fb3fb4f3d76d55b64440afd0af72775dfad3bd1dtomee * Called by native code.
fb3fb4f3d76d55b64440afd0af72775dfad3bd1dtomee private void
fb3fb4f3d76d55b64440afd0af72775dfad3bd1dtomee * Gets the message from DTrace describing this process state.
fb3fb4f3d76d55b64440afd0af72775dfad3bd1dtomee * @return DTrace message, or {@code null} if DTrace did not include
fb3fb4f3d76d55b64440afd0af72775dfad3bd1dtomee * a message with this process state
fb3fb4f3d76d55b64440afd0af72775dfad3bd1dtomee * Compares the specified object with this {@code ProcessState}
fb3fb4f3d76d55b64440afd0af72775dfad3bd1dtomee * instance for equality. Defines equality as having the same
fb3fb4f3d76d55b64440afd0af72775dfad3bd1dtomee * attributes.
fb3fb4f3d76d55b64440afd0af72775dfad3bd1dtomee * @return {@code true} if and only if the specified object is also
fb3fb4f3d76d55b64440afd0af72775dfad3bd1dtomee * a {@code ProcessState} and both instances have the same
fb3fb4f3d76d55b64440afd0af72775dfad3bd1dtomee * attributes
fb3fb4f3d76d55b64440afd0af72775dfad3bd1dtomee public boolean
fb3fb4f3d76d55b64440afd0af72775dfad3bd1dtomee if (o instanceof ProcessState) {
fb3fb4f3d76d55b64440afd0af72775dfad3bd1dtomee terminationSignalName.equals(s.terminationSignalName)) &&
fb3fb4f3d76d55b64440afd0af72775dfad3bd1dtomee return false;
fb3fb4f3d76d55b64440afd0af72775dfad3bd1dtomee * Overridden to ensure that equal instances have equal hash codes.
fb3fb4f3d76d55b64440afd0af72775dfad3bd1dtomee hash = (37 * hash) + (message == null ? 0 : message.hashCode());
fb3fb4f3d76d55b64440afd0af72775dfad3bd1dtomee private void
fb3fb4f3d76d55b64440afd0af72775dfad3bd1dtomee // check class invariants
fb3fb4f3d76d55b64440afd0af72775dfad3bd1dtomee } catch (Exception e) {
4ae67516a1d5dc4a5dbc761762bad5b596647388tomee InvalidObjectException x = new InvalidObjectException(
fb3fb4f3d76d55b64440afd0af72775dfad3bd1dtomee * Gets a string representation of this process state useful for
fb3fb4f3d76d55b64440afd0af72775dfad3bd1dtomee * logging and not intended for display. The exact details of the
fb3fb4f3d76d55b64440afd0af72775dfad3bd1dtomee * representation are unspecified and subject to change, but the
fb3fb4f3d76d55b64440afd0af72775dfad3bd1dtomee * following format may be regarded as typical:
fb3fb4f3d76d55b64440afd0af72775dfad3bd1dtomee * <pre><code>
fb3fb4f3d76d55b64440afd0af72775dfad3bd1dtomee * class-name[property1 = value1, property2 = value2]
fb3fb4f3d76d55b64440afd0af72775dfad3bd1dtomee * </code></pre>