org.mule.example.notifications
Class HeartbeatAgent

java.lang.Object
  org.mule.AbstractAgent
      org.mule.example.notifications.HeartbeatAgent

All Implemented Interfaces:

org.mule.api.agent.Agent, org.mule.api.context.MuleContextAware, org.mule.api.lifecycle.Disposable, org.mule.api.lifecycle.Initialisable, org.mule.api.lifecycle.Lifecycle, org.mule.api.lifecycle.Startable, org.mule.api.lifecycle.Stoppable, org.mule.api.NameableObject, org.mule.api.NamedObject

public class HeartbeatAgent
extends org.mule.AbstractAgent

A simple agent that fire HeartbeatNotification events at a given frequency to notify that the server is alive and well.

Nested Class Summary

class

HeartbeatAgent.Heartbeat

Field Summary

static String

NAME

Fields inherited from class org.mule.AbstractAgent

muleContext, name

Fields inherited from interface org.mule.api.lifecycle.Initialisable

PHASE_NAME

Fields inherited from interface org.mule.api.lifecycle.Startable

PHASE_NAME

Fields inherited from interface org.mule.api.lifecycle.Stoppable

PHASE_NAME

Fields inherited from interface org.mule.api.lifecycle.Disposable

PHASE_NAME

Constructor Summary

HeartbeatAgent()

Method Summary

void	dispose()
long	getFrequency()
void	initialise()
void	setFrequency(long frequency)
void	start()
void	stop()

Methods inherited from class org.mule.AbstractAgent

getDescription, getName, setMuleContext, setName, unregisterMeQuietly

Methods inherited from class java.lang.Object

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

Field Detail

NAME

public static final String NAME

See Also:

Constant Field Values

Constructor Detail

HeartbeatAgent

public HeartbeatAgent()

Method Detail

getFrequency

public long getFrequency()

setFrequency

public void setFrequency(long frequency)

initialise

public void initialise()
                throws org.mule.api.lifecycle.InitialisationException

Throws:

org.mule.api.lifecycle.InitialisationException

start

public void start()
           throws org.mule.api.MuleException

Throws:

org.mule.api.MuleException

stop

public void stop()
          throws org.mule.api.MuleException

Throws:

org.mule.api.MuleException

dispose

public void dispose()