.\"Generated by nroff_template.wdt (12-Sep-06). Do NOT edit this output file. Instead, edit the source FM+SGML file.
.de Sh \" Subsection
.br
.if t .Sp
.ne 5
.PP
\fB\\$1\fR
.PP
..
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Ip \" List item
.br
.ie \\n(.$>=3 .ne \\$3
.el .ne 3
.IP "\\$1" \\$2
..
.TH bbc.ini "" "" ""
.ds )H Hewlett-Packard Company
.ds ]L
.ds ]W June 2007
.SH NAME
bbc.ini - Configuration file for HTTPS communication.
.SH "DESCRIPTION"

.LP
bbc.ini is the configuration file of a node using HTTPS communication and is located at:

.LP
/<OvDataDir>/conf/confpar

.LP
It consists of sections headed by namespaces which contain the settings for each namespace. The bbc.ini file contains the namespaces listed below. Possible and default settings are described for each namespace.

.Sh "bbc.cb"

.LP
The Communication-Broker Namespace. You can use the following parameters:

.TP
string CHROOT_PATH = <path>

On UNIX systems only, the chroot path is used by the ovbbccb process. If this parameter is set, the ovbbccb process uses this path as the effective root thus restricting access to a limited part of the file system. Default is <OvDataDir>. This parameter is ignored on MS Windows and Sun Solaris 7 systems. See the chroot man page for details on chroot. 

.TP
bool SSL_REQUIRED = false 

If this parameter is set to true, the communication broker requires SSL authentication for all administration connections to the communication broker. If this parameter is set to false, non-SSL connections are allowed to the communication broker.

.TP
bool LOCAL_CONTROL_ONLY = false 

If this parameter is set to true, the communication broker only allows local connections to execute administrative commands such as start and stop.

.TP
bool LOG_SERVER_ACCESS = false

If this parameter is set to true, every access to the server is logged providing information about the sender's IP address, requested HTTP address, requested HTTP method, and response status.

.TP
int SERVER_PORT = 383

By default this port is set to 383. This is the port used by the communication broker to listen for requests. If a port is set in the namespace [bbc.cb.ports], it takes precedence over this parameter.

.TP
string SERVER_BIND_ADDR = <address>

Bind address for the server port. Default is INADDR_ANY.

.Sh "bbc.cb.ports"

.LP
The Communication-Broker-Port Namespace. This parameter defines the list of ports for all Communications Brokers in the network that may be contacted by applications on this host. The default port number for all BBC CBs is 383. You can use the following parameters:

.TP
string PORTS 

This configuration parameter must be the same on all nodes. To change the port number of a BBC CB on a particular host, the hostname must be added to this parameter, for example, name.hp.com:8000. You can use an asterisk "*" as a wild card to denote an entire network, for example; *.hp.com:8001. Note too, that either a comma "," or a semicolon ";" should be used to separate entries in a list of hostnames, for example;

name.hp.com:8000, *.hp.com:8001. 

In these examples, all hostnames ending in "hp.com" will configure their BBC Communication Broker to use port 8001 except host "name" which will use port 8000. All other hosts use the default port 383.

You can also use IP addresses and the asterisk wild card (*) to specify hosts. For example; 

15.0.0.1:8002, 15.*.*.*:8003

.Sh "bbc.http"

.LP
The HTTP Namespace for node-specific configuration. For application-specific settings, see the section bbc.http.ext.*. Note that application-specific settings in bbc.http.ext.* override node-specific settings in bbc.http. You can use the following parameters:

.TP
int SERVER_PORT = 0

By default this port is set to 0. If set to 0, the operating system assigns the first available port number. This is the port used by the application \fI<app_Name>\fR to listen for requests. Note that it only really makes sense to explicitly set this parameter in the bbc.http.ext.<app_Name> namespace, as the parameter is application specific with any other value than the default value.

.TP
string SERVER_BIND_ADDR = <address>

Bind address for the server port. Default is localhost.

.TP
string CLIENT_PORT = 0

Bind port for client requests. This may also be a range of ports, for example 10000-10020. This is the bind port on the originating side of a request. Default is port 0. The operating system will assign the first available port.

Note that MS Windows systems do not immediately release ports for reuse. Therefore on MS Windows systems, this parameter should be a large range.

.TP
string CLIENT_BIND_ADDR = <address>

Bind address for the client port. Default is INADDR_ANY.

.TP
bool LOG_SERVER_ACCESS = false

If this parameter is set to true, every access to the server is logged providing information about the sender's IP address, requested HTTP address, requested HTTP method, and response status.

.TP
string PROXY

Defines which proxy and port to use for a specified hostname.

Format: proxy:port +(a)-(b);proxy2:port2+(a)-(b); ...;

a: list of hostnames separated by a comma or a semicolon, for which this proxy shall be used.

b: list of hostnames separated by a comma or a semicolon, for which the proxy shall \fInot\fR be used.

The first matching proxy is chosen.

It is also possible to use IP addresses instead of hostnames so 15.*.*.* or 15:*:*:*:*:*:*:* would be valid as well, but the correct number of dots or colons MUST be specified. IP version 6 support is not currently available but will be available in the future.

.TP
string DOMAIN

This defines the default DNS domain to use if no domain is specified for a target host. This domain name will be appended to hostnames not containing a DNS domain name, if a match for the hostname alone cannot be found. This will be done for PROXY lookups and lookups in the [cb.ports] table, for example if the hostname "merlin" is specified and the DOMAIN = "bbn.hp.com", then the [cb.ports] entries will first be searched for the match of "merlin". If there is no match found for the hostname "merlin", then a search will be made for "merlin.bbn.hp.com", "*.bbn.hp.com", "*.hp.com", "*.com" and "*", in that order.

.Sh "bbc.fx"

.LP
BBC File-Transfer Namespace for node-specific configuration. For application-specific settings, see the section bbc.fx.ext.*. Note that application-specific settings in bbc.fx.ext.* override node-specific settings in bbc.fx. You can use the following parameters:

.TP
int FX_MAX_RETRIES = 3

Maximum number of retries to be attempted for the successful transfer of the object.

.TP
string FX_BASE_DIRECTORY = \fI<directory path>\fR

Base directory for which files may be uploaded or downloaded. Default directory is <OvDataDir>.

.TP
string FX_TEMP_DIRECTORY = <directory path>

Temporary directory where uploaded files are placed while upload is in progress. At completion of upload, the file will be moved to \fI<directory path>\fR. Default directory is <OvDataDir>/tmp/bbc/fx.

.TP
string FX_UPLOAD_DIRECTORY = <directory path>

Target directory for uploaded files. By default this is the base directory. The upload target directory may be overridden with this configuration parameter. Default directory is FX_BASE_DIRECTORY.

.Sh "bbc.snf"

.LP
BBC Store-and-Forward Namespace for node-specific configuration. For application-specific settings, see the section bbc.snf.ext.*. Note that application-specific settings in bbc.snf.ext.* override node-specific settings in bbc.snf. You can use the following parameters:

.TP
string BUFFER_PATH = <path>

Specifies the SNF path were the buffered requests are stored. Default is:

<OvDataDir>/datafiles/bbc/snf/<app_Name>

.TP
int MAX_FILE_BUFFER_SIZE = 0

Specifies the maximum amount of disk space that the buffer is allowed to consume on the hard disk.

0 = No limit

.Sh "bbc.http.ext.*"

.LP
HTTP External-Communication Namespaces: bbc.http.ext.<compID>.<app_Name> and bbc.http.ext.<app_Name>.

.LP
This is the Dynamic External-Communication Namespace for application-specific settings. Note that application-specific settings in bbc.http.ext.* override node-specific settings in bbc.http. 

.LP
See the section bbc.http for a list of the parameters you can use in the bbc.http.ext.* namespace.

.Sh "bbc.fx.ext.*"

.LP
The Dynamic File-Transfer (fx) Namespace for external-component and application-specific settings. Note that application-specific settings in bbc.fx.ext.* override node-specific settings in bbc.fx.

.LP
File Transfer External Namespaces:  bbc.fx.ext.<compID>.<app_Name> and bbc.fx.ext.<app_Name>.

.LP
See the section bbc.fx for a list of the parameters you can use in the bbc.fx.ext.* namespace.

.Sh "bbc.snf.ext.*"

.LP
The Dynamic Store-and-Forward (snf) Namespace for external-component and application-specific settings. Note that application-specific settings in bbc.snf.ext.* override node-specific settings in bbc.snf.

.LP
Store and Forward External Namespace:  bbc.snf.ext.<compID>.<app_Name> and bbc.snf.ext.<app_Name>.

.LP
See the section bbc.snf for a list of the parameters you can use in the bbc.snf.ext.* namespace.

.SH "AUTHOR"

.LP
bbc.ini was developed by Hewlett-Packard Company.

.SH "EXAMPLES"

.LP
PROXY=web-proxy:8088-(*.hp.com)+(*.a.hp.com;*)

.LP
The proxy web-proxy is used with port 8088 for every server (*) except hosts that match *.hp.com, for example www.hp.com. If the hostname matches *.a.hp.com, for example, merlin.a.hp.com the proxy server will be used.

.SH "SEE ALSO"

.LP
bbcutil

.SH "COPYRIGHT"

.LP
(c) Copyright 2001-2007 Hewlett-Packard Development Company, L.P.

.LP
HP shall not be liable for technical or editorial errors or omissions contained herein.