Package com.swiftmq.swiftlet.trace

Class TraceSwiftlet

java.lang.Object

com.swiftmq.swiftlet.Swiftlet

com.swiftmq.swiftlet.trace.TraceSwiftlet

public abstract class TraceSwiftlet
extends Swiftlet

The TraceSwiftlet manages trace spaces. A trace space is a destination for trace output and can be dynamically switched on/off. Therefore, every Swiftlet should place trace call into their code at relevant places to enable live tracing if necessary.

Author:

IIT GmbH, Bremen/Germany, Copyright (c) 2000-2002, All Rights Reserved

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	SPACE_KERNEL
static java.lang.String	SPACE_PROTOCOL
static java.lang.String	SPACE_QUEUE
static java.lang.String	SPACE_SWIFTLET

Fields inherited from class com.swiftmq.swiftlet.Swiftlet

STATE_ACTIVE, STATE_INACTIVE, STATE_STANDBY

Constructor Summary

Constructors

Constructor	Description
TraceSwiftlet()

Method Summary

Modifier and Type	Method	Description
protected abstract TraceSpace	createTraceSpace(java.lang.String spaceName)	Abstract factory method to create a trace space.
TraceSpace	getTraceSpace(java.lang.String spaceName)	Get a trace space with that name.
void	setTraceEnabled(java.lang.String spaceName, boolean b)	Enabled/Disables the trace space.
protected void	shutdown()	Stop this Swiftlet.

Methods inherited from class com.swiftmq.swiftlet.Swiftlet

getName, getStartupTime, getState, isSnapshotAvailable, resume, setStartupTime, standby, startup

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

SPACE_KERNEL

public static final java.lang.String SPACE_KERNEL

See Also:

Constant Field Values

SPACE_SWIFTLET

public static final java.lang.String SPACE_SWIFTLET

See Also:

Constant Field Values

SPACE_QUEUE

public static final java.lang.String SPACE_QUEUE

See Also:

Constant Field Values

SPACE_PROTOCOL

public static final java.lang.String SPACE_PROTOCOL

See Also:

Constant Field Values

Constructor Detail

TraceSwiftlet

public TraceSwiftlet()

Method Detail

getTraceSpace

public TraceSpace getTraceSpace(java.lang.String spaceName)

Get a trace space with that name.

Parameters:

spaceName - space name

Returns:

always returns a valid trace space

setTraceEnabled

public void setTraceEnabled(java.lang.String spaceName,
                            boolean b)

Enabled/Disables the trace space. If the space does not exists a new one is created.

Parameters:

spaceName - space name

b - true or false

createTraceSpace

protected abstract TraceSpace createTraceSpace(java.lang.String spaceName)

Abstract factory method to create a trace space. In every case it has to return a valid trace space object

Parameters:

spaceName - space name

Returns:

a valid trace space object

shutdown

protected void shutdown()
                 throws SwiftletException

Description copied from class: Swiftlet

Stop this Swiftlet. Called from the SwiftletManager during router shutdown.

Specified by:

shutdown in class Swiftlet

Throws:

SwiftletException - on error during shutdown.