IDSSXMLAdmin

Default value for the connectionPoolSize parameter of the Connect method.

Default value for the initialPoolSize parameter of the Connect method.

Default value for the port parameter of the Connect method.

Connects the Web API to an Intelligence Server cluster.

A connection is a TCP/IP connection between a Web XML API and a DSS Server. It is used by the XML API to pass a request (create session request, execute report request etc.) to and retrieve the response from the DSS Server.

The method establishes the connection pool for a given DSS Server Cluster. The NodeName is the name of a DSS Server in the Cluster. All the servers in the cluster should use the same port number. The InitialPoolSize and ConnectionPoolSize are for each server in the cluster. If the default values are used, this method will create four connections to each server initially. The default maximum connection pool size for both servers is 100.

Before the Web XML API can handle any request, a connection pool needs to be established. When a Web request comes in, the XML API gets a connection from the connection pool to serve the request. Connections in the connection pool are initially in free status. Once used to serve a Web request, they are in busy status. Once a request is completed (session ID returned for create sesion, messageID returned after executing a report for example), the connection is returned to the connection pool in free status.

When XML API detects that the free connections in a connection pool is too low (less than two connections) and the connection pool has not reached the maximum pool size, it dynamically expands the connection pool. In the case when the connection pool reaches its maximum pool size, if a Web request comes in when all connections are busy, the request waits for a free connection. The time to wait is configurable through this admin interface. When the waiting time is up and there is still no free connections, a Server too busy error is returned. Through this admin interface, an administrator can monitor the status of the connection pool. When all the connections in the connection pool are always stay in busy status, that means a lot of the Web users receives Server too busy messages. This is when the administrator needs to either adjust the max-wait time out setting or increase the connection pool size.

TThe XML API also balances the load among cluster nodes. The load is currently measured as the number of logins to a server.

This method is used to disconnect from an Intelligence Server Cluster.

This method will disconnect the XML API from a DSS Server Cluster. The nodeName is the name of a server in the cluster. The "busy" connections will not be disconnected and destroyed until they are returned to the "free" status. This means that this method will disconnect the connections gracefully. All ongoing requests will have a chance to be completed.

Returns null if cluster node is not connected.

This method returns an IDSSXMLCluster interface for a given node name. The returned IDSSXMLCluster interface is a collection of Cluster Nodes(Intelligence Servers) that the given cluster node belongs to.

The cluster information returned by this method may not be the latest. To get the latest cluster membership or the load for each cluster node, you need to call RefreshCluster(nodeName) first.

Returns an IDSSXMLClusterNode interface for a given node name. The returned IDSSXMLClusterNode interface contains the properties of the cluster node. Through this interface, a user can get the node name, load, connection pool size, the number of busy connections and the number of free connections. The connection pool size can also be set through this interface.

The load of the cluster node returned by this method may not be the latest. To get the latest load for this cluster node, you need to call RefreshCluster(NodeName) first.

This method returns a collection of Intelligence Server Clusters representing all clusters that the API is connected to.

The cluster information returned by this method may not be the latest. To get the latest cluster membership or the load for each cluster node, you need to call RefreshCluster first.

Refreshes the cluster information that the API returns. It takes an optional node name. If a node name is given, it only refreshes the cluster that the given node belongs to. If the node name is null or empty, it refreshes all clusters that the Web API is connected to. This method should be called if you want to get the latest cluster membership information or the load for each cluster node.

Returns the current autoconnect setting of the XMLAPI. This setting will affect all objects and threads in this instance of the XMLAPI. If this is true, then calls such as CreateSession, GetProjects, and CheckVersion will automatically connect to an unconnected Intelligence Server. If this value is false, the only way to connect to a server is through an explicit Connect call. By default, this property is false.

Returns whether the API is set to use encryption when talking to the Intelligence Server.

Returns the kind of encryption to use when putEncryption(boolean) is enabled. By default EncryptionMode#aes is used.

Returns Keep Alive parameter of the socket connections between web server and Intelligence Servers. On IDSSXMLClusterNode, it also has a setting of keep alive. When keep alive on this interface is true, all connections between web server and Intelligence Servers will be kept alive. When keep alive on this interface is false, the keep alive property of a particular connection will be determined by the keep alive setting on IDSSXMLClusterNode interface.

Returns the number of milliseconds that the Web API will wait for a Server to respond to a request.

Returns the number of milliseconds that a request waits for a "free" connection before returning the "Server too busy" error message.

Sets whether the API should use encryption when talking to the Intelligence Server. If this is not set, then only the user password will be encrypted - all other data will be plaintext to/from the Server.

Sets the number of times that the Web API could fail when initializing the connection pool.

Sets Keep Alive parameter of the socket connections between web server and Intelligence Servers. On IDSSXMLClusterNode, it also has a setting of keep alive. When keep alive on this interface is true, all connections between web server and Intelligence Servers will be kept alive. When keep alive on this interface is false, the keep alive property of a particular connection will be determined by the keep alive setting on IDSSXMLClusterNode interface.

Sets the number of milliseconds that the Web API will wait for a Server to respond to a request.

Sets the number of milliseconds that a request waits for a "free" connection before returning the "Server too busy" error message.

Sets the autoconnect setting of the XMLAPI. This setting will affect all objects and threads in this instance of the XMLAPI. If this is true, then calls such as CreateSession, GetProjects, and CheckVersion will automatically connect to an unconnected Intelligence Server. If this value is false, the only way to connect to a server is through an explicit Connect call. By default, this property is false.

Configures the kind of encryption to use. Note that to use SSL it may also be necessary to setup #getSSLConfiguration() depending on the certicate configured on the Intelligence Server.