NetSwitch Library v4.230
Classes and interfaces required for building components or applications that interact with a NetSwitch server.
Client Properties |
Console Properties |
JDBC Properties |
JSCH Properties |
Mail Properties |
Server Properties |
Socket Properties |
The following services are provided by the built-in GATEWA server.
| Destination | Description | Parameters |
|---|---|---|
GATEWA.COMMAND |
Executes the specified console command | command |
GATEWA.GET_CHANNEL |
Returns the properties of the specified channels | channelName? channelOwner? |
GATEWA.GET_OBJECT |
Returns the properties of the specified objects | objectName? objectType? |
GATEWA.GET_PARAM |
Returns the properties of the specified parameters | paramName? |
GATEWA.LIC_EXP_DATE |
Returns the license expiration date as "yyyy-MM-ddTHH:mm:ss.SSS-ZZZZ" |
none |
GATEWA.LOG_ERROR |
Writes an error message in the NetSwitch log file | message in text |
GATEWA.LOG_INFO |
Writes an information message in the NetSwitch log file | message in text |
GATEWA.LOG_WARN |
Writes a warning message in the NetSwitch log file | message in text |
GATEWA.MCAST_DISABLE |
Disables the specified multicast name | [Q multicast-name] in text |
GATEWA.MCAST_ENABLE |
Enables the specified multicast name | [Q multicast-name] in text |
GATEWA.MCAST_RESET |
Disables all multicast names of the channel | none |
GATEWA.MYSELF |
Returns information of the channel | none |
GATEWA.TIMESTAMP |
Returns a unique timestamp as "yyyy-MM-dd:HH:mm:ss.cccccc" |
none |
The following services are provided by the built-in NETSWITCH server.
| Destination | Description | Parameters |
|---|---|---|
NETSWITCH.CHANNEL_EXISTS |
Returns whether the specified channel exists | channelName |
NETSWITCH.COMMAND |
Executes the specified console command | command |
NETSWITCH.DEVICE_CLOSE |
Closes all the channels of the specified device | deviceName |
NETSWITCH.ECHO |
Writes the received message back to the source | closeChannel? |
NETSWITCH.LIC_EXP_DATE |
Returns the license expiration date as "yyyy-MM-ddTHH:mm:ss.SSS-ZZZZ" |
none |
NETSWITCH.LOG_ERROR |
Writes an error message in the NetSwitch log file | message in text |
NETSWITCH.LOG_INFO |
Writes an information message in the NetSwitch log file | message in text |
NETSWITCH.LOG_WARN |
Writes a warning message in the NetSwitch log file | message in text |
NETSWITCH.MCAST_DISABLE |
Disables the specified multicast name or '*' | mcastName |
NETSWITCH.MCAST_ENABLE |
Enables the specified multicast name | mcastName |
NETSWITCH.MCAST_LIST |
Returns the multicast names of the channel | mcastName? |
NETSWITCH.SERVER_INFO |
Returns information of the specified servers | serverName? |
NETSWITCH.TIMESTAMP |
Returns a unique timestamp as "yyyy-MM-dd:HH:mm:ss.cccccc" |
none |
The following properties control the behaviour of a MetaServer process.
| Property | Description | Type | Default |
|---|---|---|---|
meta.cleanup.max.timeout |
Cleanup maximum timeout (milliseconds) | Integer |
30000 |
meta.cleanup.period |
Cleanup task period (milliseconds) | Integer |
30000 |
meta.jmx.host |
IP address of the JMX listener | String |
none |
meta.jmx.port |
Port of the JMX listener | Integer |
none |
meta.jmx.users.file |
Path of the JMX users file (authentication) | String |
none |
meta.jmx.access.file |
Path of the JMX access file (authorization) | String |
none |
meta.keep.stdio |
Keep Java standard input, output and error | Boolean |
false |
The following properties define a Proxy Server with index «c» (1 ≤ «c» ≤ 20). All http or https connections that match uri are routed through the specified host and port.
| Property | Description | Type | Default |
|---|---|---|---|
meta.proxy.«c».host |
Name or IP Address of the Proxy Server | String |
required |
meta.proxy.«c».port |
Port number of the Proxy Server | Integer |
required |
meta.proxy.«c».uri |
URI to redirect through the Proxy Server | |
required |
Modules
Module
Description
Provides classes to build applications and components that interact with a
NetSwitch server.