com.caucho.bam
Interface BamService

All Known Implementing Classes:

AbstractBamService, BamJmsService, BamLogService, BamMailService, BamPhpAgent, BamPhpRootService, DeployService, GenericService, HempDomainService, HmuxReceiver, ImUser, ImUserService, JMXService, MemoryNick, MemoryPubSub, MemoryQueueServiceFilter, MemoryRoom, SimpleBamService

public interface BamService

BamService is a registered service.

Method Summary

BamStream	getAgentFilter(BamStream stream) Returns a filter for outbound calls, i.e.
BamStream	getAgentStream() Returns the service's agent stream
BamStream	getBrokerFilter(BamStream stream) Returns a filter for inbound calls, i.e.
java.lang.String	getJid() Returns the service's jid.
void	onAgentStart(java.lang.String jid) Called when an agent logs in
void	onAgentStop(java.lang.String jid) Called when an agent logs out
void	setJid(java.lang.String jid) Sets the service's jid.
boolean	startAgent(java.lang.String jid) Requests that an agent with the given jid be started.
boolean	stopAgent(java.lang.String jid) Requests that an agent with the given jid be stopped.

Method Detail

getJid

java.lang.String getJid()

Returns the service's jid.

setJid

void setJid(java.lang.String jid)

Sets the service's jid.

getAgentStream

BamStream getAgentStream()

Returns the service's agent stream

startAgent

boolean startAgent(java.lang.String jid)

Requests that an agent with the given jid be started.

stopAgent

boolean stopAgent(java.lang.String jid)

Requests that an agent with the given jid be stopped.

onAgentStart

void onAgentStart(java.lang.String jid)

Called when an agent logs in

onAgentStop

void onAgentStop(java.lang.String jid)

Called when an agent logs out

getAgentFilter

BamStream getAgentFilter(BamStream stream)

Returns a filter for outbound calls, i.e. filtering messages to the agent.

getBrokerFilter

BamStream getBrokerFilter(BamStream stream)

Returns a filter for inbound calls, i.e. filtering messages to the broker from the agent.