com.sun.enterprise.config.serverbeans.VirtualServer Maven / Gradle / Ivy
/*
* Copyright (c) 2022, 2023 Contributors to the Eclipse Foundation
* Copyright (c) 1997, 2020 Oracle and/or its affiliates. All rights reserved.
*
* This program and the accompanying materials are made available under the
* terms of the Eclipse Public License v. 2.0, which is available at
* http://www.eclipse.org/legal/epl-2.0.
*
* This Source Code may also be made available under the following Secondary
* Licenses when the conditions for such availability set forth in the
* Eclipse Public License v. 2.0 are satisfied: GNU General Public License,
* version 2 with the GNU Classpath Exception, which is available at
* https://www.gnu.org/software/classpath/license.html.
*
* SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
*/
package com.sun.enterprise.config.serverbeans;
import jakarta.validation.constraints.NotNull;
import jakarta.validation.constraints.Pattern;
import java.beans.PropertyVetoException;
import java.util.ArrayList;
import java.util.List;
import java.util.Objects;
import java.util.Set;
import java.util.TreeSet;
import org.glassfish.api.admin.RestRedirect;
import org.glassfish.api.admin.RestRedirects;
import org.glassfish.api.admin.config.PropertiesDesc;
import org.glassfish.api.admin.config.PropertyDesc;
import org.glassfish.config.support.datatypes.PositiveInteger;
import org.glassfish.grizzly.config.dom.NetworkConfig;
import org.glassfish.grizzly.config.dom.NetworkListener;
import org.jvnet.hk2.config.Attribute;
import org.jvnet.hk2.config.ConfigBeanProxy;
import org.jvnet.hk2.config.Configured;
import org.jvnet.hk2.config.Element;
import org.jvnet.hk2.config.types.Property;
import org.jvnet.hk2.config.types.PropertyBag;
import static java.util.Arrays.stream;
import static java.util.stream.Collectors.toCollection;
/**
* Configuration of Virtual Server
*
* Virtualization in Application Server allows multiple URL domains to be served by
* the same HTTP server process, which is listening on multiple host addresses. If an
* application is available at two virtual servers, they still share same physical
* resource pools, such as JDBC connection pools. GlassFish allows a list of virtual servers,
* to be specified along with web-module and Jakarta EE application elements. This establishes
* an association between URL domains, represented by the virtual server and the
* web modules (standalone web modules or web modules inside the ear file).
*/
@Configured
@RestRedirects({
@RestRedirect(opType = RestRedirect.OpType.POST, commandName = "create-virtual-server"),
@RestRedirect(opType = RestRedirect.OpType.DELETE, commandName = "delete-virtual-server")
})
public interface VirtualServer extends ConfigBeanProxy, PropertyBag {
String VALUES_ACCESS_LOG_ENABLED = "(true|on|false|off|inherit)";
String VALUES_SSO_ENABLED = "(true|on|false|off|inherit)";
String VALUES_SSO_COOKIE_ENABLED = "(true|false|dynamic)";
String VALUES_STATE = "(on|off|disabled)";
/**
* Gets the value of the {@code id} property.
*
*
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.
*
* @return possible object is {@link String}
*/
@Attribute(key = true)
@NotNull
String getId();
/**
* Sets the value of the {@code id} property.
*
* @param id allowed object is {@link String}
*/
void setId(String id) throws PropertyVetoException;
/**
* Gets the value of the {@code httpListeners} property.
*
*
>Comma-separated list of http-listener id(s).
*
*
Required only for a Virtual Server that is not the default virtual server.
*
* @return possible object is {@link String}
*/
@Attribute
@Deprecated
String getHttpListeners();
/**
* Sets the value of the {@code httpListeners} property.
*
* @param httpListeners allowed object is {@link String}
*/
@Deprecated
void setHttpListeners(String httpListeners) throws PropertyVetoException;
/**
* Gets the value of the {@code networkListeners} property.
*
* @return possible object is {@link String}
*/
@Attribute
String getNetworkListeners();
/**
* Sets the value of the {@code networkListeners} property.
*
* @param networkListeners object is {@link String}
*/
void setNetworkListeners(String networkListeners) throws PropertyVetoException;
/**
* Gets the value of the {@code defaultWebModule} property.
*
*
Standalone web module associated with this virtual server by default.
*
* @return possible object is {@link String}
*/
@Attribute
String getDefaultWebModule();
/**
* Sets the value of the {@code defaultWebModule} property.
*
* @param defaultWebModule allowed object is {@link String}
*/
void setDefaultWebModule(String defaultWebModule) throws PropertyVetoException;
/**
* Gets the value of the {@code hosts} property.
*
*
A comma-separated list of values allowed in the {@code Host} request header
* to select current virtual server. Each Virtual Server that is configured
* to the same Connection Group must have a unique hosts value for that group.
*
* @return possible object is {@link String}
*/
@Attribute(defaultValue = "${com.sun.aas.hostName}")
@NotNull
String getHosts();
/**
* Sets the value of the {@code hosts} property.
*
* @param hosts allowed object is {@link String}
*/
void setHosts(String hosts) throws PropertyVetoException;
/**
* Gets the value of the {@code state} property.
*
*
Determines whether Virtual Server is active({@code on}) or
* inactive({@code off}, {@code disable}). The default is {@code on} (active).
*
*
When inactive, a Virtual Server does not service requests. {@code Off} returns a
* 404: Status code (404) indicating that the requested resource is not available,
* {@code disabled} returns a 403: Status code (403) indicating the server understood
* the request but refused to fulfill it.
*
* @return possible object is {@link String}
*/
@Attribute(defaultValue = "on")
@Pattern(regexp = VALUES_STATE, message = "Valid values: " + VALUES_STATE)
String getState();
/**
* Sets the value of the {@code state} property.
*
* @param state allowed object is {@link String}
*/
void setState(String state) throws PropertyVetoException;
/**
* Gets the value of the {@code docroot} property.
*
*
The location on the filesystem where the files related to the content
* to be served by this virtual server is stored.
*
* @return possible object is {@link String}
*/
@Attribute(defaultValue = "${com.sun.aas.instanceRoot}/docroot")
String getDocroot();
/**
* Sets the value of the {@code docroot} property.
*
* @param docroot allowed object is {@link String}
*/
void setDocroot(String docroot) throws PropertyVetoException;
/**
* Gets the value of the {@code accessLog} property.
*
* @return possible object is {@link String}
*/
@Attribute(defaultValue = "${com.sun.aas.instanceRoot}/logs/access")
String getAccessLog();
/**
* Sets the value of the {@code accessLog} property.
*
* @param accessLog allowed object is {@link String}
*/
void setAccessLog(String accessLog) throws PropertyVetoException;
/**
* Gets the value of the {@code ssoEnabled} property.
*
*
Possible values: {@code true}/{@code false}/{@code inherit}.
*
* @return possible object is {@link String}
*/
@Attribute(defaultValue = "inherit")
@Pattern(regexp = VALUES_SSO_ENABLED, message = "Valid values: " + VALUES_SSO_ENABLED)
String getSsoEnabled();
/**
* Sets the value of the {@code ssoEnabled} property.
*
* @param ssoEnabled allowed object is {@link String}
*/
void setSsoEnabled(String ssoEnabled) throws PropertyVetoException;
/**
* Gets the value of the access logging enabled property.
*
*
Possible values: {@code true}/{@code false}/{@code inherit}.
*
* @return possible object is {@link String}
*/
@Attribute(defaultValue = "inherit")
@Pattern(regexp = VALUES_ACCESS_LOG_ENABLED, message = "Valid values: " + VALUES_ACCESS_LOG_ENABLED)
String getAccessLoggingEnabled();
/**
* Sets the value of the access logging enabled property.
*
* @param accessLoggingEnabled allowed object is {@link String}
*/
void setAccessLoggingEnabled(String accessLoggingEnabled) throws PropertyVetoException;
/**
* Gets the value of the {@code logFile} property.
*
*
Specifies a log file for virtual-server-specific log messages. Default value is
* {@code ${com.sun.aas.instanceRoot}/logs/server.log}.
*
* @return possible object is {@link String}
*/
@Attribute(defaultValue = "${com.sun.aas.instanceRoot}/logs/server.log")
String getLogFile();
/**
* Sets the value of the {@code logFile} property.
*
* @param logFile allowed object is {@link String}
*/
void setLogFile(String logFile) throws PropertyVetoException;
/**
* Gets the value of the {@code httpAccessLog} property.
*
* @return possible object is {@link HttpAccessLog}
*/
@Element
HttpAccessLog getHttpAccessLog();
/**
* Sets the value of the {@code httpAccessLog} property.
*
* @param httpAccessLog allowed object is {@link HttpAccessLog}
*/
void setHttpAccessLog(HttpAccessLog httpAccessLog) throws PropertyVetoException;
/**
* Gets the Secure attribute of any {@code JSESSIONIDSSO} cookies associated with
* the web applications deployed to this virtual server. Applicable only if
* the {@code ssoEnabled} property is set to true. To set the Secure attribute of a
* {@code JSESSIONID} cookie, use the {@code cookieSecure} cookie-properties property
* in the {@code sun-web.xml} file. Valid values: {@code true}, {@code false}, {@code dynamic}.
*/
@Attribute(defaultValue = "dynamic")
@Pattern(regexp = VALUES_SSO_COOKIE_ENABLED, message = "Valid values: " + VALUES_SSO_COOKIE_ENABLED)
String getSsoCookieSecure();
void setSsoCookieSecure(String ssoCookieSecure);
@Attribute(defaultValue = "true", dataType = Boolean.class)
String getSsoCookieHttpOnly();
void setSsoCookieHttpOnly(String httpOnly);
default void addNetworkListener(String name) throws PropertyVetoException {
Set listeners = getNetworkListenerNames();
listeners.add(name);
setNetworkListeners(ConfigBeansUtilities.join(listeners, ","));
}
default void removeNetworkListener(String name) throws PropertyVetoException {
final Set listeners = getNetworkListenerNames();
listeners.remove(name);
setNetworkListeners(ConfigBeansUtilities.join(listeners, ","));
}
default NetworkListener findNetworkListener(String name) {
final String listeners = getNetworkListeners();
if (listeners != null && listeners.contains(name)) {
final NetworkConfig config = getParent().getParent(Config.class).getNetworkConfig();
return config.getNetworkListener(name);
} else {
return null;
}
}
default List findNetworkListeners() {
NetworkConfig config = getParent().getParent(Config.class).getNetworkConfig();
return getNetworkListenerNames().stream()
.map(config::getNetworkListener)
.filter(Objects::nonNull)
.collect(toCollection(ArrayList::new));
}
private Set getNetworkListenerNames() {
String listeners = getNetworkListeners();
String[] listenerNames = listeners == null ? new String[0] : listeners.split(",");
return stream(listenerNames).map(String::trim).collect(toCollection(TreeSet::new));
}
/**
* Properties.
*/
@Override
@PropertiesDesc(props = {
@PropertyDesc(
name = "sso-max-inactive-seconds",
defaultValue = "300",
dataType = PositiveInteger.class,
description = "The time 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. Higher values provide longer single sign-on "
+ "persistence for the users at the expense of more memory use on the server"
),
@PropertyDesc(
name = "sso-reap-interval-seconds",
defaultValue = "60",
dataType = PositiveInteger.class,
description = "Interval between purges of expired single sign-on records"
),
@PropertyDesc(
name = "setCacheControl",
description = "Comma-separated list of Cache-Control response directives. For a list of valid "
+ "directives, see section 14.9 of the document at http://www.ietf.org/rfc/rfc2616.txt"
),
@PropertyDesc(
name = "accessLoggingEnabled",
defaultValue = "false",
dataType = Boolean.class,
description = "Enables access logging for this virtual server only"
),
@PropertyDesc(
name = "accessLogBufferSize",
defaultValue = "32768",
dataType = PositiveInteger.class,
description = "Size in bytes of the buffer where access log calls are stored. If the value is "
+ "less than 5120, a warning message is issued, and the value is set to 5120. To set this "
+ "property for all virtual servers, set it as a property of the parent http-service"
),
@PropertyDesc(
name = "accessLogWriteInterval",
defaultValue = "300",
dataType = PositiveInteger.class,
description = "Number of seconds before the log is written to the disk. The access log is written when "
+ "the buffer is full or when the interval expires. If the value is 0, the buffer "
+ "is always written even if it is not full. This means that each time the server"
+ " is accessed, the log message is stored directly to the file. To set this property"
+ " for all virtual servers, set it as a property of the parent http-service"
),
@PropertyDesc(
name = "allowRemoteAddress",
description = "Comma-separated list of regular expression patterns that the remote client's"
+ " IP address is compared to. If this property is specified, the remote address "
+ "must match for this request to be accepted. If this property is not specified,"
+" all requests are accepted unless the remote address matches a 'denyRemoteAddress' pattern"
),
@PropertyDesc(
name = "denyRemoteAddress",
description = "Comma-separated list of regular expression patterns that the remote client's "
+ "IP address is compared to. If this property is specified, the remote address must not "
+ "match for this request to be accepted. If this property is not specified, request "
+ "acceptance is governed solely by the 'allowRemoteAddress' property"
),
@PropertyDesc(
name = "allowRemoteHost",
description = "Comma-separated list of regular expression patterns that the remote client's "
+ "hostname (as returned by java.net.Socket.getInetAddress().getHostName()) is compared to. "
+ "If this property is specified, the remote hostname must match for the request to be accepted. "
+ "If this property is not specified, all requests are accepted unless the remote "
+ "hostname matches a 'denyRemoteHost' pattern"
),
@PropertyDesc(
name = "denyRemoteHost",
description = "Specifies a comma-separated list of regular expression patterns that the remote client's "
+ "hostname (as returned by java.net.Socket.getInetAddress().getHostName()) is compared to. "
+ "If this property is specified, the remote hostname must not match for this request"
+ " to be accepted. If this property is not specified, request acceptance is governed"
+ " solely by the 'allowRemoteHost' property"
),
@PropertyDesc(
name = "authRealm",
description = "Specifies the name attribute of an “auth-realm“ on page 23 element, which overrides "
+ "the server instance's default realm for stand-alone web applications deployed to"
+ " this virtual server. A realm defined in a stand-alone web application's web.xml "
+ "file overrides the virtual server's realm"
),
@PropertyDesc(
name = "securePagesWithPragma",
defaultValue = "true",
dataType = Boolean.class,
description = "Set this property to false to ensure that for all web applications on this"
+ " virtual server file downloads using SSL work properly in Internet Explorer."
+ " You can set this property for a specific web application."
),
@PropertyDesc(
name = "contextXmlDefault",
description = "The location, relative to domain-dir, of the context.xml file for this virtual server, if one is used"
),
@PropertyDesc(
name = "allowLinking",
defaultValue = "false",
dataType = Boolean.class,
description = "If true, resources that are symbolic links in web applications on this virtual server are served. "
+ "The value of this property in the sun-web.xml file takes precedence if defined. "
+ "Caution: setting this property to true on Windows systems exposes JSP source code."
),
/**
* Specifies an alternate document root (docroot), where n is a positive integer that allows specification
* of more than one. Alternate docroots allow web applications to serve requests for certain resources from
* outside their own docroot, based on whether those requests match one (or more) of the URI patterns
* of the web application's alternatedocroots.
*
* If a request matches an alternate docroot's URI pattern, it is mapped to the alternate docroot
* by appending the request URI (minus the web application's context root) to the alternate docroot's
* physical location (directory). If a request matches multiple URI patterns, the alternate docroot
* is determined according to the following precedence order:
*
*
* - Exact match
* - Longest path match
* - Extension match
*
*
* For example, the following properties specify three alternate docroots. The URI pattern of the first
* alternate docroot uses an exact match, whereas the URI patterns of the second and third alternate
* docroots use extension and longest path prefix matches, respectively.
*
* {@literal
* {@literal
* {@literal
*
*
The value of each alternate docroot has two components: The first component, from, specifies the
* alternate docroot's URI pattern, and the second component, dir, specifies the alternate docroot's
* physical location (directory). Spaces are allowed in the dir component.
*
*
You can set this property for a specific web application. For details, see “sun-web-app�?
* in Sun GlassFish Enterprise Server v3 Prelude Application Deployment Guide.
*/
@PropertyDesc(
name = "alternatedocroot_*",
description = "The '*' denotes a positive integer. Example: "
+ "
The second component, path, specifies the absolute or relative file system path of the custom
* error page. A relative file system path is interpreted as relative to the domain-dir/config directory.
*
*
The third component, reason, is optional and specifies the text of the reason string (such as
* Unauthorized or Forbidden) to be returned.
*
*
For example:
* {@literal This example property definition causes the contents of /myhost/401.html to be returned with
* 401 responses, along with this response line:
* HTTP/1.1 401 MY-401-REASON
*/
@PropertyDesc(
name = "send-error_*",
description = "The '*' denotes a positive integer. Example: "
+ "
The first component, from, specifies the prefix of the requested URI to match.
*
*
The second component, url-prefix, specifies the new URL prefix to return to the client. The from
* prefix is simply replaced by this URL prefix. For example:
* {@literal getProperty();
}