Oracle GlassFish Server 3.0.1 Upgrade Guide

HTTP Service to Network Service Changes

In GlassFish Server 3.0.1 and Sun GlassFish Enterprise Server v3, most HTTP Service settings are in the Network Service configuration that was introduced in Sun GlassFish Enterprise Server v3.

The changes are described in the following sections.

Changes to Dotted Names

The dotted name hierarchy for the HTTP Service configuration in the v3 Prelude release is shown below. Elements that are no longer supported are request-processing, keep-alive, connection-pool, http-protocol, http-file-cache, and http-listener. During the upgrade process, these discontinued elements are remapped to the new configuration automatically and then deleted.

config
    http-service
        access-log
        request-processing
        keep-alive
        connection-pool
        http-protocol
        http-file-cache
        http-listener
            ssl 
            property
        virtual-server
            http-access-log
            property
        property
    thread-pools
        thread-pool

The dotted name hierarchy for the new Network Service and HTTP Service configurations is shown below. The network-config element and all its children are new except for ssl.

config
    network-config
        transports
            selection-key-handler
            transport
        protocols
            protocol
                http
                    file-cache
                port-unification
                    protocol-finder
                protocol-chain-instance-handler
                    protocol-chain
                protocol-filter
                ssl
        network-listeners
            network-listener
    http-service
        access-log
        virtual-server
            http-access-log
            property
        property
    thread-pools
        thread-pool

The following examples compare the commands for setting a listener port for Sun GlassFish Enterprise Server v3 Prelude and GlassFish Server 3.0.1 or Sun GlassFish Enterprise Server v3.

Command for Sun GlassFish Enterprise Server v3 Prelude:

asadmin set server-config.http-service.http-listener.http-1.listenerport=4321

Command for GlassFish Server 3.0.1 or Sun GlassFish Enterprise Server v3:

asadmin set server-config.network-config.network-listeners.network-listener.http-1.listenerport=4321

Changes to `asadmin` Commands

To accommodate the move of HTTP Service into the new Network Service configuration, asadmin(1M) commands are changed as follows:

The create-ssl(1) command has a new --type parameter value, network-listener.
The create-virtual-server(1) command has a new parameter, --networklisteners.
The create-http-listener(1) command adds a network-listener element to the domain configuration. The syntax and options of this commands are unchanged.

Remapping of HTTP Service Attributes and Properties

The following tables describe how attributes and properties in the HTTP Service configuration for v3 Prelude are remapped to attributes in the Network Service configuration for GlassFish Server 3.0.1 and Sun GlassFish Enterprise Server v3. If you use a configuration from a Sun GlassFish Enterprise Server v2 or v3 release, this remapping happens automatically and then discontinued elements are deleted.

Table 1–2 com.sun.grizzly Property Remapping


`com.sun.grizzly` Property	New Owning Element	New Attribute Name
`selector.timeout`	`transport`	`selector-poll-timeout-millis`
`displayConfiguration`	`transport`	`display-configuration`
`enableSnoop`	`transport`	`snoop-enabled`
`readTimeout`	`transport`	`read-timeout-millis`
`writeTimeout`	`transport`	`write-timeout-millis`

Table 1–3 connection-pool Attribute Remapping


`connection-pool` Attribute	New Owning Element	New Attribute Name
`queue-size-in-bytes`	`thread-pool`	`max-queue-size`
`max-pending-count`	`transport`	`max-connections-count`
`receive-buffer-size-in-bytes`	`http`	`request-body-buffer-size-bytes`
`send-buffer-size-in-bytes`	`http`	`send-buffer-size-bytes`

Table 1–4 http-file-cache Attribute Remapping


`http-file-cache` Attribute	New Owning Element	New Attribute Name
`file-caching-enabled`	`file-cache`	`enabled`
`max-age-in-seconds`	`file-cache`	`max-age-seconds`
`medium-file-space-in-bytes`	`file-cache`	`max-cache-size-bytes`
`max-files-count`	`file-cache`	`max-files-count`
`globally-enabled`	none	not supported
`medium-file-size-limit-in-bytes`	none	not supported
`small-file-size-limit-in-bytes`	none	not supported
`small-file-space-in-bytes`	none	not supported
`file-transmission-enabled`	none	not supported
`hash-init-size`	none	not supported

Table 1–5 http-listener Attribute Remapping


`http-listener` Attribute	New Owning Element	New Attribute Name
`id`	`network-listener`	`name`
`address`	`network-listener`	`address`
`port`	`network-listener`	`port`
`enabled`	`network-listener`	`enabled`
`acceptor-threads`	`transport`	`acceptor-threads`
`security-enabled`	`protocol`	`security-enabled`
`default-virtual-server`	`http`	`default-virtual-server`
`server-name`	`http`	`server-name`
`redirect-port`	`http`	`redirect-port`
`xpowered-by`	`http`	`xpowered-by`
`external-port`	none	not supported
`family`	none	not supported
`blocking-enabled`	none	not supported

Table 1–6 http-listener Property Remapping


`http-listener` Property	New Owning Element	New Attribute Name
`maxKeepAliveRequests`	`http`	`max-connections`
`authPassthroughEnabled`	`http`	`auth-pass-through-enabled`
`compression`	`http`	`compression`
`compressableMimeType`	`http`	`compressable-mime-type`
`noCompressionUserAgents`	`http`	`no-compression-user-agents`
`compressionMinSize`	`http`	`compression-min-size-bytes`
`restrictedUserAgents`	`http`	`restricted-user-agents`
`cometSupport`	`http`	`comet-support-enabled`
`connectionUploadTimeout`	`http`	`connection-upload-timeout-millis`
`disableUploadTimeout`	`http`	`upload-timeout-enabled`
`chunkingDisabled`	`http`	`chunking-enabled`
`uriEncoding`	`http`	`uri-encoding`
`traceEnabled`	`http`	`trace-enabled`
`rcmSupport`	`http`	`rcm-support-enabled`
`jkEnabled`	`network-listener`	`jk-enabled`
`crlFile`	`ssl`	`crl-file`
`trustAlgorithm`	`ssl`	`trust-algorithm`
`trustMaxCertLength`	`ssl`	`trust-max-cert-length-bytes`
`tcpNoDelay`	`transport`	`tcp-no-delay`
`bufferSize`	`transport`	`buffer-size-bytes`
`use-nio-direct-bytebuffer`	`transport`	`byte-buffer-type`
`proxyHandler`	none	not supported
`proxiedProtocols`	none	not supported
`recycle-objects`	none	not supported
`reader-threads`	none	not supported
`acceptor-queue-length`	none	not supported
`reader-queue-length`	none	not supported
`connectionTimeout`	none	not supported
`monitoring-cache-enabled`	none	not supported
`monitoring-cache-refresh-in-millis`	none	not supported
`ssl-cache-entries`	none	not supported
`ssl3-session-timeout`	none	not supported
`ssl-session-timeout`	none	not supported

Table 1–7 http-protocol Attribute Remapping


`http-protocol` Attribute	New Owning Element	New Attribute Name
`version`	`http`	`version`
`forced-response-type`	`http`	`forced-response-type`
`default-response-type`	`http`	`default-response-type`
`dns-lookup-enabled`	none	not supported
`ssl-enabled`	none	not supported

Table 1–8 http-service Property Remapping


`http-service` Property	New Owning Element	New Attribute or Property Name
`accessLoggingEnabled`	`http-service`, `virtual-server`	`access-logging-enabled` attribute
`ssl-cache-entries`	`http-service`	unchanged property
`ssl3-session-timeout`	`http-service`	unchanged property
`ssl-session-timeout`	`http-service`	unchanged property
`proxyHandler`	`http-service`	unchanged property
`connectionTimeout`	`http-service`	unchanged property
all other properties	none	not supported

Table 1–9 keep-alive Attribute Remapping


`keep-alive` Attribute	New Owning Element	New Attribute Name
`max-connections`	`http`	`max-connections`
`timeout-in-seconds`	`http`	`timeout-seconds`
`thread-count`	none	not supported

Table 1–10 request-processing Attribute Remapping


`request-processing` Attribute	New Owning Element	New Attribute Name
`thread-count`	`thread-pool`	`max-thread-pool-size`
`initial-thread-count`	`thread-pool`	`min-thread-pool-size`
`header-buffer-length-in-bytes`	`http`	`header-buffer-length-bytes`
`request-timeout-in-seconds`	`http`	`request-timeout-seconds`
`thread-increment`	none	not supported

Table 1–11 ssl Attribute Changes


Previous Attribute or Property	Previous Owning Element	New `ssl` Attribute
none	none	`key-store`
none	none	`trust-store`
`crlFile` property	`http-listener`	`crl-file`
`trustAlgorithm` property	`http-listener`	`trust-algorithm`
`trustMaxCertLength` property	`http-listener`	`trust-max-cert-length-bytes`
all other `ssl` attributes	`ssl`	unchanged

Table 1–12 thread-pool Attribute Changes


Previous Attribute	Previous Owning Element	New `thread-pool` Attribute
none	none	`classname`
none	none	`max-queue-size`
`thread-pool-id`	`thread-pool`	`name`
`idle-thread-timeout-in-seconds`	`thread-pool`	`idle-thread-timeout-seconds`
`num-work-queues`	`thread-pool`	not supported
all other `thread-pool` attributes	`thread-pool`	unchanged

Table 1–13 virtual-server Attribute Changes


Previous Attribute or Property	Previous Owning Element	New `virtual-server` Attribute
`http-listeners` attribute	`virtual-server`	`network-listeners`
`accessLoggingEnabled` property	`http-service`	`access-logging-enabled`
`sso-enabled` property	`virtual-server`	`sso-enabled`
`ssoCookieSecure` property	`virtual-server`	`sso-cookie-secure`
all other `virtual-server` attributes	`virtual-server`	unchanged
all other `virtual-server` properties	`virtual-server`	unchanged, still properties

New Network Service Elements and Attributes

The following tables describe the Network Service elements and attributes that were introduced in Sun GlassFish Enterprise Server v3. For attributes and properties remapped from discontinued elements to new elements, see Remapping of HTTP Service Attributes and Properties.

The new file-cache element has no new attributes. All of its attributes are remapped from the http-file-cache element. For details, see Table 1–4.

Table 1–14 New http Attributes


Attribute	Default	Description
`adapter`	`com.sun.grizzly.tcp.StaticResourcesAdapter`	(Optional) Specifies the class name of the static resources adapter.
`max-post-size-bytes`	`2097152`	(Optional) Specifies the maximum size of `POST` actions.

For remapped http attributes, see Table 1–3, Table 1–5, Table 1–6, Table 1–7, Table 1–9, and Table 1–10.

Table 1–15 New network-listener Attributes


Attribute	Default	Description
`protocol`	none	Specifies the `name` of the `protocol` associated with this `network-listener`. Although this attribute is required, a `protocol` is automatically created with the same `name` as the `network-listener` when you use `asadmin create-http-listener` to create a `network-listener`.
`thread-pool`	none	(Optional) Specifies the `name` of the `thread-pool` associated with this `network-listener`.
`transport`	none	Specifies the `name` of the `transport` associated with this `network-listener`. Although this attribute is required, the default `transport` is used when you use `asadmin create-http-listener` to create a `network-listener`.

For remapped network-listener attributes, see Table 1–5.

Table 1–16 New port-unification Attributes


Attribute	Default	Description
`name`	none	Specifies a unique name for the `port-unification`.
`classname`	none	Specifies the class name of the `port-unification` implementation.

Table 1–17 New protocol Attributes


Attribute	Default	Description
`name`	none	Specifies a unique name for the `protocol`.

For remapped protocol attributes, see Table 1–5.

Table 1–18 New protocol-chain Attributes


Attribute	Default	Description
`name`	none	Specifies a unique name for the `protocol-chain`.
`classname`	none	Specifies the class name of the `protocol-chain` implementation.
`type`	`STATELESS`	Specifies the type of protocol chain.

Table 1–19 New protocol-chain-instance-handler Attributes


Attribute	Default	Description
`name`	none	Specifies a unique name for the `protocol-chain-instance-handler`.
`classname`	none	Specifies the class name of the `protocol-chain-instance-handler` implementation.

Table 1–20 New protocol-filter Attributes


Attribute	Default	Description
`name`	none	Specifies a unique name for the `protocol-filter`.
`classname`	none	Specifies the class name of the `protocol-filter` implementation.

Table 1–21 New protocol-finder Attributes


Attribute	Default	Description
`name`	none	Specifies a unique name for the `protocol-finder`.
`classname`	none	Specifies the class name of the `protocol-finder` implementation.
`protocol`	none	Specifies the `name` of the `protocol` associated with this `protocol-finder`.

Table 1–22 New selection-key-handler Attributes


Attribute	Default	Description
`name`	none	Specifies a unique name for the `selection-key-handler`.
`classname`	none	Specifies the class name of the `selection-key-handler` implementation.

Table 1–23 New ssl Attributes


Attribute	Default	Description
`key-store`	none	(Optional) Specifies a key store.
`trust-store`	none	(Optional) Specifies a trust store.

For remapped ssl attributes, see Table 1–11.

Table 1–24 New thread-pool Attributes


Attribute	Default	Description
`classname`	`com.sun.grizzly.http.StatsThreadPool`	(Optional) Specifies the class name of the `thread-pool` implementation.
`max-queue-size`	`-1`	(Optional) Specifies the maximum number of messages that can be queued until threads are available to process them. A value of `-1` specifies no limit.

For remapped thread-pool attributes, see Table 1–3, Table 1–10, and Table 1–12.

Table 1–25 New transport Attributes


Attribute	Default	Description
`name`	none	Specifies a unique name for the `transport`.
`classname`	`com.sun.grizzly.TCPSelectorHandler`	(Optional) Specifies the class name of the `transport` implementation.
`selection-key-handler`	none	(Optional) Specifies the `name` of the `selection-key-handler` associated with this `transport`.
`idle-key-timeout-seconds`	`30`	(Optional) Specifies the idle key timeout.

For remapped transport attributes, see Table 1–2, Table 1–3, Table 1–5, and Table 1–6.

HTTP Service to Network Service Changes

Changes to Dotted Names

Changes to asadmin Commands

Remapping of HTTP Service Attributes and Properties

New Network Service Elements and Attributes

Changes to `asadmin` Commands