org.apache.empire.jakarta.app.WebApplication Maven / Gradle / Ivy
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you 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.apache.empire.jakarta.app;
import java.sql.Connection;
import java.sql.SQLException;
import java.util.HashMap;
import java.util.Iterator;
import java.util.Locale;
import java.util.Map;
import java.util.ResourceBundle;
import javax.sql.DataSource;
import org.apache.empire.commons.StringUtils;
import org.apache.empire.data.DataType;
import org.apache.empire.db.DBDatabase;
import org.apache.empire.db.context.DBRollbackManager;
import org.apache.empire.db.context.DBRollbackManager.ReleaseAction;
import org.apache.empire.db.exceptions.UserLevelException;
import org.apache.empire.exceptions.InternalException;
import org.apache.empire.exceptions.InvalidArgumentException;
import org.apache.empire.exceptions.NotSupportedException;
import org.apache.empire.exceptions.UnexpectedReturnValueException;
import org.apache.empire.jakarta.controls.TextAreaInputControl;
import org.apache.empire.jakarta.controls.TextInputControl;
import org.apache.empire.jakarta.impl.FacesImplementation;
import org.apache.empire.jakarta.impl.ResourceTextResolver;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import jakarta.faces.application.Application;
import jakarta.faces.application.FacesMessage;
import jakarta.faces.application.FacesMessage.Severity;
import jakarta.faces.application.ViewExpiredException;
import jakarta.faces.component.NamingContainer;
import jakarta.faces.component.UIComponent;
import jakarta.faces.component.UIViewRoot;
import jakarta.faces.context.ExternalContext;
import jakarta.faces.context.FacesContext;
import jakarta.servlet.ServletContext;
import jakarta.servlet.http.HttpServletRequest;
public abstract class WebApplication
{
private static final Logger log = LoggerFactory.getLogger(WebApplication.class);
private static final String REQUEST_CONNECTION_MAP = "requestConnectionMap";
private static final String CONN_ROLLBACK_MANAGER = "connRollbackManager";
public static String APPLICATION_BEAN_NAME = "webApplication";
protected TextResolver[] textResolvers = null;
private String webRoot = null;
private FacesImplementation facesImpl = null;
private static WebApplication appInstance = null;
/**
* Returns the one and only instance of the WebApplication (Singleton)
* @param the application type
* @return the WebApplication instance
*/
@SuppressWarnings("unchecked")
public static T getInstance()
{
if (appInstance==null)
log.warn("No WebApplication instance available. Please add a PostConstructApplicationEvent using WebAppStartupListener in your faces-config.xml to create the WebApplication object.");
// return instance
return (T)appInstance;
}
protected abstract void init(ServletContext servletContext);
protected abstract DataSource getAppDataSource(DBDatabase db);
protected WebApplication()
{ // subscribe
log.info("WebApplication {} created", getClass().getName());
// Must be a singleton
if (appInstance!=null) {
throw new RuntimeException("An attempt was made to create second instance of WebApplication. WebApplication must be a Singleton!");
}
// set Instance
appInstance = this;
}
/**
* Init the Application
* @param facesImpl the faces implementation
* @param startupContext the startup context
*/
public final void init(FacesImplementation facesImpl, FacesContext startupContext)
{
// Only call once!
if (this.facesImpl!=null || this.webRoot!=null)
{ // already initialized
log.warn("WARNING: WebApplication has already been initialized! Continuing without init...");
return;
}
// set imppl
this.facesImpl = facesImpl;
// webRoot
ServletContext servletContext = (ServletContext) startupContext.getExternalContext().getContext();
webRoot = servletContext.getContextPath();
servletContext.setAttribute("webRoot", webRoot);
servletContext.setAttribute("app", this);
// Init
init(servletContext);
// post init
if (this.textResolvers==null)
{ // text resolvers
log.info("*** initTextResolvers() ***");
initTextResolvers(startupContext.getApplication());
}
// Log info
log.info("*** WebApplication initialization complete ***");
log.info("JSF-Implementation is '{}'", facesImpl.getClass().getName());
log.info("WebRoot is '{}'", webRoot);
}
public void destroy()
{
// Override if needed
}
/* Context handling */
/**
* handle request cleanup
* @param ctx the faces context
*/
public void onRequestComplete(final FacesContext ctx)
{
releaseAllConnections(ctx);
}
/**
* handle view not found
* @param fc the faces context
* @param req the request
*/
public void onViewNotFound(final FacesContext fc, final HttpServletRequest req)
{ // View not Found Error
log.warn("No view found for request to '{}'. Use FacesUtils.redirectDirectly() to redirect to valid view.", req.getRequestURI());
}
/**
* handle view change
* @param fc the faces context
* @param viewId the view id
*/
public void onChangeView(final FacesContext fc, String viewId)
{ // allow custom view change logic
// clear page resources
Map sm = FacesUtils.getSessionMap(fc);
if (sm!=null)
sm.remove(FacesUtils.PAGE_RESOURCE_MAP_ATTRIBUTE);
}
/**
* adds a Javascript call to the request
* @param fc the faces context
* @param function the javascript command
*/
public void addJavascriptCall(final FacesContext fc, String function)
{
throw new NotSupportedException(this, "addJavascriptCall");
}
/**
* return the interface for Implementation specific features
* that are specific for Mojarra or MyFaces
* @return the faces implementation
*/
public FacesImplementation getFacesImplementation()
{
return facesImpl;
}
/**
* returns the web context path as returned from ServletContext.getContextPath()
* @return the web root
*/
public String getWebRoot()
{
return webRoot;
}
/**
* returns the active locale for a given FacesContext
* @param ctx the faces context
* @return the context locale
*/
public Locale getContextLocale(final FacesContext ctx)
{
UIViewRoot root;
// Start out with the default locale
Locale locale;
Locale defaultLocale = Locale.getDefault();
locale = defaultLocale;
// See if this FacesContext has a ViewRoot
if (null != (root = ctx.getViewRoot()))
{
// If so, ask it for its Locale
if (null == (locale = root.getLocale()))
{
// If the ViewRoot has no Locale, fall back to the default.
locale = defaultLocale;
}
}
return locale;
}
public TextResolver getTextResolver(Locale locale)
{
// No text Resolvers provided
if (textResolvers == null || textResolvers.length == 0)
{
throw new NotSupportedException(this, "getTextResolver");
}
// Lookup resolver for locale
for (int i = 0; i < textResolvers.length; i++)
if (locale.equals(textResolvers[i].getLocale()))
return textResolvers[i];
// locale not found: return default
return textResolvers[0];
}
public TextResolver getTextResolver(FacesContext ctx)
{
return getTextResolver(getContextLocale(ctx));
}
/**
* checks if the current context contains an error
* @param fc the FacesContext
* @return true if the context has an error set or false otherwise
*/
public boolean hasError(final FacesContext fc)
{
Iterator msgIterator = fc.getMessages();
if (msgIterator != null)
{ // Check Messages
while (msgIterator.hasNext())
{ // Check Severity
Severity fms = msgIterator.next().getSeverity();
if (fms == FacesMessage.SEVERITY_ERROR || fms == FacesMessage.SEVERITY_FATAL)
return true;
}
}
return false;
}
/**
* Logs an exception as Error with additional information
* @param message the message to log
* @param e the underlying exception
*/
public void logException(Logger logger, String message, Throwable e)
{
if (logger==null)
logger=log;
// View Exceptions
if ((e instanceof ViewExpiredException)) // || (e instanceof ViewNotFoundException)) -- MyFaces only
{ // Session expired
logger.warn(message+": "+e.getMessage());
return;
}
// Get Session Info
String addlInfo;
try {
FacesContext fc = FacesContext.getCurrentInstance();
ExternalContext ec = (fc!=null ? fc.getExternalContext() : null);
String sessionInfo = (ec!=null ? getExceptionSessionInfo(ec.getSessionMap()) : "[NoSession]");
addlInfo = StringUtils.coalesce(sessionInfo, "[NoSessionInfo]");
} catch(Exception ex) {
addlInfo = "[Error:"+ex.getMessage()+"] ";
}
// Log now
if (e instanceof UserLevelException)
logger.info(StringUtils.concat(addlInfo, e.getClass().getSimpleName(), ": ", e.getMessage()));
else
logger.error(StringUtils.concat(addlInfo, message), e);
}
/**
* Override this to provide additonal session info for an exception
* @param sessionMap
* @return the additional session info
*/
protected String getExceptionSessionInfo(Map sessionMap)
{
return null;
}
/**
* returns true if a form input element has been partially submitted
* @param fc the Faces Context
* @return the componentId or null if no partial submit was been performed
*/
public boolean isPartialSubmit(final FacesContext fc)
{
// Override for your JSF component Framework. e.g. for IceFaces
// Map parameterMap = fc.getExternalContext().getRequestParameterMap();
// return ObjectUtils.getBoolean(parameterMap.get("ice.submit.partial"));
return false;
}
/**
* returns the componentId for which a partial submit has been performed.
* @param fc the Faces Context
* @return the componentId or null if no partial submit was been performed
*/
public String getPartialSubmitComponentId(final FacesContext fc)
{
Map parameterMap = fc.getExternalContext().getRequestParameterMap();
return parameterMap.get("jakarta.faces.source"); // or jakarta.faces.partial.execute ?
}
/**
* finds the component with the given id that is located in the same NamingContainer as a given component
* @param fc the FacesContext
* @param componentId the component id
* @param nearComponent a component within the same naming container from which to start the search (optional)
* @return the component or null if no component was found
*/
public UIComponent findComponent(FacesContext fc, String componentId, UIComponent nearComponent)
{
if (StringUtils.isEmpty(componentId))
throw new InvalidArgumentException("componentId", componentId);
// Begin search near given component (if any)
UIComponent component = null;
if (nearComponent != null)
{ // Search below the nearest naming container
component = nearComponent.findComponent(componentId);
if (component == null)
{ // Recurse upwards
UIComponent nextParent = nearComponent;
while (true)
{
nextParent = nextParent.getParent();
// search NamingContainers only
while (nextParent != null && !(nextParent instanceof NamingContainer))
{
nextParent = nextParent.getParent();
}
if (nextParent == null)
{
break;
}
else
{
component = nextParent.findComponent(componentId);
}
if (component != null)
{
break;
}
}
}
}
// Not found. Search the entire tree
if (component == null)
component = findChildComponent(fc.getViewRoot(), componentId);
// done
return component;
}
/**
* finds a child component with the given id that is located below the given parent component
* @param parent the parent
* @param componentId the component id
* @return the component or null if no component was found
*/
public static UIComponent findChildComponent(UIComponent parent, String componentId)
{
UIComponent component = null;
if (parent.getChildCount() == 0)
return null;
Iterator children = parent.getChildren().iterator();
while (children.hasNext())
{
UIComponent nextChild = children.next();
if (nextChild instanceof NamingContainer)
{
component = nextChild.findComponent(componentId);
}
if (component == null)
{
component = findChildComponent(nextChild, componentId);
}
if (component != null)
{
break;
}
}
return component;
}
/**
* returns the default input control type for a given data Type
* @see org.apache.empire.jakarta.controls.InputControlManager
* @param dataType
* @return an Input Cnotrol type
*/
public String getDefaultControlType(DataType dataType)
{
switch (dataType)
{
case CLOB:
return TextAreaInputControl.NAME;
default:
return TextInputControl.NAME;
}
}
/* Message handling */
protected void initTextResolvers(Application app)
{
int count = 0;
Iterator locales = app.getSupportedLocales();
for (count = 0; locales.hasNext(); count++)
{
locales.next();
}
// get message bundles
String messageBundle = app.getMessageBundle();
textResolvers = new TextResolver[count];
locales = app.getSupportedLocales();
for (int i = 0; locales.hasNext(); i++)
{
Locale locale = locales.next();
textResolvers[i] = new ResourceTextResolver(ResourceBundle.getBundle(messageBundle, locale));
log.info("added TextResolver for {} bundle='{}'", locale.getLanguage(), messageBundle);
}
}
/**
* Obtains a JDBC-Connection from the connection pool
* @param db the database for which to obtain a connection
* @return the connection
*/
protected Connection getConnection(DBDatabase db)
{
// Get From Pool
try
{ // Obtain a connection
Connection conn = getAppDataSource(db).getConnection();
conn.setAutoCommit(false);
log.trace("Connection {} obtained from pool", conn.hashCode());
return conn;
}
catch (SQLException e)
{
log.error("Failed to get connection from pool.", e);
throw new InternalException(e);
}
}
/**
* Releases a JDBC-Connection from the connection pool
* @param conn the connection to release
* @param commit flag whether to commit changes
* @param dbrm the rollback manager
*/
protected void releaseConnection(Connection conn, boolean commit, DBRollbackManager dbrm)
{
try
{ // check
if (conn == null)
return;
// release connection
log.trace("releasing Connection {}", conn.hashCode());
// Commit or rollback connection depending on the exit code
if (commit)
{ // success: commit all changes
if (dbrm!=null)
dbrm.releaseConnection(conn, ReleaseAction.Discard); // before commit
conn.commit();
log.debug("REQUEST commited.");
}
else
{ // failure: rollback all changes
conn.rollback();
if (dbrm!=null)
dbrm.releaseConnection(conn, ReleaseAction.Rollback); // after rollback
log.debug("REQUEST rolled back.");
}
// Release Connection
conn.close();
// done
if (log.isDebugEnabled())
log.debug("REQUEST returned connection to pool.");
}
catch (SQLException e)
{
log.error("Error releasing connection", e);
e.printStackTrace();
}
}
/**
* Obtains a DBRollbackManager for the current request
* @param fc the FacesContext
* @param create if true a DBRollbackManager will be created if not already present
* @return the rollback manager
*/
public DBRollbackManager getRollbackManagerForRequest(FacesContext fc, boolean create)
{
DBRollbackManager dbrm = (DBRollbackManager)FacesUtils.getRequestAttribute(fc, CONN_ROLLBACK_MANAGER);
if (dbrm==null && create)
{ dbrm = new DBRollbackManager(1, 8);
FacesUtils.setRequestAttribute(fc, CONN_ROLLBACK_MANAGER, dbrm);
}
return dbrm;
}
/**
* Obtains a JDBC-Connection for the current request
* @param fc the FacesContext
* @param db the DBDatabase for which to obtain a connection
* @param create if true a Connection will be created if not already present
* @return the connection
*/
public Connection getConnectionForRequest(FacesContext fc, DBDatabase db, boolean create)
{
if (fc == null)
throw new InvalidArgumentException("FacesContext", fc);
if (db == null)
throw new InvalidArgumentException("DBDatabase", db);
// Get the ConnectionContextInfo map
@SuppressWarnings("unchecked")
Map connMap = (Map) FacesUtils.getRequestAttribute(fc, REQUEST_CONNECTION_MAP);
if (connMap== null && create)
{ connMap = new HashMap(1);
FacesUtils.setRequestAttribute(fc, REQUEST_CONNECTION_MAP, connMap);
}
else if (connMap==null)
{ // Nothing to do
return null;
}
Connection conn = connMap.get(db);
if (conn==null && create)
{ // Get Pooled Connection
conn = getConnection(db);
if (conn== null)
throw new UnexpectedReturnValueException(this, "getConnection");
// Add to map
connMap.put(db, conn);
}
// done
return conn;
}
/**
* Releases all connections attached to the current request
* @param fc the FacesContext
* @param commit when true changes are committed otherwise they are rolled back
*/
public void releaseAllConnections(final FacesContext fc, boolean commit)
{
@SuppressWarnings("unchecked")
Map connMap = (Map) FacesUtils.getRequestAttribute(fc, REQUEST_CONNECTION_MAP);
if (connMap == null)
return; // Nothing to do
// Walk the connection map
DBRollbackManager dbrm = getRollbackManagerForRequest(fc, false);
for (Connection conn : connMap.values())
{
releaseConnection(conn, commit, dbrm);
}
// remove from request map
FacesUtils.setRequestAttribute(fc, REQUEST_CONNECTION_MAP, null);
}
/**
* Releases all connections attached to the current request
* If an error is detected in the faces message list, a rollback will automatically be performed insteamd of a commmit
* @param fc the FacesContext
*/
public void releaseAllConnections(final FacesContext fc)
{
releaseAllConnections(fc, !hasError(fc));
}
/**
* Releases the connection associated with a database from the request
* @param fc the FacesContext
* @param db the DBDatabase for which to release the connection
* @param commit when true changes are committed otherwise they are rolled back
*/
public void releaseConnection(final FacesContext fc, DBDatabase db, boolean commit)
{
@SuppressWarnings("unchecked")
Map connMap = (Map) FacesUtils.getRequestAttribute(fc, REQUEST_CONNECTION_MAP);
if (connMap == null || !connMap.containsKey(db))
return; // Nothing to do;
// Get RollbackManager
DBRollbackManager dbrm = getRollbackManagerForRequest(fc, false);
// Release Connection
Connection conn = connMap.get(db);
releaseConnection(conn, commit, dbrm);
// Remove from map
connMap.remove(db);
}
/**
* Releases the connection associated with a database from the request
* If an error is detected in the faces message list, a rollback will automatically be performed insteamd of a commmit
* @param fc the FacesContext
* @param db the DBDatabase for which to release the connection
*/
public void releaseConnection(final FacesContext fc, DBDatabase db)
{
releaseConnection(fc, db, !hasError(fc));
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy