com.pcbsys.nirvana.client.nSessionAttributes Class Reference

This class is a container for the attributes necessary to create a Nirvana session. More...

Public Member Functions
String	getConnectionDetail (int idx) throws Exception
	Returns the rname indexed by idx. More...
long	getInitialConnectionRetryCount ()
	Gets the inital connection retry count. More...
int	getNumberOfConnections ()
	Returns the number of protocols used by this nSession. More...
boolean	isRequestPriorityConnection ()
	Queries the property which requests a priority connection to the server. More...
	nSessionAttributes (nRealm realm) throws nIllegalArgumentException
	Constructs an nSessionAttributes object from the nRealm object supplied. More...
	nSessionAttributes (nRealm realm, long initialConnectionRetry) throws nIllegalArgumentException
	Constructs an nSessionAttributes object from the nRealm object supplied. More...
	nSessionAttributes (String url) throws nIllegalArgumentException
	Constructs an nSessionAttributes object with the string URL specified. More...
	nSessionAttributes (String url, long initialConnectionRetry) throws nIllegalArgumentException
	Constructs an nSessionAttributes object with the string URL specified and retry count for initial connection attempts. More...
	nSessionAttributes (String[] urls) throws nIllegalArgumentException
	Constructs an nSessionAttributes object with the collection of string URLs specified. More...
	nSessionAttributes (String[] urls, long initialConnectionRetry) throws nIllegalArgumentException
	Constructs an nSessionAttributes object with the collection of string URLs specified. More...
void	setRequestPriorityConnection (boolean requestPriorityConnection)
	Sets the property which requests a priority connection to the server. More...

Detailed Description

This class is a container for the attributes necessary to create a Nirvana session.

Constructor & Destructor Documentation

com.pcbsys.nirvana.client.nSessionAttributes.nSessionAttributes

(

nRealm

realm

)

throws nIllegalArgumentException

Constructs an nSessionAttributes object from the nRealm object supplied.

Parameters

realm

A nRealm object of the realm you want to connect to.

Exceptions

nIllegalArgumentException

if the url is invalid

com.pcbsys.nirvana.client.nSessionAttributes.nSessionAttributes	(	nRealm	realm,
		long	initialConnectionRetry
	)		throws nIllegalArgumentException

Constructs an nSessionAttributes object from the nRealm object supplied.

Parameters

realm	A nRealm object of the realm you want to connect to.
initialConnectionRetry	A long specfiying amount of times to retry for inital connection

Exceptions

nIllegalArgumentException

if the url is invalid

com.pcbsys.nirvana.client.nSessionAttributes.nSessionAttributes

(

String

url

)

throws nIllegalArgumentException

Constructs an nSessionAttributes object with the string URL specified.

Parameters

url	A string in the form protocol://host:port e.g. nsp://127.0.0.1:9000 Protocol can be one of nsp, nhp, nsps, nhps

Exceptions

nIllegalArgumentException

if the url is invalid

com.pcbsys.nirvana.client.nSessionAttributes.nSessionAttributes	(	String	url,
		long	initialConnectionRetry
	)		throws nIllegalArgumentException

Constructs an nSessionAttributes object with the string URL specified and retry count for initial connection attempts.

Parameters

url	A string in the form protocol://host:port e.g. nsp://127.0.0.1:9000 Protocol can be one of nsp, nhp, nsps, nhps
initialConnectionRetry	A long specfiying amount of times to retry for inital connection

Exceptions

nIllegalArgumentException

if the url is invalid

com.pcbsys.nirvana.client.nSessionAttributes.nSessionAttributes

(

String[]

urls

)

throws nIllegalArgumentException

Constructs an nSessionAttributes object with the collection of string URLs specified.

Parameters

urls	A string[], containing strings in the form protocol://host:port e.g. nsp://127.0.0.1:9000 Protocol can be one of nsp, nhp, nsps, nhps

Exceptions

nIllegalArgumentException

if the url is invalid

com.pcbsys.nirvana.client.nSessionAttributes.nSessionAttributes	(	String[]	urls,
		long	initialConnectionRetry
	)		throws nIllegalArgumentException

Constructs an nSessionAttributes object with the collection of string URLs specified.

Parameters

urls	A string[], containing strings in the form protocol://host:port e.g. nsp://127.0.0.1:9000 Protocol can be one of nsp, nhp, nsps, nhps
initialConnectionRetry	A long specfiying amount of times to retry for inital connection

Exceptions

nIllegalArgumentException

if the url is invalid

Member Function Documentation

String com.pcbsys.nirvana.client.nSessionAttributes.getConnectionDetail

(

int

idx

)

throws Exception

Returns the rname indexed by idx.

These where passed in when the initial nSession was created

Parameters

idx	the index of the connection details to return

Returns

String RNAME value

Exceptions

Exception

If the index is out of bounds

long com.pcbsys.nirvana.client.nSessionAttributes.getInitialConnectionRetryCount

(

)

Gets the inital connection retry count.

Returns

a long specifying the number of retry attempts for establishing initial connection

int com.pcbsys.nirvana.client.nSessionAttributes.getNumberOfConnections

(

)

Returns the number of protocols used by this nSession.

Returns

Number of rnames used by this nSession

boolean com.pcbsys.nirvana.client.nSessionAttributes.isRequestPriorityConnection

(

)

Queries the property which requests a priority connection to the server.

Returns

true if the request attribute is true, false otherwise.

void com.pcbsys.nirvana.client.nSessionAttributes.setRequestPriorityConnection

(

boolean

requestPriorityConnection

)

Sets the property which requests a priority connection to the server.

If this is true, sessions started with these session attributes will request their connection be a priority connection.

Parameters

requestPriorityConnection

boolean set to true to request a priority connection, false for a normal connection.