Package org.glassfish.gmbal.impl

Interface TimerAnnotationHelper.ManagedTimerFactory

All Superinterfaces:

Controllable, Named, TimerAnnotationHelper.ManagedControllable, TimerAnnotationHelper.ManagedNamed, TimerAnnotationHelper.ManagedTimerGroup, TimerFactory, TimerGroup

Enclosing class:

TimerAnnotationHelper

@ManagedObject
@Description("The Factory used to create and managed all objects in the Timer framework")
public static interface TimerAnnotationHelper.ManagedTimerFactory
extends TimerFactory, TimerAnnotationHelper.ManagedTimerGroup

Method Summary

Modifier and Type	Method	Description
Set<Timer>	activeSet()	Returns a read-only view of the set of Controllables that are currently active.
Set<? extends Controllable>	enabledSet()	Returns a read-only view of the set of enabled Controllables.
Controllable	getControllable(int id)	Returns the Controllable corresponding to id, for id in the range 0 (inclusive) to numberOfIds() (exclusive).
TimerEventController	makeController(String name)	Create a TimerController, which can create TimerEvents and send them to registered TimerEventHandlers.
LogEventHandler	makeLogEventHandler(String name)	Create a new LogEventHandler.
StatsEventHandler	makeMultiThreadedStatsEventHandler(String name)	Create a new StatsEventHandler.
StatsEventHandler	makeStatsEventHandler(String name)	Create a new StatsEventHandler.
Timer	makeTimer(String name, String description)	Create a new Timer.
TimerGroup	makeTimerGroup(String name, String description)	Create a new TimerGroup.
TimerEventHandler	makeTracingEventHandler(String name)
int	numberOfIds()	Returns the maximum id used by this TimerFactory for creating Controllables.
void	removeController(TimerEventControllerBase controller)	Remove the controller from this factory.
void	removeTimerEventHandler(TimerEventHandler handler)	Remove the handler from this TimerFactory.
Map<String,? extends TimerGroup>	timerGroups()	Returns a read-only map from TimerGroup names to TimerGroups.
Map<String,? extends Timer>	timers()	Returns a read-only map from Timer names to Timers.

Methods inherited from interface org.glassfish.gmbal.impl.TimerAnnotationHelper.ManagedControllable

contents, description, disable, enable, id, isEnabled

Methods inherited from interface org.glassfish.gmbal.impl.TimerAnnotationHelper.ManagedNamed

factory, name

Methods inherited from interface org.glassfish.gmbal.impl.TimerAnnotationHelper.ManagedTimerGroup

add, remove

Methods inherited from interface org.glassfish.pfl.tf.timer.spi.TimerFactory

timerAlreadyExists

Method Details

numberOfIds

@ManagedAttribute
@Description("The total number of Controllabled IDs in use")
int numberOfIds()

Description copied from interface: TimerFactory

Returns the maximum id used by this TimerFactory for creating Controllables. The value of con.id() for any Controllable created by this TimerFactory always ranges from 0 inclusive to numberOfIds() exclusive.

Specified by:

numberOfIds in interface TimerFactory

getControllable

@ManagedOperation
@Description("Look up a Timer or TimerGroup by its ID")
Controllable getControllable(int id)

Description copied from interface: TimerFactory

Returns the Controllable corresponding to id, for id in the range 0 (inclusive) to numberOfIds() (exclusive).

Specified by:

getControllable in interface TimerFactory

makeLogEventHandler

@ManagedOperation
@Description("Create a new LogEventHandler")
LogEventHandler makeLogEventHandler(String name)

Description copied from interface: TimerFactory

Create a new LogEventHandler. All LogEventHandler names must be unique within the same TimerFactory.

Specified by:

makeLogEventHandler in interface TimerFactory

makeTracingEventHandler

@ManagedOperation
@Description("Create a new TracingEventHandler")
TimerEventHandler makeTracingEventHandler(String name)

Specified by:

makeTracingEventHandler in interface TimerFactory

makeStatsEventHandler

@ManagedOperation
@Description("Create a new StatsEventHandler")
StatsEventHandler makeStatsEventHandler(String name)

Description copied from interface: TimerFactory

Create a new StatsEventHandler. A StatsEventHandler records running statistics for all enter/exit pairs until it is cleared, at which point it starts over. It will keep data separated for each thread, combining information correctly from multiple threads. All StatsEventHandler names must be unique within the same TimerFactory. This StatsEventHandler must be used from a single thread.

Specified by:

makeStatsEventHandler in interface TimerFactory

makeMultiThreadedStatsEventHandler

@ManagedOperation
@Description("Create a new Multi-Threaded StatsEventHandler")
StatsEventHandler makeMultiThreadedStatsEventHandler(String name)

Description copied from interface: TimerFactory

Create a new StatsEventHandler. A StatsEventHandler records running statistics for all enter/exit pairs until it is cleared, at which point it starts over. It will keep data separated for each thread, combining information correctly from multiple threads. All StatsEventHandler names must be unique within the same TimerFactory. This StatsEventHandler is multi-thread safe.

Specified by:

makeMultiThreadedStatsEventHandler in interface TimerFactory

removeTimerEventHandler

@ManagedOperation
@Description("Remove the TimerEventHandler from this factory")
void removeTimerEventHandler(TimerEventHandler handler)

Description copied from interface: TimerFactory

Remove the handler from this TimerFactory. The handler should not be used after this call.

Specified by:

removeTimerEventHandler in interface TimerFactory

makeTimer

@ManagedOperation
@Description("Create a new Timer")
Timer makeTimer(String name,
 String description)

Description copied from interface: TimerFactory

Create a new Timer. Note that Timers cannot be destroyed, other than by garbage collecting the TimerFactory that created them.

Specified by:

makeTimer in interface TimerFactory

timers

@ManagedAttribute
@Description("All timers contained in this factory")
Map<String,? extends Timer> timers()

Description copied from interface: TimerFactory

Returns a read-only map from Timer names to Timers.

Specified by:

timers in interface TimerFactory

makeTimerGroup

@ManagedOperation
@Description("Create a new TimerGroup")
TimerGroup makeTimerGroup(String name,
 String description)

Description copied from interface: TimerFactory

Create a new TimerGroup. Note that TimerGroups cannot be destroyed, other than by garbage collecting the TimerFactory that created them.

Specified by:

makeTimerGroup in interface TimerFactory

timerGroups

@ManagedAttribute
@Description("All timers contained in this factory")
Map<String,? extends TimerGroup> timerGroups()

Description copied from interface: TimerFactory

Returns a read-only map from TimerGroup names to TimerGroups.

Specified by:

timerGroups in interface TimerFactory

makeController

@ManagedOperation
@Description("Create a new TimerEventController")
TimerEventController makeController(String name)

Description copied from interface: TimerFactory

Create a TimerController, which can create TimerEvents and send them to registered TimerEventHandlers.

Specified by:

makeController in interface TimerFactory

removeController

@ManagedOperation
@Description("Remote the TimerEventController from this factory")
void removeController(TimerEventControllerBase controller)

Description copied from interface: TimerFactory

Remove the controller from this factory. The controller should not be used after this call.

Specified by:

removeController in interface TimerFactory

enabledSet

@ManagedAttribute
@Description("All explicitly enabled Timers and TimerGroups")
Set<? extends Controllable> enabledSet()

Description copied from interface: TimerFactory

Returns a read-only view of the set of enabled Controllables. These have been explicitly enabled via a call to enable().

Specified by:

enabledSet in interface TimerFactory

activeSet

@ManagedAttribute
@Description("All activated Timers")
Set<Timer> activeSet()

Description copied from interface: TimerFactory

Returns a read-only view of the set of Controllables that are currently active. An enabled Timer is active. All Controllables contained in an active or enabled TimerGroup are active.

Specified by:

activeSet in interface TimerFactory