com.pcbsys.nirvana.client.nRealm Class Reference

This class represents a nirvana Realm. More...


Public Member Functions

java.util.Vector getConnections ()
 Gets the collection of the network interfaces this realm listens in.
String getMountPoint ()
 Returns the relative name of the realm within the namespace.
String getName ()
 Gets the name of this realm.
String getNameVal ()
 Gets the name of this realm.
String[] getProtocols ()
 Returns an array of Strings with the rnames for this realm.
 nRealm (String pName, Vector connections) throws nIllegalArgumentException
 Constructs a new nRealm object with the specified name and collection of network interfaces.
 nRealm (String pName, String[] connections) throws nIllegalArgumentException
 Constructs a new nRealm object with the specified name and collection of network interfaces.
 nRealm ()
 Default constructor.
void setMountPoint (String mountPoint) throws nIllegalArgumentException
 Sets the relative name for the realm within the namespace.
void setName (String pData) throws nIllegalArgumentException
 Sets the name on this realm.
void setNameVal (String pData) throws nIllegalArgumentException
 Sets the name on this realm.

Detailed Description

This class represents a nirvana Realm.

Constructor & Destructor Documentation

com.pcbsys.nirvana.client.nRealm.nRealm ( String  pName,
String[]  connections 
) throws nIllegalArgumentException

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

Parameters:
pName A string specifying the realm's name
connections An 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:
nIllegalArgumentException if the parameters are invalid, refer to the exception message for more information

com.pcbsys.nirvana.client.nRealm.nRealm ( String  pName,
Vector  connections 
) throws nIllegalArgumentException

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

Parameters:
pName A string specifying the realm's name
connections A vector of fConnectionDetails objects. These are created using strings specifying the realm's network interfaces. The strings 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:
nIllegalArgumentException if the parameters are invalid, refer to the exception message for more information

Member Function Documentation

java.util.Vector com.pcbsys.nirvana.client.nRealm.getConnections (  ) 

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

Returns:
A vector 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.getNameVal (  ) 

Gets the name of this realm.

Deprecated:
use getName()
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  )  throws nIllegalArgumentException

Sets the relative name for the realm within the namespace.

Parameters:
mountPoint the name to add this realm in the namespace
Exceptions:
nIllegalArgumentException Illegal parameter, check the message for more information

void com.pcbsys.nirvana.client.nRealm.setName ( String  pData  )  throws nIllegalArgumentException

Sets the name on this realm.

Parameters:
pData a string specifying the name of this realm
Exceptions:
nIllegalArgumentException Illegal parameter, check the message for more information

void com.pcbsys.nirvana.client.nRealm.setNameVal ( String  pData  )  throws nIllegalArgumentException

Sets the name on this realm.

Deprecated:
use setName(String name)
Parameters:
pData a string specifying the name of this realm
Exceptions:
nIllegalArgumentException Illegal parameter, check the message for more information