1fb3fb4f3Stomee /* 2fb3fb4f3Stomee * CDDL HEADER START 3fb3fb4f3Stomee * 4fb3fb4f3Stomee * The contents of this file are subject to the terms of the 5fb3fb4f3Stomee * Common Development and Distribution License (the "License"). 6fb3fb4f3Stomee * You may not use this file except in compliance with the License. 7fb3fb4f3Stomee * 8fb3fb4f3Stomee * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE 9fb3fb4f3Stomee * or http://www.opensolaris.org/os/licensing. 10fb3fb4f3Stomee * See the License for the specific language governing permissions 11fb3fb4f3Stomee * and limitations under the License. 12fb3fb4f3Stomee * 13fb3fb4f3Stomee * When distributing Covered Code, include this CDDL HEADER in each 14fb3fb4f3Stomee * file and include the License file at usr/src/OPENSOLARIS.LICENSE. 15fb3fb4f3Stomee * If applicable, add the following below this CDDL HEADER, with the 16fb3fb4f3Stomee * fields enclosed by brackets "[]" replaced with your own identifying 17fb3fb4f3Stomee * information: Portions Copyright [yyyy] [name of copyright owner] 18fb3fb4f3Stomee * 19fb3fb4f3Stomee * CDDL HEADER END 20fb3fb4f3Stomee */ 21fb3fb4f3Stomee 22fb3fb4f3Stomee /* 2391cfa10aStomee * Copyright 2007 Sun Microsystems, Inc. All rights reserved. 24fb3fb4f3Stomee * Use is subject to license terms. 25fb3fb4f3Stomee * 26fb3fb4f3Stomee * ident "%Z%%M% %I% %E% SMI" 27fb3fb4f3Stomee */ 28fb3fb4f3Stomee package org.opensolaris.os.dtrace; 29fb3fb4f3Stomee 30fb3fb4f3Stomee import java.io.*; 31fb3fb4f3Stomee import java.util.EventObject; 32fb3fb4f3Stomee 33fb3fb4f3Stomee /** 34fb3fb4f3Stomee * An event used to pass probe data generated by a DTrace {@link 35fb3fb4f3Stomee * Consumer} to interested listeners. 36fb3fb4f3Stomee * 37fb3fb4f3Stomee * @see ConsumerListener#dataReceived(DataEvent e) 38fb3fb4f3Stomee * 39fb3fb4f3Stomee * @author Tom Erickson 40fb3fb4f3Stomee */ 41fb3fb4f3Stomee public class DataEvent extends EventObject { 42fb3fb4f3Stomee static final long serialVersionUID = 3068774547474769821L; 43fb3fb4f3Stomee 44fb3fb4f3Stomee /** @serial */ 45fb3fb4f3Stomee private ProbeData probeData; 46fb3fb4f3Stomee 47fb3fb4f3Stomee /** 48fb3fb4f3Stomee * Creates a {@link ConsumerListener#dataReceived(DataEvent e) 49fb3fb4f3Stomee * dataReceived()} event that conveys data generated by DTrace from 50fb3fb4f3Stomee * a single probe firing. 51fb3fb4f3Stomee * 52fb3fb4f3Stomee * @throws NullPointerException if the given probe data is {@code 53fb3fb4f3Stomee * null} 54fb3fb4f3Stomee */ 55fb3fb4f3Stomee public DataEvent(Object source, ProbeData generatedData)56fb3fb4f3Stomee DataEvent(Object source, ProbeData generatedData) 57fb3fb4f3Stomee { 58fb3fb4f3Stomee super(source); 59fb3fb4f3Stomee probeData = generatedData; 60fb3fb4f3Stomee validate(); 61fb3fb4f3Stomee } 62fb3fb4f3Stomee 6391cfa10aStomee private final void validate()64fb3fb4f3Stomee validate() 65fb3fb4f3Stomee { 66fb3fb4f3Stomee if (probeData == null) { 67fb3fb4f3Stomee throw new NullPointerException("probe data is null"); 68fb3fb4f3Stomee } 69fb3fb4f3Stomee } 70fb3fb4f3Stomee 71fb3fb4f3Stomee /** 72fb3fb4f3Stomee * Gets the data generated by DTrace from a single probe firing. 73fb3fb4f3Stomee * 74fb3fb4f3Stomee * @return non-null probe data generated by DTrace from a single 75fb3fb4f3Stomee * probe firing 76fb3fb4f3Stomee */ 77fb3fb4f3Stomee public ProbeData getProbeData()78fb3fb4f3Stomee getProbeData() 79fb3fb4f3Stomee { 80fb3fb4f3Stomee return probeData; 81fb3fb4f3Stomee } 82fb3fb4f3Stomee 83fb3fb4f3Stomee private void readObject(ObjectInputStream s)84fb3fb4f3Stomee readObject(ObjectInputStream s) 85fb3fb4f3Stomee throws IOException, ClassNotFoundException 86fb3fb4f3Stomee { 87fb3fb4f3Stomee s.defaultReadObject(); 88fb3fb4f3Stomee // check invariants 89fb3fb4f3Stomee try { 90fb3fb4f3Stomee validate(); 91fb3fb4f3Stomee } catch (Exception e) { 92*4ae67516Stomee InvalidObjectException x = new InvalidObjectException( 93*4ae67516Stomee e.getMessage()); 94*4ae67516Stomee x.initCause(e); 95*4ae67516Stomee throw x; 96fb3fb4f3Stomee } 97fb3fb4f3Stomee } 98fb3fb4f3Stomee 99fb3fb4f3Stomee /** 100fb3fb4f3Stomee * Gets a string representation of this event useful for logging and 101fb3fb4f3Stomee * not intended for display. The exact details of the 102fb3fb4f3Stomee * representation are unspecified and subject to change, but the 103fb3fb4f3Stomee * following format may be regarded as typical: 104fb3fb4f3Stomee * <pre><code> 105fb3fb4f3Stomee * class-name[property1 = value1, property2 = value2] 106fb3fb4f3Stomee * </code></pre> 107fb3fb4f3Stomee */ 108fb3fb4f3Stomee public String toString()109fb3fb4f3Stomee toString() 110fb3fb4f3Stomee { 111*4ae67516Stomee StringBuilder buf = new StringBuilder(); 112fb3fb4f3Stomee buf.append(DataEvent.class.getName()); 113fb3fb4f3Stomee buf.append("[source = "); 114fb3fb4f3Stomee buf.append(getSource()); 115fb3fb4f3Stomee buf.append(", probeData = "); 116fb3fb4f3Stomee buf.append(probeData); 117fb3fb4f3Stomee buf.append(']'); 118fb3fb4f3Stomee return buf.toString(); 119fb3fb4f3Stomee } 120fb3fb4f3Stomee } 121