javax.net.websocket.EndpointConfiguration Maven / Gradle / Ivy

Go to download

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

JSR 356:Java API for WebSocket

There is a newer version: 1.0-b08

Show newest version

/*
 * Copyright (c) 2012, Oracle and/or its affiliates. All rights reserved.
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * This code is free software; you can redistribute it and/or modify it
 * under the terms of the GNU General Public License version 2 only, as
 * published by the Free Software Foundation.  Oracle designates this
 * particular file as subject to the "Classpath" exception as provided
 * by Oracle in the LICENSE file that accompanied this code.
 *
 * This code is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
 * version 2 for more details (a copy is included in the LICENSE file that
 * accompanied this code).
 *
 * You should have received a copy of the GNU General Public License version
 * 2 along with this work; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
 *
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
 * or visit www.oracle.com if you need additional information or have any
 * questions.
 */
package javax.net.websocket;

import java.util.List;

/**
 * The endpoint configuration contains all the information needed during the handshake process
 * for this end point. All endpoints specify, for example, a URI. In the case of a server endpoint,
 * the URI signifies the URI to which the endpoint will be mapped. In the case of a client application
 * the URI signifies the URI of the server to which the client endpoint will attempt to connect.
 * @author dannycoward
 * @since DRAFT 001
 */
public interface EndpointConfiguration {

    /** Return the Encoder implementations configured. These
     will be used by the container to encode custom objects passed into
     * the send() methods on remote endpoints.
     * @return the list of encoders.
     */
    public List getEncoders();
     /** Return the Decoder implementations configured. These
     will be used by the container to decode incoming messages
     * into the expected custom objects on MessageListener.onMessage()
     * callbacks.
     * @return the list of decoders.
     */
    public List getDecoders();

    /**
     * see http://java.net/jira/browse/WEBSOCKET_SPEC-46
     */
    public String getPath();

}