Nirvana Flex API: com.pcbsys.nirvana.client.nSessionAttributes

View All Packages

Packagecom.pcbsys.nirvana.client
Classpublic class nSessionAttributes
InheritancenSessionAttributes Inheritance Object

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


Public Properties
 PropertyDefined By
  details : String
[read-only] Returns the rNames that were passed in via the initial nSession creation
nSessionAttributes
  initialConnectionRetryCount : int
[read-only] Returns the initial connection retry count.
nSessionAttributes
  sslCertificate : String
The certificate to use for NSPS connections
nSessionAttributes
  sslKey : String
The key to use for NSPS connections
nSessionAttributes
Public Methods
 MethodDefined By
  
nSessionAttributes(url:String, initialConnectionRetry:int)
Constructor for nSessionAttributes
nSessionAttributes
  
getConnectionDetail(index:int):String
Returns the rName indexed by index.
nSessionAttributes
  
numberOfConnections():int
Returns the number of protocols used by this nSession
nSessionAttributes
Property Detail
detailsproperty
details:String  [read-only]

Returns the rNames that were passed in via the initial nSession creation


Implementation
    public function get details():String
initialConnectionRetryCountproperty 
initialConnectionRetryCount:int  [read-only]

Returns the initial connection retry count.


Implementation
    public function get initialConnectionRetryCount():int
sslCertificateproperty 
sslCertificate:String

The certificate to use for NSPS connections


Implementation
    public function get sslCertificate():String
    public function set sslCertificate(value:String):void
sslKeyproperty 
sslKey:String

The key to use for NSPS connections


Implementation
    public function get sslKey():String
    public function set sslKey(value:String):void
Constructor Detail
nSessionAttributes()Constructor
public function nSessionAttributes(url:String, initialConnectionRetry:int)

Constructor for nSessionAttributes

Parameters
url:String — The url you would like to connect to in the form of protocol://host:port, there are 3 choices for URL. single url, a comma separated(",") string which will be processed then tried in the order they are passed in and finally semi colon separated(";") string which will be processed and randomised then called in the new randomised order.
 
initialConnectionRetry:int — the number of times to retry the initial connection to a realm when unable to connect. If you wish to never stop attempting connection set to -1.

Throws
Error — if you attempt to give a null url
Method Detail
getConnectionDetail()method
public function getConnectionDetail(index:int):String

Returns the rName indexed by index. These where passed in when the initial nSession was created

Parameters

index:int — the index of the connection details to return

Returns
String — String rName value

Throws
Error — If the index is out of bounds
numberOfConnections()method 
public function numberOfConnections():int

Returns the number of protocols used by this nSession

Returns
int — int the number of rNames used by this nSession