org.netxms.api.client

Interface Session

public interface Session

Base client session interface. All client APIs for NetXMS based products expected to provide this interface.

Method Summary

Methods

Modifier and Type	Method and Description
void	addListener(SessionListener lst) Add notification listener
boolean	checkConnection() Send KEEPALIVE message.
void	connect() Connect to the server.
int	createMappingTable(String name, String description, int flags) Create new mapping table.
void	deleteMappingTable(int id) Delete mapping table
void	disconnect() Disconnect from server.
String	getAttributeForCurrentUser(String name) Get custom attribute for currently logged in user.
String	getConnClientInfo()
String	getDateFormat() Get default date format provided by server
int	getDefaultRecvBufferSize() Get default receiver buffer size.
MappingTable	getMappingTable(int id)
int	getMaxRecvBufferSize() Get max receiver buffer size.
String	getServerAddress() Get server address
byte[]	getServerId() Get NetXMS server UID.
String	getServerTimeZone()
String	getServerVersion() Get NetXMS server version.
String	getTimeFormat() Get default time format provided by server
int	getUserId() Get identifier of logged in user.
String	getUserName() Get login name of currently logged in user
long	getUserSystemRights() Get system-wide rights of currently logged in user.
boolean	isConnected() Get connection state
boolean	isEncrypted() Get encryption state for current session.
boolean	isPasswordExpired()
List<MappingTableDescriptor>	listMappingTables() Get list of all configured mapping tables.
org.netxms.base.NXCPMessage	newMessage(int code) Create new NXCP message with unique id
void	removeListener(SessionListener lst) Remove notification listener
void	setAttributeForCurrentUser(String name, String value) Set custom attribute for currently logged in user.
void	setCommandTimeout(int commandTimeout) Set command execution timeout.
void	setConnClientInfo(String connClientInfo)
void	setRecvBufferSize(int defaultBufferSize, int maxBufferSize) Set receiver buffer size.
int	updateMappingTable(MappingTable table) Create or update mapping table.
org.netxms.base.NXCPMessage	waitForMessage(int code, long id) Wait for message with specific code and id.
org.netxms.base.NXCPMessage	waitForMessage(int code, long id, int timeout) Wait for message with specific code and id.
org.netxms.base.NXCPMessage	waitForRCC(long id) Wait for CMD_REQUEST_COMPLETED message with given id using default timeout
org.netxms.base.NXCPMessage	waitForRCC(long id, int timeout) Wait for CMD_REQUEST_COMPLETED message with given id

Method Detail

addListener

void addListener(SessionListener lst)

Add notification listener

Parameters:

lst - Listener to add

removeListener

void removeListener(SessionListener lst)

Remove notification listener

Parameters:

lst - Listener to remove

waitForMessage

org.netxms.base.NXCPMessage waitForMessage(int code,
                                         long id,
                                         int timeout)
                                           throws NetXMSClientException

Wait for message with specific code and id.

Parameters:

code - Message code

id - Message id

timeout - Wait timeout in milliseconds

Returns:

Message object

Throws:

NetXMSClientException - if message was not arrived within timeout interval

waitForMessage

org.netxms.base.NXCPMessage waitForMessage(int code,
                                         long id)
                                           throws NetXMSClientException

Wait for message with specific code and id.

Parameters:

code - Message code

id - Message id

Returns:

Message object

Throws:

NetXMSClientException - if message was not arrived within timeout interval

waitForRCC

org.netxms.base.NXCPMessage waitForRCC(long id)
                                       throws NetXMSClientException

Wait for CMD_REQUEST_COMPLETED message with given id using default timeout

Parameters:

id - Message id

Returns:

received message

Throws:

NetXMSClientException - if message was not arrived within timeout interval or contains RCC other than RCC.SUCCESS

waitForRCC

org.netxms.base.NXCPMessage waitForRCC(long id,
                                     int timeout)
                                       throws NetXMSClientException

Wait for CMD_REQUEST_COMPLETED message with given id

Parameters:

id - Message id

timeout - Timeout in milliseconds

Returns:

received message

Throws:

NetXMSClientException - if message was not arrived within timeout interval or contains RCC other than RCC.SUCCESS

newMessage

org.netxms.base.NXCPMessage newMessage(int code)

Create new NXCP message with unique id

Parameters:

code - Message code

Returns:

New message object

connect

void connect()
             throws IOException,
                    UnknownHostException,
                    NetXMSClientException,
                    IllegalStateException

Connect to the server.

Throws:

IOException

UnknownHostException

NetXMSClientException

IllegalStateException

disconnect

void disconnect()

Disconnect from server.

getDefaultRecvBufferSize

int getDefaultRecvBufferSize()

Get default receiver buffer size.

Returns:

Default receiver buffer size in bytes.

getMaxRecvBufferSize

int getMaxRecvBufferSize()

Get max receiver buffer size.

Returns:

Max receiver buffer size in bytes.

setRecvBufferSize

void setRecvBufferSize(int defaultBufferSize,
                     int maxBufferSize)

Set receiver buffer size. This method should be called before connect(). It will not have any effect after connect().

Parameters:

defaultBufferSize - default size of receiver buffer in bytes.

maxBufferSize - max size of receiver buffer in bytes.

getServerAddress

String getServerAddress()

Get server address

Returns:

Server address

getUserName

String getUserName()

Get login name of currently logged in user

Returns:

login name of currently logged in user

getServerVersion

String getServerVersion()

Get NetXMS server version.

Returns:

Server version

getServerId

byte[] getServerId()

Get NetXMS server UID.

Returns:

Server UID

getServerTimeZone

String getServerTimeZone()

Returns:

the serverTimeZone

getConnClientInfo

String getConnClientInfo()

Returns:

the connClientInfo

setConnClientInfo

void setConnClientInfo(String connClientInfo)

Parameters:

connClientInfo - the connClientInfo to set

setCommandTimeout

void setCommandTimeout(int commandTimeout)

Set command execution timeout.

Parameters:

commandTimeout - New command timeout

getUserId

int getUserId()

Get identifier of logged in user.

Returns:

Identifier of logged in user

getUserSystemRights

long getUserSystemRights()

Get system-wide rights of currently logged in user.

Returns:

System-wide rights of currently logged in user

isPasswordExpired

boolean isPasswordExpired()

Returns:

the passwordExpired

setAttributeForCurrentUser

void setAttributeForCurrentUser(String name,
                              String value)
                                throws IOException,
                                       NetXMSClientException

Set custom attribute for currently logged in user. Server will allow to change only attributes whose name starts with dot.

Parameters:

name - Attribute's name

value - New attribute's value

Throws:

IOException - if socket I/O error occurs

NetXMSClientException - if NetXMS server returns an error or operation was timed out

getAttributeForCurrentUser

String getAttributeForCurrentUser(String name)
                                  throws IOException,
                                         NetXMSClientException

Get custom attribute for currently logged in user. If attribute is not set, empty string will be returned.

Parameters:

name - Attribute's name

Returns:

Attribute's value

Throws:

IOException - if socket I/O error occurs

NetXMSClientException - if NetXMS server returns an error or operation was timed out

isConnected

boolean isConnected()

Get connection state

Returns:

connection state

isEncrypted

boolean isEncrypted()

Get encryption state for current session.

Returns:

true if session is encrypted

checkConnection

boolean checkConnection()

Send KEEPALIVE message. Return true is connection is fine and false otherwise. If connection is broken, session notification with code CONNECTION_BROKEN will be sent to all subscribers. Note that this function will not throw exception in case of error.

Returns:

true if connection is fine

getDateFormat

String getDateFormat()

Get default date format provided by server

Returns:

getTimeFormat

String getTimeFormat()

Get default time format provided by server

Returns:

listMappingTables

List<MappingTableDescriptor> listMappingTables()
                                               throws IOException,
                                                      NetXMSClientException

Get list of all configured mapping tables.

Returns:

Throws:

IOException - if socket I/O error occurs

NetXMSClientException - if NetXMS server returns an error or operation was timed out

getMappingTable

MappingTable getMappingTable(int id)
                             throws IOException,
                                    NetXMSClientException

Parameters:

id -

Returns:

Throws:

IOException - if socket I/O error occurs

NetXMSClientException - if NetXMS server returns an error or operation was timed out

createMappingTable

int createMappingTable(String name,
                     String description,
                     int flags)
                       throws IOException,
                              NetXMSClientException

Create new mapping table.

Parameters:

name - name of new table

description - description for new table

flags - flags for new table

Returns:

ID of new table object

Throws:

IOException - if socket I/O error occurs

NetXMSClientException - if NetXMS server returns an error or operation was timed out

updateMappingTable

int updateMappingTable(MappingTable table)
                       throws IOException,
                              NetXMSClientException

Create or update mapping table. If table ID is 0, new table will be created on server.

Parameters:

table - mapping table

Returns:

ID of new table object

Throws:

IOException - if socket I/O error occurs

NetXMSClientException - if NetXMS server returns an error or operation was timed out

deleteMappingTable

void deleteMappingTable(int id)
                        throws IOException,
                               NetXMSClientException

Delete mapping table

Parameters:

id - mapping table ID

Throws:

IOException - if socket I/O error occurs

NetXMSClientException - if NetXMS server returns an error or operation was timed out