Oracle GlassFish Server 3.0.1 Domain File Format Reference

Attributes

The following table describes attributes for the virtual-server element.

Table 1–176 virtual-server Attributes

Attribute 

Default 

Description 

id

none 

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

http-listeners

none 

(optional) Remapped to the network-listeners attribute of this element.

network-listeners

none 

(optional) In a comma-separated list, references id attributes of network-listener elements that specify the connection(s) the virtual server uses. Required only for a virtual-server that is not referenced by the default-virtual-server attribute of an http element.

default-web-module

none 

(optional) References the name attribute of the default web application for this virtual server, which responds to requests that cannot be resolved to other web modules deployed to this virtual server (see the application-ref element).

hosts

${com.sun.aas.hostName}

A comma-separated list of values, each of which selects the current virtual server when included in the Host request header. Two or more virtual-server elements that reference or are referenced by the same http-listener cannot have any hosts values in common.

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.

docroot

domain-dir/docroot

(optional) Specifies the document root for this virtual server. 

access-log

domain-dir/logs/access

(optional) Specifies the access log location. The file and directory in which the access log is kept must be writable by the user account under which the server runs. See the log-service description for details about logs.

log-file

server.log in the directory specified by the log-root attribute of the domain element

(optional) Writes this virtual server’s log messages to a log file separate from the server log. The file and directory in which the virtual server log is kept must be writable by the user account under which the server runs. See the log-service description for details about logs.

access-logging-enabled

inherit

If true, enables access logging for this virtual server. If false, disables access logging for this virtual server.

A true or false setting overrides the access-logging-enabled attribute setting of the http-service element. An inherit setting uses the access-logging-enabled attribute setting of the http-service element.

sso-enabled

inherit

If true, single sign-on is enabled for web applications on this virtual server that are configured for the same realm. If false, single sign-on is disabled for this virtual server, and users must authenticate separately to every application on the virtual server.

A true or false setting overrides the sso-enabled attribute setting of the http-service element. An inherit setting uses the sso-enabled attribute setting of the http-service element.

sso-cookie-secure

dynamic

Sets the Secure attribute of any JSESSIONIDSSO cookies associated with the web applications deployed to this virtual server. Applicable only if the sso-enabled attribute is set to true. Allowed values are as follows:

  • true — Sets Secure to true.

  • false — Sets Secure to false.

  • dynamic — The JSESSIONIDSSO cookie inherits the Secure setting of the first session participating in SSO.

To set the Secure attribute of a JSESSIONID cookie, use the cookieSecure cookie-properties property in the sun-web.xml file. For details, see cookie-properties in Oracle GlassFish Server 3.0.1 Application Deployment Guide.