javax.websocket.server.ServerEndpointConfigurationBuilder Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of javax.websocket-api Show documentation
JSR 356: Java API for WebSocket
There is a newer version: 1.1
/*
 * To change this template, choose Tools | Templates
 * and open the template in the editor.
 */
package javax.websocket.server;

import java.util.*;
import javax.websocket.Decoder;
import javax.websocket.Encoder;
import javax.websocket.Extension;


/**
 * The ServerEndpointConfigurationBuilder is a class used for creating
 * {@link ServerEndpointConfigurationBuilder} objects for the purposes of
 * deploying a client endpoint.
 * 

Here are some examples:

 * 
Building a plain configuration for an endpoint with just a path.


 * 
 * ServerEndpointConfiguration config = ServerEndpointConfigurationBuilder.create(ProgrammaticEndpoint.class, "/foo").build();


 *
 * 
 *

Building a configuration with no subprotocols and a custom configurator.


 * 
 * ServerEndpointConfiguration config = ServerEndpointConfigurationBuilder.create(ProgrammaticEndpoint.class, "/bar")

                .subprotocols(subprotocols)

                .serverEndpointConfigurator(new MyServerConfigurator())

                .build();

 * 
 * 
 * @author dannycoward
 */
public final class ServerEndpointConfigurationBuilder {
    private String path;
    private Class endpointClass;
    private List subprotocols = new ArrayList();
    private List extensions = new ArrayList();
    private List encoders = new ArrayList();
    private List decoders = new ArrayList();
    private ServerEndpointConfigurator serverEndpointConfigurator;
    
    /**
     * Creates the builder with the mandatory information of the endpoint class 
     * (programmatic or annotated), the relative URI or URI-template to use,
     * and with no subprotocols, extensions, encoders, decoders or custom
     * configurator.
     * @param endpointClass the class of the endpoint to configure
     * @param path The URI or URI template where the endpoint will be deployed.
     * A trailing "/" will be ignored and the path must begin with /.
     * @return a new instance of ServerEndpointConfigurationBuilder
     */
    public static ServerEndpointConfigurationBuilder create(Class endpointClass, String path) {
        return new ServerEndpointConfigurationBuilder(endpointClass, path);
    }
    
    // only one way to build them
    private ServerEndpointConfigurationBuilder() {
        
    }
    /**
     * Builds the configuration object using the current attributes
     * that have been set on this builder object.
     * 
     * @return a new ServerEndpointConfiguration object.
     */
    public ServerEndpointConfiguration build() {
        return new DefaultServerEndpointConfiguration(
                this.endpointClass,
                this.path,
                Collections.unmodifiableList(this.subprotocols),
                Collections.unmodifiableList(this.extensions),
                Collections.unmodifiableList(this.encoders),
                Collections.unmodifiableList(this.decoders),
                this.serverEndpointConfigurator
             );
    }
    
    private ServerEndpointConfigurationBuilder(Class endpointClass, String path) {
        if (endpointClass == null) {
            throw new IllegalArgumentException("endpointClass cannot be null");
        }
        this.endpointClass = endpointClass;
        if (path == null || !path.startsWith("/")) {
            throw new IllegalStateException("Path cannot be null and must begin with /");
        }
        this.path = path;
    }
    

    
    /** 
     * Sets the list of encoders for this builder.
     * 
     * @param encoders the encoders
     * @return this builder instance
     */
    public ServerEndpointConfigurationBuilder encoders(List encoders) {
        this.encoders = (encoders == null) ? new ArrayList() : encoders;
        return this;
    }

    
    /**
     * Sets the decoders to use in the configuration.
     * 
     * @param decoders the decoders
     * @return this builder instance.
     */
    public ServerEndpointConfigurationBuilder decoders(List decoders) {
        this.decoders = (decoders == null) ? new ArrayList() : decoders;
        return this;
    }
    
    /**
     * Sets the subprotocols to use in the configuration.
     * 
     * @param subprotocols the subprotocols.
     * @return this builder instance
     */
    public ServerEndpointConfigurationBuilder subprotocols(List subprotocols) {
        this.subprotocols = (subprotocols == null) ? new ArrayList() : subprotocols;
        return this;
    }

    
    /**
     * Sets the extensions to use in the configuration.
     * 
     * @param extensions the extensions to use.
     * @return this builder instance.
     */
    public ServerEndpointConfigurationBuilder extensions(List extensions) {
        this.extensions = (extensions == null) ? new ArrayList() : extensions;
        return this;
    }
 
    /** 
     * Sets the custom configurator to use on the configuration
     * object built by this builder.
     * 
     * @param serverEndpointConfigurator the configurator
     * @return this builder instance
     */
    public ServerEndpointConfigurationBuilder serverEndpointConfigurator(ServerEndpointConfigurator serverEndpointConfigurator) {
        this.serverEndpointConfigurator = serverEndpointConfigurator;
        return this;
    }
    


}