com.vaadin.server.DeploymentConfiguration Maven / Gradle / Ivy
/*
* Vaadin Framework 7
*
* Copyright (C) 2000-2024 Vaadin Ltd
*
* This program is available under Vaadin Commercial License and Service Terms.
*
* See for the full
* license.
*/
package com.vaadin.server;
import java.io.Serializable;
import java.util.Properties;
import com.vaadin.data.util.AbstractProperty;
import com.vaadin.shared.communication.PushMode;
/**
* A collection of properties configured at deploy time as well as a way of
* accessing third party properties not explicitly supported by this class.
*
* @author Vaadin Ltd
* @version @VERSION@
* @since 7.0.0
*/
public interface DeploymentConfiguration extends Serializable {
/**
* Determines the mode of the "legacyPropertyToString" parameter.
*
* @author Vaadin Ltd
* @since 7.1
*/
@Deprecated
public enum LegacyProperyToStringMode {
DISABLED("false"), WARNING("warning"), ENABLED("true");
private final String propertyString;
private LegacyProperyToStringMode(String propertyString) {
this.propertyString = propertyString;
}
/**
* Gets the string that should be used in e.g. web.xml for selecting
* this mode.
*
* @return the property value
*/
public String getPropertyString() {
return propertyString;
}
@Override
public String toString() {
// Used by VaadinServlet.readConfigurationAnnotation()
return getPropertyString();
}
public boolean useLegacyMode() {
return this == WARNING || this == ENABLED;
}
}
/**
* Returns whether Vaadin is in production mode.
*
* @return true if in production mode, false otherwise.
*/
public boolean isProductionMode();
/**
* Returns whether cross-site request forgery protection is enabled.
*
* @return true if XSRF protection is enabled, false otherwise.
*/
public boolean isXsrfProtectionEnabled();
/**
* Returns whether sync id checking is enabled. The sync id is used to
* gracefully handle situations when the client sends a message to a
* connector that has recently been removed on the server.
*
* @since 7.3
* @return true if sync id checking is enabled;
* false otherwise
*/
public boolean isSyncIdCheckEnabled();
/**
* Returns the time resources can be cached in the browsers, in seconds.
*
* @return The resource cache time.
*/
public int getResourceCacheTime();
/**
* Returns the number of seconds between heartbeat requests of a UI, or a
* non-positive number if heartbeat is disabled.
*
* @return The time between heartbeats.
*/
public int getHeartbeatInterval();
/**
* Returns whether the sending of URL's as GET and POST parameters in
* requests with content-type application/x-www-form-urlencoded
* is enabled or not.
*
* @return false if set to false or true otherwise
*/
public boolean isSendUrlsAsParameters();
/**
* Returns whether a session should be closed when all its open UIs have
* been idle for longer than its configured maximum inactivity time.
*
* A UI is idle if it is open on the client side but has no activity other
* than heartbeat requests. If {@code isCloseIdleSessions() == false},
* heartbeat requests cause the session to stay open for as long as there
* are open UIs on the client side. If it is {@code true}, the session is
* eventually closed if the open UIs do not have any user interaction.
*
* @see WrappedSession#getMaxInactiveInterval()
*
* @since 7.0.0
*
* @return True if UIs and sessions receiving only heartbeat requests are
* eventually closed; false if heartbeat requests extend UI and
* session lifetime indefinitely.
*/
public boolean isCloseIdleSessions();
/**
* Returns the mode of bidirectional ("push") client-server communication
* that should be used.
*
* @return The push mode in use.
*/
public PushMode getPushMode();
/**
* Gets the properties configured for the deployment, e.g. as init
* parameters to the servlet or portlet.
*
* @return properties for the application.
*/
public Properties getInitParameters();
/**
* Gets a configured property. The properties are typically read from e.g.
* web.xml or from system properties of the JVM.
*
* @param propertyName
* The simple of the property, in some contexts, lookup might be
* performed using variations of the provided name.
* @param defaultValue
* the default value that should be used if no value has been
* defined
* @return the property value, or the passed default value if no property
* value is found
*/
public String getApplicationOrSystemProperty(String propertyName,
String defaultValue);
/**
* Gets UI class configuration option value.
*
* @return UI class name
*
* @since 7.4
*/
public String getUIClassName();
/**
* Gets UI provider class configuration option value.
*
* @since 7.4
*
* @return UI class name
*/
public String getUIProviderClassName();
/**
* Gets Widgetset configuration option value. {@code defaultValue} is
* returned if widgetset parameter is not configured.
*
* @since 7.4
*
* @return UI class name
*/
public String getWidgetset(String defaultValue);
/**
* Gets resources path configuration option value.
*
* @since 7.4
*/
public String getResourcesPath();
/**
* Gets class loader configuration option value.
*
* @since 7.4
*/
public String getClassLoaderName();
/**
* Returns to legacy Property.toString() mode used. See
* {@link AbstractProperty#isLegacyToStringEnabled()} for more information.
*
* @return The Property.toString() mode in use.
*/
@Deprecated
public LegacyProperyToStringMode getLegacyPropertyToStringMode();
}