com.pcbsys.nirvana.client.nRealm Class Reference

This class represents a nirvana Realm More...

Public Member Functions

List< string > getConnections ()
 Gets the collection of the network interfaces this realm listens in. More...
 
string getMountPoint ()
 Returns the relative name of the realm within the namespace More...
 
string getName ()
 Gets the name of this realm More...
 
string[] getProtocols ()
 Returns an array of Strings with the rnames for this realm More...
 
 nRealm ()
 Default constructor
 
 nRealm (string pName, string[] connections)
 Constructs a new nRealm object with the specified name and collection of network interfaces More...
 
void setMountPoint (string mountPoint)
 Sets the relative name for the realm within the namespace More...
 
void setName (string pData)
 Sets the name on this realm More...
 

Detailed Description

This class represents a nirvana Realm

Constructor & Destructor Documentation

com.pcbsys.nirvana.client.nRealm.nRealm ( string  pName,
string[]  connections 
)

Constructs a new nRealm object with the specified name and collection of network interfaces

Parameters
pNameA string specifying the realm's name
connectionsAn array of strings specifying the realm's network interfaces. These have to be in the form: protocol://host:port/servlet File , where:

Protocol can be one of nsp, nhp, nsps, nhps where:

nsp => Nirvana Socket Protocol nhp => Nirvana HTTP Protocol nsps => Nirvana Socket Protocol Secure (Socket protocol over SSL/TLS) nhps => Nirvana HTTP Protocol Secure (HTTP protocol over SSL/TLS)

Host is the host the realm is running on

Port is the port the realm is listening on

servlet File specifies the location that servlets are mapped if talking to the realm via a web server (e.g. in a DMZ environment)

Exceptions
nIllegalArgumentExceptionif the parameters are invalid, refer to the exception message for more information

Member Function Documentation

List<string> com.pcbsys.nirvana.client.nRealm.getConnections ( )

Gets the collection of the network interfaces this realm listens in.

Returns
A list containing an Strings of rnames for each realm interface.
string com.pcbsys.nirvana.client.nRealm.getMountPoint ( )

Returns the relative name of the realm within the namespace

Returns
String mount point name
string com.pcbsys.nirvana.client.nRealm.getName ( )

Gets the name of this realm

Returns
A string specifying the name of this realm
string [] com.pcbsys.nirvana.client.nRealm.getProtocols ( )

Returns an array of Strings with the rnames for this realm

Returns
the Protocols, or rnames, supported by this realm
void com.pcbsys.nirvana.client.nRealm.setMountPoint ( string  mountPoint)

Sets the relative name for the realm within the namespace

Parameters
mountPointthe name to add this realm in the namespace
Exceptions
nIllegalArgumentExceptionIllegal parameter, check the message for more information
void com.pcbsys.nirvana.client.nRealm.setName ( string  pData)

Sets the name on this realm

Parameters
pDataa string specifying the name of this realm
Exceptions
nIllegalArgumentExceptionIllegal parameter, check the message for more information