BBjAPI::getBBjEnterpriseNamespace

Description

In BBj 13.00 and higher, this method returns a reference to a BBjEnterpriseNamespace. An enterprise namespace is used to share information between separate BBjServices processes.

Syntax

Return Value

Method

BBjEnterpriseNamespace

getBBjEnterpriseNamespace(string host, int port, string name, string user, string password)

BBjEnterpriseNamespace

getBBjEnterpriseNamespace(string host, int port, string name, string user, string password, string keystore, string keypass)

BBjEnterpriseNamespace

getBBjEnterpriseNamespace(string host, int port, string name, string user, string password, long timeout)

BBjEnterpriseNamespace

getBBjEnterpriseNamespace(string host, int port, string name, string user, string password, long timeout, string keystore, string keypass)

Parameters

Variable

Description

host

Specifies the host name of the enterprise namespace server.

keystore

Keystore for validating the SSL/TLS server certificate.

keypass

Password for the keystore used for validating the SSL/TLS server certificate.

name

Specifies the name of the enterprise namespace requested; creates it if it does not already exist.

password

Specifies the password for server authentication.

port

Specifies the port of the enterprise namespace server (defaults to 2552).

timeout

Maximum number of milliseconds to wait for the connection to succeed, defaults to 30,000 milliseconds (30 seconds). It should never take longer than this timeout to either succeed or fail (within a few milliseconds) and 0 will disable the timeout.

user

Specifies the user name for the server authentication.

Return Value

Returns a reference to a BBjEnterpriseNamespace on the requested server with the requested name.

Remarks

If the requested BBjEnterpriseNamespace does not exist, it will be created. All requests for a given BBjEnterpriseNamespace identified by host, port, and name will return a reference to the same enterprise namespace, allowing data to be shared. The host name must resolve to the IP address of the server machine. In particular, it cannot be redirected through NAT or a proxy.

Example

api! = BBjAPI()
ns! = api!.getBBjEnterpriseNamespace("server",2552,"testns","user","password")

See Also

BBjAPI

BBjNamespaceEvent

BBj Object Syntax

See the BBj Object Diagram for an illustration of the relationship between BBj Objects.