com.sun.faces.tyrus.WebsocketInitializer Maven / Gradle / Ivy

Go to download
/*
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
 *
 * Copyright (c) 1997-2016 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
 * https://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 com.sun.faces.tyrus;

import java.util.HashSet;
import java.util.Set;

import javax.servlet.ServletContainerInitializer;
import javax.servlet.ServletContext;
import javax.servlet.ServletException;
import javax.servlet.annotation.HandlesTypes;
import javax.websocket.Endpoint;
import javax.websocket.server.ServerApplicationConfig;
import javax.websocket.server.ServerContainer;
import javax.websocket.server.ServerEndpoint;

import org.glassfish.tyrus.servlet.TyrusServletContainerInitializer;


@HandlesTypes({
    ServerEndpoint.class, 
    ServerApplicationConfig.class, 
    Endpoint.class}
)
public class WebsocketInitializer implements ServletContainerInitializer {
    
    @Override
    public void onStartup(Set> classes, ServletContext ctx) throws ServletException {
        
        if (classes != null && !classes.isEmpty()) {
            // At least one of the classes that trigger Tyrus to initialize are 
            // on the classpath, so Tyrus will initialize without our help
            return;
        }
        
        if (ctx.getAttribute(ServerContainer.class.getName()) != null) {
            // Already initialized
            return;
        }
        
        if (!Boolean.valueOf(ctx.getInitParameter("javax.faces.ENABLE_WEBSOCKET_ENDPOINT"))) { 
            // Register websocket endpoint is not enabled
            return;
        }
        
        ServletContainerInitializer tyrusInitializer = new TyrusServletContainerInitializer();
        
        // List of classes must be none empty. TyrusServerConfiguration is ignored, 
        // so we add that as class to trigger Tyrus to initialize
        HashSet> filteredClasses = new HashSet<>();
        filteredClasses.add(org.glassfish.tyrus.server.TyrusServerConfiguration.class);
        
        tyrusInitializer.onStartup(filteredClasses, ctx);
    }

}