org.joinfaces.autoconfigure.primefaces.Primefaces4_0Properties Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of joinfaces-autoconfigure Show documentation
JoinFaces AutoConfigure
There is a newer version: 5.4.1
Show newest version
/*
 * Copyright 2016-2022 the original author or authors.
 *
 * 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.joinfaces.autoconfigure.primefaces;

import lombok.Data;
import lombok.NoArgsConstructor;
import org.joinfaces.autoconfigure.servlet.initparams.ServletContextInitParameter;
import org.joinfaces.autoconfigure.servlet.initparams.ServletContextInitParameterProperties;
import org.primefaces.component.captcha.Captcha;
import org.primefaces.util.Constants;

import org.springframework.boot.context.properties.ConfigurationProperties;

/**
 * Configuration properties for Primefaces 4.0.
 *
 * Values taken from https://www.primefaces.org/docs/guide/primefaces_user_guide_4_0.pdf
 * page 15, 56.
 *
 * @author Lars Grefer
 */
@Data
@NoArgsConstructor
@ConfigurationProperties("joinfaces.primefaces")
public class Primefaces4_0Properties implements ServletContextInitParameterProperties {

	/**
	 * Theme of the application.
	 */
	@ServletContextInitParameter(Constants.ContextParams.THEME)
	private String theme;

	/**
	 * Custom server url for PrimeFaces Push.
	 */
	@ServletContextInitParameter("primefaces.PUSH_SERVER_URL")
	private String pushServerUrl;

	/**
	 * Defines ajax submit mode, full or partial.
	 */
	@ServletContextInitParameter(Constants.ContextParams.SUBMIT)
	private String submit;

	/**
	 * Defines orientation, ltr or rtl.
	 */
	@ServletContextInitParameter(Constants.ContextParams.DIRECTION)
	private String dir;

	/**
	 * When enabled, ajax updated inputs are reset first.
	 */
	@ServletContextInitParameter(Constants.ContextParams.RESET_VALUES)
	private Boolean resetValues;

	/**
	 * Secret key to encrypt-decrypt value expressions exposed in rendering StreamedContents.
	 */
	@ServletContextInitParameter("primefaces.SECRET")
	private String secret = "primefaces";

	/**
	 * Controls client side validatation.
	 */
	@ServletContextInitParameter(Constants.ContextParams.CSV)
	private Boolean clientSideValidation;

	/**
	 * Defines uploader mode; auto, native or commons.
	 */
	@SuppressWarnings("removal")
	@Deprecated(since = "PrimeFaces 14", forRemoval = true)
	@ServletContextInitParameter(Constants.ContextParams.UPLOADER)
	private String uploader;

	/**
	 * Private reCaptcha key.
	 */
	@ServletContextInitParameter(Captcha.PRIVATE_KEY)
	private String privateCaptchaKey;

	/**
	 * Public reCaptcha key.
	 */
	@ServletContextInitParameter(Captcha.PUBLIC_KEY)
	private String publicCaptchaKey;
}