org.neo4j.server.web.WebServer Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of neo4j-server Show documentation

Neo4j web server.

There is a newer version: 5.25.1

/*
 * Copyright (c) "Neo4j"
 * Neo4j Sweden AB [http://neo4j.com]
 *
 * This file is part of Neo4j.
 *
 * Neo4j is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see .
 */
package org.neo4j.server.web;

import org.eclipse.jetty.server.RequestLog;

import java.net.InetSocketAddress;
import java.util.Collection;
import java.util.List;
import javax.servlet.Filter;

import org.neo4j.configuration.helpers.SocketAddress;
import org.neo4j.server.bind.ComponentsBinder;
import org.neo4j.ssl.SslPolicy;

public interface WebServer
{
    void setHttpAddress( SocketAddress address );

    void setHttpsAddress( SocketAddress address );

    void setSslPolicy( SslPolicy sslPolicy );

    void setRequestLog( RequestLog requestLog );

    void setMaxThreads( int maxThreads );

    void start() throws Exception;

    void stop();

    void addJAXRSPackages( List packageNames, String serverMountPoint, Collection> injectables );
    void removeJAXRSPackages( List packageNames, String serverMountPoint );

    void addJAXRSClasses( List> classes, String serverMountPoint, Collection> injectables );

    void removeJAXRSClasses( List> classes, String serverMountPoint );

    void addFilter( Filter filter, String pathSpec );

    void removeFilter( Filter filter, String pathSpec );

    void addStaticContent( String contentLocation, String serverMountPoint );
    void removeStaticContent( String contentLocation, String serverMountPoint );

    void setWadlEnabled( boolean wadlEnabled );

    void setComponentsBinder( ComponentsBinder binder );

    /**
     * @return local http connector bind port
     */
    InetSocketAddress getLocalHttpAddress();

    /**
     * @return local https connector bind port
     */
    InetSocketAddress getLocalHttpsAddress();
}