javax.websocket.WebSocketContainer Maven / Gradle / Ivy

Go to download
/*
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
 *
 * Copyright (c) 2012 Oracle and/or its affiliates. All rights reserved.
 *
 * The contents of this file are subject to the terms of either the GNU
 * General Public License Version 2 only ("GPL") or the Common Development
 * and Distribution License("CDDL") (collectively, the "License").  You
 * may not use this file except in compliance with the License.  You can
 * obtain a copy of the License at
 * http://glassfish.java.net/public/CDDL+GPL_1_1.html
 * or packager/legal/LICENSE.txt.  See the License for the specific
 * language governing permissions and limitations under the License.
 *
 * When distributing the software, include this License Header Notice in each
 * file and include the License file at packager/legal/LICENSE.txt.
 *
 * GPL Classpath Exception:
 * Oracle designates this particular file as subject to the "Classpath"
 * exception as provided by Oracle in the GPL Version 2 section of the License
 * file that accompanied this code.
 *
 * Modifications:
 * If applicable, add the following below the License Header, with the fields
 * enclosed by brackets [] replaced by your own identifying information:
 * "Portions Copyright [year] [name of copyright owner]"
 *
 * Contributor(s):
 * If you wish your version of this file to be governed by only the CDDL or
 * only the GPL Version 2, indicate your decision by adding "[Contributor]
 * elects to include this software in this distribution under the [CDDL or GPL
 * Version 2] license."  If you don't indicate a single choice of license, a
 * recipient has the option to distribute your version of this file under
 * either the CDDL, the GPL Version 2 or to extend the choice of license to
 * its licensees as provided above.  However, if you add GPL Version 2 code
 * and therefore, elected the GPL Version 2 license, then the option applies
 * only if the new code is made subject to such option by the copyright
 * holder.
 */
package javax.websocket;

import java.net.URI;
import java.util.Set;

/**
 * A WebSocketContainer is an implementation provided object that allows the developer to
 * initiate a web socket handshake from the provided endpoint.
 *
 * @author dannycoward
 * @since DRAFT 001
 */
public interface WebSocketContainer {

    /**
     * Return the number of milliseconds the implementation will timeout
     * attempting to send a websocket message for all RemoteEndpoints associated
     * with this container. A non-positive number indicates
     * the implementation will not timeout attempting to send a websocket message
     * asynchronously. Note this default may be overridden in each RemoteEndpoint.
     *
     * @return the timeout time in millsenconds.
     */
    long getDefaultAsyncSendTimeout();

    /**
     * Sets the number of milliseconds the implementation will timeout
     * attempting to send a websocket message  for all RemoteEndpoints associated
     * with this container. A non-positive number indicates
     * the implementation will not timeout attempting to send a websocket message
     * asynchronously. Note this default may be overridden in each RemoteEndpoint.
     */
    void setAsyncSendTimeout(long timeoutmillis);

    /**
     * Connect the supplied annotated object to its server. The supplied object must be a
     * class decorated with the class level
     * {@link javax.websocket.server.WebSocketEndpoint javax.websocket.server.WebSocketEndpoint} annotation. This method blocks until the connection
     * is established, or throws an error if either the connection could not be made or there
     * was a problem with the supplied endpoint class.
     *
     * @param annotatedEndpointClass the annotated websocket client endpoint with {@link WebSocketClient} annotation.
     * @param path                   the complete path to the server endpoint.
     * @return the Session created if the connection is successful.
     * @throws DeploymentException if there was a problem that prevented the client endpoint being connected to its server.
     */
    Session connectToServer(Class annotatedEndpointClass, URI path) throws DeploymentException;

    /**
     * Connect the supplied programmatic endpoint to its server with the given configuration. This method blocks until the connection
     * is established, or throws an error if the connection could not be made.
     *
     * @param endpointClass the programmatic client endpoint class {@link Endpoint}.
     * @param path          the complete path to the server endpoint.
     * @param cec the configuration used to configure the programmatic endpoint.
     * @return the Session created if the connection is successful.
     * @throws DeploymentException if there was a problem that prevented the client endpoint being connected to its server.
     */
    Session connectToServer(Class endpointClass, ClientEndpointConfiguration cec, URI path) throws DeploymentException;

    /**
     * Return a copy of the Set of the currently open web socket sessions. These
     * sessions may not still be open at any point after the return of this method. For
     * example, iterating over the set at a later time may yield one or more closed sessions. Use
     * session.isOpen() to check.
     *
     * @return the set of sessions, active at the time of return.
     */
    Set getOpenSessions();

    /**
     * Return the maximum time in milliseconds that a web socket session may be idle before
     * the container may close it.
     *
     * @return the number of milliseconds idle web socket sessions are active
     */
    long getMaxSessionIdleTimeout();

    /**
     * Sets the maximum time that a web socket session may be idle before
     * the container may close it.
     *
     * @param timeout the maximum time in milliseconds.
     */
    void setMaxSessionIdleTimeout(long timeout);

    /**
     * Returns the maximum size of binary message that this container
     * will buffer.
     *
     * @return the maximum size of binary message in number of bytes.
     */
    long getMaxBinaryMessageBufferSize();

    /**
     * Sets the maximum size of binary message that this container
     * will buffer.
     *
     * @param max the maximum size of binary message in number of bytes.
     */
    void setMaxBinaryMessageBufferSize(long max);

    /**
     * Sets the maximum size of text message that this container
     * will buffer.
     *
     * @return the maximum size of text message in number of bytes.
     */
    long getMaxTextMessageBufferSize();

    /**
     * Sets the maximum size of text message that this container
     * will buffer.
     *
     * @param max the maximum size of text message in number of bytes.
     */
    void setMaxTextMessageBufferSize(long max);

    /**
     * Return the set of Extensions installed in the container.
     *
     * @return the set of extensions.
     */
    Set getInstalledExtensions();
}