org.marketcetera.modules.remote.emitter

Interface EmitterModuleMXBean

@MXBean(value=true)
public interface EmitterModuleMXBean

The management interface for the EmitterModule.

The implementation of this interface emits AttributeChangeNotification whenever the value of isConnected() attribute changes.

Since:

1.5.0

Version:

$Id: EmitterModuleMXBean.java 16154 2012-07-14 16:34:05Z colin $

Author:

anshul@marketcetera.com

Method Summary

Modifier and Type	Method and Description
String	getLastFailure() Returns the last failure encountered when receiving objects.
String	getURL() Gets the URL for connecting to the remote receiver module.
String	getUsername() Gets the user name to use to authenticate when connecting to the remote receiver module.
boolean	isConnected() Returns true if the connection to the remote receiver is active.
void	setPassword(String inPassword) Sets the password to use to authenticate when connecting to the remote receiver module.
void	setURL(String inURL) Sets the URL for connecting to the remote receiver module.
void	setUsername(String inUsername) Sets the user name to use to authenticate when connecting to the remote receiver module.

Method Detail

getURL

String getURL()

Gets the URL for connecting to the remote receiver module.

Returns:

the URL value.

setURL

void setURL(String inURL)

Sets the URL for connecting to the remote receiver module.

Parameters:

inURL - the URL value.

Throws:

IllegalStateException - if the module is started. The URL can only be set when the module is not started.

getUsername

String getUsername()

Gets the user name to use to authenticate when connecting to the remote receiver module.

Returns:

the user name.

setUsername

void setUsername(String inUsername)

Sets the user name to use to authenticate when connecting to the remote receiver module.

Parameters:

inUsername - the user name.

Throws:

IllegalStateException - if the module is started. The Username can only be set when the module is not started.

setPassword

void setPassword(String inPassword)

Sets the password to use to authenticate when connecting to the remote receiver module.

Parameters:

inPassword - the password.

Throws:

IllegalStateException - if the module is started. The password can only be set when the module is not started.

isConnected

boolean isConnected()

Returns true if the connection to the remote receiver is active.

The bean emits attribute change notifications when this attribute value changes.

Returns:

true if the connection to the remote receiver is active.

getLastFailure

String getLastFailure()

Returns the last failure encountered when receiving objects.

Returns:

last failure encountered. Null, if no failures have been encountered so far.