All Downloads are FREE. Search and download functionalities are using the official Maven repository.

de.intarsys.tools.monitor.AbstractMonitorTrace Maven / Gradle / Ivy

There is a newer version: 4.11
Show newest version
/*
 * Copyright (c) 2007, intarsys consulting GmbH
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 * - Redistributions of source code must retain the above copyright notice,
 *   this list of conditions and the following disclaimer.
 *
 * - Redistributions in binary form must reproduce the above copyright notice,
 *   this list of conditions and the following disclaimer in the documentation
 *   and/or other materials provided with the distribution.
 *
 * - Neither the name of intarsys nor the names of its contributors may be used
 *   to endorse or promote products derived from this software without specific
 *   prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 */
package de.intarsys.tools.monitor;

import java.util.HashMap;
import java.util.Map;
import java.util.logging.Level;

/**
 * An abstract superclass to ease implementation of monitor trace objects.
 * 
 * 

* This class does not have to be synchronized anywhere. *

*/ public abstract class AbstractMonitorTrace implements ITrace { /** The monitor owning the trace */ final private AbstractMonitor owner; final private Level level; private int nesting = 0; /** * A generic container holding information describing the context of the * trace. */ private Map tags; /** * Create a MonitorTrace. * * @param owner * The monitor that created the trace. */ public AbstractMonitorTrace(AbstractMonitor owner) { super(); this.owner = owner; this.level = owner.getLevel(); } protected abstract ISample basicSample(String description); protected void basicStart() { nesting++; if (nesting == 1) { owner.started(this); if ((tags != null) && (tags.size() > 0)) { tags.clear(); } } else { sample(Level.INFO, "start"); } } protected void basicStop() { nesting--; if (nesting == 0) { owner.stopped(this); traceLog(); } else { sample(Level.INFO, "stop"); } } protected void basicTag(String key, Object tag) { if (tags == null) { tags = new HashMap(); } tags.put(key, tag); } /** * The monitor that owns this trace. * * @return The monitor that owns this trace. */ final protected AbstractMonitor getOwner() { return owner; } /* * (non-Javadoc) * * @see de.intarsys.tools.monitor.IMonitorSample#getTags() */ public Map getTags() { return tags; } /* * (non-Javadoc) * * @see de.intarsys.tools.monitor.IMonitorSample#sample(java.lang.String) */ final public ISample sample(Level level, String description) { if (this.level.intValue() > level.intValue()) { return null; } return basicSample(description); } /** * Reset the trace so that it can safely be reused. */ final protected void start() { basicStart(); } /* * (non-Javadoc) * * @see de.intarsys.monitor.IMonitorEvent#stop() */ final protected void stop() { basicStop(); } /* * (non-Javadoc) * * @see de.intarsys.monitor.IMonitorEvent#tag(String) */ final public void tag(String key, Object tag) { basicTag(key, tag); } protected void traceLog() { // do nothing } }




© 2015 - 2025 Weber Informatics LLC | Privacy Policy