This class is used with a nSessionAttributes object to create a Nirvana session. More...

Static Public Member Functions
static void	close (nSession session)
	Closes a Nirvana session More...

static nSession	create (nSessionAttributes attr)
	Creates an nSession object (Nirvana session) based on the nSessionAttributes object supplied More...

static nSession	create (nSessionAttributes attr, nReconnectHandler handler)
	Creates an nSession object (Nirvana session) based on the nSessionAttributes object and the specified reconnect handler. More...

static nSession	create (nSessionAttributes attr, nReconnectHandler handler, string username)
	Creates an nSession object (Nirvana session) based on the nSessionAttributes object and the specified reconnect handler. More...

static nSession	create (nSessionAttributes attr, string username)
	Creates an nSession object (Nirvana session) based on the nSessionAttributes object and the specified reconnect handler. More...

static nSession	createMultiplexed (nSession session)
	Enable another session to be constructed that shares the physical connection with the nSession being passed. More...

static nSession	createMultiplexed (nSession session, String newUsername)
	Enable another session to be constructed that shares the physical connection with the nSession being passed. More...

static nSession	createMultiplexed (nSessionAttributes sessionAttributes)
	Enable another session to be constructed that shares the physical connection with the nSession whose nSessionAttributes are being passed. More...

static nSession	createMultiplexed (nSessionAttributes sessionAttributes, String userName)
	Enable another session to be constructed that shares the physical connection with the nSession whose nSessionAttributes are being passed. More...

static int	getNoVended ()
	Gets the number of nirvana sessions vended More...

static void	shutdown ()
	Shuts down the session factory by closing all nirvana sessions that have been created

Detailed Description

This class is used with a nSessionAttributes object to create a Nirvana session.

Member Function Documentation

static void com.pcbsys.nirvana.client.nSessionFactory.close ( nSession session )

static

Closes a Nirvana session

Parameters

session The nSession object to be closed

Exceptions

nIllegalArgumentException if the nSession is invalid

static nSession com.pcbsys.nirvana.client.nSessionFactory.create ( nSessionAttributes attr )

static

Creates an nSession object (Nirvana session) based on the nSessionAttributes object supplied

Parameters

attr	The nSessionAttributes object containing the parameters for the session to be created

Returns: the newly created nSession object

Exceptions

nIllegalArgumentException if the nSessionAttributes is invalid

static nSession com.pcbsys.nirvana.client.nSessionFactory.create	(	nSessionAttributes	attr,
		nReconnectHandler	handler
	)

static

Creates an nSession object (Nirvana session) based on the nSessionAttributes object and the specified reconnect handler.

Parameters

attr	The nSessionAttributes object containing the parameters for the session to be created
handler	A nReconnectHandler to use if the connection to the Server is lost

Returns: the newly created nSession object

Exceptions

nIllegalArgumentException if the nSessionAttributes is invalid

static nSession com.pcbsys.nirvana.client.nSessionFactory.create	(	nSessionAttributes	attr,
		nReconnectHandler	handler,
		string	username
	)

static

Creates an nSession object (Nirvana session) based on the nSessionAttributes object and the specified reconnect handler.

Parameters

attr	The nSessionAttributes object containing the parameters for the session to be created
handler	A nReconnectHandler to use if the connection to the Server is lost
username	A String token to use when authenticating with the server

Returns: the newly created nSession object

Exceptions

nIllegalArgumentException if the nSessionAttributes is invalid

nReconnectHandler

static nSession com.pcbsys.nirvana.client.nSessionFactory.create	(	nSessionAttributes	attr,
		string	username
	)

static

Creates an nSession object (Nirvana session) based on the nSessionAttributes object and the specified reconnect handler.

Parameters

attr	The nSessionAttributes object containing the parameters for the session to be created
username	The user name to be used by this session to authenticate

Returns: the newly created nSession object

Exceptions

nIllegalArgumentException if the nSessionAttributes is invalid or the username

static nSession com.pcbsys.nirvana.client.nSessionFactory.createMultiplexed ( nSession session )

static

Enable another session to be constructed that shares the physical connection with the nSession being passed.

Allows applications to subscribe twice to the same channel or queue using different filters, or reduce the impact of any connection limits imposed by any browser / host machine to specific hosts, since the connection count will only ever be 1.

Parameters

session session the session to muliplex the connection with

Returns: a multiplexed session

static nSession com.pcbsys.nirvana.client.nSessionFactory.createMultiplexed	(	nSession	session,
		String	newUsername
	)

static

Enable another session to be constructed that shares the physical connection with the nSession being passed.

Allows applications to subscribe twice to the same channel or queue using different filters, or reduce the impact of any connection limits imposed by any browser / host machine to specific hosts, since the connection count will only ever be 1.

Parameters

session	session the session to muliplex the connection with
newUsername	Used to specify a different Username than that of the original nSession connection

Returns: a multiplexed session

static nSession com.pcbsys.nirvana.client.nSessionFactory.createMultiplexed ( nSessionAttributes sessionAttributes )

static

Enable another session to be constructed that shares the physical connection with the nSession whose nSessionAttributes are being passed.

Allows applications to subscribe twice to the same channel or queue using different filters, or reduce the impact of any connection limits imposed by any browser / host machine to specific hosts, since the connection count will only ever be 1.

Parameters

sessionAttributes the sessionAttributes of the session with which to multiplex the connection

Returns: a multiplexed session

static nSession com.pcbsys.nirvana.client.nSessionFactory.createMultiplexed	(	nSessionAttributes	sessionAttributes,
		String	userName
	)

static

Enable another session to be constructed that shares the physical connection with the nSession whose nSessionAttributes are being passed.

Allows applications to subscribe twice to the same channel or queue using different filters, or reduce the impact of any connection limits imposed by any browser / host machine to specific hosts, since the connection count will only ever be 1.

Parameters

sessionAttributes	the sessionAttributes of the session with which to multiplex the connection
userName	the user name used when no physical connection exists to the desired realm

Returns: a multiplexed session

static int com.pcbsys.nirvana.client.nSessionFactory.getNoVended ( )

static

Gets the number of nirvana sessions vended

Returns: an int specifying the number of nirvana sessions vended with this session factory

Static Public Member Functions

Detailed Description

Member Function Documentation