Package com.sun.enterprise.mgmt.transport

Interface NetworkManager

All Superinterfaces:

MessageSender, MulticastMessageSender, ShoalMessageSender

All Known Implementing Classes:

AbstractNetworkManager, GrizzlyNetworkManager, GrizzlyNetworkManager2

public interface NetworkManager
extends MulticastMessageSender, MessageSender

This interface has common APIs for network managements According to a kind of transport layers, this interface will be implemented adequately. Currently, ClusterManager initializes this with calling initialize(String, String, java.util.Map). After initialization, start() ) will be called.

Author:

Bongjae Chang

Field Summary

Fields inherited from interface com.sun.enterprise.mgmt.transport.ShoalMessageSender

TCP_TRANSPORT, UDP_TRANSPORT

Method Summary

Modifier and Type	Method	Description
void	addMessageListener(MessageListener messageListener)	Adds the MessageListener
void	addRemotePeer(PeerID peerID)	Add the peerID to this network manager
PeerID	getLocalPeerID()	Returns local PeerID
MessageSender	getMessageSender(int transport)	Returns a MessageSender corresponding with transport type
MulticastMessageSender	getMulticastMessageSender()	Returns a MulticastMessageSender
PeerID	getPeerID(String instanceName)	Returns the proper PeerID corresponding with a given instance name
void	initialize(String groupName, String instanceName, Map properties)	Initializes this network manager with given params and properties
boolean	isConnected(PeerID peerID)	Check whether the suspicious peer is alive or not This API is mainly used in HealthMonitor in order to determine the failure member
void	receiveMessage(Message message, Map piggyback)	Processes a received Message In this process, inbound Message will be wrapped into MessageEvent and be delivered to registered MessageListener with corresponding to the message type
void	removeMessageListener(MessageListener messageListener)	Removes the MessageListener
void	removePeerID(PeerID peerID)	Removes the peerID from this network manager
void	start()	Starts this network manager This method will be called after initialize(String, String, java.util.Map) internally
void	stop()	Stops this network manager For cleaning up remaining values and finishing I/O operation, this method could be used

Methods inherited from interface com.sun.enterprise.mgmt.transport.MessageSender

send

Methods inherited from interface com.sun.enterprise.mgmt.transport.MulticastMessageSender

broadcast

Method Detail

initialize

void initialize(String groupName,
                String instanceName,
                Map properties)
         throws IOException

Initializes this network manager with given params and properties

Parameters:

groupName - group name

instanceName - instance name

properties - specific properties

Throws:

IOException - if an unexpected error occurs

start

void start()
    throws IOException

Starts this network manager This method will be called after initialize(String, String, java.util.Map) internally

Specified by:

start in interface ShoalMessageSender

Throws:

IOException - if an I/O error occurs

stop

void stop()
   throws IOException

Stops this network manager For cleaning up remaining values and finishing I/O operation, this method could be used

Specified by:

stop in interface ShoalMessageSender

Throws:

IOException - if an I/O error occurs

addMessageListener

void addMessageListener(MessageListener messageListener)

Adds the MessageListener

Parameters:

messageListener - a message listener which should be registered on this network manager

removeMessageListener

void removeMessageListener(MessageListener messageListener)

Removes the MessageListener

Parameters:

messageListener - a message listener which should be removed

receiveMessage

void receiveMessage(Message message,
                    Map piggyback)

Processes a received Message In this process, inbound Message will be wrapped into MessageEvent and be delivered to registered MessageListener with corresponding to the message type

Parameters:

message - inbound message

piggyback - piggyback

getLocalPeerID

PeerID getLocalPeerID()

Returns local PeerID

Returns:

peer id

getPeerID

PeerID getPeerID(String instanceName)

Returns the proper PeerID corresponding with a given instance name

Parameters:

instanceName - instance name

Returns:

peer id

addRemotePeer

void addRemotePeer(PeerID peerID)

Add the peerID to this network manager

Parameters:

peerID - the peer Id

removePeerID

void removePeerID(PeerID peerID)

Removes the peerID from this network manager

Parameters:

peerID - the peer Id

isConnected

boolean isConnected(PeerID peerID)

Check whether the suspicious peer is alive or not This API is mainly used in HealthMonitor in order to determine the failure member

Parameters:

peerID - peer id

Returns:

true if the peer is still alive, otherwise false

getMessageSender

MessageSender getMessageSender(int transport)

Returns a MessageSender corresponding with transport type

Parameters:

transport - transport type. ShoalMessageSender.TCP_TRANSPORT or ShoalMessageSender.UDP_TRANSPORT's integer value

Returns:

a MessageSender's instance which this network manager contains

getMulticastMessageSender

MulticastMessageSender getMulticastMessageSender()

Returns a MulticastMessageSender

Returns:

a MulticastMessageSender's instance which this network manager contains