javax.websocket.ClientEndpointConfigurator Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of javax.websocket-api Show documentation

JSR 356: Java API for WebSocket

There is a newer version: 1.1

/*
 * To change this template, choose Tools | Templates
 * and open the template in the editor.
 */
package javax.websocket;

import java.util.List;
import java.util.Map;
import java.util.ServiceLoader;

/**
 * The ClientEndpointConfigurator interface may be implemented by developers who want to
 * provide custom configuration algorithms, such as intercepting the opening handshake, or
 * providing arbitrary methods and algorithms that can be accessed from each endpoint
 * instance configured with this configurator.
 * 
 * @author dannycoward
 */
public abstract class ClientEndpointConfigurator {
    
    /**
     * This method is called by the implementation after it has formulated the handshake
     * request that will be used to initiate the connection to the server, but before it has
     * sent any part of the request. This allows the developer to inspect and modify the
     * handshake request headers prior to the start of the handshake interaction.
     *
     * @param headers the mutable map of handshake request headers the implementation is about to send to
     *                start the handshake interaction.
     */
    public void beforeRequest(Map> headers) {
        
    }

    /**
     * This method is called by the implementation after it has received a handshake response
     * from the server as a result of a handshake interaction it initiated. The developer may implement
     * this method in order to inspect the returning handshake response.
     *
     * @param hr the handshake response sent by the server.
     */
    public void afterResponse(HandshakeResponse hr) {
        
    }
}