org.primefaces.context.RequestContext Maven / Gradle / Ivy
/*
* Copyright 2009-2014 PrimeTek.
*
* 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.primefaces.context;
import java.util.Collection;
import java.util.List;
import java.util.Map;
import javax.faces.application.FacesMessage;
import javax.faces.context.FacesContext;
import org.primefaces.component.api.AutoUpdatable;
import org.primefaces.util.AjaxRequestBuilder;
import org.primefaces.util.CSVBuilder;
import org.primefaces.util.StringEncrypter;
import org.primefaces.util.WidgetBuilder;
/**
* A RequestContext is a helper class consisting of several utilities.
* RequestContext is thread-safe and scope is same as FacesContext.
* Current instance can be retrieved as;
*
* RequestContext.getCurrentInstance();
*
*/
public abstract class RequestContext {
private static final ThreadLocal INSTANCE = new ThreadLocal();
private static final String INSTANCE_KEY = RequestContext.class.getName();
public static RequestContext getCurrentInstance() {
RequestContext context = INSTANCE.get();
// #6503 - it's valid that a FacesContext can be released during the request
// Our PrimeFacesContext therefore will only release our ThreadLocal cache
// The RequestContext will be destroyed automatically if the FacesContext and it's attributes will be destroyed
if (context == null) {
FacesContext facesContext = FacesContext.getCurrentInstance();
if (facesContext != null && !facesContext.isReleased()) {
context = (RequestContext) facesContext.getAttributes().get(INSTANCE_KEY);
if (context != null) {
INSTANCE.set(context);
}
}
}
return INSTANCE.get();
}
public static void setCurrentInstance(final RequestContext context, final FacesContext facesContext) {
if (context == null) {
INSTANCE.remove();
facesContext.getAttributes().remove(INSTANCE_KEY);
} else {
INSTANCE.set(context);
facesContext.getAttributes().put(INSTANCE_KEY, context);
}
}
public static void releaseThreadLocalCache() {
INSTANCE.remove();
}
/**
* @return true if request is an ajax request, otherwise return false.
*/
public abstract boolean isAjaxRequest();
/**
* Add a parameter for ajax oncomplete client side callbacks. Value would be serialized to json.
* Currently supported values are plain objects, primitives, JSONObject and JSONArray.
*
* @param name name of the parameter.
* @param object value of the parameter.
*/
public abstract void addCallbackParam(String name, Object value);
/**
* @return all callback parameters added in the current request.
*/
public abstract Map getCallbackParams();
/**
* @return all scripts added in the current request.
*/
public abstract List getScriptsToExecute();
/**
* Execute a javascript after current ajax request is completed.
* @param script Javascript statement to execute.
*/
public abstract void execute(String script);
/**
* Scroll to a component after ajax request is completed.
* @param clientId Client side identifier of the component.
*/
public abstract void scrollTo(String clientId);
/**
* Update a component with ajax.
* @param name Client side identifier of the component.
*/
public abstract void update(String name);
/**
* Update components with ajax.
* @param collection Client side identifiers of the components.
*/
public abstract void update(Collection collection);
/**
* Reset an editableValueHolder.
* @param expressions A string with one or multiple search expression to resolve the components.
*/
public abstract void reset(String expressions);
/**
* Reset a collection of editableValueHolders.
* @param expressions A list with with one or multiple search expression to resolve the components.
*/
public abstract void reset(Collection expressions);
/**
* @return Shared WidgetBuilder instance of the current request
*/
public abstract WidgetBuilder getWidgetBuilder();
/**
* @return Shared AjaxRequestBuilder instance of the current request
*/
public abstract AjaxRequestBuilder getAjaxRequestBuilder();
/**
* @return Shared Client Side Validation builder instance of the current request
*/
public abstract CSVBuilder getCSVBuilder();
/**
* @return Attributes map in RequestContext scope
*/
public abstract Map getAttributes();
/**
* Open a view in dialog.
* @param outcome The logical outcome used to resolve a navigation case.
*/
public abstract void openDialog(String outcome);
/**
* Open a view in dialog.
* @param outcome The logical outcome used to resolve a navigation case.
* @param options Configuration options for the dialog.
* @param params Parameters to send to the view displayed in a dialog.
*/
public abstract void openDialog(String outcome, Map options, Map> params);
/**
* Close a dialog.
* @param data Optional data to pass back to a dialogReturn event.
*/
public abstract void closeDialog(Object data);
/**
* Displays a message in a dialog.
* @param message FacesMessage to be displayed.
*/
public abstract void showMessageInDialog(FacesMessage message);
/**
* @return ApplicationContext instance.
*/
public abstract ApplicationContext getApplicationContext();
/**
* @return StringEncrypter used to encode and decode a string.
*/
public abstract StringEncrypter getEncrypter();
/**
* Clear resources.
*/
public abstract void release();
/**
* Returns a boolean indicating whether this request was made using a secure channel, such as HTTPS.
*/
public abstract boolean isSecure();
/**
* @return true if {@link AutoUpdatable} components should not be updated automatically in this request.
*/
public abstract boolean isIgnoreAutoUpdate();
public abstract boolean isRTL();
}