org.xmlBlaster.engine
Interface EventPluginMBean

All Superinterfaces:

I_AdminPlugin, I_AdminService, I_AdminUsage

All Known Implementing Classes:

EventPlugin

public interface EventPluginMBean

extends I_AdminService

JMX control for the native EventPlugin.

Author:

Marcel Ruff

Method Summary

int	clearPendingEmails() Depending on the configuration setting mail.collectMillis emails are collected to not send too many emails in too short period of time.
java.lang.String	dumpPendingEmails() Depending on the configuration setting mail.collectMillis emails are collected to not send too many emails in too short period of time.
java.lang.String	getEventTypes() The comma separated list of active events.
java.lang.String	getJmxDestinationConfiguration() The JMX configuration setup from xmlBlasterPlugins.xml
long	getMailCollectMillis() How long to collect outgoing emails?
int	getNumOfPendingEmails()
java.lang.String	getPublishDestinationConfiguration() The publish-message configuration setup from xmlBlasterPlugins.xml
java.lang.String	getSmtpDestinationConfiguration() Configuration properties of the email sink.
java.lang.String	sendPendingEmails() Depending on the configuration setting mail.collectMillis emails are collected to not send too many emails in too short period of time.
java.lang.String	sendTestEmail() Triggers a default email to test the configuration.
void	setEventTypes(java.lang.String eventTypes) A comma separated list of active events.
void	setMailCollectMillis(long mailCollectMillis)
void	setSmtpDestinationConfiguration(java.lang.String smtpDestinationConfiguration) Configuration properties of the email sink.
java.lang.String	triggerHeartbeatNotification() Manually trigger a heart beat message.
java.lang.String	triggerTestLogSevere() Triggers a log.severe to test the configuration.
java.lang.String	triggerTestLogWarning() Triggers a log.warning to test the configuration.

Methods inherited from interface org.xmlBlaster.util.admin.I_AdminService

activate, deActivate, isActive

Methods inherited from interface org.xmlBlaster.util.admin.I_AdminPlugin

getType, getVersion, isShutdown, shutdown

Methods inherited from interface org.xmlBlaster.util.admin.I_AdminUsage

getUsageUrl, setUsageUrl, usage

Method Detail

dumpPendingEmails

public java.lang.String dumpPendingEmails()

Depending on the configuration setting mail.collectMillis emails are collected to not send too many emails in too short period of time. Here it is possible to look into such emails.

The default collection time is 12 hours.

Returns:

The XML dump of the pending emails.

clearPendingEmails

public int clearPendingEmails()

Depending on the configuration setting mail.collectMillis emails are collected to not send too many emails in too short period of time. Here it is possible to look into such emails.

The default collection time is 12 hours.

Returns:

Number of removed emails, usually 1 as all events are collected to one mail

getNumOfPendingEmails

public int getNumOfPendingEmails()

sendTestEmail

public java.lang.String sendTestEmail()

Triggers a default email to test the configuration.

Returns:

A comment about the send mail

triggerTestLogSevere

public java.lang.String triggerTestLogSevere()

Triggers a log.severe to test the configuration.

Returns:

A comment about the test

triggerTestLogWarning

public java.lang.String triggerTestLogWarning()

Triggers a log.warning to test the configuration.

Returns:

A comment about the test

sendPendingEmails

public java.lang.String sendPendingEmails()

Depending on the configuration setting mail.collectMillis emails are collected to not send too many emails in too short period of time. Here it is possible to send such emails now.

The default collection time is 12 hours.

Returns:

Comment about send emails, usually all events are collected to one mail

getMailCollectMillis

public long getMailCollectMillis()

How long to collect outgoing emails?

Returns:

Returns the mailCollectMillis or -1 if no email sink is configured

setMailCollectMillis

public void setMailCollectMillis(long mailCollectMillis)

Parameters:

mailCollectMillis - The mailCollectMillis to set.

getEventTypes

public java.lang.String getEventTypes()

The comma separated list of active events.

Returns:

Returns the eventTypes.

setEventTypes

public void setEventTypes(java.lang.String eventTypes)

A comma separated list of active events.

Parameters:

eventTypes - A comma separated list of active events

getSmtpDestinationConfiguration

public java.lang.String getSmtpDestinationConfiguration()

Configuration properties of the email sink.

Returns:

Returns the comma separated properties

setSmtpDestinationConfiguration

public void setSmtpDestinationConfiguration(java.lang.String smtpDestinationConfiguration)

Configuration properties of the email sink.

Parameters:

smtpDestinationConfiguration - The comma separated properties to set.

getJmxDestinationConfiguration

public java.lang.String getJmxDestinationConfiguration()

The JMX configuration setup from xmlBlasterPlugins.xml

Returns:

getPublishDestinationConfiguration

public java.lang.String getPublishDestinationConfiguration()

The publish-message configuration setup from xmlBlasterPlugins.xml

Returns:

Returns the publishDestinationConfiguration.

triggerHeartbeatNotification

public java.lang.String triggerHeartbeatNotification()

Manually trigger a heart beat message.

Returns:

Success text