This appendix provides information about the Oracle Communications Contacts Server configuration parameters.
The ContactsServer_home/config/davserver.properties file contains the main configuration settings. It consists of configuration parameters and their current values.
Caution:
Do not edit this file by hand. Always use the davadmin command to set configuration parameters.The format of the davserver.properties file is:
parameter=value parameter=value : :
The ContactsServer_home/config/ashttpd.properties file contains the document store configuration parameters. Table B-1 describes the parameters in the ashttpd.properties file.
Table B-1 ashttpd.properties File Parameters
Parameter | Description | Default Value |
---|---|---|
service.host |
Specifies the server host. |
* |
service.port |
Specifies the server port number. |
8008 |
store.datadir |
Specifies the data directory. |
/var/opt/sun/comms/nabserver |
store.lockdir |
Specifies the lock directory. |
/var/opt/sun/comms/nabserver/lock |
store.loglevel |
Log level |
INFO |
store.sslkeystorepath |
Keystore for the server private key |
/var/opt/sun/comms/nabserver/config/dskeystore.jks |
store.sslprotocols |
SSL protocols |
TLSv1 TLSv1.1 TLSv1.2 |
store.usessl |
Use SSL to communicate with document store client. |
false |
The format of the ashttpd.properties file is the following:
key=value key=value : :
Each line in the ashttpd.properties file stores a single property. Do not include a space before and after key and value. When the host uses multiple network interfaces, and the host should bind to only one, specify that interface with the service.host configuration parameter.
You can provide options to the davadmin command by including them in the ContactsServer_home/config/davadmin.properties file.
Table B-2 describes the parameters in the davadmin.properties file.
Table B-2 davadmin.properties File Parameters
Parameter | Description |
---|---|
userid |
Specifies the application server Administrator user ID. |
hostname |
Specifies the application server host name. |
port |
Specifies the application server administration port (JMX connector port). |
secure |
Specifies the path to the truststore file used for a secure connection (HTTPS) to the application server. |
dbtype |
Specifies the type of database, either mysql or oracle. |
dbhost |
Specifies the database host. |
dbport |
Specifies the database port. |
dbuserid |
Specifies the MySQL Server or Oracle Database user ID for database commands. |
sslprotocols |
Specifies the supported SSL protocols (TLSv1, TLSv1.1, and TLSv1.2) for the JMX proxy to communicate with the management beans in the server. |
The format of the davadmin.properties file is:
parameter=value parameter=value : :
You can customize the corporate directory displayname extension by using the ContactsServer_home/config/corpdir/corpdirnames-lang.properties file. The displayname extension enables you to provide a localized customized name for the corporate directory.
To change the default value, edit the idtag in the corpdirnames-lang.properties file. An idtag lookup is performed to a map of corporate directory names in various languages.
The following languages are supported:
English
French
Spanish
German
Japanese
Korean
Simplified Chinese
Traditional Chinese
For example, in the following URL, the directory name corresponding to the idtag "id2" in the corpdirnames-lang.properties file is returned when querying a list of public directories for the deployment in the given language:
ldap://virtuallistpool/o=HQ,o=isp??sub?(objectclass=*)?displayname="id2"
If you do not set the displayname in the URL, the URL uses the default idtag of "id1," which has the value "Corporate Directory," when performing the lookup in the English language.
Table B-3 lists the configuration parameters and descriptions for Contacts Server.
Table B-3 Contacts Server Configuration Parameters
Parameter | Type | Description | Default value | Minimum Value | Maximum Value | Version |
---|---|---|---|---|---|---|
base.ldapinfo.cachesize |
integer |
Size of the LDAP authentication cache. |
1000 |
1 |
1000000 |
8.0 |
base.ldapinfo.cachettl |
integer (seconds) |
Time to live (in seconds) of cached LDAP authentication info. |
60 |
1 |
Maximum int value |
8.0 |
base.ldapinfo.dcroot |
string |
Root of DC tree (Schema 1) or of the domain and users tree (Schema 2) in Directory Server. |
o=isp |
N/A |
N/A |
8.0 |
base.ldapinfo.defaultdomain |
string |
Default domain. |
demo.example.com |
N/A |
N/A |
8.0 |
base.ldapinfo.domainattrs |
string |
Space separated list of LDAP attributes to use when retrieving domain information. |
nabStatus nabDomainNames nabDomainAcl externalAuthPreUrlTemplate externalAuthPostUrlTemplate corpDirectoryUrl |
N/A |
N/A |
8.0 |
base.ldapinfo.loginseparator |
string |
Characters to be used as login separator (between user ID and domain). |
@ |
N/A |
N/A |
8.0 |
base.ldapinfo.schemalevel |
integer |
Schema level. |
2 |
1 |
2 |
8.0 |
base.ldapinfo.searchfilter |
string |
Search filter to look up users during authentication when none is specified in the inetDomainSearchFilter for the domain. The syntax is the same as inetDomainSearchFilter (see Communications Suite Schema Reference). |
(uid=%U) |
N/A |
N/A |
8.0 |
base.ldapinfo.serviceadmindn |
string |
DN of single admin in LDAP in absence of admin group. |
N/A |
N/A |
N/A |
8.0 |
base.ldapinfo.serviceadminsgroupdn |
string |
DN of service admins group in LDAP. |
N/A |
N/A |
N/A |
8.0 |
base.ldapinfo.userattrs |
string |
Space separated list of LDAP attributes to retrieve from user entries during the authentication phase. |
mail ismemberof |
N/A |
N/A |
8.0 |
base.ldapinfo.authldap.binddn |
string |
DN to use when authenticating. |
N/A |
N/A |
N/A |
8.0 |
base.ldapinfo.authldap.bindpassword |
password |
Password to use when authenticating. |
N/A |
N/A |
N/A |
8.0 |
base.ldapinfo.authldap.ldaphost |
string |
Space-delimited list of host names. Each host name can include a trailing colon and port number. |
localhost:389 |
N/A |
N/A |
8.0 |
base.ldapinfo.authldap.ldappoolrefreshinterval |
integer (minutes) |
Length of elapsed time until the failover Directory Server reverts back to the primary Directory Server. If set to -1, do not refresh. |
1 |
1 |
60 |
8.0 |
base.ldapinfo.authldap.ldappoolsize |
integer |
Maximum number of connections for this pool. |
10 |
1 |
100 |
8.0 |
base.ldapinfo.authldap.ldapport |
integer |
Port number to which to connect. Ignored for any host name that includes a colon and port number. |
389 |
0 |
65535 |
8.0 |
base.ldapinfo.authldap.ldaptimeout |
integer (seconds) |
Timeout for all LDAP operations. |
60 |
1 |
3600 |
8.0 |
base.ldapinfo.authldap.ldapusessl |
boolean |
Use SSL to connect to the LDAP host. |
false |
N/A |
N/A |
8.0 |
base.ldapinfo.authldap.sslprotocols |
string |
Specifies a space-delimited list of the supported SSL protocols to communicate with the back-end LDAP service. |
TLSv1 TLSv1.1 TLSv1.2 |
N/A |
N/A |
8.0.0.1 |
base.ldapinfo.ugldap.binddn |
string |
DN to use when authenticating. |
N/A |
N/A |
N/A |
8.0 |
base.ldapinfo.ugldap.bindpassword |
password |
Password to use when authenticating. |
N/A |
N/A |
N/A |
8.0 |
base.ldapinfo.ugldap.ldaphost |
string |
Space-delimited list of host names. Each host name may include a trailing colon and port number. |
localhost:389 |
N/A |
N/A |
8.0 |
base.ldapinfo.ugldap.ldappoolrefreshinterval |
integer (minutes) |
Length of elapsed time until the failover Directory Server reverts back to the primary Directory Server. If set to -1, do not refresh. |
1 |
1 |
60 |
8.0 |
base.ldapinfo.ugldap.ldappoolsize |
integer |
Maximum number of connections for this pool. |
10 |
1 |
100 |
8.0 |
base.ldapinfo.ugldap.ldapport |
integer |
Port number to which to connect. Ignored for any host name that includes a colon and port number. |
389 |
0 |
65535 |
8.0 |
base.ldapinfo.ugldap.ldaptimeout |
integer (seconds) |
Timeout for all LDAP operations. |
60 |
1 |
3600 |
8.0 |
base.ldapinfo.ugldap.ldapusessl |
boolean |
Use SSL to connect to the LDAP host. |
false |
N/A |
N/A |
8.0 |
base.ldapinfo.ugldap.sslprotocols |
string |
Specifies a space-delimited list of the supported SSL protocols to communicate with the back-end LDAP service. |
TLSv1 TLSv1.1 TLSv1.2 |
N/A |
N/A |
8.0.0.1 |
base.ldappool.*.binddn |
string |
DN to use when authenticating. |
N/A |
N/A |
N/A |
8.0 |
base.ldappool.*.bindpassword |
password |
Password to use when authenticating. |
N/A |
N/A |
N/A |
8.0 |
base.ldappool.*.ldaphost |
string |
Space-delimited list of host names. Each host name can include a trailing colon and port number. |
localhost:389 |
N/A |
N/A |
8.0 |
base.ldappool.*.ldappoolrefreshinterval |
integer (minutes) |
Length of elapsed time until the failover Directory Server reverts back to the primary Directory Server. If set to -1, do not refresh. |
1 |
1 |
60 |
8.0 |
base.ldappool.*.ldappoolsize |
integer |
Maximum number of connections for this pool. |
10 |
1 |
100 |
8.0 |
base.ldappool.*.ldapport |
integer |
Port number to which to connect. Ignored for any host name that includes a colon and port number. |
389 |
0 |
65535 |
8.0 |
base.ldappool.*.ldaptimeout |
integer (seconds) |
Timeout for all LDAP operations. |
60 |
1 |
3600 |
8.0 |
base.ldappool.*.ldapusessl |
boolean |
Use SSL to connect to the LDAP host. |
false |
N/A |
N/A |
8.0 |
base.ldappool.*.sslprotocols |
string |
Specifies a space-delimited list of the supported SSL protocols for the LDAP pool to communicate with the back-end LDAP service. |
TLSv1 TLSv1.1 TLSv1.2 |
N/A |
N/A |
8.0.0.1 |
davcore.acl.aclcachesize |
integer |
Maximum number of ACL entries kept in cache. Entries are removed from the cache only when this maximum is reached or when ACL configuration parameters are changed. If set to 0, indicates no cache. |
1000 |
0 |
Maximum int value |
8.0 |
davcore.acl.aclcachettl |
integer (seconds) |
Maximum amount of time (in seconds) that an ACL entry can be kept in cache. |
60 |
1 |
Maximum int value |
8.0 |
davcore.attachment.enable |
boolean |
Enable or disable attachments. |
true |
N/A |
N/A |
8.0 |
davcore.auth.cert.enable |
boolean |
Enable certificate-based client authentication. |
false |
N/A |
N/A |
8.0 |
davcore.auth.cert.fallback |
boolean |
Fallback to user name and password authentication |
true |
N/A |
N/A |
8.0 |
davcore.autocreate.displaynameattr |
string |
LDAP attribute, whose value is used to set display name, during autocreation. Default setting used on autocreation. |
cn |
N/A |
N/A |
8.0 |
davcore.autocreate.emailnotificationaddressattr |
string |
LDAP attribute, whose value is used to set email notification address, during autocreation. Default setting used on autocreation. |
|
N/A |
N/A |
8.0 |
davcore.autocreate.enableautocreate |
boolean |
Enable autocreate operation. Default setting used on autocreation. |
true |
N/A |
N/A |
8.0 |
davcore.autocreate.enableemailnotification |
boolean |
Enable email notification. Default setting used on autocreation. |
true |
N/A |
N/A |
8.0 |
davcore.homeuri.*.backendid |
string |
When it is determined that a URI matches the pattern, this backendid template is used to identify the back end hosting this resource. The template can reference the variables $1, $2, and so on, saved during the pattern matching. The template can also reference LDAP attributes of the subject matching the subjectfilter attribute using the |
N/A |
N/A |
N/A |
8.0 |
davcore.homeuri.*.rank |
integer |
When multiple URI patterns are configured, this value determines the order in which to evaluate those URI patterns. A lower number indicates that this pattern should be evaluated first. |
1 |
0 |
Maximum int value |
8.0 |
davcore.homeuri.*.subjectdomain |
string |
When it is determined that a URI matches the pattern, this domain template is used to identify the subject owning this resource. The template can reference the variables $1, $2, and so on, saved during the pattern matching. For example, if subjectdomain is set to $2, and using the URI in the uripattern example, the domain of the subject is example.com. If empty, indicates the default domain. |
$2 |
N/A |
N/A |
8.0 |
davcore.homeuri.*.subjectfilter |
string |
When it is determined that a URI matches the pattern, this LDAP filter template is used to identify the subject owning this resource. The template can reference the variables $1, $2, and so on, saved during the pattern matching. For example, if subjectfilter is set to (mail=$1@$2), and using the URI in the uripattern example, the LDAP filter becomes (mail=john@example.com). If empty, indicates that this namespace is not associated with a particular subject. |
(mail=$1@$2) |
N/A |
N/A |
8.0 |
davcore.homeuri.*.uripattern |
string |
Regex pattern to be matched by the URI. This pattern can contain regex groups (identified by () parenthesis) that are saved into $1, $2, and so on. The last regex group identifies the local path if there is any. For example, if the pattern is \^/home/([^/]+)@([^/]+)(/\z|/.*), the URI /home/john@example.com/addressbook/ matches that pattern. $1 is set to the value john, $2 is set to the value example.com, and the local path is /addressbook. |
^/home/([^/]+)@([^/]+)(/\z|/.*) |
N/A |
N/A |
8.0 |
davcore.ldapattr.commonname |
string |
Common name attribute. |
cn |
N/A |
N/A |
8.0 |
davcore.ldapattr.corpdirectoryurl |
string |
LDAP attribute to locate a custom external corporate directory for this domain. |
corpDirectoryUrl |
N/A |
N/A |
8.0 |
davcore.ldapattr.davstore |
string |
Logical back-end id attribute. |
nabStore |
N/A |
N/A |
8.0 |
davcore.ldapattr.dngroupmember |
string |
Attributes for members in an LDAP group. |
uniquemember |
N/A |
N/A |
8.0 |
davcore.ldapattr.externalauthposturltemplate |
string |
LDAP attribute that determines whether external authentication should do a post auth lookup against this domain. |
externalAuthPostUrlTemplate |
N/A |
N/A |
8.0 |
davcore.ldapattr.externalauthpreurltemplate |
string |
LDAP attribute that determines whether external authentication should be used against this domain. |
externalAuthPreUrlTemplate |
N/A |
N/A |
8.0 |
davcore.ldapattr.groupobject |
string |
Space separated list of object class values indicating an LDAP group. |
groupofuniquenames groupofurls inetmailgroup |
N/A |
N/A |
8.0 |
davcore.ldapattr.inetresourcestatus |
string |
LDAP attribute for global status of resources. |
inetresourcestatus |
N/A |
N/A |
8.0 |
davcore.ldapattr.inetuserstatus |
string |
LDAP attribute for status of user's account with regards to global service access. |
inetuserstatus |
N/A |
N/A |
8.0 |
davcore.ldapattr.mail |
string |
Mail attribute. |
|
N/A |
N/A |
8.0 |
davcore.ldapattr.mailalternateaddress |
string |
Space separated list of alternate mail attributes. |
mailAlternateAddress |
N/A |
N/A |
8.0 |
davcore.ldapattr.mailgroupmember |
string |
Attributes for members in an LDAP group. |
mgrprfc822mailmember |
N/A |
N/A |
8.0 |
davcore.ldapattr.memberattr |
string |
LDAP attribute listing the groups of which the entry is a member. |
ismemberof |
N/A |
N/A |
8.0 |
davcore.ldapattr.nabstatus |
string |
Contacts Server status attribute. |
nabstatus |
N/A |
N/A |
8.0 |
davcore.ldapattr.preferredlang |
string |
Language attribute. |
preferredLanguage |
N/A |
N/A |
8.0 |
davcore.ldapattr.resourcetype |
string |
LDAP attribute to use to determine the CUTYPE (ROOM versus RESOURCE) of a resource. The CUTYPE of users and groups is not based on this attribute. The attribute value can take the following values: * location and room are mapped to a CUTYPE of ROOM. * thing and resource are mapped to a CUTYPE of RESOURCE. * other values are mapped to RESOURCE. |
kind |
N/A |
N/A |
8.0 |
davcore.ldapattr.uid |
string |
User ID attribute. |
uid |
N/A |
N/A |
8.0 |
davcore.ldapattr.urlgroupmember |
string |
Attributes for members in an LDAP group. |
memberurl |
N/A |
N/A |
8.0 |
davcore.otheruri.*.backendid |
string |
When it is determined that a URI matches the pattern, this backendid template is used to identify the back end hosting this resource. The template can reference the variables $1, $2, and so on, saved during the pattern matching. The template also references LDAP attributes of the subject matching the subjectfilter, using the |
N/A |
N/A |
N/A |
8.0 |
davcore.otheruri.*.rank |
integer |
When multiple URI patterns are configured, this value determines the evaluation order. A lower number indicates that this pattern should be evaluated first. |
1 |
0 |
Maximum int value |
8.0 |
davcore.otheruri.*.subjectdomain |
string |
When it is determined that a URI matches the pattern, this domain template is used to identify the subject owning this resource. The template can reference the variables $1, $2, and so on, saved during the pattern matching. For example, if the subjectdomain is set to $2, and using the URI in the uripattern example, the domain of the subject is example.com. If empty, indicates the default domain. |
$2 |
N/A |
N/A |
8.0 |
davcore.otheruri.*.subjectfilter |
string |
When it is determined that a URI matches the pattern, this LDAP filter template is used to identify the subject owning with this resource. The template can reference the variables $1, $2, and so on, saved during the pattern matching. For example, if the subjectfilter is set to (mail=$1@$2), and using the URI in the uripattern example, the LDAP filter becomes (mail=john@example.com). Can be empty, indicating that this namespace is not associated with a particular subject. |
(mail=$1@$2) |
N/A |
N/A |
8.0 |
davcore.otheruri.*.uripattern |
string |
Regex pattern to be matched by the uri. This pattern can contain regex groups (identified by () parenthesis) which is saved into $1, $2, and so on. The last regex group identifies the local path if there is any. For example, if the pattern is ^/home/([^/]+)@([^/]+)(/\z|/.*), the URI /home/john@example.com/addressbook/ matchws that pattern. $1 is set to the value john, $2 is set to the value example.com, and the local path is /addressbook. |
^/home/([^/]+)@([^/]+)(/\z|/.*) |
N/A |
N/A |
8.0 |
davcore.principalsuri.*.backendid |
string |
When it is determined that a URI matches the pattern, this backendid template is used to identify the back end hosting this resource. The template can reference the variables $1, $2, and so on, saved during the pattern matching. The template can also reference LDAP attributes of the subject matching the subjectfilter, using the ${attrname} syntax or the ${attrname,defaultvalue} syntax. If this parameter is not set, the uriinfo.backendidtemplate parameter is used. |
N/A |
N/A |
N/A |
8.0 |
davcore.principalsuri.*.rank |
integer |
When multiple URI patterns are configured, this value determines the evaluation order. A lower number indicates that this pattern should be evaluated first. |
1 |
0 |
Maximum int value |
8.0 |
davcore.principalsuri.*.subjectdomain |
string |
When it is determined that a URI matches the pattern, this domain template is used to identify the subject owning with this resource. The template can reference the variables $1, $2, and so on, saved during the pattern matching. For example, if the subjectdomain is set to $2, and using the URI in the uripattern example, the domain of the subject is example.com. Can be empty to indicate the default domain. |
$2 |
N/A |
N/A |
8.0 |
davcore.principalsuri.*.subjectfilter |
string |
When it is determined that a URI matches the pattern, this LDAP filter template is used to identify the subject owning with this resource. The template can reference the variables $1, $2, and so on, saved during the pattern matching. For example, if the subjectfilter is set to (mail=$1@$2), and using the URI in the uripattern example, the LDAP filter becomes (mail=john@example.com). Can be empty, to indicate that this namespace is not associated with a particular subject. |
(mail=$1@$2) |
N/A |
N/A |
8.0 |
davcore.principalsuri.*.uripattern |
string |
Regex pattern to be matched by the URI. This pattern can contain regex groups (identified by () parenthesis) which are saved into $1, $2, and so on. The last regex group identifies the local path if there is any. For example, if the pattern is ^/home/([^/]+)@([^/]+)(/\z|/.*), the URI /home/john@example.com/addressbook/ matches that pattern. $1 is set to the value john, $2 is set to the value example.com, and the local path is /addressbook. |
^/home/([^/]+)@([^/]+)(/\z|/.*) |
N/A |
N/A |
8.0 |
davcore.reverseuri.*.backendid |
string |
Back-end id on which to apply this reverse mapping. There should be only one mapping per back end. |
N/A |
N/A |
N/A |
8.0 |
davcore.reverseuri.*.uritemplate |
string |
Canonical form of the URI prefix for this back end. This template should have a corresponding uripattern. It should not end with a slash. The template can reference LDAP attributes of the subject, using the ${attrname} syntax or the ${attrname,defaultvalue} syntax. The ${domain} syntax can be used to reference the domain of the subject. If no template is defined for a given back end, the uriinfo.defaulthomeuritemplate parameter is used. |
N/A |
N/A |
N/A |
8.0 |
davcore.serverdefaults.exportconfigdir |
filepath |
Directory path for export XSL transformation files. |
config/export |
N/A |
N/A |
8.0 |
davcore.serverdefaults.importconfigdir |
filepath |
Directory path for import properties and translation files. |
config/import |
N/A |
N/A |
8.0 |
davcore.serverdefaults.jsonprefix |
string |
Default prefix to append to all JSON output. |
{}&& |
N/A |
N/A |
8.0 |
davcore.serverdefaults.sslprotocols |
string |
Specifies a space-delimited list of the supported SSL protocols as the default for the various back-end services' sslprotocols configuration. That is, if the specific sslprotocols parameter is not set, it is set to the value of davcore.serverdefaults.sslprotocols. |
TLSv1 TLSv1.1 TLSv1.2 |
N/A |
N/A |
8.0.0.1 |
davcore.serverlimits.httpconnecttimeout |
integer |
HTTP connection timeout value (in milliseconds), when connecting to another server. |
5000 |
500 |
100000 |
8.0 |
davcore.serverlimits.httpsockettimeout |
integer |
HTTP Socket timeout value (in milliseconds), when connecting to another server, and waiting for data. |
5000 |
500 |
100000 |
8.0 |
davcore.serverlimits.maxaddressbookcontentlength |
long (bytes) |
Maximum size of a contacts resource. |
10000000 |
0 |
Maximum long value |
8.0 |
davcore.serverlimits.maxcontentlength |
long (bytes) |
Maximum size of a resource. Might be overwritten for certain types of content (for example text/vcard). |
10000000 |
0 |
Maximum long value |
8.0 |
davcore.serverlimits.maxgroupexpansion |
integer |
Maximum nested level of group expansion. |
3 |
0 |
-1 |
8.0 |
davcore.serverlimits.maxhttpredirects |
integer |
Maximum number of HTTP redirects to follow, when connecting to another server. |
3 |
0 |
10 |
8.0 |
davcore.serverlimits.maxmigrationthreads |
integer |
Maximum number of threads to create when running migration. |
2 |
1 |
20 |
8.0 |
davcore.serverlimits.maxnumberofresourcesincollection |
long (bytes) |
Maximum number of resources allowed in a collection. A value of -1 means no limit. |
10000 |
-1 |
Maximum long value |
8.0 |
davcore.serverlimits.maxresults |
integer |
Maximum number of resources returned by a single fetch operation. A value of 0 means no limit. Administrator users are not affected by this limit. |
10000 |
0 |
Maximum int value |
8.0 |
davcore.serverlimits.maxsearchtimerange |
long (days) |
Maximum bounded search range in days. |
3660 |
0 |
366000 |
8.0 |
davcore.serverlimits.maxuploadcontentlength |
long (bytes) |
Maximum size when uploading data. This affects operations that let you create multiple resources in one request (for example import). It does not affect regular PUT. |
20000000 |
0 |
Maximum long value |
8.0 |
davcore.serverlimits.migrationtimeout |
integer |
Maximum number of hours to wait before terminating a migration. |
8 |
1 |
100 |
8.0 |
davcore.serverlimits.minsearchcharacters |
integer |
Minimum number of characters allowed in a text filter search. |
3 |
0 |
256 |
8.0 |
davcore.serverlimits.templockretry |
integer |
Maximum number of attempts to acquire a temporary lock when doing write operations. |
20 |
1 |
Maximum int value |
8.0 |
davcore.serverlimits.templocktimeout |
integer (seconds) |
Maximum amount of time to wait for a temporary lock when doing write operations. |
60 |
1 |
Maximum int value |
8.0 |
davcore.serverlimits.templockusebackend |
boolean |
If true, temporary locks are ensured at the back-end level instead of staying local to a server instance. |
false |
N/A |
N/A |
8.0 |
davcore.uriinfo.backendidtemplate |
string |
The backendid template is used to identify the back end hosting the home of a given subject. The template can reference LDAP attributes of the subject, using the ${attrname} syntax or the ${attrname,defaultvalue} syntax. |
${nabStore,defaultbackend} |
N/A |
N/A |
8.0 |
davcore.uriinfo.defaultdavuriprefix |
string |
Canonical form of DAV URI prefix for WebDAV based protocols. This prefix corresponds to one of the DavServlet specific path (for example /dav) as defined in theweb.xml file. It should not end with a slash. |
/dav |
N/A |
N/A |
8.0 |
davcore.uriinfo.defaulthomeuritemplate |
string |
Canonical form of a subject home URI prefix. This template should have a corresponding uripattern. It should not end with a slash The template can reference LDAP attributes of the subject, using the ${attrname} syntax or the ${attrname,defaultvalue} syntax. The ${domain} syntax can be used to reference the domain of the subject. |
/home/${mail} |
N/A |
N/A |
8.0 |
davcore.uriinfo.defaultprincipaluritemplate |
string |
Canonical form of a subject principal URI prefix. This template should have a corresponding uripattern. It should not end with a slash. The template can reference LDAP attributes of the subject, using the ${attrname} syntax or the ${attrname,defaultvalue} syntax. The ${domain} syntax can be used to reference the domain of the subject. |
/principals/${mail} |
N/A |
N/A |
8.0 |
davcore.uriinfo.defaultresturiprefix |
string |
Canonical form of REST URI prefix for WebDAV based protocols. This prefix corresponds to one of the RESTfulServlet specific path as defined in the web.xml file. It should not end with a slash. |
/rest |
N/A |
N/A |
8.0 |
davcore.uriinfo.directoryrootcollection |
string |
Defines the root collection of all directory collections (without any prefix). |
/directory/ |
N/A |
N/A |
8.0 |
davcore.uriinfo.emailsearchfiltertemplate |
string |
LDAP Filter used when searching a subject by email address. The |
|(mail=%s)(mailalternateaddress=%s) |
N/A |
N/A |
8.0 |
davcore.uriinfo.fulluriprefix |
string |
Full URL prefix to use wherever a full URL is required. It should not end with a slash. This prefix is used to construct attachment URLs embedded in resources. Modifying this parameter does not change full URLs in already existing resources. If SSL is used, the host name part of this prefix should match the host name associated with the certificate. |
http://localhost |
N/A |
N/A |
8.0 |
davcore.uriinfo.ldapcachesize |
integer |
Maximum number of subjects (LDAP users, resources, and groups) kept in cache when mapping URIs and subjects. Entries are removed from the cache only when this maximum is reached or when any of the uriinfo configuration parameter is changed. Can be set to 0, indicating no cache. |
1000 |
0 |
Maximum int value |
8.0 |
davcore.uriinfo.ldapcachettl |
integer (seconds) |
Maximum time (in seconds) that subjects (LDAP users, resources, and groups) are kept in cache when mapping URIs and subjects. |
60 |
1 |
Maximum int value |
8.0 |
davcore.uriinfo.permanentuniqueid |
string |
Name of an LDAP attribute present in the LDAP entry of all subjects (users, groups, resources, and so on) and defining a permanent and unique identifier for each subject. The attribute value is used internally to do the mapping between the subject LDAP entry and its repository. As such, it should remain constant for the lifetime of the subject LDAP entry and it should be unique (at least within the subject domain). Changing this configuration parameter results in data loss when the user repositories have been created. |
davuniqueid |
N/A |
N/A |
8.0 |
davcore.uriinfo.principalsrootcollection |
string |
Defines the root collection of all principals in their canonical form. (without any prefix). This parameter is used to return the WebDAV DAV:principal-collection-set property. |
/principals/ |
N/A |
N/A |
8.0 |
davcore.uriinfo.subjectattributes |
string |
Space separated list of LDAP attribute names to retrieve when doing a search for users, groups, or resources. |
cn nabstore nabstatus mail mailalternateaddress davuniqueid owner preferredlanguage uid objectclass ismemberof uniquemember memberurl mgrprfc822mailmember kind |
N/A |
N/A |
8.0 |
davcore.uriinfo.subjectsearchfilter |
string |
LDAP Filter used when a user is searching for other users. The %s token is replaced by the search string. |
(|(uid=%s*)(cn=*%s*)(mail=*%s*)) |
N/A |
N/A |
8.0 |
davcore.uriinfo.subjectsearchfilterminimum |
integer |
The minimum number of characters allowed for the search string. |
3 |
-2147483648 |
Maximum int value |
8.0 |
davcore.uriinfo.uricachesize |
integer |
Maximum number of resolved URIs kept in cache. Entries are removed from the cache only when this maximum is reached or when any of the uriinfo configuration parameter is changed. Can be set to 0, indicating no cache. |
10000 |
0 |
Maximum int value |
8.0 |
davcore.uriinfo.uricachettl |
integer (seconds) |
Maximum time (in seconds) that resolved URIs are kept in cache. |
60 |
1 |
Maximum int value |
8.0 |
davcore.uriinfo.useldapproxyauth |
boolean |
If true, use proxy authorization for any LDAP search on behalf of a user. If false, use administrator credentials for all LDAP searches. |
true |
N/A |
N/A |
8.0 |
davcore.virusscan.auth |
boolean |
Determines if the virus scan connection should use user and password authorization. |
false |
N/A |
N/A |
8.0 |
davcore.virusscan.clivirusaction |
string |
Action to be performed when a virus is detected during command-line operation. Value is empty or delete. |
N/A |
N/A |
N/A |
8.0 |
davcore.virusscan.debug |
boolean |
Determines if the virus scan SMTP connection should use debug. |
false |
N/A |
N/A |
8.0 |
davcore.virusscan.emailaddress |
string |
Sets the email recipient address that the MTA uses to trigger a custom virus scan. (Requires MTA configuration). |
N/A |
N/A |
N/A |
8.0 |
davcore.virusscan.host |
string |
Host of the MTA configured to accept virus scans. |
N/A |
N/A |
N/A |
8.0 |
davcore.virusscan.onlineenable |
boolean |
Enable and disable online virus scan. |
false |
N/A |
N/A |
8.0 |
davcore.virusscan.onlinefailureaction |
string |
Action to be performed when virus service fails during an online submission. Value is empty or reject. |
N/A |
N/A |
N/A |
8.0 |
davcore.virusscan.onlinevirusaction |
string |
Action to be performed when a virus is detected during an online submission. Value is empty or reject. |
N/A |
N/A |
N/A |
8.0 |
davcore.virusscan.pass |
password |
The SMTP authorization password for the SMTP virus scan connection. |
N/A |
N/A |
N/A |
8.0 |
davcore.virusscan.port |
string |
Port of the MTA host that is configured to accept virus scans. |
25 |
N/A |
N/A |
8.0 |
davcore.virusscan.starttls |
boolean |
Determines if the virus scan connection should use starttls. |
false |
N/A |
N/A |
8.0 |
davcore.virusscan.timeout |
string |
Timeout value (in milliseconds) for the connection to the MTA host during a virus scan operation. |
10000 |
N/A |
N/A |
8.0 |
davcore.virusscan.user |
string |
The SMTP authorization user for the SMTP virus scan connection. |
N/A |
N/A |
N/A |
8.0 |
davcore.virusscan.usessl |
boolean |
Determines if the virus scan connection should use SSL. |
false |
N/A |
N/A |
8.0 |
log.dav.commands.logdateformat |
logdateformat |
Specifies the date format pattern for the log. |
yyyy-MM-dd'T'HH:mm:ss.SSSZ |
N/A |
N/A |
8.0 |
log.dav.commands.logdir |
filepath |
Directory path for log files. |
logs |
N/A |
N/A |
8.0 |
log.dav.commands.loglevel |
loglevel |
Specifies the log level. Valid levels are OFF (no information is logged), SEVERE, WARNING, INFO, CONFIG, FINE, FINER, FINEST, and ALL (all information is logged). The FINEST and ALL levels produce a large amount of data. |
INFO |
N/A |
N/A |
8.0 |
log.dav.commands.logtoparent |
boolean |
Flag to enable logging to the application server log file, in addition to the Contacts Server logs. |
false |
N/A |
N/A |
8.0 |
log.dav.commands.maxlogfiles |
integer |
Maximum number of log files. |
10 |
1 |
100 |
8.0 |
log.dav.commands.maxlogfilesize |
integer (bytes) |
Maximum size of each log file. |
2097152 |
2097152 |
Maximum int value |
8.0 |
log.dav.errors.logdateformat |
logdateformat |
Specifies the date format pattern for the log. |
yyyy-MM-dd'T'HH:mm:ss.SSSZ |
N/A |
N/A |
8.0 |
log.dav.errors.logdir |
filepath |
Directory path for log files. |
logs |
N/A |
N/A |
8.0 |
log.dav.errors.loglevel |
loglevel |
Specify the log level. Valid levels are OFF (no information is logged), SEVERE, WARNING, INFO, CONFIG, FINE, FINER, FINEST, and ALL (all information is logged). The FINEST and ALL levels produce a large amount of data. |
INFO |
N/A |
N/A |
8.0 |
log.dav.errors.logtoparent |
boolean |
Flag to enable logging to the application server log file, in addition to the Contacts Server logs. |
false |
N/A |
N/A |
8.0 |
log.dav.errors.maxlogfiles |
integer |
Maximum number of log files. |
10 |
1 |
100 |
8.0 |
log.dav.errors.maxlogfilesize |
integer (bytes) |
Maximum size of each log file. |
2097152 |
2097152 |
Maximum int value |
8.0 |
log.dav.scan.logdateformat |
logdateformat |
Specifies the date format pattern for the log. |
yyyy-MM-dd'T'HH:mm:ss.SSSZ |
N/A |
N/A |
8.0 |
log.dav.scan.logdir |
filepath |
Directory path for log files. |
logs |
N/A |
N/A |
8.0 |
log.dav.scan.loglevel |
loglevel |
Specifies the log level. Valid levels are OFF (no information is logged), SEVERE, WARNING, INFO, CONFIG, FINE, FINER, FINEST, and ALL (all information is logged). The FINEST and ALL levels produce a large amount of data. |
INFO |
N/A |
N/A |
8.0 |
log.dav.scan.logtoparent |
boolean |
Flag to enable logging to the application server log file, in addition to the Contacts Server logs. |
false |
N/A |
N/A |
8.0 |
log.dav.scan.maxlogfiles |
integer |
Maximum number of log files |
10 |
1 |
100 |
8.0 |
log.dav.scan.maxlogfilesize |
integer (bytes) |
Maximum size of each log file |
2097152 |
2097152 |
Maximum int value |
8.0 |
log.dav.telemetry.logdateformat |
logdateformat |
Specifies the date format pattern for the log. |
yyyy-MM-dd'T'HH:mm:ss.SSSZ |
N/A |
N/A |
8.0 |
log.dav.telemetry.logdir |
filepath |
Directory path for log files. |
logs |
N/A |
N/A |
8.0 |
log.dav.telemetry.loglevel |
loglevel |
Specifies the log level. Valid levels are OFF (no information is logged), SEVERE, WARNING, INFO, CONFIG, FINE, FINER, FINEST, and ALL (all information is logged). The FINEST and ALL levels produce a large amount of data. |
INFO |
N/A |
N/A |
8.0 |
log.dav.telemetry.logtoparent |
boolean |
Flag to enable logging to the application server log file, in addition to the Contacts Server logs. |
false |
N/A |
N/A |
8.0 |
log.dav.telemetry.maxlogfiles |
integer |
Maximum number of log files. |
10 |
1 |
100 |
8.0 |
log.dav.telemetry.maxlogfilesize |
integer (bytes) |
Maximum size of each log file. |
2097152 |
2097152 |
Maximum int value |
8.0 |
notification.dav.configdir |
filepath |
Directory path for notification configuration files or format files |
config/templates |
N/A |
N/A |
8.0 |
notification.dav.dateformat |
dateformat |
Specifies the date format pattern for notification. For example, EEE MMMMM dd, yyyy. |
EEE MMMMM dd, yyyy |
N/A |
N/A |
8.0 |
notification.dav.enableemailnotif |
boolean |
Enables server-wide email notification |
true |
N/A |
N/A |
8.0 |
notification.dav.enablejmsnotif |
boolean |
Enables server-wide JMS notification |
true |
N/A |
N/A |
8.0 |
notification.dav.maxpayload |
integer |
Maximum payload size in bytes. |
10000000 |
-2147483648 |
Maximum int value |
8.0 |
notification.dav.smtpauth |
string |
SMTP-AUTH access control mechanism flag. |
false |
N/A |
N/A |
8.0 |
notification.dav.smtpdebug |
string |
Specifies SMTP debug flag. |
false |
N/A |
N/A |
8.0 |
notification.dav.smtphost |
string |
Specifies SMTP host. |
N/A |
N/A |
N/A |
8.0 |
notification.dav.smtppassword |
password |
Specifies SMTP password. |
N/A |
N/A |
N/A |
8.0 |
notification.dav.smtpport |
string |
Specifies SMTP port. |
25 |
N/A |
N/A |
8.0 |
notification.dav.smtpstarttls |
string |
Use SMTP starttls flag. |
true |
N/A |
N/A |
8.0 |
notification.dav.smtpuser |
string |
Specifies SMTP user. |
user |
N/A |
N/A |
8.0 |
notification.dav.smtpusessl |
string |
Specifies SMTP to use SSL flag. |
false |
N/A |
N/A |
8.0 |
notification.dav.timeformat |
timeformat |
Specifies the time format pattern for notification. Use 'a' for AM/PM marker. For example, hh:mm:ss aaa. |
hh:mm:ss aaa |
N/A |
N/A |
8.0 |
notification.dav.timezoneformat |
timezoneformat |
Specifies the time zone format pattern for notification. Use 'z' for general time zone, or 'Z' for RFC822 time zone. |
z |
N/A |
N/A |
8.0 |
service.dav.blacklist |
string |
List of clients to be denied of service, expressed as a space separated list of regular expressions. Any client whose User-Agent HTTP header contains any of the regex is denied access. |
N/A |
N/A |
N/A |
8.0 |
service.dav.propfinddavheadervalue |
string |
Value of the HTTP Dav header value to return in all PROPFIND responses. |
1, 3, access-control, addressbook |
N/A |
N/A |
8.0 |
service.dav.telemetry.filter |
string |
Space separated list of request URIs that a particular request should match (start with) to be logged by telemetry. For example: /dav/home/jsmith/addressbook/ /dav/home/jdoe/addressbook/ |
N/A |
N/A |
N/A |
8.0 |
service.dav.telemetry.forcetelemetry |
boolean |
Force telemetry for all users. Use with caution, as it causes lots of data to be generated. |
false |
N/A |
N/A |
8.0 |
store.corpdir.defaultcorpdirectoryurl |
string |
Default corporate directory information to use when performing searches. Can be overwritten by domain specific information (corpDirectoryUrl LDAP attribute in the domain entry). If no baseDN is provided, the user's domain baseDN for users and group is used. The list of attributes to retrieve is ignored. |
ldap://ugldap/??sub?(objectclass=inetorgperson) |
N/A |
N/A |
8.0 |
store.corpdir.enablecorpdir |
boolean |
Enable or disable corporate directory lookups. |
true |
N/A |
N/A |
8.0 |
store.corpdir.useldapproxyauth |
boolean |
If true, uses LDAP proxy authorization to issue LDAP searches on behalf of the logged-in user. If false, uses the LDAP Pool credentials for all LDAP searches. This parameter applies only to the default corporate directory configuration. |
true |
N/A |
N/A |
8.0 |
store.dav.*.attachstorehost |
string |
Specifies document store host. |
N/A |
N/A |
N/A |
8.0 |
store.dav.*.attachstoreport |
integer |
Specifies document store port. |
8008 |
-2147483648 |
Maximum int value |
8.0 |
store.dav.*.backendid |
string |
Specifies back-end identifier. |
- |
N/A |
N/A |
8.0 |
store.dav.*.dbdir |
filepath |
Specifies directory path for nabstore. |
data/db |
N/A |
N/A |
8.0 |
store.dav.*.jndiname |
string |
JNDI name pointing to this back end's JDBC DataSource, as defined in the J2EE container (for example, jdbc/defaultbackend). |
N/A |
N/A |
N/A |
8.0 |
store.dav.*.purgedelay |
long (seconds) |
Sets the delay between deletion of a resource and its actual removal (purge) from the back end. Setting this value too low might cause synchronization clients to perform a full resynchronization too often. |
2592000 |
0 |
Maximum long value |
8.0 |
store.document.password |
password |
Password to use when authenticating to a remote document store. |
N/A |
N/A |
N/A |
8.0 |
store.document.timeout |
integer |
The HTTP(S) connection and read timeout value. |
10000 |
-2147483648 |
Maximum int value |
8.0 |
store.document.usessl |
boolean |
Use SSL for communications with remote document store. |
false |
N/A |
N/A |
8.0 |