org.ow2.jasmine.monitoring.mbeancmd.sampling
Class Sampler

java.lang.Object
  org.ow2.jasmine.monitoring.mbeancmd.sampling.Sampler

Direct Known Subclasses:

CpuSunSampler, DSSampler, EntitySampler, JCACFSampler, JoramQSampler, ServerSampler, ServletSampler, SessionBeanSampler, TxSampler, WebSampler

public abstract class Sampler
extends Object

Base class for all sampler classes.

Field Summary

protected SamplerContext	context context of the sampler
protected org.ow2.util.log.Log	logger Logger.

Constructor Summary

Sampler(SamplerContext context)
Creates the Sampler using a JMX URL.

Method Summary

String	getCmdId()
protected abstract String	getDefaultOnPattern()
String	getDomain()
String	getJmxUrl()
protected MBeanServerConnection	getMBeanServerConnection()
String	getName()
protected String	getOnPattern()
String	getServer()
boolean	isHasFailed()
protected abstract SampleData	newSampleData()
protected abstract SampleData	poll(SampleData prev) Poll based on a previous sample.
protected ObjectName[]	queryON(String onProto) Gets the list of object names that match a given object name prototype, and set the OnjectName list in the SamplerContext (onames).
protected void	releaseMbeanServerConnection()
SampleData	sample(SampleData previous) Samples data based on a previous sample.
void	setHasFailed(boolean hasFailed)
void	setOnPattern(String onPattern) Set pattern, then set the OnjectName list in the SamplerContext (onames).

Methods inherited from class java.lang.Object

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

Field Detail

logger

protected org.ow2.util.log.Log logger

Logger.

context

protected SamplerContext context

context of the sampler

Constructor Detail

Sampler

public Sampler(SamplerContext context)

Creates the Sampler using a JMX URL.

Parameters:

urlString - JMX URL.

Method Detail

getMBeanServerConnection

protected final MBeanServerConnection getMBeanServerConnection()

Returns:

Connection to MBean server. Will return existing instance if already connected, and try to connect if no connection exists. Returns null on failure.

releaseMbeanServerConnection

protected void releaseMbeanServerConnection()

queryON

protected final ObjectName[] queryON(String onProto)
                              throws Exception

Gets the list of object names that match a given object name prototype, and set the OnjectName list in the SamplerContext (onames).

Parameters:

onProto - Object name filtering pattern to use.

Returns:

All objects that match onProto. Null if no objects found.

Throws:

Exception

getDefaultOnPattern

protected abstract String getDefaultOnPattern()

Returns:

Default Object name filtering pattern for this sampler. If null, we'll consider that the Sampler doesn't have one default object name filter.

getOnPattern

protected String getOnPattern()

Returns:

Object name filtering pattern.

setOnPattern

public void setOnPattern(String onPattern)

Set pattern, then set the OnjectName list in the SamplerContext (onames).

Parameters:

onProto - Object name filtering pattern to set.

sample

public final SampleData sample(SampleData previous)

Samples data based on a previous sample.

Parameters:

previous - Previous sample.

Returns:

Sampled data,

See Also:

SampleData.compute(SampleData)

getName

public String getName()

Returns:

Name set for the server in the jmxurls.properties file.

getJmxUrl

public String getJmxUrl()

Returns:

getServer

public String getServer()

Returns:

Server name.

getDomain

public String getDomain()

Returns:

Server's domain name.

getCmdId

public String getCmdId()

newSampleData

protected abstract SampleData newSampleData()

Returns:

New sample data.

poll

protected abstract SampleData poll(SampleData prev)

Poll based on a previous sample.

Parameters:

prev - Previous sample.

Returns:

Resulting data.

isHasFailed

public boolean isHasFailed()

setHasFailed

public void setHasFailed(boolean hasFailed)