com.pcbsys.nirvana.nAdminAPI.nInterface Class Reference

Abstract Class nInterface. More...

Inheritance diagram for com.pcbsys.nirvana.nAdminAPI.nInterface:

com.pcbsys.nirvana.nAdminAPI.nHTTPInterface com.pcbsys.nirvana.nAdminAPI.nSocketInterface com.pcbsys.nirvana.nAdminAPI.nHTTPSInterface com.pcbsys.nirvana.nAdminAPI.nSSLInterface

Public Member Functions

boolean canAdvertise ()
 Will this interface be used by other realms to send client redirects to.
boolean equals (Object item)
 used to sort interfaces
boolean equals (long aLong)
 used to sort interfaces
String getAdapaterAlias ()
 Returns the interfaces known alias's.
String getAdapter ()
 Get the adapter that this interface will use.
int getAuthTimeOut ()
 Returns the number of milliseconds that the remote client has to authenticate with the server before the server closes the communications with the client.
int getBacklog ()
 The number of socket connect requests that the Operating System will queue before sending a reject to the remote client.
String getName ()
 Get the name of this interface.
int getPort ()
 Get the port that this interface will bind to at startup.
String getProtocol ()
 Returns the protocol string used by this interface.
int getRecvBufferSize ()
 Return the socket buffer size in bytes used by this interface when receiving data.
int getSelectThreadSize ()
 Returns the number of select threads used by NIO.
int getSendBufferSize ()
 Return the socket buffer size in bytes used by this interface when sending data.
int getThreadCount ()
 Returns the current Thread Pool size that handles client socket connections.
String getURL ()
 Get the URL that specifies this interface.
nACL getViaList ()
 Retrieves the interfaces Via list.
boolean isAllowNIO ()
 Returns whether NIO is enabled on this interface.
boolean isClientConnectionsAllowed ()
 Returns whether this interface can be used by clients to connect.
boolean isInterRealmAllow ()
 Returns whether this interface is allowed to be used in inter realm / cluster communication.
boolean lessThan (Object item)
 used to sort interfaces
boolean lessThan (long aLong)
 used to sort interfaces
void setAdapterAlias (String alias)
 Sets the interfaces alias.
void setAdvertise (boolean flag)
 Change the current advertise status for this interface.
void setAllowClientConnections (boolean clientconnections)
 Sets whether this interface can accept client connections or not.
void setAllowNIO (boolean allowNIO)
 Set whether NIO is enabled on the interface.
void setAuthTimeOut (int timeout) throws nAdminIllegalArgumentException
 Changes the number of milliseconds that the remote client has to authenticate with the server.
void setAutostart (boolean flag)
 Change the current Autostart status for this interface.
void setBacklog (int backlog) throws nAdminIllegalArgumentException
 Changes the number of connections to queue before the Operating System will send rejects to the remote client.
void setInterRealmAllow (boolean interealmAllow)
 Sets whether this interface is allowed to be used in inter realm / cluster communication.
void setManager (nInterfaceManager im)
 Set the Interface Manager.
void setRecvBufferSize (int myRecvBufferSize)
 Set the socket buffer size in bytes used by this interface when receiving data.
void setSelectThreadSize (int selectThreadSize)
 Sets the number of select threads used by NIO.
void setSendBufferSize (int mySendBufferSize)
 Set the socket buffer size in bytes used by this interface when sending data.
void setThreadCount (int count) throws nAdminIllegalArgumentException
 Changes the thread pool size handling the client connections.
void setUseForProxyForward (boolean useForproxyForward)
 Set if ProxyForwarding is to be used.
void setViaList (nACL acl) throws nInsufficientPrivilegesException, nNodeException, nBaseAdminException
 Commits the nACL object passed in with the Realm Server.
String toString ()
 Return a string representation of the interface details.
boolean useForProxyForward ()
 Returns true if proxy forwarding is enabled.
boolean willAutostart ()
 Will this interface automatically be started when the Realm Server starts.

Detailed Description

Abstract Class nInterface.

This class exposes the common attributes to all Nirvana Realm interfaces.

Member Function Documentation

boolean com.pcbsys.nirvana.nAdminAPI.nInterface.canAdvertise (  ) 

Will this interface be used by other realms to send client redirects to.

Returns:
Current value

String com.pcbsys.nirvana.nAdminAPI.nInterface.getAdapaterAlias (  ) 

Returns the interfaces known alias's.

This is used by the server to tell other servers how to contact it if it is behind a NAT or Proxy server. It is specified as a HOST:PORT syntax

Returns:
String alias

String com.pcbsys.nirvana.nAdminAPI.nInterface.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

int com.pcbsys.nirvana.nAdminAPI.nInterface.getAuthTimeOut (  ) 

Returns the number of milliseconds that the remote client has to authenticate with the server before the server closes the communications with the client.

Returns:
The current timeout

int com.pcbsys.nirvana.nAdminAPI.nInterface.getBacklog (  ) 

The number of socket connect requests that the Operating System will queue before sending a reject to the remote client.

Returns:
The current setting

String com.pcbsys.nirvana.nAdminAPI.nInterface.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.nInterface.getPort (  ) 

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

Returns:
Integer value of the port

String com.pcbsys.nirvana.nAdminAPI.nInterface.getProtocol (  ) 

Returns the protocol string used by this interface.

Can be one of nsp, nsps, nhps or nhp

Returns:
The protocol used by this interface

int com.pcbsys.nirvana.nAdminAPI.nInterface.getRecvBufferSize (  ) 

Return the socket buffer size in bytes used by this interface when receiving data.

Returns:
the inbound socket buffer size in bytes used by this interface

int com.pcbsys.nirvana.nAdminAPI.nInterface.getSelectThreadSize (  ) 

Returns the number of select threads used by NIO.

Returns:
the number of select threads used
Since:
4.0

int com.pcbsys.nirvana.nAdminAPI.nInterface.getSendBufferSize (  ) 

Return the socket buffer size in bytes used by this interface when sending data.

Returns:
the outbound socket buffer size in bytes used by this interface

int com.pcbsys.nirvana.nAdminAPI.nInterface.getThreadCount (  ) 

Returns the current Thread Pool size that handles client socket connections.

Depending on the number of connections/second this size should be around 1 or 2 anything more may not really gain any improvement

Returns:
The current size

String com.pcbsys.nirvana.nAdminAPI.nInterface.getURL (  ) 

Get the URL that specifies this interface.

It is made up from the protocol the adapter and port

Returns:
URL string

nACL com.pcbsys.nirvana.nAdminAPI.nInterface.getViaList (  ) 

Retrieves the interfaces Via list.

This list is contained in a nACL object.

Returns:
nACL
See also:
nACL

boolean com.pcbsys.nirvana.nAdminAPI.nInterface.isAllowNIO (  ) 

Returns whether NIO is enabled on this interface.

Returns:
if NIO is enabled
Since:
4.0

boolean com.pcbsys.nirvana.nAdminAPI.nInterface.isClientConnectionsAllowed (  ) 

Returns whether this interface can be used by clients to connect.

Returns:
whether this interface is allowed for client communication

boolean com.pcbsys.nirvana.nAdminAPI.nInterface.isInterRealmAllow (  ) 

Returns whether this interface is allowed to be used in inter realm / cluster communication.

Returns:
whether this interface is allowed for cluster communication

void com.pcbsys.nirvana.nAdminAPI.nInterface.setAdapterAlias ( String  alias  ) 

Sets the interfaces alias.

This string is of the format HOST:PORT where HOST is the alias interface and port is the number used to communicate with the server.

Parameters:
alias an alias hostname for the interface

void com.pcbsys.nirvana.nAdminAPI.nInterface.setAdvertise ( boolean  flag  ) 

Change the current advertise status for this interface.

Parameters:
flag True or False

void com.pcbsys.nirvana.nAdminAPI.nInterface.setAllowClientConnections ( boolean  clientconnections  ) 

Sets whether this interface can accept client connections or not.

Parameters:
clientconnections whether this interface can be used by clients

void com.pcbsys.nirvana.nAdminAPI.nInterface.setAllowNIO ( boolean  allowNIO  ) 

Set whether NIO is enabled on the interface.

Parameters:
allowNIO whether NIO is enabled
Since:
4.0

void com.pcbsys.nirvana.nAdminAPI.nInterface.setAuthTimeOut ( int  timeout  )  throws nAdminIllegalArgumentException

Changes the number of milliseconds that the remote client has to authenticate with the server.

Parameters:
timeout time in milliseconds

void com.pcbsys.nirvana.nAdminAPI.nInterface.setAutostart ( boolean  flag  ) 

Change the current Autostart status for this interface.

Parameters:
flag True or False

void com.pcbsys.nirvana.nAdminAPI.nInterface.setBacklog ( int  backlog  )  throws nAdminIllegalArgumentException

Changes the number of connections to queue before the Operating System will send rejects to the remote client.

Parameters:
backlog Must be between 1 and 100

void com.pcbsys.nirvana.nAdminAPI.nInterface.setInterRealmAllow ( boolean  interealmAllow  ) 

Sets whether this interface is allowed to be used in inter realm / cluster communication.

Parameters:
interealmAllow whether this interface is allowed for cluster commincation

void com.pcbsys.nirvana.nAdminAPI.nInterface.setManager ( nInterfaceManager  im  ) 

Set the Interface Manager.

Parameters:
im the interface manager to use

void com.pcbsys.nirvana.nAdminAPI.nInterface.setRecvBufferSize ( int  myRecvBufferSize  ) 

Set the socket buffer size in bytes used by this interface when receiving data.

Parameters:
myRecvBufferSize the inbound socket buffer size in bytes used by this interface

void com.pcbsys.nirvana.nAdminAPI.nInterface.setSelectThreadSize ( int  selectThreadSize  ) 

Sets the number of select threads used by NIO.

Parameters:
selectThreadSize the number of select threads used
Since:
4.0

void com.pcbsys.nirvana.nAdminAPI.nInterface.setSendBufferSize ( int  mySendBufferSize  ) 

Set the socket buffer size in bytes used by this interface when sending data.

Parameters:
mySendBufferSize the size to set the outbound buffer size to

void com.pcbsys.nirvana.nAdminAPI.nInterface.setThreadCount ( int  count  )  throws nAdminIllegalArgumentException

Changes the thread pool size handling the client connections.

Parameters:
count Must be between 1 and 5 inclussive

void com.pcbsys.nirvana.nAdminAPI.nInterface.setUseForProxyForward ( boolean  useForproxyForward  ) 

Set if ProxyForwarding is to be used.

Parameters:
useForproxyForward use Proxy forwarding if true

void com.pcbsys.nirvana.nAdminAPI.nInterface.setViaList ( nACL  acl  )  throws nInsufficientPrivilegesException, nNodeException, nBaseAdminException

Commits the nACL object passed in with the Realm Server.

This causes these nInterfaceViaEntry to be active once the function returns. The nACL object can be retrieved by calling the getViaList() function which returns the interface current VIA list.

Parameters:
acl A nACL containing nInterfaceViaEntry
Exceptions:
nInsufficientPrivilegesException If the user is not permissioned to perform this operation
nNodeException if the ACLs being set are invalid
nBaseAdminException if unable to perform the operation, check the message for further information

String com.pcbsys.nirvana.nAdminAPI.nInterface.toString (  ) 

Return a string representation of the interface details.

Returns:
a string representation of the interface details

boolean com.pcbsys.nirvana.nAdminAPI.nInterface.useForProxyForward (  ) 

Returns true if proxy forwarding is enabled.

Returns:
true if proxy forwarding is enabled

boolean com.pcbsys.nirvana.nAdminAPI.nInterface.willAutostart (  ) 

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

Returns:
Current value