com.bmc.arsys.apitransport

Interface ApiProxyI

All Known Implementing Classes:

ApiProxyBase, ApiProxyJRpcBase, Proxy, ProxyJRpc

public interface ApiProxyI

The interface for Proxy classes

Field Summary

Fields

Modifier and Type	Field and Description
static int	AR_JNI_RPC
static int	AR_JRPC
static int	CMDB_JRPC
static int	RPC_NONE

Method Summary

Modifier and Type	Method and Description
void	ARSetServerPort(ApiUserContextI ctx, int port, int progNum) Specifies the port that your program will use to communicate with the AR System server, and whether to use a private server.
void	ARSetSessionConfiguration(ApiUserContextI ctx, int tag, ApiValueBase value) Allows session variables to be set.
long	ARTermination(ApiUserContextI ctx) Performs environment-specific cleanup routines and disconnects from the specified Action Request System session.
void	ARVerifyUser(ApiUserContextI ctx) Checks the cache on the specified server to determine whether the user you specify for the control parameter is registered in AR System.
long	getEstablishTime() get the system time this proxy is established
long	getLastUsed() get last used system time for this proxy.
void	setLastUsed(long tm) set last used system time for this proxy.
void	setProxyProperties(ApiUserContextI context)

Field Detail

RPC_NONE

static final int RPC_NONE

See Also:

Constant Field Values

AR_JRPC

static final int AR_JRPC

See Also:

Constant Field Values

AR_JNI_RPC

static final int AR_JNI_RPC

See Also:

Constant Field Values

CMDB_JRPC

static final int CMDB_JRPC

See Also:

Constant Field Values

Method Detail

setProxyProperties

void setProxyProperties(ApiUserContextI context)
                 throws ARException

Throws:

ARException

ARSetSessionConfiguration

void ARSetSessionConfiguration(ApiUserContextI ctx,
                               int tag,
                               ApiValueBase value)
                        throws ARException

Allows session variables to be set.

Throws:

ARException - if variables are not set

ARSetServerPort

void ARSetServerPort(ApiUserContextI ctx,
                     int port,
                     int progNum)
              throws ARException

Specifies the port that your program will use to communicate with the AR System server, and whether to use a private server.

Throws:

ARException - if port is not specified

ARTermination

long ARTermination(ApiUserContextI ctx)
            throws ARException

Performs environment-specific cleanup routines and disconnects from the specified Action Request System session. All API programs that interact with AR System should call this function upon completing work in a given session. Calling this function is especially important in environments that use floating licenses. If you do not disconnect from the server, your license token is unavailable for other users for the defined time-out interval.

Throws:

ARException - if routines are not performed

ARVerifyUser

void ARVerifyUser(ApiUserContextI ctx)
           throws ARException

Checks the cache on the specified server to determine whether the user you specify for the control parameter is registered in AR System.

Throws:

ARException - if cache is not checked

setLastUsed

void setLastUsed(long tm)

set last used system time for this proxy.

getLastUsed

long getLastUsed()

get last used system time for this proxy.

getEstablishTime

long getEstablishTime()

get the system time this proxy is established

Returns: