org.omnifaces.ApplicationInitializer Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of omnifaces Show documentation
Jakarta Faces 3.0+ utility library
There is a newer version: 4.4.1
/*
 * Copyright OmniFaces
 *
 * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with
 * the License. You may obtain a copy of the License at
 *
 *     https://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on
 * an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the
 * specific language governing permissions and limitations under the License.
 */
package org.omnifaces;

import static java.lang.String.format;
import static java.util.logging.Level.WARNING;

import java.util.Set;
import java.util.logging.Logger;

import jakarta.faces.webapp.FacesServlet;
import jakarta.servlet.ServletContainerInitializer;
import jakarta.servlet.ServletContext;
import jakarta.servlet.ServletException;

import org.omnifaces.config.OmniFaces;
import org.omnifaces.facesviews.FacesViews;
import org.omnifaces.util.Platform;

/**
 * 
 * OmniFaces application initializer. This runs when the servlet container starts up.
 * This performs the following tasks:
 * 

 * Log OmniFaces version.
 * 
Determine the default {@link FacesServlet} mapping.
 * 
Register {@link FacesViews} forwarding filter.
 * 
 * 
 * This is invoked before {@link ApplicationListener} and {@link ApplicationProcessor}.
 * If any exception is thrown, then the deployment will fail, unless the {@value OmniFaces#PARAM_NAME_SKIP_DEPLOYMENT_EXCEPTION}
 * context parameter is set to true, it will then merely log a WARNING line.
 *
 * @author Bauke Scholtz
 * @since 2.0
 */
public class ApplicationInitializer implements ServletContainerInitializer {

	// Constants ------------------------------------------------------------------------------------------------------

	private static final Logger logger = Logger.getLogger(ApplicationInitializer.class.getName());

	static final String WARNING_OMNIFACES_INITIALIZATION_FAIL =
			"OmniFaces failed to initialize! %s";
	static final String ERROR_OMNIFACES_INITIALIZATION_FAIL =
			"OmniFaces failed to initialize! Report an issue to OmniFaces.";

	// Actions --------------------------------------------------------------------------------------------------------

	@Override
	public void onStartup(Set> c, ServletContext servletContext) throws ServletException {
		logOmniFacesVersion();

		try {
			Platform.getDefaultFacesServletMapping(servletContext);
			FacesViews.registerForwardingFilter(servletContext);
		}
		catch (Exception | LinkageError e) {
			if (OmniFaces.skipDeploymentException(servletContext)) {
				logger.log(WARNING, format(WARNING_OMNIFACES_INITIALIZATION_FAIL, e));
			}
			else {
				throw new IllegalStateException(ERROR_OMNIFACES_INITIALIZATION_FAIL, e);
			}
		}
	}

	private void logOmniFacesVersion() {
		logger.info("Using OmniFaces version " + OmniFaces.getVersion());
	}

}