Listener Elements

DESCRIPTION

zero or one 

Contains a text description of the listen socket. 

SSLPARAMS

zero or one 

Defines Secure Socket Layer (SSL) parameters. 

id

none 

(Optional) The socket family type. A socket family type cannot begin with a number. 

When you create a secure listen socket in the server.xml file, security must be turned on in magnus.conf. When you create a secure listen socket in the Server Manager, security is automatically turned on globally in magnus.conf.

ip

any 

Specifies the IP address of the listen socket. Can be in dotted-pair or IPv6 notation. Can also be any for INADDR_ANY.

port

none 

Port number to create the listen socket on. Legal values are 1 - 65535. On UNIX, creating sockets that listen on ports 1 - 1024 requires superuser privileges. Configuring an SSL listen socket to listen on port 443 is recommended. Two different IP addresses can’t use the same port.

security

false

(Optional) Determines whether the listen socket runs SSL. Legal values are on, off, yes, no, 1, 0, true, false. You can turn SSL2 or SSL3 on or off and set ciphers using an SSLPARAMS subelement for this listen socket.

The Security setting in the magnus.conf file globally enables or disables SSL by making certificates available to the server instance. Therefore, Security in magnus.conf must be on or security in server.xml does not work. For more information, see Chapter 3, Syntax and Use of magnus.conf

acceptorthreads

1

(Optional) Number of acceptor threads for the listener. The recommended value is the number of processors in the machine. Legal values are 1 - 1024.

family

none 

(Optional) The socket family type. Legal values are inet, inet6, and nca. Use the value inet6 for IPv6 listen sockets. When using the value of inet6, IPv4 addresses are prefixed with ::ffff: in the log file. Specify nca to use the Solaris Network Cache and Accelerator.

blocking

false 

(Optional) Determines whether the listen socket and the accepted socket are put in to blocking mode. Use of blocking mode may improve benchmark scores. Legal values are on, off, yes, no, 1, 0, true, false.

defaultvs

none 

The id attribute of the default virtual server for this particular listen socket.

servername

none 

Tells the server what to put in the host name section of any URLs it sends to the client. This affects URLs the server automatically generates. it does not affect the URLs for directories and files stored in the server. This name should be the alias name if your server uses an alias. 

If you append a colon and port number, that port will be used in URLs the server sends to the client. 

servercertnickname

Server-Cert

The nickname of the server certificate in the certificate database or the PKCS#11 token. In the certificate, the name format is tokenname:nickname. Including the tokenname: part of the name in this attribute is optional.

ssl2

false

(Optional) Determines whether SSL2 is enabled. Legal values are on, off, yes, no, 1, 0, true, and false. If both SSL2 and SSL3 are enabled for a virtual server, the server tries SSL3 encryption first. If that fails, the server tries SSL2 encryption.

ssl2ciphers

none 

(Optional) A space-separated list of the SSL2 ciphers used, with the prefix + to enable or - to disable. For example +rc4. Allowed values are rc4, rc4export, rc2, rc2export, idea, des, desede3.

ssl3

true

(optional) Determines whether SSL3 is enabled. Legal values are on, off, yes, no, 1, 0, true and false. If both SSL2 and SSL3 are enabled for a virtual server, the server tries SSL3 encryption first. If that fails, the server tries SSL2 encryption.

ssl3tlsciphers

none 

(optional) A space-separated list of the SSL3 ciphers used, with the prefix + to enable or - to disable, for example +rsa_des_sha. Allowed SSL3 values are rsa_rc4_128_md5, rsa_3des_sha, rsa_des_sha, rsa_rc4_40_md5, rsa_rc2_40_md5, rsa_null_md5. Allowed TLS values are rsa_des_56_sha, rsa_rc4_56_sha.

tls

true

(optional) Determines whether TLS is enabled. Legal values are on, off, yes, no, 1, 0, true, and false.

tlsrollback

true

(optional) Determines whether TLS rollback is enabled. Legal values are on, off, yes, no, 1, 0, true, and false. TLS rollback should be enabled for Microsoft Internet Explorer 5.0 and 5.5.

clientauth

false

(optional) Determines whether SSL3 client authentication is performed on every request, independent of ACL-based access control. Legal values are on, off, yes, no, 1, 0, true, and false.

id

none 

Internal name for the MIME types listing. Used in a VS element to define the MIME types used by the virtual server. The MIME types name cannot begin with a number.

file

none 

The name of a MIME types file. For more information, see Chapter 5, MIME Types.

DESCRIPTION

Zero or one 

Contains a text description of the ACLFILE element

id

none 

Internal name for the ACL file listing. Used in a VS element to define the ACL file used by the virtual server. An ACL file listing name cannot begin with a number.

file

none 

A space-separated list of ACL files. Each ACL file must have a unique name. For information about the format of an ACL file, see the Sun Java System Web Server 6.1 SP10 Administrator’s Guide.

The name of the default ACL file is generated.https-server_id.acl, and the file resides in the server_root/server_id/httpacl directory. To use this file, you must reference it in server.xml.

DESCRIPTION

zero or one 

Contains a text description of the VSCLASS.

VARS

zero or one 

Specifies a property of the VSCLASS.

PROPERTY

zero or more 

Specifies a property of the VSCLASS.

VS

zero or more 

Defines a virtual server. 

QOSPARAMS

zero or one 

Defines quality of service parameters. 

id

none 

Virtual server class ID. This is a unique ID that allows lookup of a specific virtual server class. A virtual server class ID cannot begin with a number. 

objectfile

obj.conf

The obj.conf file for this class of virtual servers. Cannot be overridden in a VS element.

rootobject

default 

(Optional) Tells the server which object loaded from an obj.conf file is the default. The default object is expected to have all the name translation (NameTrans) directives for the virtual server, any server behavior that is configured in the default object affects the entire server.

If you specify an object that doesn’t exist, the server does not report an error until a client tries to retrieve a document. The Server Manager assumes the default to be the object named default. Do not deviate from this convention if you use (or plan to use) the Server Manager.

acceptlanguage

false

(Optional) If true, the server parses the Accept-Language header and sends an appropriate language version based on which language the client can accept. You should set this value to on only if the server supports multiple languages. Can be overridden in a VS element.

Legal values are on, off, yes, no, 1, 0, true, and false.

DESCRIPTION

zero or one 

Contains a text description of this element. 

VARS

zero or one 

Specifies a property or a variable of the VS.

PROPERTY

zero or more 

Specifies a property or a variable of the VS.

QOSPARAMS

zero or one 

Defines quality of service parameters. 

USERDB

zero or more 

Defines the user database for the virtual server. 

DAV

zero or one 

Defines the WebDAV configuration for the virtual server. 

SEARCH

zero or one 

Defines the search configuration for the virtual server. 

WEBAPP

zero or more 

Specifies a web application. 

id

none 

Virtual server ID. This is a unique ID that allows lookup of a specific virtual server. Can also be referred to as the variable $id in an obj.conf file. A virtual server ID cannot begin with a number.

connections

none 

(optional) A space-separated list of LS ids that specify the connection(s) the virtual server uses. Required only for a VS that is not the defaultvs of a listen socket.

urlhosts

none 

A space-separated list of values allowed in the Host request header to select the current virtual server. Each VS that is configured to the same listen socket must have a unique urlhosts value for that group.

objectfile

objectfile of the enclosing VSCLASS

(optional) The file name of the obj.conf file for this virtual server.

rootobject

default

(optional) Tells the server which object loaded from an obj.conf file is the default.

Tells the server which object loaded from an obj.conf file is the default. The default object is expected to have all the name translation (NameTrans) directives for the virtual server; any server behavior that is configured in the default object affects the entire server.

If you specify an object that doesn't exist, the server doesn't report an error until a client tries to retrieve a document. 

mime

none 

The id of the MIME element used by the virtual server.

aclids

none 

(optional) One or more id attributes of ACLFILE elements, separated by commas. Specifies the ACL file(s) used by the virtual server.

errorlog

none 

(optional) Specifies a log file for virtual-server-specific error messages. See the LOG description for details about logs.

acceptlanguage

off

(optional) If true, the server parses the Accept-Language header and sends an appropriate language version based on which language the client can accept. You should set this value to on only if the server supports multiple languages.

Legal values are on, off, yes, no, 1, 0, true, false.

state

on

(optional) Determines whether a virtual-server is active (on) or inactive (off, disabled). The default is on (active). When inactive, a virtual server does not service requests.

If a virtual server is disabled, only the global server administrator can turn it on. 

maxbps

none 

(required if enforcebandwidth is yes) The maximum bandwidth limit for the server, vsclass, or vs in bytes per second.

enforcebandwidth

false

(optional) Specifies whether the bandwidth limit should be enforced or not. Allowed values are yes, no, true, false, on, off, 1, 0.

maxconn

none 

(required if enforceconnections is yes) The maximum number of concurrent connections for the SERVER, VSCLASS, or VS.

enforceconnections

false

(optional) Specifies whether the connection limit should be enforced or not. Allowed values are yes, no, true, false, on, off, 1, 0.

DESCRIPTION

zero or one 

Contains a text description of this element. 

id

none 

The user database name in the virtual server's ACL file. A user database name cannot begin with a number. 

database

none 

The user database name in the dbswitch.conf file.

basedn

none 

(optional) Overrides the base DN lookup in the dbswitch.conf file. However, the basedn value is still relative to the base DN value from the dbswitch.conf entry.

certmaps

none 

(optional) Specifies which certificate mapped to LDAP entry mappings (defined in certmap.conf) to use. If not present, all mappings are used. All lookups based on mappings in certmap.conf are relative to the final base DN of the VS.