com.sun.enterprise.config.serverbeans.HttpService Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of payara-micro Show documentation
Show all versions of payara-micro Show documentation
Micro Distribution of the Payara Project
/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright (c) 2012-2013 Oracle and/or its affiliates. All rights reserved.
*
* The contents of this file are subject to the terms of either the GNU
* General Public License Version 2 only ("GPL") or the Common Development
* and Distribution License("CDDL") (collectively, the "License"). You
* may not use this file except in compliance with the License. You can
* obtain a copy of the License at
* https://glassfish.dev.java.net/public/CDDL+GPL_1_1.html
* or packager/legal/LICENSE.txt. See the License for the specific
* language governing permissions and limitations under the License.
*
* When distributing the software, include this License Header Notice in each
* file and include the License file at packager/legal/LICENSE.txt.
*
* GPL Classpath Exception:
* Oracle designates this particular file as subject to the "Classpath"
* exception as provided by Oracle in the GPL Version 2 section of the License
* file that accompanied this code.
*
* Modifications:
* If applicable, add the following below the License Header, with the fields
* enclosed by brackets [] replaced by your own identifying information:
* "Portions Copyright [year] [name of copyright owner]"
*
* Contributor(s):
* If you wish your version of this file to be governed by only the CDDL or
* only the GPL Version 2, indicate your decision by adding "[Contributor]
* elects to include this software in this distribution under the [CDDL or GPL
* Version 2] license." If you don't indicate a single choice of license, a
* recipient has the option to distribute your version of this file under
* either the CDDL, the GPL Version 2 or to extend the choice of license to
* its licensees as provided above. However, if you add GPL Version 2 code
* and therefore, elected the GPL Version 2 license, then the option applies
* only if the new code is made subject to such option by the copyright
* holder.
*/
// Portions Copyright [2018-2022] Payara Foundation and/or affiliates
package com.sun.enterprise.config.serverbeans;
import java.beans.PropertyVetoException;
import java.util.*;
import java.util.logging.Level;
import java.util.logging.Logger;
import com.sun.enterprise.config.util.ConfigApiLoggerInfo;
import org.glassfish.api.admin.config.ConfigExtension;
import org.jvnet.hk2.config.*;
import org.jvnet.hk2.config.types.Property;
import org.jvnet.hk2.config.types.PropertyBag;
import org.glassfish.api.admin.config.PropertiesDesc;
import org.glassfish.api.admin.config.PropertyDesc;
import org.glassfish.config.support.datatypes.NonNegativeInteger;
import jakarta.validation.constraints.NotNull;
import jakarta.validation.constraints.Pattern;
@Configured
public interface HttpService extends ConfigBeanProxy, PropertyBag, ConfigExtension {
/**
* Gets the value of the accessLog property.
*
* @return possible object is
* {@link AccessLog }
*/
@Element
@NotNull
AccessLog getAccessLog();
/**
* Sets the value of the accessLog property.
*
* @param value allowed object is {@link AccessLog }
* @throws PropertyVetoException
*/
void setAccessLog(AccessLog value) throws PropertyVetoException;
/**
* Gets the value of the virtualServer property.
*
*
* This accessor method returns a reference to the live list,
* not a snapshot. Therefore any modification you make to the
* returned list will be present inside the JAXB object.
* This is why there is not a set method for the virtualServer property.
*
*
* For example, to add a new item, do as follows:
*
* getVirtualServer().add(newItem);
*
*
*
*
* Objects of the following type(s) are allowed in the list
* {@link VirtualServer }
* @return
*/
@Element(required=true)
List getVirtualServer();
@DuckTyped
VirtualServer getVirtualServerByName(String name);
@DuckTyped
List getNonAdminVirtualServerList();
@Attribute(defaultValue = "false")
@Pattern(regexp="(false|true|on|off)")
String getAccessLoggingEnabled();
void setAccessLoggingEnabled(String enabled);
String getAccessLogPrefix();
void setAccessLogPrefix(String name);
/**
* If true, single sign-on is enabled by default for all web applications on all virtual servers on this
* server instance that are configured for the same realm. If false, single sign-on is disabled by
* default for all virtual servers, and users must authenticate separately to every application on each
* virtual server. The sso-enabled property setting of the virtual-server element can override this
* setting for an individual virtual server or inherit the value by using "inherit."
*
* @return possible object is {@link String }
*/
@Attribute(defaultValue = "false")
@Pattern(regexp="(true|false|on|off)")
String getSsoEnabled();
/**
* Sets the value of the sso-enabled property.
*
* @param value allowed object is {@link String }
*/
void setSsoEnabled(String value);
class Duck {
private static final Logger LOGGER = ConfigApiLoggerInfo.getLogger();
public static VirtualServer getVirtualServerByName(HttpService target, String name) {
for (VirtualServer v : target.getVirtualServer()) {
if (v.getId().equals(name)) {
return v;
}
}
return null;
}
public static List getNonAdminVirtualServerList(
HttpService target) {
List nonAdminVSList = new ArrayList();
for (VirtualServer v : target.getVirtualServer()) {
if (!v.getId().equals("__asadmin")) {
nonAdminVSList.add(v.getId());
}
}
return Collections.unmodifiableList(nonAdminVSList);
}
public static HttpService createDefaultConfig(Config c) {
final Config param = c;
try {
ConfigSupport.apply(new SingleConfigCode() {
@Override
public Object run(Config param) throws PropertyVetoException, TransactionFailure {
HttpService httpService = param.createChild(HttpService.class);
AccessLog accessLog = httpService.createChild(AccessLog.class);
List vsList = httpService.getVirtualServer();
httpService.setAccessLog(accessLog);
VirtualServer vs = httpService.createChild(VirtualServer.class);
vs.setId("server");
vs.setNetworkListeners("http-listener-1,http-listener-2");
VirtualServer vs1 = httpService.createChild(VirtualServer.class);
vs1.setId("__asadmin");
vs1.setNetworkListeners("admin-listener");
vsList.add(vs);
vsList.add(vs1);
param.getContainers().add(httpService);
return httpService;
}
}, param);
} catch (TransactionFailure ex) {
// Will use the BG logging infrastrucre... And probably some exception type?
LOGGER.log(Level.INFO, ConfigApiLoggerInfo.unableToCreateHttpServiceConfig, ex);
}
return param.getExtensionByType(HttpService.class);
}
}
@PropertiesDesc(
props={
@PropertyDesc(name="monitoring-cache-enabled", defaultValue="true", dataType=Boolean.class,
description="Enables the monitoring cache"),
@PropertyDesc(name="monitoring-cache-refresh-in-millis", defaultValue="5000", dataType=NonNegativeInteger.class,
description="Specifies the interval between refreshes of the monitoring cache"),
@PropertyDesc(name="recycle-objects", defaultValue="true", dataType=Boolean.class,
description="Whether to recycle internal objects instead of using the VM garbage collector"),
@PropertyDesc(name="reader-threads", defaultValue="0", dataType=NonNegativeInteger.class,
description="Specifies the number of reader threads, which read bytes from the non-blocking socket"),
@PropertyDesc(name="acceptor-queue-length", defaultValue="4096", dataType=NonNegativeInteger.class,
description="Specifies the length of the acceptor thread queue. Once full, connections are rejected"),
@PropertyDesc(name="reader-queue-length", defaultValue="4096", dataType=NonNegativeInteger.class,
description="Specifies the length of the reader thread queue. Once full, connections are rejected"),
@PropertyDesc(name="use-nio-direct-bytebuffer", defaultValue="true", dataType=Boolean.class,
description="Controls whether the NIO direct ByteBuffer is used. In a limited resource environment, " +
"it might be faster to use non-direct Java's ByteBuffer by setting a value of false"),
@PropertyDesc(name="authPassthroughEnabled", defaultValue="false", dataType=Boolean.class,
description="Indicates that the http-listeners receive traffic from an SSL-terminating proxy server, " +
"which is responsible for forwarding any information about the original client request (such as client " +
"IP address, SSL keysize, and authenticated client certificate chain) to the HTTP listeners using custom request headers. " +
"Each subelement can override this setting for itself"),
/**
Specifies the fully qualified class name of a custom implementation of the
com.sun.appserv.ProxyHandler abstract class, which allows a back-end
application server instance to retrieve information about the original client
request that was intercepted by an SSL-terminating proxy server (for
example, a load balancer). An implementation of this abstract class inspects
a given request for the custom request headers through which the proxy
server communicates the information about the original client request to
the Enterprise Server instance, and returns that information to its caller.
The default implementation reads the client IP address from an HTTP
request header named Proxy-ip, the SSL keysize from an HTTP request
header named Proxy-keysize, and the SSL client certificate chain from an
HTTP request header named Proxy-auth-cert. The Proxy-auth-cert
value must contain the BASE-64 encoded client certificate chain without
the BEGIN CERTIFICATE and END CERTIFICATE boundaries and with \n
replaced with % d% a.
Only used if authPassthroughEnabled is set to true. Each “http-listener”
on page 37 subelement can override the setting for itself.
*/
@PropertyDesc(name="proxyHandler", defaultValue="com.sun.enterprise.web.web.ProxyHandlerImpl",
description="Specifies the fully qualified class name of a custom implementation of com.sun.appserv.ProxyHandler. " +
"Only used if authPassthroughEnabled is set to true. Each http-listener can override the setting for itself"),
@PropertyDesc(name="bufferSize", defaultValue="4096", dataType=NonNegativeInteger.class,
description="Size in bytes of the buffer to be provided for input streams created by HTTP listeners"),
@PropertyDesc(name="connectionTimeout", defaultValue="30", dataType=NonNegativeInteger.class,
description="Number of seconds HTTP listeners wait, after accepting a connection, for the request URI line to be presented"),
@PropertyDesc(name="maxKeepAliveRequests", defaultValue="250", dataType=NonNegativeInteger.class,
description="Maximum number of HTTP requests that can be pipelined until the connection is closed by the server. " +
"Set this property to 1 to disable HTTP/1.0 keep-alive, as well as HTTP/1.1 keep-alive and pipelining"),
@PropertyDesc(name="traceEnabled", defaultValue="true", dataType=Boolean.class,
description="Enables the TRACE operation. Set to false to make the server less susceptible to cross-site scripting attacks"),
@PropertyDesc(name="accessLoggingEnabled", defaultValue="false", dataType=Boolean.class,
description="Controls access logging for all virtual-server that do not specify this property"),
@PropertyDesc(name="disableUploadTimeout", defaultValue="true", dataType=Boolean.class,
description="If false, the connection for a servlet that reads bytes slowly is closed after the 'connectionUploadTimeout' is reached"),
@PropertyDesc(name="connectionUploadTimeout", defaultValue="5", dataType=NonNegativeInteger.class,
description="Specifies the timeout for uploads. Applicable only if 'disableUploadTimeout' is set to false"),
@PropertyDesc(name="uriEncoding", defaultValue="UTF-8",
description="Specifies the character set used to decode the request URIs received on http-listeners that " +
"do not define this property. Must be a valid IANA character set name")
})
@Element("property")
@Override
List getProperty();
}