org.java_websocket.protocols.IProtocol Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of Java-WebSocket Show documentation

A barebones WebSocket client and server implementation written 100% in Java

There is a newer version: 1.5.7

/*
 * Copyright (c) 2010-2020 Nathan Rajlich
 *
 *  Permission is hereby granted, free of charge, to any person
 *  obtaining a copy of this software and associated documentation
 *  files (the "Software"), to deal in the Software without
 *  restriction, including without limitation the rights to use,
 *  copy, modify, merge, publish, distribute, sublicense, and/or sell
 *  copies of the Software, and to permit persons to whom the
 *  Software is furnished to do so, subject to the following
 *  conditions:
 *
 *  The above copyright notice and this permission notice shall be
 *  included in all copies or substantial portions of the Software.
 *
 *  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
 *  EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
 *  OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
 *  NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
 *  HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
 *  WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
 *  FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
 *  OTHER DEALINGS IN THE SOFTWARE.
 */

package org.java_websocket.protocols;

/**
 * Interface which specifies all required methods for a Sec-WebSocket-Protocol
 *
 * @since 1.3.7
 */
public interface IProtocol {

	/**
	 * Check if the received Sec-WebSocket-Protocol header field contains a offer for the specific protocol
	 *
	 * @param inputProtocolHeader the received Sec-WebSocket-Protocol header field offered by the other endpoint
	 * @return true, if the offer does fit to this specific protocol
	 * @since 1.3.7
	 */
	boolean acceptProvidedProtocol( String inputProtocolHeader );

	/**
	 * Return the specific Sec-WebSocket-protocol header offer for this protocol if the endpoint.
	 * If the extension returns an empty string (""), the offer will not be included in the handshake.
	 *
	 * @return the specific Sec-WebSocket-Protocol header for this protocol
	 * @since 1.3.7
	 */
	String getProvidedProtocol();

	/**
	 * To prevent protocols to be used more than once the Websocket implementation should call this method in order to create a new usable version of a given protocol instance.
	 * @return a copy of the protocol
	 * @since 1.3.7
	 */
	IProtocol copyInstance();

	/**
	 * Return a string which should contain the protocol name as well as additional information about the current configurations for this protocol (DEBUG purposes)
	 *
	 * @return a string containing the protocol name as well as additional information
	 * @since 1.3.7
	 */
	String toString();
}