com.pcbsys.nirvana.nAdminAPI.nBaseInterface Class Referenceabstract

Base class for all Admin API interfaces. More...

Inheritance diagram for com.pcbsys.nirvana.nAdminAPI.nBaseInterface:
com.pcbsys.nirvana.nAdminAPI.nInterface com.pcbsys.nirvana.nAdminAPI.nMulticastConfiguration com.pcbsys.nirvana.nAdminAPI.nHTTPInterface com.pcbsys.nirvana.nAdminAPI.nRDMAInterface com.pcbsys.nirvana.nAdminAPI.nSharedMemoryInterface com.pcbsys.nirvana.nAdminAPI.nSocketInterface com.pcbsys.nirvana.nAdminAPI.nHTTPSInterface com.pcbsys.nirvana.nAdminAPI.nSSLInterface

Public Member Functions

String getAdapter ()
 Get the adapter that this interface will use. More...
 
String getName ()
 Get the name of this interface. More...
 
int getPort ()
 Get the port that this interface will bind to at startup. More...
 
String getURL ()
 Get the URL that specifies this interface. More...
 
void setAutostart (boolean flag)
 Change the current Autostart status for this interface. More...
 
boolean willAutostart ()
 Will this interface automatically be started when the Realm Server starts. More...
 

Detailed Description

Base class for all Admin API interfaces.

Member Function Documentation

String com.pcbsys.nirvana.nAdminAPI.nBaseInterface.getAdapter ( )

Get the adapter that this interface will use.

Reserved interfaces are

0.0.0.0 - Bind to all physical interfaces on the machine 127.0.0.1 - Bind to local loopback

Returns
The current interface
String com.pcbsys.nirvana.nAdminAPI.nBaseInterface.getName ( )

Get the name of this interface.

This is the unique name for this interface on the realm

Returns
String name of the interface
int com.pcbsys.nirvana.nAdminAPI.nBaseInterface.getPort ( )

Get the port that this interface will bind to at startup.

Returns
Integer value of the port
String com.pcbsys.nirvana.nAdminAPI.nBaseInterface.getURL ( )

Get the URL that specifies this interface.

It is made up from the protocol the adapter and port

Returns
URL string
void com.pcbsys.nirvana.nAdminAPI.nBaseInterface.setAutostart ( boolean  flag)

Change the current Autostart status for this interface.

Parameters
flagTrue or False
boolean com.pcbsys.nirvana.nAdminAPI.nBaseInterface.willAutostart ( )

Will this interface automatically be started when the Realm Server starts.

Returns
Current value