com.bmc.arsys.apitransport

Class ApiProxyBase

java.lang.Object

com.bmc.arsys.apitransport.ApiProxyBase

All Implemented Interfaces:

ApiProxyI

Direct Known Subclasses:

ApiProxyJRpcBase, Proxy

public abstract class ApiProxyBase
extends Object
implements ApiProxyI

The base class that contains the common base methods that can be used for different type of AR Proxy. i.e. Proxy extends ApiProxyBase ProxyJrpc extends ProxyJRpcBase => ApiProxyJRpcBase => ApiProxyBase CMDBProxy extends ApiProxyBase

Field Summary

Fields inherited from interface com.bmc.arsys.apitransport.ApiProxyI

AR_JNI_RPC, AR_JRPC, CMDB_JRPC, RPC_NONE

Method Summary

Modifier and Type	Method and Description
abstract 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.
abstract void	ARSetSessionConfiguration(ApiUserContextI ctx, int tag, ApiValueBase value) Allows session variables to be set.
abstract long	ARTermination(ApiUserContextI ctx) Performs environment-specific cleanup routines and disconnects from the specified Action Request System session.
long	getEstablishTime() get the system time this proxy is established
long	getLastUsed() get last used system time for this proxy.
Object	getSocket(ApiUserContextI context)
void	setEstablishTime(long m_establishTime) set the system time this proxy is established
void	setLastUsed(long tm) set last used system time for this proxy.
void	setProxyProperties(ApiUserContextI context)
void	setSocket(ApiUserContextI context, Object so)

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.bmc.arsys.apitransport.ApiProxyI

ARVerifyUser

Method Detail

setProxyProperties

public void setProxyProperties(ApiUserContextI context)
                        throws ARException

Specified by:

setProxyProperties in interface ApiProxyI

Throws:

ARException

setLastUsed

public void setLastUsed(long tm)

set last used system time for this proxy.

Specified by:

setLastUsed in interface ApiProxyI

getLastUsed

public long getLastUsed()

get last used system time for this proxy.

Specified by:

getLastUsed in interface ApiProxyI

setEstablishTime

public void setEstablishTime(long m_establishTime)

set the system time this proxy is established

Parameters:

m_establishTime -

getEstablishTime

public long getEstablishTime()

get the system time this proxy is established

Specified by:

getEstablishTime in interface ApiProxyI

Returns:

ARSetSessionConfiguration

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

Description copied from interface: ApiProxyI

Allows session variables to be set.

Specified by:

ARSetSessionConfiguration in interface ApiProxyI

Throws:

ARException - if variables are not set

ARSetServerPort

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

Description copied from interface: ApiProxyI

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

Specified by:

ARSetServerPort in interface ApiProxyI

Throws:

ARException - if port is not specified

ARTermination

public abstract long ARTermination(ApiUserContextI ctx)
                            throws ARException

Description copied from interface: ApiProxyI

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.

Specified by:

ARTermination in interface ApiProxyI

Throws:

ARException - if routines are not performed

getSocket

public Object getSocket(ApiUserContextI context)
                 throws ARException

Throws:

ARException

setSocket

public void setSocket(ApiUserContextI context,
                      Object so)
               throws ARException

Throws:

ARException