javax.net.websocket.DefaultClientConfiguration 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.ArrayList;
import java.util.List;

/**
 * The DefaultClientConfiguration is a concrete implementation of a client configuration. Developers
 * may subclass this class in order to provide their own custom configuration behaviors.
 * @author dannycoward
 */
public class DefaultClientConfiguration implements ClientEndpointConfiguration {
    private String path;
    private List preferredSubprotocols = new ArrayList();
    private List extensions = new ArrayList();
    private List encoders = new ArrayList();
    private List decoders = new ArrayList();
    /** Creates a client configuration that will attempt
     * to connect to the given URI.
     * @param uri
     */
    public DefaultClientConfiguration(String uri) {
        this.path = uri;
    }

    public String getPath() {
        return path;
    }

    /** Return the protocols, in order of preference, favorite first, that this client would
     * like to use for its sessions.
     * @return
     */
    public List getPreferredSubprotocols() {
        return this.preferredSubprotocols;
    }

    /** Assign the List of preferred subprotocols that this client would like to
     * use.
     * @return
     */
    public DefaultClientConfiguration setPreferredSubprotocols(List preferredSubprotocols) {
        this.preferredSubprotocols = preferredSubprotocols;
        return this;
    }

    /** Return the extensions, in order of preference, favorite first, that this client would
     * like to use for its sessions.
     * @return
     */
    public List getExtensions() {
        this.extensions = extensions;
        return null;
    }

    /** Assign the List of preferred subprotocols that this client would like to
     * use.
     * @return
     */
    public ClientEndpointConfiguration setExtensions(List preferredExtensions) {
        this.extensions = preferredExtensions;
        return this;
    }

    /** Assign the list of encoders this client will use.
     * @return
     */
    public List getEncoders() {
        return this.encoders;
    }
    /** Assign the list of encoders this client will use. */
     public ClientEndpointConfiguration setEncoders(List encoders) {
         this.encoders = encoders;
        return this;
    }
    /** Assign the list of decoders this client will use.
     * @return
     */
    public List getDecoders() {
        return this.decoders;
    }

        /** Assign the list of decoders this client will use. */
     public ClientEndpointConfiguration setDecoders(List decoders) {
         this.decoders = decoders;
        return this;
    }
}