javax.net.websocket.ClientEndpointConfiguration Maven / Gradle / Ivy
//
// ========================================================================
// Copyright (c) 1995-2012 Mort Bay Consulting Pty. Ltd.
// ------------------------------------------------------------------------
// 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 javax.net.websocket;
import java.util.List;
/**
* The ClientEndpointConfiguration is a special kind of endpoint configuration
* object that contains web socket configuration information specific only to
* client endpoints.
*
* @since DRAFT 001
*/
// FIXME: need .setCookieStore(java.net.CookieStore cookieStore)
// FIXME: need .setHeader(String name, String value)
public interface ClientEndpointConfiguration extends EndpointConfiguration {
/**
* http://java.net/jira/browse/WEBSOCKET_SPEC-45
*
* Return the list of all the extensions that this client supports. These
* are the extensions that will be used to populate the
* Sec-WebSocket-Extensions header in the opening handshake for clients
* using this configuration. The first extension in the list is the most
* preferred extension. See Negotiating
* Extensions
*
* @return a list of extensions
*/
List getExtensions();
/**
* The ordered list of sub protocols a client endpoint would like to use.
* This list is used to generate the Sec-WebSocket-Protocol header in the
* opening handshake for clients using this configuration. The first
* protocol name is the most preferred. See Cilent Opening
* Handshake
*
* @return a list of subprotocols
*/
List getPreferredSubprotocols();
}