Package org.dellroad.msrp

Class Msrp

java.lang.Object

org.dellroad.msrp.Msrp

public class Msrp
extends Object

An MSRP protocol stack.

Instances must be start()ed before being used. Once started, new MSRP Sessions may be created by invoking createSession() with the local and remote URI's, a SessionListener for receiving notification of session events, and an Executor on which all callback notifications will be delivered.

Invoking stop() shuts down all active sessions and stops the instance. Stopped instances may be restarted if desired.

Field Summary

Fields

Modifier and Type	Field	Description
static long	DEFAULT_CONNECT_TIMEOUT	Default connect timeout for outgoing connections (20000L milliseconds).
static long	DEFAULT_MAX_IDLE_TIME	Default idle connection timeout (30000L milliseconds).
static int	DEFAULT_MAX_SESSIONS	Default maximum number of allowed sessions (1000).

Constructor Summary

Constructors

Constructor	Description
Msrp()	Constructor.

Method Summary

Modifier and Type	Method	Description
protected void	configureServerSocketChannel(ServerSocketChannel serverSocketChannel)	Configure the ServerSocketChannel to be used by this instance.
protected void	configureSocketChannel(SocketChannel socketChannel, Endpoint endpoint)	Configure a SocketChannel to be used by this instance with the given Endpoint.
Session	createSession(MsrpUri localURI, MsrpUri remoteURI, Endpoint endpoint, SessionListener listener, Executor callbackExecutor, boolean active)	Create a new Session using the given local and remote URIs.
long	getConnectTimeout()	Get the outgoing connection timeout in milliseconds.
InetSocketAddress	getListenAddress()	Get the InetSocketAddress to which this instance is bound.
long	getMaxContentLength()	Get the maximum allowed content length for incoming messages.
long	getMaxIdleTime()	Get the maximum idle time for connections that have no associated sessions.
int	getMaxSessions()	Get the maximum number of allowed sessions.
SortedMap<MsrpUri,Session>	getSessions()	Get all known Sessions keyed by local URI.
boolean	isMatchSessionId()	Get whether to match by session ID only (instead of the entire URL) when matching messages to sessions.
void	setConnectTimeout(long connectTimeout)
void	setListenAddress(InetSocketAddress listenAddress)	Set the InetSocketAddress to which this instance should bind.
void	setMatchSessionId(boolean matchSessionId)
void	setMaxContentLength(long maxContentLength)
void	setMaxIdleTime(long maxIdleTime)
void	setMaxSessions(int maxSessions)
void	start()	Start this instance.
void	stop()	Stop this instance.
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

DEFAULT_MAX_SESSIONS

public static final int DEFAULT_MAX_SESSIONS

Default maximum number of allowed sessions (1000).

See Also:

getMaxSessions(), Constant Field Values

DEFAULT_MAX_IDLE_TIME

public static final long DEFAULT_MAX_IDLE_TIME

Default idle connection timeout (30000L milliseconds).

See Also:

getMaxIdleTime(), Constant Field Values

DEFAULT_CONNECT_TIMEOUT

public static final long DEFAULT_CONNECT_TIMEOUT

Default connect timeout for outgoing connections (20000L milliseconds).

See Also:

getConnectTimeout(), Constant Field Values

Constructor Detail

Msrp

public Msrp()

Constructor.

Method Detail

getListenAddress

public InetSocketAddress getListenAddress()

Get the InetSocketAddress to which this instance is bound.

Returns:

listen address, possibly null

setListenAddress

public void setListenAddress(InetSocketAddress listenAddress)

Set the InetSocketAddress to which this instance should bind.

If this instance is already started, invoking this method will have no effect until it is stopped and restarted.

By default, instances listen on all interfaces on port MsrpConstants.DEFAULT_PORT.

Parameters:

listenAddress - listen address, or null to listen on all interfaces on port MsrpConstants.DEFAULT_PORT

getMaxSessions

public int getMaxSessions()

Get the maximum number of allowed sessions. Default is 1000.

Returns:

maximum number of simultaneous sessions

setMaxSessions

public void setMaxSessions(int maxSessions)

getMaxContentLength

public long getMaxContentLength()

Get the maximum allowed content length for incoming messages. Default is MsrpInputParser.DEFAULT_MAX_CONTENT_LENGTH.

Returns:

maximum message content size

setMaxContentLength

public void setMaxContentLength(long maxContentLength)

getMaxIdleTime

public long getMaxIdleTime()

Get the maximum idle time for connections that have no associated sessions. Default is 30000Lms.

Returns:

maximum connection idle time

setMaxIdleTime

public void setMaxIdleTime(long maxIdleTime)

getConnectTimeout

public long getConnectTimeout()

Get the outgoing connection timeout in milliseconds. Default is 20000Lms.

Returns:

connection timeout in milliseconds

setConnectTimeout

public void setConnectTimeout(long connectTimeout)

isMatchSessionId

public boolean isMatchSessionId()

Get whether to match by session ID only (instead of the entire URL) when matching messages to sessions.

Default is true.

Returns:

true to match by session ID only, otherwise false

See Also:

Session Matching Update for the Message Session Relay Protocol (MSRP)

setMatchSessionId

public void setMatchSessionId(boolean matchSessionId)

start

public void start()
           throws IOException

Start this instance. Does nothing if already started.

Throws:

IOException - if server socket cannot be created

stop

public void stop()

Stop this instance. Does nothing if already stopped.

createSession

public Session createSession(MsrpUri localURI,
                             MsrpUri remoteURI,
                             Endpoint endpoint,
                             SessionListener listener,
                             Executor callbackExecutor,
                             boolean active)

Create a new Session using the given local and remote URIs.

Notification of Session events will be delivered to listener using the provided callbackExecutor; the callbackExecutor must execute actions in a separate thread from the one that invoked it in order to avoid deadlocks and re-entrancy problems. For example, using an Executor returned by Executors.newSingleThreadScheduledExecutor() is sufficient.

Parameters:

localURI - URI identifying the local side of the session

remoteURI - URI identifying the remote side of the session

endpoint - destination for outgoing TCP connection (if any), or null to infer from remoteURI; ignored if !active

listener - listener for session events

callbackExecutor - executes listener callbacks; must do so in a separate thread

active - true if this side is active and should initiate the connection, false to wait for the remote side connect to us

Returns:

newly created session, or null if there are already too many existing sessions

Throws:

IllegalStateException - if this instance is not started

IllegalArgumentException - if any parameter other than endpoint is null

IllegalArgumentException - if a session corresponding to localURI already exists

getSessions

public SortedMap<MsrpUri,Session> getSessions()

Get all known Sessions keyed by local URI. Note that as keys in the returned map, URI's are compared for equality according to RFC 4579, Section 6.1.

Returns:

mutable "snapshot" mapping from local URI to Session

configureServerSocketChannel

protected void configureServerSocketChannel(ServerSocketChannel serverSocketChannel)

Configure the ServerSocketChannel to be used by this instance. This method is invoked by start().

The implementation in Msrp does nothing. Subclasses may override to configure socket options, etc.

Parameters:

serverSocketChannel - channel to configure

configureSocketChannel

protected void configureSocketChannel(SocketChannel socketChannel,
                                      Endpoint endpoint)

Configure a SocketChannel to be used by this instance with the given Endpoint.

The implementation in Msrp does nothing. Subclasses may override to configure socket options, etc.

Parameters:

socketChannel - channel to configure

endpoint - the remote endpoint with which the socket will be used to communicate

toString

public String toString()

Overrides:

toString in class Object