com.proofpoint.http.server.HttpServerModule Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of http-server Show documentation
The newest version!
/*
 * Copyright 2010 Proofpoint, Inc.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package com.proofpoint.http.server;

import com.google.inject.Binder;
import com.google.inject.Module;
import com.google.inject.Scopes;
import com.proofpoint.discovery.client.announce.AnnouncementHttpServerInfo;
import com.proofpoint.http.server.HttpServerBinder.HttpResourceBinding;
import jakarta.servlet.Filter;
import org.eclipse.jetty.ee10.servlet.SessionHandler;
import org.eclipse.jetty.util.VirtualThreads;

import static com.google.inject.multibindings.Multibinder.newSetBinder;
import static com.proofpoint.configuration.ConfigBinder.bindConfig;
import static com.proofpoint.reporting.ReportBinder.reportBinder;
import static org.weakref.jmx.guice.ExportBinder.newExporter;

/**
 * Provides a fully configured instance of an HTTP server,
 * ready to use with Guice.
 * 
 * Features:
 * 

 * HTTP/HTTPS
 * Basic Auth
 * Request logging
 * JMX
 * 
 * Configuration options are provided via {@link HttpServerConfig}
 * 
 * To enable JMX, an {@link javax.management.MBeanServer} must be bound elsewhere
 * 

 * To enable Basic Auth, a {@link org.eclipse.jetty.security.LoginService} must be bound elsewhere
 * 
 * To enable HTTPS, {@link HttpServerConfig#isHttpsEnabled()} must return true
 * and {@link HttpServerConfig#getKeystorePath()}
 * and {@link HttpServerConfig#getKeystorePassword()} must return the path to
 * the keystore containing the SSL cert and the password to the keystore, respectively.
 * The HTTPS port is specified via {@link HttpServerConfig#getHttpsPort()}.
 */
public class HttpServerModule
        implements Module
{
    public static final String REALM_NAME = "Proofpoint";

    private boolean bindSessionHandler = false;
    private final HttpServerModuleOptions moduleOptions = new HttpServerModuleOptions();

    @Override
    public void configure(Binder binder)
    {
        binder.disableCircularProxies();

        if (bindSessionHandler) {
            binder.bind(SessionHandler.class).in(Scopes.SINGLETON);
        }
        if (moduleOptions.isEnableVirtualThreads()) {
            if (!VirtualThreads.areSupported()) {
                binder.addError("Virtual threads are not supported");
            }
        }

        binder.bind(HttpServerModuleOptions.class).toInstance(moduleOptions);
        binder.bind(HttpServer.class).toProvider(HttpServerProvider.class).in(Scopes.SINGLETON);
        binder.bind(HttpServerInfo.class).in(Scopes.SINGLETON);
        binder.bind(QueryStringFilter.class).in(Scopes.SINGLETON);
        binder.bind(RequestStats.class).in(Scopes.SINGLETON);
        binder.bind(ClientAddressExtractor.class).in(Scopes.SINGLETON);
        newSetBinder(binder, Filter.class, TheServlet.class);
        newSetBinder(binder, Filter.class, TheAdminServlet.class);
        newSetBinder(binder, HttpResourceBinding.class, TheServlet.class);

        reportBinder(binder).export(HttpServer.class);
        newExporter(binder).export(HttpServer.class).withGeneratedName();
        reportBinder(binder).bindReportCollection(DetailedRequestStats.class).withNamePrefix("HttpServer");

        bindConfig(binder).bind(HttpServerConfig.class);
        bindConfig(binder).bind(InternalNetworkConfig.class);

        binder.bind(AnnouncementHttpServerInfo.class).to(LocalAnnouncementHttpServerInfo.class).in(Scopes.SINGLETON);
    }

    public HttpServerModule withSessionHandler()
    {
        this.bindSessionHandler = true;
        return this;
    }

    public HttpServerModule allowAmbiguousUris()
    {
        moduleOptions.setAllowAmbiguousUris();
        return this;
    }

    /**
     * Enables Jetty's virtual threads support.
     * Note: Java 17 does not support virtual threads.
     */
    public HttpServerModule enableVirtualThreads()
    {
        moduleOptions.setEnableVirtualThreads();
        return this;
    }
}