Sun Java System Application Server Enterprise Edition 8.1 2005Q2 Administration Guide

Admin Console Tasks for Virtual Servers

ProcedureTo create a virtual server

  1. In the tree component, expand the Configurations node.

  2. Select the instance to configure:

    • To configure a particular instance, select the instance’s config node. For example, for the default instance, server, select the server-config node.

    • To configure the default settings for future instances that use a copy of default-config, select the default-config node.

  3. Expand the HTTP Service node.

  4. Select the Virtual Servers node.

  5. On the Virtual Servers page, click New.

    The Create Virtual Server page appears.

  6. In the ID field, type a unique name for the virtual server.

    This value is used to identify the virtual server internally. It is not exposed to HTTP clients. The host names that are exposed to HTTP clients must be specified in the Hosts field.

  7. In the Hosts field, type the host name or names for the machine on which the server is running.

    Use either actual or virtual host names that are registered with the DNS server for your network (and, on a UNIX system, in your /etc/hosts file).

  8. In the area opposite State, select either On, Off, or Disabled.

    The default is On.

  9. Leave the HTTP Listeners field empty.

    It is filled in automatically when you create an HTTP listener and associate it with this server.

    Use of this field requires that you specify an existing HTTP listener. You must not, however, specify a listener that is used by another virtual server; if you do, an error appears in the server log. Since a listener must be associated with an existing virtual server when it is created, all existing listeners are used by another virtual server.

  10. From the Default Web Module drop-down list, choose the deployed web module (if any) that is to respond to all requests that cannot be mapped to other web modules deployed to the virtual server.

    If a Default Web Module is not specified, the web module that has an empty context root is used. If there is no web module with an empty context root, a system default web module is created and used.

  11. In the Log File field, type the path name of the file where logging messages from this virtual server will appear.

    Leave this field empty to send logging messages to the default server log, domain-dir/logs/server.log.

  12. In the Additional Properties area, click Add Property to add a property for the virtual server.

    Whether you specify properties or not, the new server has the default properties docroot and accesslog, set to default values.

    The following table lists the available virtual server properties.

    Property Name  

    Description  

    docroot

    Absolute path to root document directory for server. 

    Default is domain-dir/docroot.

    accesslog

    Absolute path to server access logs. 

    Default is domain-dir/logs/access.

    sso-enabled

    If false, single sign-on is disabled for this virtual server, and users must authenticate separately to every application on the virtual server. 

    Single sign-on across applications on the Application Server is supported by servlets and JSP pages. This feature allows multiple applications that require the same user sign-on information to share this information, rather than have the user sign on separately for each application. 

    Default is true. 

    sso-max-inactive-seconds

    Specifies the number of seconds after which a user’s single sign-on record becomes eligible for purging if no client activity is received. Since single sign-on applies across several applications on the same virtual server, access to any of the applications keeps the single sign-on record active. 

    Default is 300 seconds (5 minutes). Higher values provide longer single sign-on persistence for users at the expense of more memory use on the server. 

    sso-reap-interval-seconds

    Specifies the number of seconds between purges of expired single sign-on records. 

    Default is 60. 

    allowLinking

    If true, resources that are symbolic links will be served for all web applications deployed on this virtual server. Individual web applications may override this setting by using the sun-web-app property allowLinking in the sun-web.xml file:

    <sun-web-app>
       <property name="allowLinking" 
          value="{true|false}"/>
    </sun-web-app>

    Default is true. 

  13. Click OK to save the virtual server.

Equivalent asadmin command

create-virtual-server

ProcedureTo edit a virtual server

  1. In the tree component, expand the Configurations node.

  2. Select the instance to configure:

    • To configure a particular instance, select the instance’s config node. For example, for the default instance, server, select the server-config node.

    • To configure the default settings for future instances that use a copy of default-config, select the default-config node.

  3. Expand the HTTP Service node.

  4. Select the Virtual Servers node.

  5. Select the virtual server to be edited.

  6. On the Edit Virtual Server page, you can perform these tasks:

    • Change the host name in the Hosts field.

    • Change the value of the State setting.

    • Add or remove an HTTP listener.

    • Change the Default Web Module selection.

    • Change the Log File value.

    • Add, remove, or modify properties.

  7. Click Save to save the changes.

ProcedureTo delete a virtual server

  1. In the tree component, expand the Configurations node.

  2. Select the instance to configure:

    • To configure a particular instance, select the instance’s config node. For example, for the default instance, server, select the server-config node.

    • To configure the default settings for future instances that use a copy of default-config, select the default-config node.

  3. Expand the HTTP Service node.

  4. Select the Virtual Servers node.

  5. On the Virtual Servers page, check the box next to the name of the virtual server to be deleted.

  6. Click Delete.

    It is possible to delete the __asadmin virtual server, but this is not recommended. If you plan to do so, first copy the virtual-server elements of the Application Server’s domain.xml file to a safe place so that the settings can be restored if needed.

Equivalent asadmin command

delete-virtual-server