com.communote.plugins.mq.provider.activemq.settings

Interface MQSettingsDAO

All Known Implementing Classes:

MQDatabaseSettingsDAO

public interface MQSettingsDAO

Interface for accessing the configuration of the broker.

Author:

Communote GmbH - http://www.communote.com/

Method Summary

Modifier and Type	Method and Description
Set<String>	getBrokerConnectorURLs() Use this this method to list all urls that the broker should be started on, hence the vm url will not be included, since it will be available always.
Set<String>	getBrokerConnectorURLsWithVM() Use this method to list all urls that can be used to connect to the broker
String	getBrokerName()
String	getDataDirectory()
String	getJmxDomainName()
int	getJmxPort()
String	getQueueName()
String	getReplyQueueNamePrefix()
String	getSSLPort()
String	getTcpPort()
String	getUrlHostname()
String	getVMConnectorURL()
boolean	isBrokerStarted()
boolean	isEnableSSL()
boolean	isEnableTCP()
boolean	isEnableVM() This flag is only relevant for the adapter connecting to the broker, since the VM connection is always available once the broker is started.
boolean	isForceSSL()
boolean	isForceSSLClientAuthentication()
boolean	isJmxMonitoringEnabled()
boolean	isJmxRemoteEnabled()
void	setBrokerStarted(boolean isStarted) sets broker's state flag
void	setDataDirectory(String dataDirectoryPath) sets data directory path
void	setEnableJmxRemote(boolean enableJmx)
void	setEnableSSL(boolean enableSSL)
void	setEnableTCP(boolean enableTCP)
void	setEnableVM(boolean enableVM) VM = virtual machine connector
void	setForceSSL(boolean forceSSL)
void	setForceSSLClientAuthentication(boolean needClientAuth)

Method Detail

getBrokerConnectorURLs

Set<String> getBrokerConnectorURLs()

Use this this method to list all urls that the broker should be started on, hence the vm url will not be included, since it will be available always.

Returns:

broker connector urls

getBrokerConnectorURLsWithVM

Set<String> getBrokerConnectorURLsWithVM()

Use this method to list all urls that can be used to connect to the broker

Returns:

broker connector urls including the VM url (if isEnableVM() is true)

getBrokerName

String getBrokerName()

Returns:

broker name

getDataDirectory

String getDataDirectory()

Returns:

data directory path

getJmxDomainName

String getJmxDomainName()

Returns:

the JMX domain name for the MQ broker

getJmxPort

int getJmxPort()

Returns:

the port to be used for jmx connection

getQueueName

String getQueueName()

Returns:

the name of the communote message queue

getReplyQueueNamePrefix

String getReplyQueueNamePrefix()

Returns:

the name of queue to reply messages to

getSSLPort

String getSSLPort()

Returns:

the ssl port to use

getTcpPort

String getTcpPort()

Returns:

the tcp port to use

getUrlHostname

String getUrlHostname()

Returns:

the hostname of the url to use

getVMConnectorURL

String getVMConnectorURL()

Returns:

the vm url for clients to connect to

isBrokerStarted

boolean isBrokerStarted()

Returns:

broker's state

isEnableSSL

boolean isEnableSSL()

Returns:

true if SSL is enabled. default ist false

isEnableTCP

boolean isEnableTCP()

Returns:

true to enable tcp connector. default ist false.

isEnableVM

boolean isEnableVM()

This flag is only relevant for the adapter connecting to the broker, since the VM connection is always available once the broker is started. It can be used to tell the adaper, not to use the vm and connect to another host.

Returns:

true to enable vm connection. default ist true.

isForceSSL

boolean isForceSSL()

Returns:

the forceSSL. default ist false.

isForceSSLClientAuthentication

boolean isForceSSLClientAuthentication()

Returns:

true if a client certificate is required (if it is a SSL connection, will be ignored for non SSL connections)

isJmxMonitoringEnabled

boolean isJmxMonitoringEnabled()

Returns:

true to enable the jmx monitoring

isJmxRemoteEnabled

boolean isJmxRemoteEnabled()

Returns:

true if jmx is enabled for remote connections and should be started on the getJmxPort() port

setBrokerStarted

void setBrokerStarted(boolean isStarted)
               throws AuthorizationException

sets broker's state flag

Parameters:

isStarted - the flag value

Throws:

AuthorizationException

setDataDirectory

void setDataDirectory(String dataDirectoryPath)
               throws AuthorizationException

sets data directory path

Parameters:

dataDirectoryPath - path to set

Throws:

AuthorizationException

setEnableJmxRemote

void setEnableJmxRemote(boolean enableJmx)
                 throws AuthorizationException

Parameters:

enableJmx - the enableJmx to set

Throws:

AuthorizationException

setEnableSSL

void setEnableSSL(boolean enableSSL)
           throws AuthorizationException

Parameters:

enableSSL - true to enable the ssl connector

Throws:

AuthorizationException

setEnableTCP

void setEnableTCP(boolean enableTCP)
           throws AuthorizationException

Parameters:

enableTCP - true to enable tcp

Throws:

AuthorizationException

setEnableVM

void setEnableVM(boolean enableVM)
          throws AuthorizationException

VM = virtual machine connector

Parameters:

enableVM - true to enable vm (which actually only relevant for the embedded adapter)

Throws:

AuthorizationException

setForceSSL

void setForceSSL(boolean forceSSL)
          throws AuthorizationException

Parameters:

forceSSL - the forceSSL to set

Throws:

AuthorizationException

setForceSSLClientAuthentication

void setForceSSLClientAuthentication(boolean needClientAuth)
                              throws AuthorizationException

Parameters:

needClientAuth - true if a client auth by certificate is expected on connecting to the broker

Throws:

AuthorizationException