VisiBroker for C++ Developer’s Guide : VisiBroker properties

VisiBroker properties
This section describes the VisiBroker properties.
Smart Agent properties
The following table describes the properties for Smart Agent:
vbroker.agent.
clientHandlerPort
vbroker.agent.
keepAliveTimer
Smart agent will wake up after this timeout and based on the vbroker.agent.keepAliveThreshold value, will compute whether to do client verification. The logic is if the last received heart beat value is less than current time - (keepAliveTimer + keepAliveThreshold), then do client verification. The value of this property should be greater than 1 second and less than 120 seconds. The number of times the client verification is tried can be controlled by vbroker.agent.maxRetries property.
vbroker.agent.
keepAlivethreshold
See vbroker.agent.keepAliveTimer. This value should be greater than 0.
$ osagent -Dvbroker.agent.timer 60
   -Dvbroker.agent.threshold 5
See vbroker.agent.timer. This value should be greater than 0.
Smart Agent communication properties
The properties described in the table below are used by the ORB for Smart Agent communication.
vbroker.agent.
keepAliveTimer
The duration in seconds that the process will pause before trying to reconnect to the Smart Agent in the event of disconnection from the Smart Agent. If the value is -1, the process will exit upon disconnection from the Smart Agent. The default value of 0 (zero) means that reconnection will be made without any pause.
Specifies the IP address or host name of a host running a Smart Agent. The default value, null, instructs VisiBroker applications to use the value from the OSAGENT_ADDR environment variable. If this OSAGENT_ADDR variable is not set, then it is assumed that the Smart Agent is running on a local host.
When set to true, specifies that the system will display debugging information about communication of VisiBroker applications with the Smart Agent.
vbroker.agent.
enableLocator
When set to false, does not allow VisiBroker applications to communicate with the Smart Agent.
When set to true, allows a VisiBroker application to fail over to another Smart Agent.
vbroker.agent.
clientPortRange
By default, VisiBroker will load Osagent(DSUser
) library when property
vbroker.agent.enableLocator=true or vbroker.orb.loadDSUser=true.
If this is set to true but the application needs to use OAD with osagent disabled, set vbroker.orb.loadDSUser=true and vbroker.agent.enableLocator=false.
VisiBroker ORB properties
This table lists the VisiBroker ORB properties.
vbroker.orb.
defaultThreadStackSize
When set to true, the application dynamically loads the fw library to make the Gatekeeper firewall component available.
By default, the property is false. When false, the fw library is not loaded, so the gatekeeper firewall component is not available.
When set to true, allows VisiBroker applications to cache IOR.
It determines if the ORB should rebind in the case of a failure to connect during a LOCATION_FORWARD. When the client is forwarded to a new object, an attempt is made to connect to the new (destination) object. If this attempt ends in failure, the ORB transparently connects back to the original object (the source of the forward). This rebind to the source object occurs only if two conditions are fulfilled. The first is that the total number of forwards at this point (without a normal response punctuating them) should not have exceeded the count specified in this property.
When set to TRUE, the server is operating in backward compatibility mode.
When set to TRUE, passing a null string causes a BAD_PARAM exception to be thrown. Passing zero length strings is allowed if vbroker.orb.backCompat is TRUE.
vbroker.orb.
enableServerManager
When set to TRUE, this property enables Server Manager within a server so that clients can access to it.
Specifies the maximum number of input buffers retained in a pool. Defaults to 16. Set the value to 0 to disable the caching of the input buffers.
Specifies the maximum number of output buffers retained in a pool. Defaults to 16. Set the value to 0 to disable the caching of the output buffers.
When set to true, specifies that clients must always connect to the server using the GateKeeper.
Specifies an IOR of the GateKeeper which will be used as proxy to Smart Agent. If this property is not set, the GateKeeper specified by the vbroker.orb.gatekeeper.ior property is used for this purpose. For more information, go to the VisiBroker GateKeeper Guide.
vbroker.orb.
exportFirewallPath
If set to true, forces PASSTHROUGH firewall mode globally in the application scope (use QoSExt::ProxyModePolicy in your code to force it selectively per object or per ORB).
2
3
4
5
6
The transports that appear first have higher precedence. For example, if an IOR contains both LIOP and IIOP profiles, the first chance goes to LIOP. Only if the LIOP fails is IIOP used. (The critical bid, specified by the vbroker.orb.bids.critical property, has highest precedence no matter where it is specified in the bid order.)
You can enter the value vbsec to load the correct configured security provider, provided that the VisiBroker lib directory is present on the shared library load path. This enables you to specify the security library without needing to know the exact full VisiSecure shared library name, prefix and shared library suffix. See the chapter Creating Secure CORBA Applications Using C++ in the VisiBroker for C++ Developer’s Guide for examples of using this property.
When an IOR is created, the VisiBroker ORB embeds the codeset components into the IOR. This may produce problems with some non-compliant ORBs. By turning off the embedCodeset property, you instruct the VisiBroker ORB not to embed codesets in IORs. When set to false, specifies that character and wide character conversions between the client and the server are not to be negotiated.
vbroker.orb.
enableVB4backcompat
vbroker.orb.
enableNullString
If set to TRUE, enables marshaling of null strings.
vbroker.orb.
serverSendTimeout
Default value 0 means no timeout.
If the write operation is blocked for more then the serverSendTimeout limit, it will timeout and close the connection.
vbroker.orb.
serverRecvTimeout
Default value of 0 means no timeout.
If you set it to true, the behavior of VisiBroker interceptors (when using with servant manager) is the same as in VisiBroker version 6.5.
If this property is set to true, and if the IOR has both IIOP and TCP type Firewall components, then if any one of the end points fail, fail-over can occur.
Setting vbroker.orb.alwaysProxy=true or a programmatically configured firewall proxy takes precedence.
If true, any thread calling ORB::perform_work() can performs the request. If false, the thread that calls ORB::perform_work() the first time becomes the "main thread" throughout the lifetime of the ORB. The call to ORB::perform_work() from a thread other than the "main thread" does nothing.
Set this property to true to send a GIOP Locate request on binding to verify it is a GIOP server.
If set to true, this property makes the C++ ORB accept file: scheme IORs of the form file:my.ior, and interpret them as locations relative to the current working directory.
The file URL conforms to the standard format of “file://<domain name>/<path>/<file>”. However, there are some constraints in the format supported by VisiBroker for C++.
The following paths show examples of valid paths:
file:///home/user/appl.ior
file:///C|/My Documents/User/root.txt
ServerManager properties
This table lists the Server Manager properties.
vbroker.serverManager.
enableOperations
When set to true, enables operations exposed, by the Server Manager, to be invoked.
vbroker.serverManager.
enableSetProperty
Properties showing run-time status of server
The following properties show information on the run-time state of the Server, which can be queried from through the Server Manager’s container. These are all read-only; you cannot modify them.
Properties related to Server-side resource usage
 
vbroker.se.<SE_name>.scm.
<SCM_name>.manager.
allocatedFileDescriptors
vbroker.se.<SE_name>.scm.
<SCM_name>.manager.
maxFileDescriptor
vbroker.se.<SE_name>.scm.
<SCM_name>.manager.
inUseConnections
vbroker.se.<SE_name>.scm.
<SCM_name>.manager.
idleConnections
vbroker.se.<SE_name>.scm.
<SCM_name>.manager.
idledTimeoutConnections
vbroker.se.<SE_name>.scm.
<SCM_name>.dispatcher.
inUseThreads
vbroker.se.<SE_name>.scm.
<SCM_name>.dispatcher.
idleThreads
Properties related to Client-side resource usage
 
vbroker.ce.<CE_name>.ccm.
maxFileDescriptor
vbroker.ce.<CE_name>.ccm.
activeConnections
vbroker.ce.<CE_name>.ccm.
cachedConnections
vbroker.ce.<CE_name>.ccm.
idledTimeoutConnections
Properties related to the Smart Agent (osagent)
 
Miscellaneous Properties
 
The value of the PATH environment variable under which the ORB is running.
vbroker.process.
fileDescriptorLimit
Location Service properties
This table lists the Location Service properties.
When set to true, allows the Location Service to display debugging information.
Note: This property is deprecated. See “Debug Logging properties” for recommended properties to use in its place.
When set to true, allows the Location Service to check for the existence of an object referred by an object reference sent from the Smart Agent. Only objects registered BY_INSTANCE are verified for existence. Objects that are either registered with OAD, or those registered BY_POA policy are not verified for existence.
Event Service properties
This table lists the Event Service properties.
vbroker.events.
maxQueueLength
When set to true, allows the event channel factory to be instantiated, instead of an event channel.
When set to true, allows output of debugging information.
When set to true, allows the event channel to be executed in a console-driven, interactive mode.
Naming Service (VisiNaming) properties
The following tables list the VisiNaming Service properties.
If 1, enables master/slave naming services configuration. See “VisiNaming Service Clusters for Failover and Load Balancing” for information about master/slave naming services.
This property specifies the full path name for storing the naming service IOR. If you do not set this property, the naming service will try to output its IOR into a file named ns.ior in the current directory. The naming service silently ignores file access permission exceptions when it tries to output its IOR.
Note: This property is deprecated. See “Debug Logging properties” for recommended properties to use in its place.
This property allows special logging for all of the update operations on the CosNaming::NamingContext, CosNamingExt::Cluster, and CosNamingExt::ClusterManager interfaces.
The CosNaming::NamingContext interface operations for which this property is effective are:
bind, bind_context, bind_new_context, destroy, rebind, rebind_context, unbind.
The CosNamingExt::Cluster interface operations for which this property is effective are:
bind, rebind, unbind, destroy.
The CosNamingExt::ClusterManager interface operation for which this property is effective is:
create_cluster
When this property value is set to true and any of the above methods is invoked, the following log message is printed (the output shows a bind operation being executed):
vbroker.se.iiop_tp.scm.
iiop_tp.listener.
deferAccept,
vbroker.se.iiop_tp.scm.ssl.
listener.deferAccept
Properties relating to object clustering
For more information see , “Using the VisiNaming Service.”
vbroker.naming.
enableClusterFailover
When set to true, it specifies that an interceptor be installed to handle fail-over for objects that were retrieved from the VisiNaming Service. In case of an object failure, an attempt is made to transparently reconnect to another object from the same cluster as the original.
If 1, the implicit clustering feature is turned on.
This property is relevant when the name service cluster uses the Smart Round Robin criterion. When this property is set to 1, a stale object reference that was previously bound to a cluster with the Smart Round Robin criterion will be removed from the bindings when the name service discovers it. If this property is set to 0, stale object reference bindings under the cluster are not eliminated. However, a cluster with Smart Round Robin criterion will always return an active object reference upon a resolve() or select() call if such an object binding exists, regardless of the value of the vbroker.naming.smrr.pruneStaleRef property. By default, the implicit clustering in the name service uses the Smart Round Robin criterion with the property value set to 1. If set to 2, this property disables the clearing of stale references completely, and the responsibility of cleaning up the bindings belongs to the application, rather than to VisiNaming.
VisiNaming service cluster related properties
For more information see , “Using the VisiNaming Service.”
This property is used to configure VisiNaming Service instances in the cluster mode or in the master/slave mode. The vbroker.naming.enableSlave property must be set to 1 for this property to take effect.
Set this property to cluster to configure VisiNaming Service instances in the cluster mode. VisiNaming Service clients will then be load balanced among the VisiNaming Service instances that comprise the cluster. Client failover across these instances are enabled.
Set this property to slave to configure VisiNaming Service instances in the master/slave mode. VisiNaming Service clients will always be bound to the master server if the master is running but failover to the slave server when the master server is down.
vbroker.naming.
serverClusterName
See the related property, vbroker.naming.serverAddresses.
vbroker.naming.
serverAddresses
This property specifies the host and listening port for the VisiNaming Service instances that comprise a VisiNaming Service cluster. The order of VisiNaming Service instances in this list must be identical to that of the related property vbroker.naming.serverNames, which specifies the names of the VisiNaming Service instances that comprise a VisiNaming Service Cluster. This property supports the format:
vbroker.naming.
anyServiceOrder
This property must be set to true on the VisiNaming Service client to utilize the load balancing and failover features available when VisiNaming Service instances are configured in the VisiNaming Service cluster mode. The following is an example of how to use this property:
Pluggable Backing Store Properties
The following tables show property information for the VisiNaming service pluggable backing store types.
Default properties common to all adapters
 
vbroker.naming.
backingStoreType
This property is required when the Naming Service cache is enabled (vbroker.naming.cacheOn=1) and the Naming Service instances are configured in Cluster or Master/Slave mode. It helps locate an Event Service instance in the format <hostname>:<port>. For example:
See “Caching facility” for details about enabling the caching facility and setting the appropriate properties.
JDBC Adapter properties
 
vbroker.naming.
jdbcDriver
interbase.interclient.Driver—Interbase driver
weblogic.jdbc.mssqlserver4.Driver—WebLogic MS SQLServer Driver
vbroker.naming.
resolveAutoCommit
jdbc:db2:<db-name>—IBM DB2 URL
<full-path-JDataStore-db>—DataExpress URL for the native driver
vbroker.naming.
minReconInterval
This property sets the database reconnection retry time by the Naming Service in seconds. The default value is 30. The Naming Service will ignore the request and throw a CannotProceed exception if the time interval between this request and the last reconnection time is less than the vset value. Valid values for this property are non-negative integers. If set to 0, the Naming Service will try to reconnect to the database for every request.
DataExpress Adapter properties
The following table describes the DataExpress Adapter properties:
JNDI adapter properties
The following is an example of settings that can appear in the configuration file for a JNDI adapter:
vbroker.naming.jndiInitialFactory=
com.sun.jndi.ldap.LdapCtxFactory
vbroker.naming.jndiProviderURL=
ldap://<hostname>:389/<initial root context>
VisiNaming Service Security-related properties
 
vbroker.naming.
security.disable
vbroker.naming.
security.authDomain
vbroker.naming.
security.transport
This property indicates what transport to be used. The available values are:
ServerQoPPolicy.SECURE_ONLY=1
ServerQoPPolicy.CLEAR_ONLY=0
ServerQoPPolicy.ALL=3
vbroker.naming.
security.
requireAuthentication
This property indicates whether naming client authentication is required. When vbroker.naming.security.disable is true, no client authentication will be performed regardless what value this property takes.
vbroker.naming.
security.
enableAuthorization
vbroker.naming.
security.
requiredRolesFile
OAD properties
This table lists the OAD properties that can be set.
vbroker.oad.
killOnUnregister
vbroker.oad.
verifyRegistration
This table lists the OAD properties that cannot be overridden in a property file. They can however be overridden with environment variables or from the command line.
Interface Repository properties
This table lists the Interface Repository (IR) properties.
When the vbroker.ir.name property is set to the default value, null, the VisiBroker ORB will try to use this property to locate the IR.
TypeCode properties
The table below lists the VisiBroker for C++ TypeCode properties.
When set to true, this property allows the typecode code to display debugging.
Note: This property is deprecated. See “Debug Logging properties” for recommended properties to use in its place.
vbroker.typecode.
noIndirection
When set to true, this property does not allow the use of indirection when writing a recursive typecode.
vbroker.typecode.
marshalName
vbroker.orb.
topLevelTCIndirection
Top-level typecode indirection optimization was introduced in VisiBroker 7.0. Details of this can be examined as OMG Issue 4796 at http://www.omg.org. You may need to turn this optimization off to guarantee successful communication with applications of an older VisiBroker version, which do not recognize the optimization and may cause a MARSHAL exception.
Client-side LIOP connection properties
The table below lists the VisiBroker for C++ Client-side LIOP Connection properties.
vbroker.ce.liop.ccm.
connectionCacheMax
vbroker.ce.liop.ccm.
disableConnectionCache
When set to true, this property disables connection caching on the client side.
vbroker.ce.liop.
connection.rcvBufSize
vbroker.se.default.local.
listener.doorMaxMsgSize
Client-side IIOP connection properties
The table below lists the VisiBroker for C++ Client-side IIOP Connection properties.
vbroker.ce.iiop.ccm.
connectionCacheMax
vbroker.ce.iiop.ccm.
disableConnectionCache
When set to true, this property disables connection caching on the client side.
vbroker.ce.iiop.ccm.
connectionMaxIdle
Specifies the type of client connection management used by a client. The value Pool means connection pool. This is currently the only valid value for this property.
0 (system-defined port)
A range should be specified using the vbroker.ce.iiop.clientPortRange property when this property is used.
vbroker.ce.iiop.
clientPortRange
vbroker.ce.iiop.
connection.forceLinger
When set to TRUE, the server's sockets are configured to send any data written to them immediately instead of batching the data as the buffer fills.
When set to TRUE, this property allows the server to call back to the client.
Provides a value that identifies the scope identifier or interface number. It is used in conjunction with the IPv6 scoped addresses such as link-local or site-local. The default value is null. This value will be used to formulate into the form “<ipv6 address="">%<ipv6scopeid>” for the getaddrinfo() network function to translate the scope identifier string into a sin6_scope_id integer value of the sockaddr_in6 structure. The IPv6 scoped address is from the IOR host address.
QoS-related Properties
 
vbroker.qos.
defaultRRTTimeout
vbroker.qos.
defaultRRQTimeout
vbroker.orb.qos.
defaultConnectTimeout
Server-side server engine properties
This table lists the server-side server engine properties.
When set to false, disables LIOP connection.
Server-side thread session IIOP_TS/IIOP_TS connection properties
This table lists the server-side thread session IIOP_TS/IIOP_TS connection properties.
One possible value for security would be ssl. See the VisiBroker Security Guide for details.
vbroker.se.iiop_ts.scm.
iiop_ts.manager.type
vbroker.se.iiop_ts.scm.
iiop_ts.manager.
connectionMax
vbroker.se.iiop_ts.scm.
iiop_ts.manager.
connectionMaxIdle
vbroker.se.iiop_ts.scm.
iiop_ts.manager.
garbageCollectTimer
vbroker.se.iiop_ts.scm.
iiop_ts.listener.type
vbroker.se.iiop_ts.scm.
iiop_ts.listener.
preferIPv4Stack
If the property vbroker.se.iiop_ts.host is given an IPv4 or IPv6 address value, then you can ignore the property setting.
Note: On Windows XP platforms, the IPv6 stack does not accept IPv4 traffic. This is a Microsoft implementation limitation. However, Windows Vista and above do not have such a limitation. Enabling the IPv6 stack on Windows XP requires the associated “…preferIPv6Address…” properties to be set accordingly. This property also supersedes the old-style property name vbroker.connection.onlyListenIPv4=<false|true>.
vbroker.se.iiop_ts.scm.
iiop_ts.listener.
preferIPv6Addresses
If the property vbroker.se.iiop_tp.host is given an IPv4 or IPv6 address value, then you can ignore this property setting.
vbroker.se.iiop_ts.scm.
iiop_ts.listener.
preferIPv6AddressType
none provides the first address returned by the getaddrinfo() network function.
linklocal provides the address type of Link-Local.
others returned the first other address except if it is the Link-Local type.
vbroker.se.iiop_ts.scm.
iiop_ts.listener.
ipv6ScopeId
This value will be used to formulate into the form “<ipv6 address>%<ipv6ScopeId>” for the getaddrinfo() network function to translate the scope identifier string into a sin6_scope_id integer value of the sockaddr_in6 structure.
If a link-local address is returned with the value “fe80::1”, then internally the scoped address “fe80::1%eth0” is formulated and passed to getaddrinfo().
Alternatively, you could also set it via "vbroker.se.iiop_ts.host" with the value “fe80::1%eth0”.
vbroker.se.iiop_ts.scm.
iiop_ts.listener.port
Specifies the port number that is used with the host name property. The default value, 0 (zero), means the system will pick a random port number.
vbroker.se.iiop_ts.scm.
iiop_ts.listener.proxyPort
vbroker.se.iiop_ts.scm.
iiop_ts.listener.rcvBufSize
vbroker.se.iiop_ts.scm.
iiop_ts.listener.
sendBufSize
vbroker.se.iiop_ts.scm.
iiop_ts.listener.
socketLinger
vbroker.se.iiop_ts.scm.
iiop_ts.listener.
keepAlive
vbroker.se.iiop_ts.scm.
iiop_ts.listener.
giopVersion
vbroker.se.iiop_ts.scm.
iiop_ts.dispatcher.type
vbroker.se.iiop_ts.scm.
iiop_ts.dispatcher.
threadStackSize
vbroker.se.iiop_ts.scm.
iiop_ts.dispatcher.
coolingTime
vbroker.se.iiop_ts.scm.
iiop_ts.connection.
rcvBufSize
vbroker.se.iiop_ts.scm.
iiop_ts.connection.
sendBufSize
vbroker.se.iiop_ts.scm.
iiop_ts.connection.
socketLinger
vbroker.se.iiop_ts.scm.
iiop_ts.connection.
keepAlive
vbroker.se.iiop_ts.scm.
iiop_ts.connection.
tcpNoDelay
When this property is set to false, this turns on buffering for the socket. The default value, true, turns off buffering, so that all packets are sent as soon as they are ready.
Server-side thread session BOA_TS/BOA_TS connection properties
This protocol has the same set of properties as the “Server-side thread session IIOP_TS/IIOP_TS connection properties”, by replacing alliiop_ts with boa_ts in all the properties. For example, the vbroker.se.iiop_ts.scm.iiop_ts.manager.connectionMax will become vbroker.se.boa_ts.scm.boa_ts.manager.connectionMax. Also, the default value for vbroker.se.boa_ts.scms is boa_ts.
Server-side thread pool IIOP_TP/IIOP_TP connection properties
This table lists the server-side thread pool IIOP_TP/IIOP_TP connection properties.
Specifies the host name that can be used by this server engine. The default value, null, means use the host name from the system. Host names or IP addresses are acceptable values.
Specifies the proxy host name that can be used by this server engine. The default value, null, means use the host name from the system. Host names or IP addresses are acceptable values.
One possible value for security would be ssl. See the VisiBroker Security Guide for details.
vbroker.se.iiop_tp.scm.
iiop_tp.manager.type
vbroker.se.iiop_tp.scm.
iiop_tp.manager.
connectionMax
vbroker.se.iiop_tp.scm.
iiop_tp.manager.
connectionMaxIdle
vbroker.se.iiop_tp.scm.
iiop_tp.listener.type
vbroker.se.iiop_tp.scm.
iiop_tp.listener.
preferIPv4Stack
If the property "vbroker.se.iiop_tp.host" is given an IPv4 or IPv6 address value, then you can ignore the property setting.
Note: On Windows XP platforms, the IPv6 stack does not accept IPv4 traffic. This is a Microsoft implementation limitation. However, Windows Vista and above do not have such a limitation. Enabling the IPv6 stack on Windows XP requires the associated “…preferIPv6Address…” properties to be set accordingly. This property also supersedes the old-style property name vbroker.connection.onlyListenIPv4=<false|true>.
vbroker.se.iiop_tp.scm.
iiop_tp.listener.
preferIPv6Addresses
If the property vbroker.se.iiop_tp.host is given an IPv4 or IPv6 address value, then you can ignore this property setting.
vbroker.se.iiop_tp.scm.
iiop_tp.listener.
preferIPv6AddressType
none provides the first address returned by the getaddrinfo() network function.
linklocal provides the address type of Link-Local.
others returned the first other address except if it is the Link-Local type.
vbroker.se.iiop_tp.scm.
iiop_tp.listener.
ipv6ScopeId
This value will be used to formulate into the form “<ipv6 address>%<ipv6ScopeId>” for the getaddrinfo() network function to translate the scope identifier string into a sin6_scope_id integer value of the sockaddr_in6 structure.
If a link-local address is returned with the value “fe80::1”, then internally the scoped address “fe80::1%eth0” is formulated and passed to getaddrinfo().
Alternatively, you could also set it via "vbroker.se.iiop_tp.host" with the value “fe80::1%eth0”.
vbroker.se.iiop_tp.scm.
iiop_tp.listener.port
Specifies the port number used with the host name property. The default value, 0 (zero), means that the system will pick a random port number.
vbroker.se.iiop_tp.scm.
iiop_tp.listener.portRange
This property is effective only when listener.port is greater than 0 (zero). If the listener cannot bind to that port because the port may be in use then the listener will try to bind to the ports in the range [port, port+portRange]. If no ports in the range are available then a COMM_FAILURE exception will be thrown.
vbroker.se.iiop_tp.scm.
iiop_tp.listener.proxyPort
Specifies the proxy port number used with the proxy host name property. The default value, 0 (zero), means that the system will pick a random port number.
vbroker.se.iiop_tp.scm.
iiop_tp.listener.rcvBufSize
vbroker.se.iiop_tp.scm.
iiop_tp.listener.
sendBufSize
vbroker.se.iiop_tp.scm.
iiop_tp.listener.
socketLinger
vbroker.se.iiop_tp.scm.
iiop_tp.listener.keepAlive
vbroker.se.iiop_tp.scm.
iiop_tp.listener.
giopVersion
vbroker.se.iiop_tp.scm.
iiop_tp.dispatcher.type
vbroker.se.iiop_tp.scm.
iiop_tp.dispatcher.
threadMin
vbroker.se.iiop_tp.scm.
iiop_tp.dispatcher.
threadMax
Setting the property vbroker.se.iiop_tp.scm.iiop_tp.dispatcher.unlimitedConcurrency=true implies that setting this property to 0 enables and unlimited number of threads in the thread pool to be created.
vbroker.se.iiop_tp.scm.
iiop_tp.dispatcher.
threadMaxIdle
vbroker.se.iiop_tp.scm.
iiop_tp.dispatcher.
threadStackSize
vbroker.se.iiop_tp.scm.
iiop_tp.dispatcher.
coolingTime
vbroker.se.iiop_tp.scm.
iiop_tp.connection.
rcvBufSize
vbroker.se.iiop_tp.scm.
iiop_tp.connection.
sendBufSize
vbroker.se.iiop_tp.scm.
iiop_tp.connection.
socketLinger
vbroker.se.iiop_tp.scm.
iiop_tp.connection.
keepAlive
vbroker.se.iiop_tp.scm.
iiop_tp.connection.
tcpNoDelay
When this property is set to false, this turns on buffering for the socket. The default value, true, turns off buffering, so that all packets are sent as soon as they are ready.
vbroker.iiop_tp.scm.
iiop_tp.dispatcher.
unlimitedConcurrency
Setting this property to true allows the thread pool dispatcher to create an unlimited number of threads when the property vbroker.se.xxx.scm.yyy.dispatcher.threadMax is set to 0. By default, the ORB will utilize internal heuristics calculation to determine the need of creating new threads.
Server-side thread pool BOA_TP/BOA_TP connection properties
This protocol has the same set of properties as the “Server-side thread pool IIOP_TP/IIOP_TP connection properties”, but replacing all iiop_tp with boa_tp in all the properties. For example, vbroker.se.iiop_tp.scm.iiop_tp.manager.connectionMax becomes vbroker.se.boa_tp.scm.boa_tp.manager.connectionMax. Also, the default value for vbroker.se.boa_tp.scms is boa_tp.
Server-side thread pool LIOP_TP/LIOP_TP connection properties
This table lists the server-side thread pool LIOP_TP/LIOP_TP connection properties.
Specifies the host name that can be used by this server engine. The default value, null, means use the host name from the system. Host names or IP addresses are acceptable values.
Specifies the proxy host name that can be used by this server engine. The default value, null, means use the host name from the system. Host names or IP addresses are acceptable values.
vbroker.se.liop_tp.scm.
liop_tp.manager.type
vbroker.se.liop_tp.scm.
liop_tp.manager.
connectionMax
vbroker.se.liop_tp.scm.
liop_tp.manager.
connectionMaxIdle
vbroker.se.liop_tp.scm.
liop_tp.manager.
garbageCollectTimer
vbroker.se.liop_tp.scm.
liop_tp.listener.type
vbroker.se.liop_tp.scm.
liop_tp.listener.port
Specifies the port number used with the host name property. The default value, 0 (zero), means that the system will pick a random port number.
vbroker.se.liop_tp.scm.
liop_tp.listener.proxyPort
Specifies the proxy port number used with the proxy host name property. The default value, 0 (zero), means that the system will pick a random port number.
Specifies whether shared memory will be used for the Client and Server to communicate when running on the same machine. When set to true, shared memory is used for the LIOP. When set to false, the LIOP uses a UNIX Domain Socket for IPC.
vbroker.se.liop_tp.scm.
liop_tp.listener.shmSize
vbroker.se.liop_tp.scm.
liop_tp.listener.
userConstrained
When set to true, the file is hidden in a directory accessible only by the owner.
vbroker.se.liop_tp.scm.
liop_tp.listener.
giopVersion
vbroker.se.liop_tp.scm.
liop_tp.listener.
allowedGroups
vbroker.se.liop_tp.scm.
liop_tp.dispatcher.type
vbroker.se.liop_tp.scm.
liop_tp.dispatcher.
threadMin
vbroker.se.liop_tp.scm.
liop_tp.dispatcher.
threadMax
vbroker.se.liop_tp.scm.
liop_tp.dispatcher.
threadMaxIdle
vbroker.se.liop_tp.scm.
liop_tp.dispatcher.
threadStackSize
vbroker.se.liop_tp.scm.
liop_tp.dispatcher.
coolingTime
vbroker.se.liop_tm.scm.
liop_tm.manager.enabled
Set this to false if you are using a Main Thread model with LIOP on a Windows system, to ensure that a request is serviced in that environment.
Server-side thread pool BOA_LTP/BOA_LTP connection properties
This protocol has the same set of properties as the thread pool liop_tp/liop_tp connection properties, but replacing all liop_tp with boa_ltp in all the properties. For example, vbroker.se.liop_tp.scm.liop_tp.manager.connectionMax becomes vbroker.se.boa_ltp.scm.boa_ltp.manager.connectionMax. Also, the default value for vbroker.se.boa_ltp.scms is boa_ltp.
Properties that support bi-directional communication
This table lists the properties that support bidirectional communication. These properties are evaluated only once—when the SCMs are created. In all cases, the exportBiDir and importBiDir properties on the SCMs are given priority over the enableBiDir property. In other words, if both properties are set to conflicting values, the SCM-specific properties will take effect. This allows you to set the enableBiDir property globally and specifically turn off bidirectionality in individual SCMs.
You can selectively make bidirectional connections. If the client defines vbroker.orb.enableBiDir=client and the server defines vbroker.orb.enableBiDir=server the value of vbroker.orb.enableBiDir at the GateKeeper determines the state of the connection. Values of this property are: server, client, both or none.
vbroker.se.<se>.scm.<scm>.
manager.exportBiDir
A client-side property. Setting it to true enables creation of a bidirectional callback POA on the specified server engine. Setting it to false disables creation of a bidirectional POA on the specified server engine.
vbroker.se.<se>.scm.<scm>.
manager.importBiDir
A server-side property. Setting it to true allows the server-side to reuse the connection already established by the client for sending requests to the client. Setting it to false prevents reuse of connections in this fashion.
Debug Logging properties
This section details the properties that can be used to control and configure the output of debug log statements.
The debug log statements are categorized according to the areas of the ORB from where they are logged. These categories are called source names. Currently the following source names are logged:
connection – logs from the connection related source areas such as client side connection, server side connection, connection pool etc.
client – logs from client side invocation path
agent – logs for Osagent communication
cdr – logs for GIOP areas
se – logs from the server engine, such as dispatcher, listener etc.
server – logs from server side invocation path.
orb – log outputs from the ORB.
For VisiNotify, the following source names are logged:
v_vntfy - logs from the process.
v_vnchnl - logs from the channel object.
v_vn_pxsup - logs from proxy supplier objects.
v_vnper - logs from persistency module.
v_vndb - logs from low level circular file based db layer
v_vnlogdiscard - Details of any events that are discarded
For VisiTelcoLog, the following source names are logged:
v_vtlog - logs from the process.
v_vtlper - logs from the log persistence layer.
v_vndb - logs from low level circular file based db layer.
For VisiTransact, the following source names are logged:
v_ots_txncontext - logs from transaction factory, control and coordinator.
v_ots_interceptor - logs from client and server interceptors and transaction current related operations.
v_ots_completion - logs related to transaction completion.
v_ots_pc - logs related to resource and synchronization objects registered.
For VisiSecure C++, the following source names are logged:
v_secauthn - logs from authentication related code (login module, callback handler, identity services and alike).
v_secauthz - logs from authorization related code (Authorization provider, Authorization domain, role map and alike).
v_secssl - logs from SSL transport related code (SecureSocketProvider, CertificateFactory and alike).
v_seccsiv2 - logs from CSIV2 service context protocol related code (Security context management code and alike).
v_secmisc - logs from the rest of code.
Enabling and Filtering
The following table describes the properties used to enable logging and filtering.
When set to true, all logging statements will be produced unless it is being filtered.
Values are true or false.
emerg - indicates some panic condition.
alert - a condition that requires user attention--for example, if security has been disabled.
crit - critical conditions, such as a device error.
err - error conditions.
warning - warning conditions--these may accompany some troubleshooting advice. on the opening of a connection.
info - informational, such as binding in progress.
debug - debug conditions understood by developers.
Values are client, server, connection, cdr, se, agent and orb. Multiple values can be provided as a comma separated string.
Note: The source names have to be registered using this property before they can be explicitly controlled using the vbroker.log.filter.default.<source-name>.enable and vbroker.log.filter.default.<source-name>.logLevel properties.
vbroker.log.default.filter.
<source-name>.enable
Values are true or false.
vbroker.log.default.filter.
<source-name>.logLevel
vbroker.log.
enableSigHandler
When set to true, installs a signal handler based on SIGUSR2 to allow toggling of logging at runtime. Values are true or false.
Note: This applies only to UNIX platforms.
Appending and Logging
The output of the logs can be appended (forwarded) to either the Console or a rolling local file system file (or both), either in a simple layout or in a more complicated Log4J XML event layout (format). By default the logs are appended to the Console in a simple layout. The names of the various appenders and layouts supported are:
stdout – Name of the Console appender.
rolling – Name of the rolling file appender.
simple – Name of a simple predefined output layout.
xml – Name of Log4J XML event layout.
full – Name of a full record fields printout layout.
The following table describes the properties used to configure the destination of the log output and its format.
vbroker.log.default.
appender.
<appender-inst-name>.
appenderType
vbroker.log.default.
appender.
<appender-inst-name>.
layoutType
Values are simple or xml or a custom layout type.
vbroker.log.default.
appender.
<appender-inst-name>.async
When set to true, the appender will log events asynchronously. This feature is mainly designed to improve logging performance of FileAppender.
Configurations
For the built-in rolling appender type, you can create the following configurations. The properties are described below, assuming that for each appender instance, the appender type is specified as “rolling”.
vbroker.log.default.
appender.
<appender-inst-name>.logDir
vbroker.log.default.
appender.
<appender-inst-name>.
fileName
vbroker.log.default.
appender.
<appender-inst-name>.
maxFileSize
vbroker.log.default.
appender.
<appender-inst-name>.
maxBackupIndex
vbroker.log.default.
appender.
<appender-inst-name>.async
Asynchronous logging mechanism, When set to false, the appender outputs the message with synchronous manner.
The following properties can be used to define custom appender and layout types.
vbroker.log.appender.
<appender-type-name>.
sharedLib
vbroker.log.appender.
<layout-type-name>.
sharedLib
Examples
The following examples explain some of the debug logging properties' usage scenarios. In the example commands, vbapp is a VisiBroker for C++ application.
1
prompt> vbapp –Dvbroker.log.enable=true
2
prompt> vbapp –Dvbroker.log.enable=true –Dvbroker.log.logLevel=info
3
prompt> vbapp –Dvbroker.log.enable=true \
–Dvbroker.log.default.filter.register=agent \
–Dvbroker.log.default.filter.agent.enable=false
4
prompt> vbapp –Dvbroker.log.enable=true \
-Dvbroker.log.default.filter.enable=false \
–Dvbroker.log.default.filter.register=client,connection
5
prompt> vbapp –Dvbroker.log.enable=true \
-Dvbroker.log.logLevel=info \
–Dvbroker.log.default.filter.register=se,cdr \
–Dvbroker.log.default.filter.se.logLevel=emerg \
–Dvbroker.log.default.filter.cdr.logLevel=err
6
prompt> vbapp –Dvbroker.log.default.appenders=rolling \
-Dvbroker.log.default.appender.rolling.logDir=/opt/vbc \
-Dvbroker.log.default.appender.rolling.fileName=vbc.log \
-Dvbroker.log.default.appender.rolling.maxBackupIndex=3