/*
 * Copyright (c) 2010, 2020 Oracle and/or its affiliates. All rights reserved.
 *
 * This program and the accompanying materials are made available under the
 * terms of the Eclipse Public License v. 2.0, which is available at
 * http://www.eclipse.org/legal/epl-2.0.
 *
 * This Source Code may also be made available under the following Secondary
 * Licenses when the conditions for such availability set forth in the
 * Eclipse Public License v. 2.0 are satisfied: GNU General Public License,
 * version 2 with the GNU Classpath Exception, which is available at
 * https://www.gnu.org/software/classpath/license.html.
 *
 * SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
 */

package org.glassfish.grizzly.http;

import org.glassfish.grizzly.Buffer;
import org.glassfish.grizzly.Connection;

Monitoring probe providing callbacks that may be invoked by Grizzly Http filters.
Author:
Alexey Stashok
Since:
2.0/**
 * Monitoring probe providing callbacks that may be invoked by Grizzly Http filters.
 *
 * @author Alexey Stashok
 *
 * @since 2.0
 */
public interface HttpProbe {
    
Method will be called, when Buffer will come for processing to the HttpCodecFilter (either request or response). 
Params:
connection – Connection, the event belongs to.
buffer – Buffer to be parsed./**
     * Method will be called, when {@link Buffer} will come for processing to the {@link HttpCodecFilter} (either request or
     * response).
     *
     * @param connection {@link Connection}, the event belongs to.
     * @param buffer {@link Buffer} to be parsed.
     */
    void onDataReceivedEvent(Connection connection, Buffer buffer);

    
Method will be called, when Buffer, produced by the HttpCodecFilter will be ready to go to the next Filter in the chain and finally written on wire. 
Params:
connection – Connection, the event belongs to.
buffer – serialized Buffer./**
     * Method will be called, when {@link Buffer}, produced by the {@link HttpCodecFilter} will be ready to go to the next
     * {@link org.glassfish.grizzly.filterchain.Filter} in the chain and finally written on wire.
     *
     * @param connection {@link Connection}, the event belongs to.
     * @param buffer serialized {@link Buffer}.
     */
    void onDataSentEvent(Connection connection, Buffer buffer);

    
Method will be called, when HTTP message header gets parsed (either request or response).
Params:
connection – Connection, the event belongs to.
header – parsed HttpHeader.
size – the size of the parsed header buffer./**
     * Method will be called, when HTTP message header gets parsed (either request or response).
     *
     * @param connection {@link Connection}, the event belongs to.
     * @param header parsed {@link HttpHeader}.
     * @param size the size of the parsed header buffer.
     */
    void onHeaderParseEvent(Connection connection, HttpHeader header, int size);

    
Method will be called, when HTTP message header gets serialized (either request or response).
Params:
connection – Connection, the event belongs to.
header – serialized HttpHeader.
buffer – the serialized header Buffer./**
     * Method will be called, when HTTP message header gets serialized (either request or response).
     *
     * @param connection {@link Connection}, the event belongs to.
     * @param header serialized {@link HttpHeader}.
     * @param buffer the serialized header {@link Buffer}.
     */
    void onHeaderSerializeEvent(Connection connection, HttpHeader header, Buffer buffer);

    
Method will be called, when HTTP message content chunk gets parsed (either request or response).
Params:
connection – Connection, the event belongs to.
content – parsed HttpContent./**
     * Method will be called, when HTTP message content chunk gets parsed (either request or response).
     *
     * @param connection {@link Connection}, the event belongs to.
     * @param content parsed {@link HttpContent}.
     */
    void onContentChunkParseEvent(Connection connection, HttpContent content);

    
Method will be called, when HTTP message content chunk is prepared to be serialized (either request or response).
Params:
connection – Connection, the event belongs to.
content – HttpContent to be serialized./**
     * Method will be called, when HTTP message content chunk is prepared to be serialized (either request or response).
     *
     * @param connection {@link Connection}, the event belongs to.
     * @param content {@link HttpContent} to be serialized.
     */
    void onContentChunkSerializeEvent(Connection connection, HttpContent content);

    
Method will be called, when ContentEncoding will be applied during the parsing/decoding of the certain HTTP message content chunk. 
Params:
connection – Connection, the event belongs to.
header – HTTP HttpHeader, the event belongs to.
buffer – Buffer to be parsed/decoded.
contentEncoding – ContentEncoding to be applied./**
     * Method will be called, when {@link ContentEncoding} will be applied during the parsing/decoding of the certain HTTP
     * message content chunk.
     *
     * @param connection {@link Connection}, the event belongs to.
     * @param header HTTP {@link HttpHeader}, the event belongs to.
     * @param buffer {@link Buffer} to be parsed/decoded.
     * @param contentEncoding {@link ContentEncoding} to be applied.
     */
    void onContentEncodingParseEvent(Connection connection, HttpHeader header, Buffer buffer, ContentEncoding contentEncoding);

    
This method will be called after the ContentEncoding has been applied. 
Params:
connection – Connection, the event belongs to.
header – HTTP HttpHeader, the event belongs to.
result – the result of the decode operation.
contentEncoding – the ContentEncoding that was applied.
Since:
2.3.3/**
     * This method will be called after the {@link ContentEncoding} has been applied.
     *
     * @param connection {@link Connection}, the event belongs to.
     * @param header HTTP {@link HttpHeader}, the event belongs to.
     * @param result the result of the decode operation.
     * @param contentEncoding the {@link ContentEncoding} that was applied.
     *
     * @since 2.3.3
     */
    void onContentEncodingParseResultEvent(Connection connection, HttpHeader header, Buffer result, ContentEncoding contentEncoding);

    
/** Method will be called, when ContentEncoding will be applied during the serialization/encoding of the certain HTTP message content chunk. 
Params:
connection – Connection, the event belongs to.
header – HTTP HttpHeader, the event belongs to.
buffer – Buffer to be serialized/encoded.
contentEncoding – ContentEncoding to be applied./**
     * 
     * /** Method will be called, when {@link ContentEncoding} will be applied during the serialization/encoding of the
     * certain HTTP message content chunk.
     *
     * @param connection {@link Connection}, the event belongs to.
     * @param header HTTP {@link HttpHeader}, the event belongs to.
     * @param buffer {@link Buffer} to be serialized/encoded.
     * @param contentEncoding {@link ContentEncoding} to be applied.
     */
    void onContentEncodingSerializeEvent(Connection connection, HttpHeader header, Buffer buffer, ContentEncoding contentEncoding);

    
Method will be called, when ContentEncoding will be applied during the serialization/encoding of the certain HTTP message content chunk. 
Params:
connection – Connection, the event belongs to.
header – HTTP HttpHeader, the event belongs to.
result – The result of the encoding processes.
contentEncoding – ContentEncoding to be applied.
Since:
2.3.3/**
     * Method will be called, when {@link ContentEncoding} will be applied during the serialization/encoding of the certain
     * HTTP message content chunk.
     *
     * @param connection {@link Connection}, the event belongs to.
     * @param header HTTP {@link HttpHeader}, the event belongs to.
     * @param result The result of the encoding processes.
     * @param contentEncoding {@link ContentEncoding} to be applied.
     *
     * @since 2.3.3
     */
    void onContentEncodingSerializeResultEvent(Connection connection, HttpHeader header, Buffer result, ContentEncoding contentEncoding);

    
Method will be called, when TransferEncoding will be applied during the parsing/decoding of the certain HTTP message content chunk. 
Params:
connection – Connection, the event belongs to.
header – HTTP HttpHeader, the event belongs to.
buffer – Buffer to be parsed/decoded.
transferEncoding – TransferEncoding to be applied./**
     * Method will be called, when {@link TransferEncoding} will be applied during the parsing/decoding of the certain HTTP
     * message content chunk.
     *
     * @param connection {@link Connection}, the event belongs to.
     * @param header HTTP {@link HttpHeader}, the event belongs to.
     * @param buffer {@link Buffer} to be parsed/decoded.
     * @param transferEncoding {@link TransferEncoding} to be applied.
     */
    void onTransferEncodingParseEvent(Connection connection, HttpHeader header, Buffer buffer, TransferEncoding transferEncoding);

    
Method will be called, when TransferEncoding will be applied during the serialization/encoding of the certain HTTP message content chunk. 
Params:
connection – Connection, the event belongs to.
header – HTTP HttpHeader, the event belongs to.
buffer – Buffer to be serialized/encoded.
transferEncoding – TransferEncoding to be applied./**
     * Method will be called, when {@link TransferEncoding} will be applied during the serialization/encoding of the certain
     * HTTP message content chunk.
     *
     * @param connection {@link Connection}, the event belongs to.
     * @param header HTTP {@link HttpHeader}, the event belongs to.
     * @param buffer {@link Buffer} to be serialized/encoded.
     * @param transferEncoding {@link TransferEncoding} to be applied.
     */
    void onTransferEncodingSerializeEvent(Connection connection, HttpHeader header, Buffer buffer, TransferEncoding transferEncoding);

    
Method will be called, when error occurs during the HttpCodecFilter processing. 
Params:
connection – Connection, the event belongs to.
connection – HttpPacket, the event belongs to.
error – error/**
     * Method will be called, when error occurs during the {@link HttpCodecFilter} processing.
     *
     * @param connection {@link Connection}, the event belongs to.
     * @param connection {@link HttpPacket}, the event belongs to.
     * @param error error
     */
    void onErrorEvent(Connection connection, HttpPacket httpPacket, Throwable error);

    // ---------------------------------------------------------- Nested Classes

    
HttpProbe adapter that provides no-op implementations for all interface methods allowing easy extension by the developer. 
Since:
2.1.9/**
     * {@link HttpProbe} adapter that provides no-op implementations for all interface methods allowing easy extension by
     * the developer.
     *
     * @since 2.1.9
     */
    @SuppressWarnings("UnusedDeclaration")
    class Adapter implements HttpProbe {

        // ---------------------------------------------- Methods from HttpProbe

        
{@inheritDoc}
/**
         * {@inheritDoc}
         */
        @Override
        public void onDataReceivedEvent(Connection connection, Buffer buffer) {
        }

        
{@inheritDoc}
/**
         * {@inheritDoc}
         */
        @Override
        public void onDataSentEvent(Connection connection, Buffer buffer) {
        }

        
{@inheritDoc}
/**
         * {@inheritDoc}
         */
        @Override
        public void onHeaderParseEvent(Connection connection, HttpHeader header, int size) {
        }

        
{@inheritDoc}
/**
         * {@inheritDoc}
         */
        @Override
        public void onHeaderSerializeEvent(Connection connection, HttpHeader header, Buffer buffer) {
        }

        
{@inheritDoc}
/**
         * {@inheritDoc}
         */
        @Override
        public void onContentChunkParseEvent(Connection connection, HttpContent content) {
        }

        
{@inheritDoc}
/**
         * {@inheritDoc}
         */
        @Override
        public void onContentChunkSerializeEvent(Connection connection, HttpContent content) {
        }

        
{@inheritDoc}
/**
         * {@inheritDoc}
         */
        @Override
        public void onContentEncodingParseEvent(Connection connection, HttpHeader header, Buffer buffer, ContentEncoding contentEncoding) {
        }

        
{@inheritDoc}
/**
         * {@inheritDoc}
         */
        @Override
        public void onContentEncodingParseResultEvent(Connection connection, HttpHeader header, Buffer result, ContentEncoding contentEncoding) {
        }

        
{@inheritDoc}
/**
         * {@inheritDoc}
         */
        @Override
        public void onContentEncodingSerializeEvent(Connection connection, HttpHeader header, Buffer buffer, ContentEncoding contentEncoding) {
        }

        
{@inheritDoc}
/**
         * {@inheritDoc}
         */
        @Override
        public void onContentEncodingSerializeResultEvent(Connection connection, HttpHeader header, Buffer result, ContentEncoding contentEncoding) {
        }

        
{@inheritDoc}
/**
         * {@inheritDoc}
         */
        @Override
        public void onTransferEncodingParseEvent(Connection connection, HttpHeader header, Buffer buffer, TransferEncoding transferEncoding) {
        }

        
{@inheritDoc}
/**
         * {@inheritDoc}
         */
        @Override
        public void onTransferEncodingSerializeEvent(Connection connection, HttpHeader header, Buffer buffer, TransferEncoding transferEncoding) {
        }

        
{@inheritDoc}
/**
         * {@inheritDoc}
         */
        @Override
        public void onErrorEvent(Connection connection, HttpPacket httpPacket, Throwable error) {
        }

    } // END Adapter
}