VisiBroker properties

This section describes the BES VisiBroker properties.

Note: The properties in this section can be used with the current version of the VisiBroker.

Important: For documentation updates, go to www.borland.com/techpubs/bes.

Smart Agent and Smart Agent communication properties

Smart Agent properties

Property Default Old property Description
vbroker.agent.addrFile null ORBagentAddrFile Specifies a file that stores information on where the IP addresses or host names Smart Agent maybe found.
vbroker.agent.localFile null N/A Specifies which network interface to use on multi-home machines. This used to be the OSAGENT_LOCAL_FILE environment variable.
vbroker.agent.clientHandlerPort null N/A Specifies the port that the Smart Agent uses to verify the existence of a client—in this case a VisiBroker application. The default value null means that the Smart Agent picks a random port number.
vbroker.agent.port 14000 ORBagentPort Specifies the port number that defines a domain within your network. VisiBroker applications and the Smart Agent work together when they have the same port number. This is the same property as the OSAGENT_PORT environment variable.

These properties are used by the ORB for Smart Agent communication.

Property Default Old property Description
vbroker.agent.keepAliveTimer 120 N/A The duration in seconds during which the ORB will send keep-alive messages to the Smart Agent (applicable to both clients and servers). Valid values are integers between 1 and 120 inclusive.
vbroker.agent.retryDelay 0 (zero) N/A The duration in seconds to pause before trying to reconnect to 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.
vbroker.agent.addr null ORBagentAddr 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.
vbroker.agent.addrFile null ORBagentAddrFile Specifies a file that stores information on where the IP addresses or host names Smart Agent maybe found.
vbroker.agent.debug false ORBdebug When set to true, specifies that the system will display debugging information about communication of VisiBroker applications with the Smart Agent.
vbroker.agent.enableLocator true ORBdisableLocator When set to false, does not allow VisiBroker applications to communicate with the Smart Agent.
vbroker.agent.port 14000 ORBagentPort Specifies the port number that defines a domain within your network. VisiBroker applications and the Smart Agent work together when they have the same port number. This is the same property as the OSAGENT_PORT environment variable.
vbroker.agent.failOver true ORBagentNoFailOver When set to true, allows a VisiBroker application to fail over to another Smart Agent.
vborker.agent.clientPort 0 (zero) N/A Specifies the starting port number to bind to for the dsuser socket.
vbroker.agent.clientPortRange 0 (zero) N/A Specifies the range of port numbers to try to bind to for the dsuser socket. This property should be used in conjunction with vbroker.agent.clientPort property.

VisiBroker ORB properties

This table lists the VisiBroker ORB properties.

VisiBroker ORB properties

Property Default Description
vbroker.orb.cacheDSQuery true When set to true, allows VisiBroker applications to cache IOR.
vbroker.orb.rebindForward 0 (zero) This property controls the number of times a client would try to connect to a forwarded target. It is useful when the client cannot communicate with forwarded target (because of network failure, for example). The default value of 0 (zero) means that client will keep on trying.
vbroker.orb.activationIOR null Allows the launched server to easily establish contact with the OAD that launched it.
vbroker.orb.oadUID 0 (zero) Used to ensure that the OAD that launched the server still exists - a value of 1.
vbroker.orb.propStorage null Specifies a property file that contains property values.
vbroker.orb.backCompat FALSE When set to TRUE, the server is operating in backward compatibility mode.
vbroker.orb.nullstring FALSE 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.admDir null Specifies the administration directory at which various system files are located. This property can be set using the VBROKER_ADM environment variable.
vbroker.orb.isNTService FALSE When set to TRUE, this property coupled with the compile flag WIN32, enables any NT service/ COM+ app to stay running when a user logs out.
vbroker.orb.enableServerManager FALSE When set to TRUE, this property enables Server Manager within a server so that clients can access to it.
vbroker.orb.input.maxBuffers 16 Specifies the maximum number of input buffers retained in a pool.
vbroker.orb.input.buffSize 255 Specifies the size of the input buffer.
vbroker.orb.output.maxBuffers 16 Specifies the maximum number of output buffers retained in a pool.
vbroker.orb.output.buffSize 255 Specifies the size of the output buffer.
vbroker.orb.initRef null Specifies the initial reference.
vbroker.orb.defaultInitRef null Specifies the default initial reference.
vbroker.orb.boa_map.TSingle boa_s Maps the BOA bid policy of single threaded to boa_s.
vbroker.orb.boa_map.TPool boa_tp Maps the BOA bid policy of thread pool to boa_tp.
vbroker.orb.boa_map.TSession boa_ts Maps the BOA bid policy of thread session to boa_ts.
vbroker.orb.boa_map.TPool_LIOP boa_ltp Maps the BOA bid policy of local thread pool to boa_ltp.
vbroker.orb.alwaysProxy false When set to true, specifies that clients must always connect to the server using the GateKeeper.
vbroker.orb.gatekeeper.ior null Forces the client application to always connect to server through the GateKeeper whose IOR is provided.
vbroker.locator.ior null 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 false Forces the server application to include firewall information as part of any servant's IOR which this server exposes (use Firewall::FirewallPolicy in your code to force it selectively per POA).
vbroker.orb.proxyPassthru false 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).
vbroker.orb.bids.critical inprocess The critical bid has highest precedence no matter where it is specified in the bid order. If there are multiple values for critical bids, then their relative importance is decided by the bidOrder property.
vbroker.orb.bidOrder inprocess:liop:ssl:iiop:proxy:hiop:locator You can specify the relative order of importance for the various transports. Transports are given precedence as follows:
  1. inprocess
  2. liop
  3. ssl
  4. iiop
  5. proxy
  6. hiop
  7. locator

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.)
vbroker.orb.dynamicLibs null Specifies a list of available services used by the VisiBroker ORB separated by commas.
vbroker.orb.embedCodeset true 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 false This property enables work-arounds to deal with behavior that is not GIOP 1.2-compliant in VisiBroker 4.0 and 4.1. Any VisiBroker client running on VisiBroker 4.1.1 or a release previous to 4.1.1 is affected, especially if GateKeeper is involved. To work with a Visibroker 4.0 or 4.1 client, this flag needs to be set to true. This is a server-side only flag and does not require to be set on the client-side.
vbroker.orb.procId 0 Specifies the process ID of the server.

ServerManager properties

This table lists the Server Manager properties.

ServerManager properties

Property Default Description
vbroker.serverManager.name null Specifies the name of the Server Manager.
vbroker.serverManager.enableOperations true When set to true, enables operations exposed, by the Server Manager, to be invoked.
vbroker.serverManager.enableSetProperty true When set to true, enables properties, exposed by the Server Manager, to be changed.

Additional Properties

The following section describes the new properties supported by the Server Manager. These properties can be queried through their containers.

Properties related to Server-side resource usage

Property Description
vbroker.se.<SE_name>.scm.<SCM_name>.manager.allocatedFileDescriptors The current number of file descriptors used by the Server Connection Manager (SCM). This value is typically equal to the current number of incoming connections plus two used by the listener.
vbroker.se.<SE_name>.scm.<SCM_name>.manager.maxFileDescriptor The maximum value of the file descriptor with the SCM.
vbroker.se.<SE_name>.scm.<SCM_name>.manager.inUseConnections The number of incoming connections for which there are requests executing in the ORB.
vbroker.se.<SE_name>.scm.<SCM_name>.manager.idleConnections The number of incoming connections for which there are not any requests currently being executed in the ORB.
vbroker.se.<SE_name>.scm.<SCM_name>.manager.idledTimeoutConnections The number of idle connections which have also idled past their idle timeout setting but have yet to be closed (due to garbage collection restrictions, for example).
vbroker.se.<SE_name>.scm.<SCM_name>.dispatcher.inUseThreads The number of threads currently executing requests within the dispatcher.
vbroker.se.<SE_name>.scm.<SCM_name>.dispatcher.idleThreads The number of threads which are currently idle waiting for work to be assigned.

Properties related to Client-side resource usage

Property Description
vbroker.ce.<CE_name>.ccm.maxFileDescriptor The maximum number of file descriptors within the Client Connection Manager (CCM).
vbroker.ce.<CE_name>.ccm.activeConnections The number of connections in the active pool; that is, object references are using these connections.
vbroker.ce.<CE_name>.ccm.cachedConnections The number of connections in the cache pool; no object references are using these connections.
vbroker.ce.<CE_name>.ccm.inUseConnections The number of outgoing connections with pending requests.
vbroker.ce.<CE_name>.ccm.idleConnections The number of outgoing connections with no pending requests.
vbroker.ce.<CE_name>.ccm.idledTimeoutConnections The number of idle connections which have idled past their timeout setting but have not been closed.

Properties related to the Smart Agent (Smart Agent)

Property Description
vbroker.agent.currentAgentIP The IP address of the current ORB's Smart Agent (Smart Agent).
vbroker.agent.currentAgentClientPort The port of the Smart Agent to which the ORB is sending requests.

Miscellaneous Properties

Property Description
vbroker.env.path The value of the PATH environment variable under which the ORB is running.
vbroker.env.shlibPath The value of the shared library path environment variable. In HP-UX, it corresponds to the SHLIB_PATH environment variable.
vbroker.env.orbVersion This is the ORB version of the currently loaded ORB. It can also be obtained by running vbver liborb_r.sl in HP-UX.
vbroker.process.fileDescriptorLimit The maximum number of file descriptors for the current process.
vbroker.orb.uid The user ID of the user who started the VisiBroker server application.
vbroker.orb.commandLine The command-line argument passed to the CORBA::ORB_init method.

Location Service properties

This table lists the Location Service properties.

Property Default Description
vbroker.locationservice.debug false When set to true, allows the Location Service to display debugging information.
vbroker.locationservice.verify false 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.
vbroker.locationservice.timeout 1 Specifies the connect/receive/send timeout, in seconds, when trying to interact with the Location Service.

Event Service properties

This table lists the Event Service properties.

Property Default Description
vbroker.events.maxQueueLength 100 Specifies the number of messages to be queued for slow consumers.
vbroker.events.factory false When set to true, allows the event channel factory to be instantiated, instead of an event channel.
vbroker.events.debug false When set to true, allows output of debugging information.
vbroker.events.interactive false 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.

Core VisiNaming Service properties

Property Default Description
vbroker.naming.adminPwd inprise Password required by administrative VisiBroker naming service operations.
vbroker.naming.enableSlave 0 If 1, enables master/slave naming services configuration. See the Failover section for information about configuring master/slave naming services.
vbroker.naming.iorFile ns.ior 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.
vbroker.naming.logLevel emerg This property specifies the level of log messages to be output from naming service. Acceptable values are:
  • emerg (0): indicates some panic condition.
  • alert (1): a condition that requires user attention--for example, if security has been disabled.
  • crit (2): critical conditions, such as a device error.
  • err (3): error conditions.
  • warning (4): warning conditions--these may accompany some troubleshooting advice.
  • notice (5): conditions that are not errors but may require some attention, such as upon the opening of a connection.
  • info (6): informational, such as binding in progress.
  • debug (7): debug conditions understood by developers.
vbroker.naming.logUpdate false 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): 

00000007,5/26/04 10:11 AM,127.0.0.1,00000000,

VBJ-Application,VBJ ThreadPool Worker,INFO,



OPERATION NAME : bind

CLIENT END POINT : Connection[socket=Socket

[addr=/127.0.0.1, port=2026, localport=1993]]

PARAMETER 0 : [(Tom.LoanAccount)]

PARAMETER 1 : Stub[repository_id=IDL:Bank/

LoanAccount:1.0, key=TransientId[poaName=/,

id={4 bytes: (0)(0)(0)(0)},sec=505,usec=990917734, 

key_string=%00VB%01%00%00%00%02/%00%20%20%00%00%00%

04%00%00%00%00%00%00%01%f9;%104f],codebase=null]

Object Clustering Related properties

For more information see the Object Clusters section.

Property Default Description
vbroker.naming.enableClusterFailover true 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.
vbroker.naming.propBindOn 0 If 1, the implicit clustering feature is turned on.
vbroker.naming.smrr.pruneStaleRef 1 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 the VisiNaming Service Clusters section.

Property Default Description
vbroker.naming.enableSlave 0 See the Core VisiNaming Service properties section.
vbroker.naming.slaveMode No default. Can be set to cluster or slave. 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 null This property specifies the name of a VisiNaming Service cluster. Multiple VisiNaming Service instances belong to a particular cluster (for example, clusterXYZ) when they are configured with the cluster name using this property.
vbroker.naming.serverNames null This property specifies the factory names of the VisiNaming Service instances that belong to a cluster. Each VisiNaming Service instance within the cluster should be configured using this property to be aware of all the instances that constitute the cluster. Each name in the list must be unique. This property supports the format: 
vbroker.naming.serverNames=

Server1:Server2:Server3
See the related property, vbroker.naming.serverAddresses.
vbroker.naming.serverAddresses null 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.serverAddresses=host1:

port1;host2:port2;host3:port3
vbroker.naming.anyServiceOrder (To be set on VisiNaming Service clients) false 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: 
client -DVbroker.naming.anyServiceOrder=true

Pluggable Backing Store Properties

The following tables show property information for the VisiNaming service pluggable backing store types.

Default properties common to all adapters

Property Default Description
vbroker.naming.backingStoreType InMemory Specifies the naming service adapter type to use. This property specifies which type of backing store you want the VisiNaming Service to use. The valid options are: InMemory, JDBC, Dx, JNDI. The default is InMemory.
vbroker.naming.cacheOn 0 Specifies whether to use the Naming Service cache. A value of 1 (one) enables caching.
vbroker.naming.cache.connectString N/A 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: 
vbroker.naming.cache.connectString=127.0.0.1:14500
See Caching facility for details about enabling the caching facility and setting the appropriate properties.
vbroker.naming.cache.size 2000 This property specifies the size of the Naming Service cache. Higher values will mean caching of more data at the cost of increased memory consumption.
vbroker.naming.cache.timeout 0 (no limit) This property specifies the time, in seconds, since the last time a piece of data was accessed, after which the data in the cache will be purged in order to free memory. The cached entries are deleted in LRU (Least Recently Used) order.

JDBC Adapter properties

Property Default Description
vbroker.naming.jdbcDriver com.borland.datastore.jdbc.DataStoreDriver This property specifies the JDBC driver that is needed to access the database used as your backing store. The VisiNaming Service loads the appropriate JDBC driver specified. Valid values are:
  • com.borland.datastore.jdbc.DataStoreDriver—JDataStore driver
  • com.sybase.jdbc.SybDriver—Sybase driver
  • oracle.jdbc.driver.OracleDriver—Oracle driver
  • interbase.interclient.Driver—Interbase driver
  • weblogic.jdbc.mssqlserver4.Driver—WebLogic MS SQLServer Driver
  • COM.ibm.db2.jdbc.app.DB2Driver—IBM DB2 Driver
vbroker.naming.loginName VisiNaming The login name associated with the database.
vbroker.naming.loginPwd VisiNaming The login password associated with the database.
vbroker.naming.poolSize 5 This property specifies the number of database connections in your connection pool when using the JDBC Adapter as your backing store.
vbroker.naming.url jdbc:borland:dslocal:rootDB.jds This property specifies the location of the database which you want the Naming Service to access. The setting is dependent upon the database in use. Acceptable values are:
  • jdbc:borland:dslocal:<db-name>—JDataStore UTL
  • jdbc:sybase:Tds:<host-name>:<port-number>/<db-name>—Sybase URL
  • jdbc:oracle:thin@<host-name>:<port-number>:<sid>—Oracle URL
  • jdbc:interbase://<server-name>/<full-db-path>—Interbase URL
  • jdbc:weblogic:mssqlserver4:<db-name>@<host-name>:<port-number>—WebLogic MS SQLSever URL
  • jdbc:db2:<db-name>—IBM DB2 URL
  • <full-path-JDataStore-db>—DataExpress URL for the native driver
vbroker.naming.minReconInterval 30 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:

Property Description
vbroker.naming.backingStoreType This property should be set to Dx.
vbroker.naming.loginName This property is the login name associated with the database. The default is VisiNaming.
vbroker.naming.loginPwd This property is the login password associated with the database. The default value is VisiNaming.
vbroker.naming.url This property specifies the location of the database.

JNDI adapter properties

The following is an example of settings that can appear in the configuration file for a JNDI adapter:

Setting Description
vbroker.naming.backingStoreType=JNDI This setting specifies the backing store type which is JNDI for the JNDI adapter.
vbroker.naming.loginName=<user_name> The user login name on the JNDI backing server.
vbroker.naming.loginPwd=<password> The password for the JNDI backing server user.
vbroker.naming.jndiInitialFactory=com.sun.jndi.ldap.LdapCtxFactory This setting specifies the JNDI initial factory.
vbroker.naming.jndiProviderURL=ldap://<hostname>:389/<initial root context> This setting specifies the JNDI provider URL
vbroker.naming.jndiAuthentication=simple This setting specifies the JNDI authentication type supported by the JNDI backing server.

VisiNaming Service Security-related properties

Property Value Default Description
vbroker.naming.security.disable boolean true This property indicates whether the security service is disabled.
vbroker.naming.security.authDomain string "" This property indicates the authorization domain name to be used for the naming service method access authorization.
vbroker.naming.security.transport int 3 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 boolean false 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 boolean false This property indicates whether method access authorization is enabled.
vbroker.naming.security.requiredRolesFile string null This property points to the file containing the required roles that are necessary for invocation of each method in the protected object types. For more information see the Method Level Authorization section.

OAD properties

This table lists the OAD properties that can be set.

Property Default Description
vbroker.oad.spawnTimeOut 20 After the OAD spawns an executable, specifies how long, in seconds, the system will wait to receive a callback from the desired object before throwing a NO_RESPONSE exception.
vbroker.oad.verbose false Allows the OAD to print detailed information about its operations.
vbroker.oad.readOnly false When set to true, does not allow you to register, unregister, or change the OAD implementation.
vbroker.oad.iorFile Oadj.ior Specifies the filename for the OAD's stringified IOR.
vbroker.oad.quoteSpaces false Specifies whether to quote a command.
vbroker.oad.killOnUnregister false Specifies whether to kill spawned servers once they are unregistered.
vbroker.oad.verifyRegistration false Specifies whether to verify the object registration.

This table list the OAD properties that cannot be overridden in a property file. They can however be overridden with environment variables or from the command line.

Property Default Description
vbroker.oad.implName impl_rep Specifies the filename for the implementation repository.
vbroker.oad.implPath null Specifies the directory where the implementation repository is stored.
vbroker.oad.path null Specifies the directory for the OAD.
vbroker.oad.systemRoot null Specifies the root directory.
vbroker.oad.windir null Specifies the Windows directory.

Interface Repository properties

This table lists the Interface Repository (IR) properties.

Property Default Description
vbroker.ir.debug false When set to true, allows the IR resolver to display debugging information.
vbroker.ir.ior null 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.
vbroker.ir.name null Specifies the name that is used by the VisiBroker ORB to locate the IR.

TypeCode properties

The table below lists the VisiBroker Edition for C++ TypeCode properties.

TypeCode properties

Property Default Description
vbroker.typecode.debug FALSE When set to TRUE, this property allows the typecode code to display debugging.
vbroker.typecode.noIndirection FALSE When set to TRUE, this property does not allow the use of indirection when writing a recursive typecode.

Client-Side LIOP Connection properties

The table below lists the VisiBroker for C++ client-side LIOP connection properties.

Client-side LIOP connection properties

Property Default Description
vbroker.ce.liop.ccm.connectionCacheMax 5 Specifies the maximum number of cached connections on a client. The connection is cached when a client releases it. So, the next time a client needs a new connection, it can first try to collect an available one from the cache instead of creating a new one.
vbroker.ce.liop.ccm.disableConnectionCache false Setting to true disables connection caching on the client side.
vbroker.ce.liop.ccm.connectionMax 0 Specifies the maximum number of total connections within a client. This is equal to active connections plus the ones that are cached. The default value of 0 (zero) means that the client does not try to close any of the old active or cached connections.
vbroker.ce.liop.ccm.connectionMaxIdle 360 Specifies the time in seconds that the client uses to determine if a cached connection should be closed. If a cached connection has been idle longer than this time, then the client will close it.
vbroker.ce.liop.ccm.type Pool Specifies what type of client connection management is used by a client. The default value Pool means connection pool.
vbroker.ce.liop.connection.rcvBufSize 0 Specifies the size of the receive socket buffer. The default value 0 (zero) implies system dependent value.
vbroker.ce.liop.connection.sendBufSize 0 Specifies the size of the send socket buffer. The default value 0 (zero) implies system dependent value.
vbroker.ce.liop.connection.shmSize 4096 Specifies the size in bytes in shared memory. If your client program and object implementation communicate via shared memory, you may use this option to enhance performance.
vbroker.se.default.local.listener.doorMaxMsgSize 1,000,000 Specifies the maximum message size which will be sent through the fast IPC (door) mechanism in Solaris (when the client and server are running on the same machine). If the message size is greater than the default value (1,000,000), it will not be sent using door IPC and will default to the next available mechanism (Unix domain socket or TCP/IP socket).

Client-side IIOP connection properties

The table below lists the VisiBroker for C++ Client-side IIOP Connection properties.

Client-side IIOP connection properties

Property Default Description
vbroker.ce.iiop.ccm.connectionCacheMax 5 Specifies the maximum number of cached connections on a client. The connection is cached when a client releases it. So, the next time a client needs a new connection, it firt tries to collect an available one from th cache instead of just creating a new one.
vbroker.ce.iiop.ccm.disableConnectionCache false If you set this to true, it disables connection caching on the client side.
vbroker.ce.iiop.ccm.connectionMax 0 Specifies the maximum number of the total connections within a client. This is equal to active connections plus the ones that are cached. The default value of zero means that the client does not try to close any of the old active or cached connections.
vbroker.ce.iiop.ccm.connectionMaxIdle 0 Specifies the time in seconds that the client uses to determine if a cached connection should be closed. If a cached connection has been idle longer than this time, then the client closes it.
vbroker.ce.iiop.ccm.type Pool 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.
vbroker.ce.iiop.connection.rcvBufSize 0 Specifies the size of the receive socket buffer. The default value 0 (zero) implies system dependent value.
vbroker.ce.iiop.connection.sendBufSize 0 Specifies the size of the send socket buffer. The default value 0 (zero) implies system dependent value.
vbroker.ce.iiop.connection.tcpNoDelay FALSE 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.
vbroker.ce.iiop.host none Binds the client side sockets to desired interface. If value is null, wild-card interface is taken.
vbroker.ce.iiop.connection.noCallback FALSE When set to TRUE, this property allows the server to call back to the client.
vbroker.ce.iiop.connection.socketLinger 0 A TCP/IP setting.
vbroker.ce.iiop.connection.keepAlive TRUE A TCP/IP setting.

QoS-related Properties

Property Default Description
vbroker.qos.cache True Specifies if QoS policies should be cached per delegate instead of being checked prior to every request made by the client.

Client-side in-process connection properties

This table lists the Client-side in-process connection properties.

Property Default Description
vbroker.ce.inprocess.ccm.bid 9488 Specifies the bid value for the POA bidder. It affects an automatic process in the VisiBroker ORB used in picking a protocol to handle client connections.
vbroker.ce.iiop.ccm.bid 10000 Specifies the bid value for the iiop bidder. It affects an automatic process in the VisiBroker ORB used in picking a protocol to handle client connections.

Server-side server engine properties

This table lists the server-side server engine properties.

Property Default Description
vbroker.se.default iiop_tp Specifies the default server engine.

Server-side thread session IIOP_TS/IIOP_TS connection properties

This table lists the server-side thread session IIOP_TS/IIOP_TS connection properties.

Property Default Description
vbroker.se.iiop_ts.host null Specifies the host name used by this server engine. The default value, null, means use the host name from the system.
vbroker.se.iiop_ts.proxyHost null Specifies the proxy host name used by this server engine. The default value, null, means use the host name from the system.
vbroker.se.iiop_ts.scms iiop_ts Specifies the list of Server Connection Manager name(s).
vbroker.se.iiop_ts.scm.iiop_ts.manager.type Socket Specifies the type of Server Connection Manager.
vbroker.se.iiop_ts.scm.iiop_ts.manager.connectionMax 0 Specifies the maximum number of connections the server will accept. The default value, 0 (zero), implies no restriction.
vbroker.se.iiop_ts.scm.iiop_ts.manager.connectionMaxIdle 0 Specifies the time in seconds the server uses to determine if an inactive connection should be closed or not.
vbroker.se.iiop_ts.scm.iiop_ts.manager.garbageCollectTimer 30 The garbage-collect timer (in seconds) for connections.
vbroker.se.iiop_ts.scm.iiop_ts.listener.type IIOP Specifies the type of protocol the listener is using.
vbroker.se.iiop_ts.scm.iiop_ts.listener.port 0 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 0 Specifies the proxy port number used with the proxy 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.rcvBufSize 0 Specifies the size of the receive socket buffer. The default value 0 implies system dependent value.
vbroker.se.iiop_ts.scm.iiop_ts.listener.sendBufSize 0 Specifies the size of the send buffer. The default value 0 implies system dependent value.
vbroker.se.iiop_ts.scm.iiop_ts.listener.socketLinger 0 A TCP/IP setting
vbroker.se.iiop_ts.scm.iiop_ts.listener.keepAlive true A TCP/IP setting
vbroker.se.iiop_ts.scm.iiop_ts.listener.giopVersion 1.2 This property can be used to resolve interoperability problems with older VisiBroker ORBs that cannot handle unknown minor GIOP versions correctly. Legal values for this property are 1.0, 1.1 and 1.2. For example, to make the nameservice produce a GIOP 1.1 ior, start it like this:

nameserv -VBJprop vbroker.se.iiop_tp.scm.iiop_tp.listener.giopVersion=1.1
vbroker.se.iiop_ts.scm.iiop_ts.dispatcher.type "ThreadSession" Specifies the type of thread dispatcher used in the Server Connection Manager.
vbroker.se.iiop_ts.scm.iiop_ts.dispatcher.threadStackSize 0 The size of the thread stack. Default value 0 indicates system default. However, on HP-UX, the value is 128 KB.
vbroker.se.iiop_ts.scm.iiop_ts.dispatcher.coolingTime 3 Time duration in seconds when a connection is considered hot (expecting more requests). After the time is elapsed, the connection is returned back from the dispatcher.
vbroker.se.iiop_ts.scm.iiop_ts.connection.rcvBufSize 0 Specifies the size of the receive socket buffer. The default value 0 implies system dependent value.
vbroker.se.iiop_ts.scm.iiop_ts.connection.sendBufSize 0 Specifies the size of the send buffer. The default value 0 implies system dependent value.
vbroker.se.iiop_ts.scm.iiop_ts.connection.socketLinger 0 A TCP/IP setting
vbroker.se.iiop_ts.scm.iiop_ts.connection.keepAlive true A TCP/IP setting
vbroker.se.iiop_ts.scm.iiop_ts.connection.tcpNoDelay true 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 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.

Property Default Description
vbroker.se.iiop_tp.host null 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.
vbroker.se.iiop_tp.proxyHost null 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.iiop_tp.scms iiop_tp Specifies the list of Server Connection Manager name(s).
vbroker.se.iiop_tp.scm.iiop_tp.manager.type Socket Specifies the type of Server Connection Manager.
vbroker.se.iiop_tp.scm.iiop_tp.manager.connectionMax 0 Specifies the maximum number of cache connection on the server. The default value, 0 (zero), implies no restriction.
vbroker.se.iiop_tp.scm.iiop_tp.manager.connectionMaxIdle 0 Specifies the time in seconds that the server uses to determine if an inactive connection should be closed or not.
vbroker.se.iiop_tp.scm.iiop_tp.manager.garbageCollectTimer 30 The garbage-collect timer (in seconds) for connections.
vbroker.se.iiop_tp.scm.iiop_tp.listener.type IIOP Specifies the type of protocol the listener is using.
vbroker.se.iiop_tp.scm.iiop_tp.listener.port 0 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.proxyPort 0 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 0 Specifies the size of the receive socket buffer. The default value 0 implies system dependent value.
vbroker.se.iiop_tp.scm.iiop_tp.listener.sendBufSize 0 Specifies the size of the send buffer. The default value 0 implies system dependent value.
vbroker.se.iiop_tp.scm.iiop_tp.listener.socketLinger 0 A TCP/IP setting
vbroker.se.iiop_tp.scm.iiop_tp.listener.keepAlive true A TCP/IP setting
vbroker.se.iiop_tp.scm.iiop_tp.listener.giopVersion 1.2 This property can be used to resolve interoperability problems with older VisiBroker ORBs that cannot handle unknown minor GIOP versions correctly. Legal values for this property are 1.0, 1.1 and 1.2.
vbroker.se.iiop_tp.scm.iiop_tp.dispatcher.type ThreadPool Specifies the type of thread dispatcher used in the Server Connection Manager.
vbroker.se.iiop_tp.scm.iiop_tp.dispatcher.threadMin 0 Specifies the minimum number of threads that the Server Connection Manager can create.
vbroker.se.iiop_tp.scm.iiop_tp.dispatcher.threadMax 0 Specifies the maximum number of threads that the Server Connection Manager can create. The default value, 0 (zero) implies the ORB will control the thread generation using an internal algorithm based on heuristics.
vbroker.se.iiop_tp.scm.iiop_tp.dispatcher.threadMaxIdle 300 Specifies the time in seconds before an idle thread will be destroyed.
vbroker.se.iiop_tp.scm.iiop_tp.dispatcher.threadStackSize 0 The size of the thread stack. Default value 0 indicates system default. However, on HP-UX, the value is 128 KB.
vbroker.se.iiop_tp.scm.iiop_tp.dispatcher.coolingTime 3 Time duration in seconds when a connection is considered hot (expecting more requests). After the time is elapsed, the connection is returned back from the dispatcher.
vbroker.se.iiop_tp.scm.iiop_tp.connection.rcvBufSize 0 Specifies the size of the receive socket buffer. The default value 0 implies system dependent value.
vbroker.se.iiop_tp.scm.iiop_tp.connection.sendBufSize 0 Specifies the size of the send buffer. The default value 0 implies system dependent value.
vbroker.se.iiop_tp.scm.iiop_tp.connection.socketLinger 0 A TCP/IP setting
vbroker.se.iiop_tp.scm.iiop_tp.connection.keepAlive true A TCP/IP setting
vbroker.se.iiop_tp.scm.iiop_tp.connection.tcpNoDelay true 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 pool BOA_TP/BOA_TP connection properties

This protocol has the same set of properties as the thread pool iiop_tp/iiop_tp connection properties, by replacing all iiop_tp with boa_tp in all the properties. For example, the vbroker.se.iiop_tp.scm.iiop_tp.manager.connectionMax will become 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.

Property Default Description
vbroker.se.liop_tp.host null 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.
vbroker.se.liop_tp.proxyHost null 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.scms liop_tp Specifies the list of Server Connection Manager name(s).
vbroker.se.liop_tp.scm.liop_tp.manager.type Local Specifies the type of Server Connection Manager.
vbroker.se.liop_tp.scm.liop_tp.manager.connectionMax 0 Specifies the maximum number of cache connection on the server. The default value, 0 (zero), implies no restriction.
vbroker.se.liop_tp.scm.liop_tp.manager.connectionMaxIdle 0 Specifies the time in seconds that the server uses to determine if an inactive connection should be closed or not.
vbroker.se.liop_tp.scm.liop_tp.manager.garbageCollectTimer 30 The garbage-collect timer (in seconds) for connections.
vbroker.se.liop_tp.scm.liop_tp.listener.type LIOP Specifies the type of protocol the listener is using.
vbroker.se.liop_tp.scm.liop_tp.listener.port 0 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 0 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.default.local.listener.door true Specifies whether Door API has to be used for Client and Server to communicate when running on the same machine. When set to true the Door API is used for LIOP. When set to false LIOP uses Unix Domain Socket for IPC. Only on Solaris.
vbroker.se.xxx.scm.yyy.listener.shmSize 4096 The size in bytes and in shared memory. If your client program and object implementation communicate via shared memory, you may use this option to enhance performance.
vbroker.se.xxx.scm.yyy.listener.userConstrained 0 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 1.2 This property can be used to resolve interoperability problems with older VisiBroker ORBs that cannot handle unknown minor GIOP versions correctly. Legal values for this property are 1.0, 1.1 and 1.2.
vbroker.se.liop_tp.scm.liop_tp.listener.allowedGroups null Allows server applications to control the trustees to the securable synchronization objects used for Local IPC communication on Windows. Allows semicolon separated Windows User groups to access servers using LIOP. Users not belonging to the groups specified will not be allowed to connect and will failover to IIOP.
vbroker.se.liop_tp.scm.liop_tp.dispatcher.type ThreadPool Specifies the type of thread dispatcher used in the Server Connection Manager.
vbroker.se.liop_tp.scm.liop_tp.dispatcher.threadMin 0 Specifies the minimum number of threads that the Server Connection Manager can create.
vbroker.se.liop_tp.scm.liop_tp.dispatcher.threadMax 0 Specifies the maximum number of threads that the Server Connection Manager can create. The default value, 0 (zero) implies the ORB will control the thread generation using an internal algorithm based on heuristics.
vbroker.se.liop_tp.scm.liop_tp.dispatcher.threadMaxIdle 300 Specifies the time in seconds before an idle thread will be destroyed.
vbroker.se.liop_ts.scm.liop_ts.dispatcher.threadStackSize 0 The size of the thread stack. Default value 0 indicates system default. However, on HP-UX, the value is 128 KB.
vbroker.se.liop_tp.scm.liop_tp.dispatcher.coolingTime 3 Time duration in seconds when a connection is considered hot (expecting more requests). After the time is elapsed, the connection is returned back from the dispatcher.

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, by replacing all liop_tp with boa_ltp in all the properties. For example, the vbroker.se.liop_tp.scm.liop_tp.manager.connectionMax will become 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 bidirectional 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.

Property Default Description
vbroker.orb.enableBiDir none 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 By default,not set by the ORB. 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 By default, not set by the ORB. 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:

The following table describes the properties used to enable logging and filtering.

Property Default Description
vbroker.log.enable false When set to true, all logging statements will be produced unless it is being filtered.
Values are true or false.
vbroker.log.logLevel debug Specifies the logging level of the log message. When set at a level, the logs with log levels equal to the specified level or above are forwarded. This property is applied at the global level.
Values are emerg, alert, crit, err, warning, notice, info and debug ranking from the highest to the lowest.
The meaning of the log levels are:
  • 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.
vbroker.log.filter.default.register null Register source name for controlling (filtering) the logs from that source.
Values are client, server, connection, cdr, se, agent and orb. Multiple values can be provided as a comma separated string.
Please note that 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.filter.default.<source-name>.enable true Once a source name is registered, logs output from the source can be explicitly controlled using this property.
Values are true or false.
vbroker.log.filter.default.<source-name>.logLevel debug This property provides finer-grained control over the global log level property. The log level specified using this property explicitly applies to the given source name.
The possible values are similar to the global logLevel values.
vbroker.log.filter.default.enable true Default filtering mechanism at source level identified within ORBs. When set to false, all logging will be filtered out which is equivalent to setting the property vbroker.log.enable to false.
Values are true or false.
vbroker.log.enableSigHandler false 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.

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:

The following table describes the properties used to configure the destination of the log output and its format.

Property Default Description
vbroker.log.default.appenders stdout List of comma-separated appenders for specifying log output destination.
Values are stdout and/or rolling.
vbroker.log.default.appender.<appender>.layout simple Type of layout (format) to be associated with the registered appender destination.
Values are simple or xml.
vbroker.log.default.appender.rolling.logDir <current_directory> Directory for the rolling log file to reside in.
vbroker.log.default.appender.rolling.fileName vbrolling.log Name of rolling log file.
vbroker.log.default.appender.rolling.maxFileSize 10 Size in MB for each backup before rolling over.
Values >= 1.
vbroker.log.default.appender.rolling.maxBackupIndex 1 Number of backups needed. When set to 0 (zero), no backup is created and logging will keep on appending to the file.
Values >= 0.

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. To turn on logging with default log level. 
    
prompt> vbapp –Dvbroker.log.enable=true
  2. To trace only info level and above. 
    
prompt> vbapp –Dvbroker.log.enable=true –Dvbroker.log.logLevel=info
  3. To turn off agent related component statements. 
    
prompt> vbapp –Dvbroker.log.enable=true \

–Dvbroker.log.filter.default.register=agent \

–Dvbroker.log.filter.default.agent.enable=false
  4. To trace the client and connection related area only. 
    
prompt> vbapp –Dvbroker.log.enable=true \

-Dvbroker.log.filter.default.enable=false \

–Dvbroker.log.filter.default.register=client,connection
  5. To trace emerg on se and err on the cdr areas and the rest info level. 
    
prompt> vbapp –Dvbroker.log.enable=true \

-Dvbroker.log.logLevel=info \

–Dvbroker.log.filter.default.register=se,cdr \

–Dvbroker.log.filter.default.se.logLevel=emerg \

–Dvbroker.log.filter.default.cdr.logLevel=err
  6. To set up output to local file systems with three backups. 
    
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
  7. To set up output to both console and local filesystems as xml format. 
    
prompt> vbapp –Dvbroker.log.default.appenders=stdout,rolling \

-Dvbroker.log.default.appender.rolling.logDir=/opt/vbc \

-Dvbroker.log.default.appender.rolling.fileName=vbc.log \

-Dvbroker.log.default.appender.rolling.layout=xml \

-Dvbroker.log.default.appender.stdout.layout=xml