org.mobicents.protocols.api

Interface Management

public interface Management

Management class manages the underlying Association and Server.

Management should persist the state of Server and Association

Management when started looks for file XXX_sctp.xml containing serialized state of underlying Association and Server. Set the directory path by calling setPersistDir(String) to direct Management to look at specified directory for underlying serialized file.

If directory path is not set, Management searches for system property sctp.persist.dir to get the path for directory

Even if sctp.persist.dir system property is not set, Management will look at System set property user.dir

Author:

amit bhayani

Method Summary

Methods

Modifier and Type	Method and Description
Association	addAssociation(java.lang.String hostAddress, int hostPort, java.lang.String peerAddress, int peerPort, java.lang.String assocName) Add Association.
Association	addAssociation(java.lang.String hostAddress, int hostPort, java.lang.String peerAddress, int peerPort, java.lang.String assocName, IpChannelType ipChannelType, java.lang.String[] extraHostAddresses) Add Association
void	addManagementEventListener(ManagementEventListener listener) Adding ManagementEventListener.
Server	addServer(java.lang.String serverName, java.lang.String hostAddress, int port) Add new Server.
Server	addServer(java.lang.String serverName, java.lang.String hostAddress, int port, IpChannelType ipChannelType, boolean acceptAnonymousConnections, int maxConcurrentConnectionsCount, java.lang.String[] extraHostAddresses) Add new Server.
Server	addServer(java.lang.String serverName, java.lang.String hostAddress, int port, IpChannelType ipChannelType, java.lang.String[] extraHostAddresses) Add new Server.
Association	addServerAssociation(java.lang.String peerAddress, int peerPort, java.lang.String serverName, java.lang.String assocName) Add server Association.
Association	addServerAssociation(java.lang.String peerAddress, int peerPort, java.lang.String serverName, java.lang.String assocName, IpChannelType ipChannelType) Add server Association.
Association	getAssociation(java.lang.String assocName) Get existing Association for passed name
java.util.Map<java.lang.String,Association>	getAssociations() Get configured Association map with name as key and Association instance as value
int	getConnectDelay() Get connection delay.
java.lang.String	getName() Returns the name of this Management instance
java.lang.String	getPersistDir() Get persist dir
ServerListener	getServerListener() The AssociationListener set for this Association
java.util.List<Server>	getServers() Get the list of Servers configured
int	getWorkerThreads() Number of threads configured to callback AssociationListener methods.
boolean	isSingleThread() If set as single thread, number of workers thread set has no effect and entire protocol stack runs on single thread
boolean	isStarted() returns true if Management is started
void	removeAllResourses() This method stops and removes all registered servers and associations Management should be started Use this method only for test purposes or after total crashes
void	removeAssociation(java.lang.String assocName) Remove existing Association.
void	removeManagementEventListener(ManagementEventListener listener) Removing ManagementEventListener.
void	removeServer(java.lang.String serverName) Remove existing Server
void	setConnectDelay(int connectDelay) Set the connection delay for client side Association
void	setPersistDir(java.lang.String persistDir) Directory where the XXX.xml will be searched
void	setServerListener(ServerListener serverListener) The AssociationListener to be registered for this Association
void	setSingleThread(boolean singleThread) Set protocol stack as single thread
void	setWorkerThreads(int workerThreads) Number of threads configured for callback AssociationListener
void	start() Start the management.
void	startAssociation(java.lang.String assocName) Start the existing Association
void	startServer(java.lang.String serverName) Start the existing Server
void	stop() Stop the management.
void	stopAssociation(java.lang.String assocName) Stop the existing Association
void	stopServer(java.lang.String serverName) Stop the Server.

Method Detail

getName

java.lang.String getName()

Returns the name of this Management instance

Returns:

getPersistDir

java.lang.String getPersistDir()

Get persist dir

Returns:

setPersistDir

void setPersistDir(java.lang.String persistDir)

Directory where the XXX.xml will be searched

Parameters:

persistDir -

getServerListener

ServerListener getServerListener()

The AssociationListener set for this Association

Returns:

setServerListener

void setServerListener(ServerListener serverListener)

The AssociationListener to be registered for this Association

Parameters:

associationListener -

addManagementEventListener

void addManagementEventListener(ManagementEventListener listener)

Adding ManagementEventListener. This listener is notified when adding/removing servers and associations

Parameters:

listener -

removeManagementEventListener

void removeManagementEventListener(ManagementEventListener listener)

Removing ManagementEventListener. This listener is notified when adding/removing servers and associations

Parameters:

listener -

start

void start()
           throws java.lang.Exception

Start the management. No management operation can be executed unless Management is started. If Server and Association were defined previously, Management should recreate those Server and Association.

Throws:

java.lang.Exception

stop

void stop()
          throws java.lang.Exception

Stop the management. It should persist the state of Server and Associtaion.

Throws:

java.lang.Exception

isStarted

boolean isStarted()

returns true if Management is started

Returns:

removeAllResourses

void removeAllResourses()
                        throws java.lang.Exception

This method stops and removes all registered servers and associations Management should be started Use this method only for test purposes or after total crashes

Throws:

java.lang.Exception

addServer

Server addServer(java.lang.String serverName,
               java.lang.String hostAddress,
               int port,
               IpChannelType ipChannelType,
               boolean acceptAnonymousConnections,
               int maxConcurrentConnectionsCount,
               java.lang.String[] extraHostAddresses)
                 throws java.lang.Exception

Add new Server.

Parameters:

serverName - name of the Server. Should be unique name

hostAddress - IP address that this server will bind to

port - port that this server will bind to

ipChannelType - IP channel type: SCTP or TCP

acceptAnonymousConnections - true: this Server accepts Anonymous connections, false: no

maxConcurrentConnectionsCount - A count of concurrent connections that can accept a Server. 0 means an unlimited count.

extraHostAddresses - When SCTP multi-homing configuration extra IP addresses can be put here If multi-homing absence this parameter can be null

Returns:

new Server instance

Throws:

java.lang.Exception - Exception if management not started or server name already taken or some other server already has same ip:port

addServer

Server addServer(java.lang.String serverName,
               java.lang.String hostAddress,
               int port,
               IpChannelType ipChannelType,
               java.lang.String[] extraHostAddresses)
                 throws java.lang.Exception

Add new Server. Server can not accept anonymous connections.

Parameters:

serverName - name of the Server. Should be unique name

hostAddress - IP address that this server will bind to

port - port that this server will bind to

ipChannelType - IP channel type: SCTP or TCP

extraHostAddresses - When SCTP multi-homing configuration extra IP addresses can be put here If multi-homing absence this parameter can be null

Returns:

new Server instance

Throws:

java.lang.Exception - Exception if management not started or server name already taken or some other server already has same ip:port

addServer

Server addServer(java.lang.String serverName,
               java.lang.String hostAddress,
               int port)
                 throws java.lang.Exception

Add new Server. IP channel type is SCTP. Server can not accept anonymous connections.

Parameters:

serverName - name of the Server. Should be unique name

hostAddress - IP address that this server will bind to

port - port that this server will bind to

Returns:

new Server instance

Throws:

java.lang.Exception - Exception if management not started or server name already taken or some other server already has same ip:port

removeServer

void removeServer(java.lang.String serverName)
                  throws java.lang.Exception

Remove existing Server

Parameters:

serverName -

Throws:

java.lang.Exception - Exception if no Server with the passed name exist or Server is started. Before removing server, it should be stopped

startServer

void startServer(java.lang.String serverName)
                 throws java.lang.Exception

Start the existing Server

Parameters:

serverName - name of the Server to be started

Throws:

java.lang.Exception - Exception if no Server found for given name or Server already started

stopServer

void stopServer(java.lang.String serverName)
                throws java.lang.Exception

Stop the Server.

Parameters:

serverName - name of the Server to be stopped

Throws:

java.lang.Exception - Exception if no Server found for given name or any of the Association within Server still started. All the Association's must be stopped before stopping Server

getServers

java.util.List<Server> getServers()

Get the list of Servers configured

Returns:

addServerAssociation

Association addServerAssociation(java.lang.String peerAddress,
                               int peerPort,
                               java.lang.String serverName,
                               java.lang.String assocName)
                                 throws java.lang.Exception

Add server Association.

Parameters:

peerAddress - the peer IP address that this association will accept connection from

peerPort - the peer port that this association will accept connection from

serverName - the Server that this association belongs to

assocName - unique name of Association

Returns:

Throws:

java.lang.Exception

addServerAssociation

Association addServerAssociation(java.lang.String peerAddress,
                               int peerPort,
                               java.lang.String serverName,
                               java.lang.String assocName,
                               IpChannelType ipChannelType)
                                 throws java.lang.Exception

Add server Association. IP channel type is SCTP.

Parameters:

peerAddress - the peer IP address that this association will accept connection from

peerPort - the peer port that this association will accept connection from

serverName - the Server that this association belongs to

assocName - unique name of Association

ipChannelType - IP channel type: SCTP or TCP

Returns:

Throws:

java.lang.Exception

addAssociation

Association addAssociation(java.lang.String hostAddress,
                         int hostPort,
                         java.lang.String peerAddress,
                         int peerPort,
                         java.lang.String assocName)
                           throws java.lang.Exception

Add Association. IP channel type is SCTP.

Parameters:

hostAddress -

hostPort - If hostPort==0 this mean the local port will be any vacant port

peerAddress -

peerPort -

assocName -

Returns:

Throws:

java.lang.Exception

addAssociation

Association addAssociation(java.lang.String hostAddress,
                         int hostPort,
                         java.lang.String peerAddress,
                         int peerPort,
                         java.lang.String assocName,
                         IpChannelType ipChannelType,
                         java.lang.String[] extraHostAddresses)
                           throws java.lang.Exception

Add Association

Parameters:

hostAddress -

hostPort - If hostPort==0 this mean the local port will be any vacant port

peerAddress -

peerPort -

assocName -

ipChannelType - IP channel type: SCTP or TCP

extraHostAddresses - When SCTP multi-homing configuration extra IP addresses can be put here If multi-homing absence this parameter can be null

Returns:

Throws:

java.lang.Exception

removeAssociation

void removeAssociation(java.lang.String assocName)
                       throws java.lang.Exception

Remove existing Association. Association should be stopped before removing

Parameters:

assocName -

Throws:

java.lang.Exception

getAssociation

Association getAssociation(java.lang.String assocName)
                           throws java.lang.Exception

Get existing Association for passed name

Parameters:

assocName -

Returns:

Throws:

java.lang.Exception

getAssociations

java.util.Map<java.lang.String,Association> getAssociations()

Get configured Association map with name as key and Association instance as value

Returns:

startAssociation

void startAssociation(java.lang.String assocName)
                      throws java.lang.Exception

Start the existing Association

Parameters:

assocName -

Throws:

java.lang.Exception

stopAssociation

void stopAssociation(java.lang.String assocName)
                     throws java.lang.Exception

Stop the existing Association

Parameters:

assocName -

Throws:

java.lang.Exception

getConnectDelay

int getConnectDelay()

Get connection delay. If the client side Association dies due to network failure or any other reason, it should attempt to reconnect after connectDelay interval

Returns:

setConnectDelay

void setConnectDelay(int connectDelay)

Set the connection delay for client side Association

Parameters:

connectDelay -

getWorkerThreads

int getWorkerThreads()

Number of threads configured to callback AssociationListener methods.

Returns:

setWorkerThreads

void setWorkerThreads(int workerThreads)

Number of threads configured for callback AssociationListener

Parameters:

workerThreads -

isSingleThread

boolean isSingleThread()

If set as single thread, number of workers thread set has no effect and entire protocol stack runs on single thread

Returns:

setSingleThread

void setSingleThread(boolean singleThread)

Set protocol stack as single thread

Parameters:

singleThread -