org.graylog2.web.IndexHtmlGenerator Maven / Gradle / Ivy

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

Graylog

There is a newer version: 6.0.1

/*
 * Copyright (C) 2020 Graylog, Inc.
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the Server Side Public License, version 1,
 * as published by MongoDB, Inc.
 *
 * 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
 * Server Side Public License for more details.
 *
 * You should have received a copy of the Server Side Public License
 * along with this program. If not, see
 * .
 */
package org.graylog2.web;

import javax.ws.rs.core.MultivaluedMap;

/**
 * Implementations provide HTML content for an "index.html" file. This file will be served to browser clients.
 */
public interface IndexHtmlGenerator {
    /**
     * Get the HTML content.
     *
     * @param headers the HTTP request headers of the web request
     * @return the HTML string
     */
    String get(MultivaluedMap headers);
}