xmog_remote_client_manager Class Reference

A class that is the factory class for remote connections to Codemesh's shared JVM server. More...

#include <xmog_remote_client_manager.h>

List of all members.

Static Public Member Functions
static xmog_jvm *	get_connection (const char *connect, const char *auth, const char *encrypt)
	The factory method for remote JVM connections.
static const char *	get_file (const char *start, size_t &len)
	A utility method that can be used by module implementers to get the filename in which the functionality is implemented.
static const char *	get_prefix (const char *start, size_t &len)
	A utility method that can be used by module implementers to get the API prefix that is being used.
static const char *	get_appname (const char *start, size_t &len)
	A utility method that can be used by module implementers to get the application identifier.
static const char *	get_client_signon_name (const char *start, size_t &len)
	A utility method that can be used by module implementers to get the client signon name (username).
static const char *	get_client_signon_creds (const char *start, size_t &len)
	A utility method that can be used by module implementers to get the client credentials (password or similar).
static const char *	get_string_copy_limit (const char *start, size_t &len)
	A utility method that can be used by module implementers to get the string copy limit.
static const char *	get_primarray_copy_limit (const char *start, size_t &len)
	A utility method that can be used by module implementers to get the primarray copy limit.
static const char *	get (const char *key, const char *start, size_t &len)

---

Detailed Description

A class that is the factory class for remote connections to Codemesh's shared JVM server.

---

Member Function Documentation

static const char* xmog_remote_client_manager::get_appname (  const char *  start, size_t &  len )  [static]

A utility method that can be used by module implementers to get the application identifier. The application identifier is a remote client's way to specify a specific "application" on the server. The server can support multiple different versions of the same API or even totally different APIs by using separate classloaders. Each of these logical applications is identified by an application ID. Your client specifies an application ID to select one of these deployed applications. Think of this as the remote counterpiece to Java's classpath. Parameters: start  a pointer to the location where we start searching. a  reference to the variable that will hold the length of the found string. If nothing is found, the length will be set to 0.

static const char* xmog_remote_client_manager::get_client_signon_creds (  const char *  start, size_t &  len )  [static]

A utility method that can be used by module implementers to get the client credentials (password or similar). Parameters: start  a pointer to the location where we start searching. a  reference to the variable that will hold the length of the found string. If nothing is found, the length will be set to 0.

static const char* xmog_remote_client_manager::get_client_signon_name (  const char *  start, size_t &  len )  [static]

A utility method that can be used by module implementers to get the client signon name (username). Parameters: start  a pointer to the location where we start searching. a  reference to the variable that will hold the length of the found string. If nothing is found, the length will be set to 0.

static xmog_jvm* xmog_remote_client_manager::get_connection (  const char *  connect, const char *  auth, const char *  encrypt )  [static]

The factory method for remote JVM connections. This method is implemented to allow the modular extension of the connection and encryption facility via user-defined code residing in dynamic link libraries. To that purpose, the format of the connection string is modelled on a file URL with the file portion being optional. If no file portion is specified, the API to be used is expected to be present in the runtime library. An example for a common connection string would be: host=localhost&port=17354&appid=addressbook In that example, we're using the default connection mechanism (sockets) to connect to a server that's running on the same machine and listening on port 17354. The codebase and configuration information is available to the server in a (sub-)directory called addressbook. Parameters: connect  the connection string. auth  the authentication string. The authentication string is kept separately from the connection string to allow authentication facilities to be provided in a different module easily. encrypt  the encryption string. The encryption string is kept separately from the connection string to allow encryption facilities to be provided in a different module easily.

static const char* xmog_remote_client_manager::get_file (  const char *  start, size_t &  len )  [static]

A utility method that can be used by module implementers to get the filename in which the functionality is implemented. Parameters: start  a pointer to the location where we start searching. a  reference to the variable that will hold the length of the found string. If nothing is found, the length will be set to 0.

static const char* xmog_remote_client_manager::get_prefix (  const char *  start, size_t &  len )  [static]

A utility method that can be used by module implementers to get the API prefix that is being used. The prefix is used to support the implementation of more than one version of an extension API in one dynamic link library. The default prefix is "IPv4Sockets_" and represents TCP/IP v4 sockets that should be available on just about any platform. Parameters: start  a pointer to the location where we start searching. a  reference to the variable that will hold the length of the found string. If nothing is found, the length will be set to 0.

static const char* xmog_remote_client_manager::get_primarray_copy_limit (  const char *  start, size_t &  len )  [static]

A utility method that can be used by module implementers to get the primarray copy limit. The primitive array copy limit is an integer that specifies how many elements the server will report back to the client with every primitive array proxy return value. The default value is 256. Parameters: start  a pointer to the location where we start searching. a  reference to the variable that will hold the length of the found string. If nothing is found, the length will be set to 0.

static const char* xmog_remote_client_manager::get_string_copy_limit (  const char *  start, size_t &  len )  [static]

A utility method that can be used by module implementers to get the string copy limit. The string copy limit is an integer that specifies how many characters the server will report back to the client with every string proxy return value. The default value is 256. Parameters: start  a pointer to the location where we start searching. a  reference to the variable that will hold the length of the found string. If nothing is found, the length will be set to 0.

---

The documentation for this class was generated from the following file:

• xmog_remote_client_manager.h

---