Package org.mases.datadistributionmanager

Interface ISmartDataDistribution

All Known Implementing Classes:

SmartDataDistribution

public interface ISmartDataDistribution

Main interface to activate Data Distribution Manager

Method Summary

Modifier and Type	Method	Description
void	addListener(IChangedStateListener listener)	Adds a IChangedStateListener listener
void	addListener(IChangingStateListener listener)	Adds a IChangingStateListener listener
void	addListener(IClusterStateChangeListener listener)	Adds a IClusterStateChangeListener listener
void	addListener(ICompletelyDisconnectedListener listener)	Adds a ICompletelyDisconnectedListener listener
void	addListener(IConfigurationListener listener)	Adds a IConfigurationListener listener
void	addListener(IFirstStateChangeListener listener)	Adds a IFirstStateChangeListener listener
void	addListener(ILoggingListener listener)	Adds a ILoggingListener listener
void	addListener(IMultiplePrimaryListener listener)	Adds a IMultiplePrimaryListener listener
void	addListener(IRequestedStateListener listener)	Adds a IRequestedStateListener listener
void	addListener(IStateChangeListener listener)	Adds a IStateChangeListener listener
void	addListener(IStateReadyListener listener)	Adds a IStateReadyListener listener
<T extends SmartDataDistributionChannel> T	CreateSmartChannel(java.lang.Class<T> clazz, java.lang.String channelName)
<T extends SmartDataDistributionChannel> T	CreateSmartChannel(java.lang.Class<T> clazz, java.lang.String channelName, DDM_CHANNEL_DIRECTION direction, java.lang.String[] arrayParams)
<T extends SmartDataDistributionChannel> T	CreateSmartChannel(java.lang.Class<T> clazz, java.lang.String channelName, IConfiguration configuration)
<T extends SmartDataDistributionChannel> T	CreateSmartChannel(java.lang.Class<T> clazz, java.lang.String channelName, IConfiguration configuration, DDM_CHANNEL_DIRECTION direction)
java.lang.String	getMastershipLib()
ISmartDataDistributionMastership	getMastershipManager()
java.lang.String	GetParameter(java.lang.String paramName)	Get global parameter
java.lang.String	GetParameter(DDM_GENERAL_PARAMETER paramId)	Get global parameter
java.lang.String	getProtocol()
java.lang.String	getProtocolLib()
OPERATION_RESULT	Initialize(java.lang.String conf_file)	Initialize the instance using configuration file
OPERATION_RESULT	Initialize(java.lang.String[] arrayParams)	Initialize the instance using a set of key=value pairs
OPERATION_RESULT	Initialize(java.lang.String[] arrayParams, java.lang.String topicTrailer)	Initialize the instance using a set of key=value pairs
OPERATION_RESULT	Initialize(java.lang.String[] arrayParams, java.lang.String szMyAddress, java.lang.String topicTrailer)	Initialize the instance using a set of key=value pairs
OPERATION_RESULT	Initialize(java.lang.String conf_file, java.lang.String topicTrailer)	Initialize the instance using configuration file
OPERATION_RESULT	Initialize(java.lang.String conf_file, java.lang.String szMyAddress, java.lang.String topicTrailer)	Initialize the instance using configuration file
OPERATION_RESULT	Initialize(IConfiguration configuration)	Initialize the instance using a configuration instance
OPERATION_RESULT	Initialize(IConfiguration configuration, java.lang.String topicTrailer)	Initialize the instance using a configuration instance
OPERATION_RESULT	Initialize(IConfiguration configuration, java.lang.String szMyAddress, java.lang.String topicTrailer)	Initialize the instance using a configuration instance
void	OnChangedState(DDM_INSTANCE_STATE newState)	The state has changed
void	OnChangingState(DDM_INSTANCE_STATE oldState, DDM_INSTANCE_STATE newState)	The state is starting to change
void	OnClusterStateChange(DDM_CLUSTEREVENT change, long serverid)	The cluster has changed its state
void	OnFirstStateChange(DDM_INSTANCE_STATE newState)	Called the first time there is state change
void	OnMultiplePrimary(long myId, long otherId)	There are multiple primary server in the cluster
void	OnRequestedState(byte[] buffer)	Called when a state transfer was requested
void	OnStateChange(DDM_INSTANCE_STATE newState, DDM_INSTANCE_STATE oldState)	My state has changed
void	OnStateReady(byte[] buffer)	The state is ready to be used
void	removeListener(IChangedStateListener listener)	Removes a IChangedStateListener listener
void	removeListener(IChangingStateListener listener)	Removes a IChangingStateListener listener
void	removeListener(IClusterStateChangeListener listener)	Removes a IClusterStateChangeListener listener
void	removeListener(ICompletelyDisconnectedListener listener)	Removes a ICompletelyDisconnectedListener listener
void	removeListener(IConfigurationListener listener)	Removes a IConfigurationListener listener
void	removeListener(IFirstStateChangeListener listener)	Removes a IFirstStateChangeListener listener
void	removeListener(ILoggingListener listener)	Removes a ILoggingListener listener
void	removeListener(IMultiplePrimaryListener listener)	Removes a IMultiplePrimaryListener listener
void	removeListener(IRequestedStateListener listener)	Removes a IRequestedStateListener listener
void	removeListener(IStateChangeListener listener)	Removes a IStateChangeListener listener
void	removeListener(IStateReadyListener listener)	Removes a IStateReadyListener listener
OPERATION_RESULT	RequestMastershipManager()	Request to allocate mastership manager
OPERATION_RESULT	RequestMastershipManager(java.lang.String serverName)	Request to allocate mastership manager
OPERATION_RESULT	RequestMastershipManager(java.lang.String[] parameters)	Request to allocate mastership manager
OPERATION_RESULT	RequestMastershipManager(java.lang.String serverName, java.lang.String[] parameters)	Request to allocate mastership manager
OPERATION_RESULT	RequestMastershipManager(java.lang.String serverName, IConfiguration parameters)	Request to allocate mastership manager
OPERATION_RESULT	RequestMastershipManager(IConfiguration parameters)	Request to allocate mastership manager
void	SetParameter(java.lang.String paramName, java.lang.String paramValue)	Set global parameter
void	SetParameter(DDM_GENERAL_PARAMETER paramId, java.lang.String paramValue)	Set global parameter
OPERATION_RESULT	Start(int timeout)	Starts the manager
OPERATION_RESULT	Stop(int timeout)	Stops the manager

Method Detail

Initialize

OPERATION_RESULT Initialize(java.lang.String conf_file)

Initialize the instance using configuration file

Parameters:

conf_file - Configuration file to use

Returns:

OPERATION_RESULT

Initialize

OPERATION_RESULT Initialize(java.lang.String conf_file,
                            java.lang.String topicTrailer)

Initialize the instance using configuration file

Parameters:

conf_file - Configuration file to use

topicTrailer - Trailer string to append on channel names

Returns:

OPERATION_RESULT

Initialize

OPERATION_RESULT Initialize(java.lang.String conf_file,
                            java.lang.String szMyAddress,
                            java.lang.String topicTrailer)

Initialize the instance using configuration file

Parameters:

conf_file - Configuration file to use

szMyAddress - The name of the server hosting the process

topicTrailer - Trailer string to append on channel names

Returns:

OPERATION_RESULT

Initialize

OPERATION_RESULT Initialize(IConfiguration configuration)
                     throws java.lang.IllegalArgumentException

Initialize the instance using a configuration instance

Parameters:

configuration - The configuration coming from an instance of IConfiguration

Returns:

OPERATION_RESULT

Throws:

java.lang.IllegalArgumentException - @see IConfiguration

Initialize

OPERATION_RESULT Initialize(IConfiguration configuration,
                            java.lang.String topicTrailer)
                     throws java.lang.IllegalArgumentException

Initialize the instance using a configuration instance

Parameters:

configuration - The configuration coming from an instance of IConfiguration

topicTrailer - Trailer string to append on channel names

Returns:

OPERATION_RESULT

Throws:

java.lang.IllegalArgumentException - @see IConfiguration

Initialize

OPERATION_RESULT Initialize(IConfiguration configuration,
                            java.lang.String szMyAddress,
                            java.lang.String topicTrailer)
                     throws java.lang.IllegalArgumentException

Initialize the instance using a configuration instance

Parameters:

configuration - The configuration coming from an instance of IConfiguration

szMyAddress - The name of the server hosting the process

topicTrailer - Trailer string to append on channel names

Returns:

OPERATION_RESULT

Throws:

java.lang.IllegalArgumentException - @see IConfiguration

Initialize

OPERATION_RESULT Initialize(java.lang.String[] arrayParams)

Initialize the instance using a set of key=value pairs

Parameters:

arrayParams - array of key=value parameters

Returns:

OPERATION_RESULT

Initialize

OPERATION_RESULT Initialize(java.lang.String[] arrayParams,
                            java.lang.String topicTrailer)

Initialize the instance using a set of key=value pairs

Parameters:

arrayParams - array of key=value parameters

topicTrailer - Trailer string to append on channel names

Returns:

OPERATION_RESULT

Initialize

OPERATION_RESULT Initialize(java.lang.String[] arrayParams,
                            java.lang.String szMyAddress,
                            java.lang.String topicTrailer)

Initialize the instance using a set of key=value pairs

Parameters:

arrayParams - array of key=value parameters

szMyAddress - The name of the server hosting the process

topicTrailer - Trailer string to append on channel names

Returns:

OPERATION_RESULT

RequestMastershipManager

OPERATION_RESULT RequestMastershipManager()

Request to allocate mastership manager

Returns:

OPERATION_RESULT

RequestMastershipManager

OPERATION_RESULT RequestMastershipManager(java.lang.String[] parameters)

Request to allocate mastership manager

Parameters:

parameters - Paramaters to send to underlying layer

Returns:

OPERATION_RESULT

RequestMastershipManager

OPERATION_RESULT RequestMastershipManager(IConfiguration parameters)

Request to allocate mastership manager

Parameters:

parameters - IConfiguration instance of parameters to send to underlying layer

Returns:

OPERATION_RESULT

RequestMastershipManager

OPERATION_RESULT RequestMastershipManager(java.lang.String serverName)

Request to allocate mastership manager

Parameters:

serverName - The server name

Returns:

OPERATION_RESULT

RequestMastershipManager

OPERATION_RESULT RequestMastershipManager(java.lang.String serverName,
                                          IConfiguration parameters)

Request to allocate mastership manager

Parameters:

serverName - The server name

parameters - IConfiguration instance of parameters to send to underlying layer

Returns:

OPERATION_RESULT

RequestMastershipManager

OPERATION_RESULT RequestMastershipManager(java.lang.String serverName,
                                          java.lang.String[] parameters)

Request to allocate mastership manager

Parameters:

serverName - The server name

parameters - Paramaters to send to underlying layer

Returns:

OPERATION_RESULT

getMastershipManager

ISmartDataDistributionMastership getMastershipManager()

Returns:

Returns ISmartDataDistributionMastership

Start

OPERATION_RESULT Start(int timeout)

Starts the manager

Parameters:

timeout - Timeout in ms

Returns:

OPERATION_RESULT

Stop

OPERATION_RESULT Stop(int timeout)

Stops the manager

Parameters:

timeout - Timeout in ms

Returns:

OPERATION_RESULT

getProtocol

java.lang.String getProtocol()

Returns:

Return the protocol in use

getProtocolLib

java.lang.String getProtocolLib()

Returns:

Return the protocol library in use

getMastershipLib

java.lang.String getMastershipLib()

Returns:

Return the mastership library in use

SetParameter

void SetParameter(java.lang.String paramName,
                  java.lang.String paramValue)

Set global parameter

Parameters:

paramName - Parameter name to set

paramValue - Parameter value to set

SetParameter

void SetParameter(DDM_GENERAL_PARAMETER paramId,
                  java.lang.String paramValue)

Set global parameter

Parameters:

paramId - Parameter DDM_GENERAL_PARAMETER to set

paramValue - Parameter value to set

GetParameter

java.lang.String GetParameter(java.lang.String paramName)

Get global parameter

Parameters:

paramName - Parameter name to get

Returns:

Parameter value

GetParameter

java.lang.String GetParameter(DDM_GENERAL_PARAMETER paramId)

Get global parameter

Parameters:

paramId - Parameter DDM_GENERAL_PARAMETER to get

Returns:

Parameter value

CreateSmartChannel

<T extends SmartDataDistributionChannel> T CreateSmartChannel(java.lang.Class<T> clazz,
                                                              java.lang.String channelName)
                                                       throws java.lang.Throwable

Type Parameters:

T - The class extending SmartDataDistributionChannel

Parameters:

clazz - The class to be instantiated

channelName - The channel name

Returns:

The allocated instance

Throws:

java.lang.Throwable - generic exception for all errors (if subsystem was unable to create a channel the exception is a generic Exception)

CreateSmartChannel

<T extends SmartDataDistributionChannel> T CreateSmartChannel(java.lang.Class<T> clazz,
                                                              java.lang.String channelName,
                                                              IConfiguration configuration)
                                                       throws java.lang.Throwable

Type Parameters:

T - The class extending SmartDataDistributionChannel

Parameters:

clazz - The class to be instantiated

channelName - The channel name

configuration - The configuration coming from an instance of IConfiguration

Returns:

The allocated instance

Throws:

java.lang.Throwable - generic exception for all errors (if subsystem was unable to create a channel the exception is a generic Exception)

CreateSmartChannel

<T extends SmartDataDistributionChannel> T CreateSmartChannel(java.lang.Class<T> clazz,
                                                              java.lang.String channelName,
                                                              IConfiguration configuration,
                                                              DDM_CHANNEL_DIRECTION direction)
                                                       throws java.lang.Throwable

Type Parameters:

T - The class extending SmartDataDistributionChannel

Parameters:

clazz - The class to be instantiated

channelName - The channel name

direction - The DDM_CHANNEL_DIRECTION of the channel

configuration - The configuration coming from an instance of IConfiguration

Returns:

The allocated instance

Throws:

java.lang.Throwable - generic exception for all errors (if subsystem was unable to create a channel the exception is a generic Exception)

CreateSmartChannel

<T extends SmartDataDistributionChannel> T CreateSmartChannel(java.lang.Class<T> clazz,
                                                              java.lang.String channelName,
                                                              DDM_CHANNEL_DIRECTION direction,
                                                              java.lang.String[] arrayParams)
                                                       throws java.lang.Throwable

Type Parameters:

T - The class extending SmartDataDistributionChannel

Parameters:

clazz - The class to be instantiated

channelName - The channel name

direction - The DDM_CHANNEL_DIRECTION of the channel

arrayParams - Specific parameters which override main parameters

Returns:

The allocated instance

Throws:

java.lang.Throwable - generic exception for all errors (if subsystem was unable to create a channel the exception is a generic Exception)

addListener

void addListener(IConfigurationListener listener)

Adds a IConfigurationListener listener

Parameters:

listener - IConfigurationListener listener to add

removeListener

void removeListener(IConfigurationListener listener)

Removes a IConfigurationListener listener

Parameters:

listener - IConfigurationListener listener to remove

addListener

void addListener(ILoggingListener listener)

Adds a ILoggingListener listener

Parameters:

listener - ILoggingListener listener to add

removeListener

void removeListener(ILoggingListener listener)

Removes a ILoggingListener listener

Parameters:

listener - ILoggingListener listener to remove

addListener

void addListener(ICompletelyDisconnectedListener listener)

Adds a ICompletelyDisconnectedListener listener

Parameters:

listener - ICompletelyDisconnectedListener listener to add

removeListener

void removeListener(ICompletelyDisconnectedListener listener)

Removes a ICompletelyDisconnectedListener listener

Parameters:

listener - ICompletelyDisconnectedListener listener to remove

addListener

void addListener(IClusterStateChangeListener listener)

Adds a IClusterStateChangeListener listener

Parameters:

listener - IClusterStateChangeListener listener to add

removeListener

void removeListener(IClusterStateChangeListener listener)

Removes a IClusterStateChangeListener listener

Parameters:

listener - IClusterStateChangeListener listener to remove

OnClusterStateChange

void OnClusterStateChange(DDM_CLUSTEREVENT change,
                          long serverid)

The cluster has changed its state

Parameters:

change - New cluster event

serverid - Server has emitted event

addListener

void addListener(IStateChangeListener listener)

Adds a IStateChangeListener listener

Parameters:

listener - IStateChangeListener listener to add

removeListener

void removeListener(IStateChangeListener listener)

Removes a IStateChangeListener listener

Parameters:

listener - IStateChangeListener listener to remove

OnStateChange

void OnStateChange(DDM_INSTANCE_STATE newState,
                   DDM_INSTANCE_STATE oldState)

My state has changed

Parameters:

newState - New state

oldState - Old state

addListener

void addListener(IStateReadyListener listener)

Adds a IStateReadyListener listener

Parameters:

listener - IStateReadyListener listener to add

removeListener

void removeListener(IStateReadyListener listener)

Removes a IStateReadyListener listener

Parameters:

listener - IStateReadyListener listener to remove

OnStateReady

void OnStateReady(byte[] buffer)

The state is ready to be used

Parameters:

buffer - The buffer state receiver

addListener

void addListener(IRequestedStateListener listener)

Adds a IRequestedStateListener listener

Parameters:

listener - IRequestedStateListener listener to add

removeListener

void removeListener(IRequestedStateListener listener)

Removes a IRequestedStateListener listener

Parameters:

listener - IRequestedStateListener listener to remove

OnRequestedState

void OnRequestedState(byte[] buffer)

Called when a state transfer was requested

Parameters:

buffer - Pointer to the buffer

addListener

void addListener(IMultiplePrimaryListener listener)

Adds a IMultiplePrimaryListener listener

Parameters:

listener - IMultiplePrimaryListener listener to add

removeListener

void removeListener(IMultiplePrimaryListener listener)

Removes a IMultiplePrimaryListener listener

Parameters:

listener - IMultiplePrimaryListener listener to remove

OnMultiplePrimary

void OnMultiplePrimary(long myId,
                       long otherId)

There are multiple primary server in the cluster

Parameters:

myId - My identifier

otherId - Other identifier which is primary

addListener

void addListener(IFirstStateChangeListener listener)

Adds a IFirstStateChangeListener listener

Parameters:

listener - IFirstStateChangeListener listener to add

removeListener

void removeListener(IFirstStateChangeListener listener)

Removes a IFirstStateChangeListener listener

Parameters:

listener - IFirstStateChangeListener listener to remove

OnFirstStateChange

void OnFirstStateChange(DDM_INSTANCE_STATE newState)

Called the first time there is state change

Parameters:

newState - New state

addListener

void addListener(IChangingStateListener listener)

Adds a IChangingStateListener listener

Parameters:

listener - IChangingStateListener listener to add

removeListener

void removeListener(IChangingStateListener listener)

Removes a IChangingStateListener listener

Parameters:

listener - IChangingStateListener listener to remove

OnChangingState

void OnChangingState(DDM_INSTANCE_STATE oldState,
                     DDM_INSTANCE_STATE newState)

The state is starting to change

Parameters:

oldState - Old state

newState - New state

addListener

void addListener(IChangedStateListener listener)

Adds a IChangedStateListener listener

Parameters:

listener - IChangedStateListener listener to add

removeListener

void removeListener(IChangedStateListener listener)

Removes a IChangedStateListener listener

Parameters:

listener - IChangedStateListener listener to remove

OnChangedState

void OnChangedState(DDM_INSTANCE_STATE newState)

The state has changed

Parameters:

newState - New state