org.eclipse.jetty.server.RequestLog Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of aem-sdk-api Show documentation

The Adobe Experience Manager SDK

There is a newer version: 2024.11.18751.20241128T090041Z-241100

// 
// ========================================================================
// Copyright (c) 1995-2022 Mort Bay Consulting Pty Ltd and others.
// ------------------------------------------------------------------------
// All rights reserved. This program and the accompanying materials
// are made available under the terms of the Eclipse Public License v1.0
// and Apache License v2.0 which accompanies this distribution.
// 
// The Eclipse Public License is available at
// http://www.eclipse.org/legal/epl-v10.html
// 
// The Apache License v2.0 is available at
// http://www.opensource.org/licenses/apache2.0.php
// 
// You may elect to redistribute this code under either of these licenses.
// ========================================================================
// 
package org.eclipse.jetty.server;

import java.io.IOException;
import org.eclipse.jetty.server.handler.RequestLogHandler;

/**
 *  A RequestLog can be attached to a {@link org.eclipse.jetty.server.handler.RequestLogHandler} to enable
 *  logging of requests/responses.
 *
 *  @see RequestLogHandler#setRequestLog(RequestLog)
 *  @see Server#setRequestLog(RequestLog)
 *
 * @deprecated The Eclipse Jetty and Apache Felix Http Jetty packages are no longer supported.
 */
@Deprecated(since = "2021-05-27")
public interface RequestLog {

    /**
     * @param request The request to log.
     * @param response The response to log.  Note that for some requests
     * the response instance may not have been fully populated (Eg 400 bad request
     * responses are sent without a servlet response object).  Thus for basic
     * log information it is best to consult {@link Response#getCommittedMetaData()}
     * and {@link Response#getHttpChannel()} directly.
     */
    void log(Request request, Response response);

    /**
     *  Writes the generated log string to a log sink
     *
     * @deprecated The Eclipse Jetty and Apache Felix Http Jetty packages are no longer supported.
     */
    @Deprecated(since = "2021-05-27")
    interface Writer {

        void write(String requestEntry) throws IOException;
    }

    // @deprecated The Eclipse Jetty and Apache Felix Http Jetty packages are no longer supported.
    @Deprecated(since = "2021-05-27")
    class Collection implements RequestLog {

        private final RequestLog[] _logs;

        public Collection(RequestLog... logs) {
            _logs = logs;
        }

        @Override
        public void log(Request request, Response response) {
            for (RequestLog log : _logs) {
                log.log(request, response);
            }
        }
    }
}