com.bmc.arsys.apitransport

Class ApiConfig

java.lang.Object

com.bmc.arsys.apitransport.ApiConfig

All Implemented Interfaces:

ApiConfigI, ApiPropertyI

Direct Known Subclasses:

Config

public abstract class ApiConfig
extends Object
implements ApiConfigI

The abstract base class ARConfig i.e. in api package: public class Config extends ApiConfig

Field Summary

Fields

Modifier and Type	Field and Description
static String	MAINCONFIG_NAME
static String	PROPERTY_NAME

Constructor Summary

Constructors

Constructor and Description
ApiConfig(String configName, String file)

Method Summary

Modifier and Type	Method and Description
ApiWebSocketConfig	get(String serverName)
int	getApiRecording()
int	getClientRpcVersion()
String	getConfigName()
long	getConnectionLifespan() Number of timeUnit interval that connection will be load balanced.
int	getConnectionMaxRetries()
long	getConnectionTimeout() Number of timeUnit that -- connections that exceed idleConnectionsPerServer can be idle before being terminated.
int	getIdleConnectionsPerServer() Number of idle connections in an active connection pool that are not subject to the idleConnectionsPerServer limit.
int	getJniLoadMode()
boolean	getJrpcMode()
int	getMaxProxiesPerServer() Connection pool size per server
int	getMinimumSupportedServerRpcVersion()
String	getRpcClientStubType() Return APIs RpcClientStub type
int	getTimeLagBetweenRetriesMillSec()
ARTimeUnit	getTimeUnit() ARTimeUnit for connectionTimeout and connectionLifespan.
String	getTimeUnitStr() ARTimeUnit name for connectionTimeout and connectionLifespan.
ApiWebSocketConfig	getWebSocket_config(String server)
boolean	isProxyPoolingOn()
void	put(String serverName, ApiWebSocketConfig updatingConfig)
static void	register(ApiConfig config) register an ApiConfig instance into the ApiConfig instance collection.
void	setApiRecordingMode(int apiRecording) set API recording
void	setClientRpcVersion(int clientRpcVersion) set client RPC version
void	setConnectionMaxRetries(int connectionMaxRetries) set connection Max retries
void	setJniLoadMode(int jniLoadMode) set JNI Load Mode
void	setJrpcMode(boolean jrpcMode) set Jrpcmode
void	setJrpcMode(org.apache.commons.configuration.Configuration config)
void	setMinimumSupportedServerRpcVersion(int minimumSupportedServerRpcVersion) Set minimum supported Server RPC Version
void	setRpcClientStubType(String rpcClientStubType) Set RpcClientStub type
void	setTimeLagBetweenRetriesMillSec(int timeLagBetweenRetriesMillSec) Set time-lag between Retries
void	setWebSocketConfig(List<ApiWebSocketConfig> configList)
void	updateWebSocketSettingsInXml(Map<String,ApiWebSocketConfig> updateConfigs)

Methods inherited from class java.lang.Object

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

Field Detail

PROPERTY_NAME

public static final String PROPERTY_NAME

See Also:

Constant Field Values

MAINCONFIG_NAME

public static final String MAINCONFIG_NAME

See Also:

Constant Field Values

Constructor Detail

ApiConfig

public ApiConfig(String configName,
                 String file)

Method Detail

getConfigName

public String getConfigName()

register

public static void register(ApiConfig config)

register an ApiConfig instance into the ApiConfig instance collection.

Parameters:

config -

setJrpcMode

public void setJrpcMode(org.apache.commons.configuration.Configuration config)

setJrpcMode

public void setJrpcMode(boolean jrpcMode)

Description copied from interface: ApiConfigI

set Jrpcmode

Specified by:

setJrpcMode in interface ApiConfigI

getJrpcMode

public boolean getJrpcMode()

Specified by:

getJrpcMode in interface ApiConfigI

Returns:

the jrpcMode

setClientRpcVersion

public void setClientRpcVersion(int clientRpcVersion)

Description copied from interface: ApiConfigI

set client RPC version

Specified by:

setClientRpcVersion in interface ApiConfigI

getClientRpcVersion

public int getClientRpcVersion()

Specified by:

getClientRpcVersion in interface ApiConfigI

Returns:

getClientRpcVersion

setJniLoadMode

public void setJniLoadMode(int jniLoadMode)

Description copied from interface: ApiConfigI

set JNI Load Mode

Specified by:

setJniLoadMode in interface ApiConfigI

getJniLoadMode

public int getJniLoadMode()

Specified by:

getJniLoadMode in interface ApiConfigI

Returns:

the jniLoadMode

setApiRecordingMode

public void setApiRecordingMode(int apiRecording)

Description copied from interface: ApiConfigI

set API recording

Specified by:

setApiRecordingMode in interface ApiConfigI

getApiRecording

public int getApiRecording()

Specified by:

getApiRecording in interface ApiConfigI

Returns:

the apiRecordingMode

setMinimumSupportedServerRpcVersion

public void setMinimumSupportedServerRpcVersion(int minimumSupportedServerRpcVersion)

Description copied from interface: ApiConfigI

Set minimum supported Server RPC Version

Specified by:

setMinimumSupportedServerRpcVersion in interface ApiConfigI

getMinimumSupportedServerRpcVersion

public int getMinimumSupportedServerRpcVersion()

Specified by:

getMinimumSupportedServerRpcVersion in interface ApiConfigI

Returns:

the MinimumSupportedServerRpcVersion

setConnectionMaxRetries

public void setConnectionMaxRetries(int connectionMaxRetries)

Description copied from interface: ApiConfigI

set connection Max retries

Specified by:

setConnectionMaxRetries in interface ApiConfigI

getConnectionMaxRetries

public int getConnectionMaxRetries()

Specified by:

getConnectionMaxRetries in interface ApiConfigI

Returns:

the connectionMaxRetries

setTimeLagBetweenRetriesMillSec

public void setTimeLagBetweenRetriesMillSec(int timeLagBetweenRetriesMillSec)

Description copied from interface: ApiConfigI

Set time-lag between Retries

Specified by:

setTimeLagBetweenRetriesMillSec in interface ApiConfigI

getTimeLagBetweenRetriesMillSec

public int getTimeLagBetweenRetriesMillSec()

Specified by:

getTimeLagBetweenRetriesMillSec in interface ApiConfigI

Returns:

the timeLagBetweenRetriesMillSec

isProxyPoolingOn

public boolean isProxyPoolingOn()

getMaxProxiesPerServer

public int getMaxProxiesPerServer()

Connection pool size per server

Returns:

getIdleConnectionsPerServer

public int getIdleConnectionsPerServer()

Number of idle connections in an active connection pool that are not subject to the idleConnectionsPerServer limit. These connections can be open indefinitely. Value must be less than or equal to the maxProxyPerServer value. Default value is 5. variable to 0 to result if all connections in a pool have been idle for the specified time period, the entire pool is deleted.

Returns:

getConnectionTimeout

public long getConnectionTimeout()

Number of timeUnit that -- connections that exceed idleConnectionsPerServer can be idle before being terminated. This time limit ensures that active pools regularly clean up their excess idle connections. variable to 0 to prevent any idle connection from terminating before the Java API client--such as the mid tier or BMC Remedy Data Import--is shut down,

Returns:

getConnectionLifespan

public long getConnectionLifespan()

Number of timeUnit interval that connection will be load balanced. variable to 0 to prevent any termination on connection,

Returns:

getTimeUnitStr

public String getTimeUnitStr()

ARTimeUnit name for connectionTimeout and connectionLifespan.

Returns:

getTimeUnit

public ARTimeUnit getTimeUnit()

ARTimeUnit for connectionTimeout and connectionLifespan.

Returns:

setRpcClientStubType

public void setRpcClientStubType(String rpcClientStubType)

Description copied from interface: ApiConfigI

Set RpcClientStub type

Specified by:

setRpcClientStubType in interface ApiConfigI

getRpcClientStubType

public String getRpcClientStubType()

Return APIs RpcClientStub type

Specified by:

getRpcClientStubType in interface ApiConfigI

Returns:

the getRpcClientStubType

getWebSocket_config

public ApiWebSocketConfig getWebSocket_config(String server)

setWebSocketConfig

public void setWebSocketConfig(List<ApiWebSocketConfig> configList)

updateWebSocketSettingsInXml

public void updateWebSocketSettingsInXml(Map<String,ApiWebSocketConfig> updateConfigs)

get

public ApiWebSocketConfig get(String serverName)

put

public void put(String serverName,
                ApiWebSocketConfig updatingConfig)