org.ow2.petals.jbi.messaging.routing.monitoring
Interface RouterMonitorMBean

All Superinterfaces:

org.ow2.petals.jmx.api.IPetalsMonitoringService

All Known Subinterfaces:

RouterMonitorService

All Known Implementing Classes:

RouterMonitorServiceImpl

public interface RouterMonitorMBean
extends org.ow2.petals.jmx.api.IPetalsMonitoringService

The NMR monitor MBean.

Since:

3.1

Author:

rnaudin

Nested Class Summary

Nested classes/interfaces inherited from interface org.ow2.petals.jmx.api.IPetalsMonitoringService

org.ow2.petals.jmx.api.IPetalsMonitoringService.Event, org.ow2.petals.jmx.api.IPetalsMonitoringService.EventType, org.ow2.petals.jmx.api.IPetalsMonitoringService.Exchange, org.ow2.petals.jmx.api.IPetalsMonitoringService.MEP, org.ow2.petals.jmx.api.IPetalsMonitoringService.NormalizedMessage, org.ow2.petals.jmx.api.IPetalsMonitoringService.NormalizedMessageType, org.ow2.petals.jmx.api.IPetalsMonitoringService.Role, org.ow2.petals.jmx.api.IPetalsMonitoringService.RouterMonitor, org.ow2.petals.jmx.api.IPetalsMonitoringService.Status

Method Summary

void	clearMonitorStorage() Clear the monitor storage.The persisted data related to the monitored exchanges are deleted.
java.util.Map<java.lang.String,java.lang.String>	getExchange(java.lang.String exchangeId) Get the exchange with the given exchange Id.
java.util.Map<java.lang.String,java.lang.Long>	getExchangeHistory(java.lang.String exchangeId) Get the history of the given exchange.
java.util.List<java.lang.String>	getExchangeIds(javax.xml.namespace.QName interfaceName, javax.xml.namespace.QName serviceName, java.lang.String endpointName, javax.xml.namespace.QName operationName, long startDate, long endDate) Get the list of exchange Ids that has been sent or received at least once, matching the given criteria and the exchange persistence duration.
java.util.List<java.lang.String>	getExchangeIds(java.lang.String propertyKey, java.lang.String propertyValue) Get the list of exchange Ids that has been sent or received at least once, matching the given exchange property and the exchange persistence duration.
int	getExchanges(javax.xml.namespace.QName interfaceName, javax.xml.namespace.QName serviceName, java.lang.String endpointName, javax.xml.namespace.QName operationName, long startDate, long endDate) Get the number of exchange that has been sent or received at least once and matching the duration.
java.util.List<java.util.Map<java.lang.String,java.lang.String>>	getMonitoredExchanges() Get the list of Router Monitor filter.
long	getMonitorStorageDuration() Get the duration of the monitoring storage.
void	monitorExchanges(javax.xml.namespace.QName interfaceName, javax.xml.namespace.QName serviceName, java.lang.String endpointName, javax.xml.namespace.QName operationName, boolean storeExchanges) Activate the monitoring of the exchanges matching the given criteria.
void	setMonitorStorageDuration(long duration) Set the duration of the monitoring storage.
void	unmonitorExchanges(javax.xml.namespace.QName interfaceName, javax.xml.namespace.QName serviceName, java.lang.String endpointName, javax.xml.namespace.QName operationName) Deactivate the monitoring of the exchanges matching the given criteria.

Method Detail

clearMonitorStorage

void clearMonitorStorage()

Clear the monitor storage.The persisted data related to the monitored exchanges are deleted.

Throws:

javax.jbi.messaging.MessagingException - Failed to clear the storage

getExchange

java.util.Map<java.lang.String,java.lang.String> getExchange(java.lang.String exchangeId)
                                                             throws javax.jbi.messaging.MessagingException

Get the exchange with the given exchange Id.

Parameters:

exchangeId -

Returns:

The exchange in a key/value form

Throws:

javax.jbi.messaging.MessagingException - Failed to retrieve the exchange

getExchangeHistory

java.util.Map<java.lang.String,java.lang.Long> getExchangeHistory(java.lang.String exchangeId)
                                                                  throws javax.jbi.messaging.MessagingException

Get the history of the given exchange.

Parameters:

exchangeId - the send/received history

Returns:

Throws:

javax.jbi.messaging.MessagingException - Failed to retrieve the exchange history

getExchangeIds

java.util.List<java.lang.String> getExchangeIds(javax.xml.namespace.QName interfaceName,
                                                javax.xml.namespace.QName serviceName,
                                                java.lang.String endpointName,
                                                javax.xml.namespace.QName operationName,
                                                long startDate,
                                                long endDate)
                                                throws javax.jbi.messaging.MessagingException

Get the list of exchange Ids that has been sent or received at least once, matching the given criteria and the exchange persistence duration.

Parameters:

interfaceName - The interface name that exchange targets. Can be null

serviceName - The service name that exchange targets. Can be null

endpointName - The endpoint name that exchange targets. Can be null

operationName - The operation name that exchange targets. Can be null

startDate - the start date

endDate - the end date

Returns:

the list of the exchange Ids

Throws:

javax.jbi.messaging.MessagingException - Failed to retrieve the list of exchange Ids

getExchangeIds

java.util.List<java.lang.String> getExchangeIds(java.lang.String propertyKey,
                                                java.lang.String propertyValue)
                                                throws javax.jbi.messaging.MessagingException,
                                                       java.io.IOException

Get the list of exchange Ids that has been sent or received at least once, matching the given exchange property and the exchange persistence duration.

Parameters:

propertyKey - The name of the property

propertyValue - The value of the property as a String

Returns:

the list of the exchange Ids

Throws:

javax.jbi.messaging.MessagingException - Failed to retrieve the list of exchange Ids

java.io.IOException - Failed to retrieve the list of exchange Ids

getExchanges

int getExchanges(javax.xml.namespace.QName interfaceName,
                 javax.xml.namespace.QName serviceName,
                 java.lang.String endpointName,
                 javax.xml.namespace.QName operationName,
                 long startDate,
                 long endDate)
                 throws javax.jbi.messaging.MessagingException

Get the number of exchange that has been sent or received at least once and matching the duration.

Parameters:

interfaceName - The interface name that exchange targets. Can be null

serviceName - The service name that exchange targets. Can be null

endpointName - The endpoint name that exchange targets. Can be null

operationName - The operation name that exchange targets. Can be null

startDate - the start date

endDate - the end date

Returns:

the list of the exchange Ids

Throws:

javax.jbi.messaging.MessagingException - Failed to retrieve the list of exchange Ids

getMonitoredExchanges

java.util.List<java.util.Map<java.lang.String,java.lang.String>> getMonitoredExchanges()

Get the list of Router Monitor filter.

Returns:

the list of Router Monitor filter in key/values form.

monitorExchanges

void monitorExchanges(javax.xml.namespace.QName interfaceName,
                      javax.xml.namespace.QName serviceName,
                      java.lang.String endpointName,
                      javax.xml.namespace.QName operationName,
                      boolean storeExchanges)
                      throws javax.jbi.messaging.MessagingException

Activate the monitoring of the exchanges matching the given criteria.

Parameters:

interfaceName - The interface name that exchange targets. Can be null

serviceName - The service name that exchange targets. Can be null

endpointName - The endpoint name that exchange targets. Can be null

operationName - The operation name that exchange targets. Can be null

storeExchanges - if true, the exchanges are stored in the Persistence Service.

Throws:

javax.jbi.messaging.MessagingException - A Router Monitor filter already exists on these criteria

setMonitorStorageDuration

void setMonitorStorageDuration(long duration)

Set the duration of the monitoring storage. Once the duration is reached, the persisted data related to the monitored exchange are deleted.

Parameters:

duration - The duration in millisecond

getMonitorStorageDuration

long getMonitorStorageDuration()

Get the duration of the monitoring storage. Once the duration is reached, the persisted data related to the monitored exchange are deleted.

Parameters:

duration - The duration in millisecond

unmonitorExchanges

void unmonitorExchanges(javax.xml.namespace.QName interfaceName,
                        javax.xml.namespace.QName serviceName,
                        java.lang.String endpointName,
                        javax.xml.namespace.QName operationName)
                        throws javax.jbi.messaging.MessagingException

Deactivate the monitoring of the exchanges matching the given criteria.

Parameters:

interfaceName - The interface name that exchange targets. Can be null

ServiceName - The service name that exchange targets. Can be null

endpointName - The endpoint name that exchange targets. Can be null

operationName - The operation name that exchange targets. Can be null

Throws:

javax.jbi.messaging.MessagingException - No Router Monitor filter activated on the given criteria