org.thymeleaf.spring5.expression.SPELContextMapWrapper Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of thymeleaf-spring5 Show documentation
Show all versions of thymeleaf-spring5 Show documentation
Modern server-side Java template engine for both web and standalone environments
/*
* =============================================================================
*
* Copyright (c) 2011-2018, The THYMELEAF team (http://www.thymeleaf.org)
*
* 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
*
* http://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.thymeleaf.spring5.expression;
import java.util.Collection;
import java.util.Map;
import java.util.Set;
import org.thymeleaf.context.IContext;
import org.thymeleaf.exceptions.TemplateProcessingException;
/**
*
* Wrapper on {@link IContext} objects that makes them look like {@code java.util.Map} objects
* in order to be used at the root of SpEL expressions without the need to use custom property accessors
* in most scenarios.
*
*
* @author Daniel Fernández
*
* @since 3.0.3
*
*/
public final class SPELContextMapWrapper implements Map {
private static final String REQUEST_PARAMETERS_RESTRICTED_VARIABLE_NAME = "param";
private final IContext context;
private final IThymeleafEvaluationContext evaluationContext;
SPELContextMapWrapper(final IContext context, final IThymeleafEvaluationContext evaluationContext) {
super();
this.context = context;
this.evaluationContext = evaluationContext;
}
public int size() {
throw new TemplateProcessingException(
"Cannot call #size() on an " + IContext.class.getSimpleName() + " implementation");
}
public boolean isEmpty() {
throw new TemplateProcessingException(
"Cannot call #isEmpty() on an " + IContext.class.getSimpleName() + " implementation");
}
public boolean containsKey(final Object key) {
if (this.evaluationContext.isVariableAccessRestricted()) {
if (REQUEST_PARAMETERS_RESTRICTED_VARIABLE_NAME.equals(key)) {
throw new TemplateProcessingException(
"Access to variable \"" + key + "\" is forbidden in this context. Note some restrictions apply to " +
"variable access. For example, direct access to request parameters is forbidden in preprocessing and " +
"unescaped expressions, in TEXT template mode, in fragment insertion specifications and " +
"in some specific attribute processors.");
}
}
// We will be NOT calling this.context.containsVariable(key) as it could be very inefficient in web
// environments (based on HttpServletRequest#getAttributeName()), so we will just consider that every possible
// element exists in an IContext, and simply return null for those not found
return this.context != null;
}
public boolean containsValue(final Object value) {
throw new TemplateProcessingException(
"Cannot call #containsValue(value) on an " + IContext.class.getSimpleName() + " implementation");
}
public Object get(final Object key) {
if (this.context == null) {
throw new TemplateProcessingException("Cannot read property on null target");
}
/*
* NOTE we do not check here whether we are being asked for the 'locale', 'request', 'response', etc.
* because there already are specific expression objects for the most important of them, which should
* be used instead: #locale, #httpServletRequest, #httpSession, etc.
* The context should just be used as a map, without exposure of its more-internal methods...
*/
// 'execInfo' translation from context variable to expression object - deprecated and to be removed in 3.1
if ("execInfo".equals(key)) { // Quick check to avoid deprecated method call
final Object execInfoResult = SPELContextPropertyAccessor.checkExecInfo(key.toString(), this.evaluationContext);
if (execInfoResult != null) {
return execInfoResult;
}
}
return this.context.getVariable(key == null? null : key.toString());
}
public Object put(final Object key, final Object value) {
throw new TemplateProcessingException(
"Cannot call #put(key,value) on an " + IContext.class.getSimpleName() + " implementation");
}
public Object remove(final Object key) {
throw new TemplateProcessingException(
"Cannot call #remove(key) on an " + IContext.class.getSimpleName() + " implementation");
}
public void putAll(final Map m) {
throw new TemplateProcessingException(
"Cannot call #putAll(m) on an " + IContext.class.getSimpleName() + " implementation");
}
public void clear() {
throw new TemplateProcessingException(
"Cannot call #clear() on an " + IContext.class.getSimpleName() + " implementation");
}
public Set keySet() {
throw new TemplateProcessingException(
"Cannot call #keySet() on an " + IContext.class.getSimpleName() + " implementation");
}
public Collection values() {
throw new TemplateProcessingException(
"Cannot call #values() on an " + IContext.class.getSimpleName() + " implementation");
}
public Set entrySet() {
throw new TemplateProcessingException(
"Cannot call #entrySet() on an " + IContext.class.getSimpleName() + " implementation");
}
}
© 2015 - 2024 Weber Informatics LLC | Privacy Policy