net.databinder.DataApplication Maven / Gradle / Ivy
/*
* Databinder: a simple bridge from Wicket to Hibernate
* Copyright (C) 2006 Nathan Hamblen [email protected]
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 2.1 of the License, or (at your option) any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
*/
package net.databinder;
import java.net.URL;
import java.util.Locale;
import javax.servlet.http.HttpServletResponse;
import net.databinder.components.PageExpiredCookieless;
import net.databinder.util.URLConverter;
import org.hibernate.cfg.AnnotationConfiguration;
import wicket.ISessionFactory;
import wicket.Session;
import wicket.markup.html.pages.PageExpiredErrorPage;
import wicket.protocol.http.BufferedWebResponse;
import wicket.protocol.http.WebApplication;
import wicket.protocol.http.WebResponse;
import wicket.util.convert.Converter;
import wicket.util.convert.IConverterFactory;
/**
* Databinder Application subclass for request cycle hooks and a basic configuration.
* @author Nathan Hamblen
*/
public abstract class DataApplication extends WebApplication {
/** true if in development mode, false if deployment */
private boolean development;
/** true if cookieless use is supported through URL rewriting(defaults to true). */
private boolean cookielessSupported = true;
/**
* Configures this application for development or production, turns off
* default page versioning, and establishes a DataSession factory, and
* initializes Hibernate. Development mode is the default; set a JVM property of
* wicket.configuration=deployment for production. (The context and init params
* in wicket.protocol.http.WebApplication are not supported here). Override
* this method for further customization.
*/
@Override
protected void init() {
// this databinder-specific parameter will eventually be dropped in favor
// of wicket.configuration
String configuration = System.getProperty("net.databinder.configuration");
if (configuration != null)
configure(configuration);
else
configuration = System.getProperty("wicket." + CONFIGURATION, DEVELOPMENT);
// (if using wicket.configuration, calling configure() is unnecessary)
development = configuration.equalsIgnoreCase(DEVELOPMENT);
// versioning doesn't do so much for database driven pages
getPageSettings().setVersionPagesByDefault(false);
getApplicationSettings().setConverterFactory(new IConverterFactory() {
/** Registers URLConverter in addition to the Wicket defaults. */
public wicket.util.convert.IConverter newConverter(Locale locale) {
Converter conv = new Converter(locale);
conv.set(URL.class, new URLConverter());
return conv;
}
});
setSessionFactory(new ISessionFactory() {
public Session newSession()
{
return newDataSession();
}
});
DataRequestCycle.initHibernate(); // don't wait for first request
}
/**
* Returns a new instance of a DataSession. Override if your application uses
* its own DataSession subclass.
* @return new instance of DataSession
*/
protected DataSession newDataSession() {
return new DataSession(DataApplication.this);
}
/**
* Reports if the program is running in a development environment, as determined by the
* "net.databinder.configuration" environment variable. If that variable is unset or set to
* "development", the app is considered to be running in development.
* @return true if running in a development environment
*/
protected boolean isDevelopment() {
return development;
}
/**
* Override to add annotated classes for persistent storage by Hibernate, but don't forget
* to call this super-implementation. If running in a development environment,
* the session factory is set for hbm2ddl auto updating to create and add columns to tables
* as required. Otherwise, it is configured for C3P0 connection pooling. (At present the two
* seem to be incompatible.) If you don't want this behaviour, don't call the
* super-implementation.
* @param config used to build Hibernate session factory
*/
protected void configureHibernate(AnnotationConfiguration config) {
if (isDevelopment())
config.setProperty("hibernate.hbm2ddl.auto", "update");
else {
config.setProperty("hibernate.c3p0.max_size", "20")
.setProperty("hibernate.c3p0.timeout","3000")
.setProperty("hibernate.c3p0.idle_test_period", "300");
}
}
/**
* If isCookielessSupported() returns false, this method returns
* a custom WebResponse that disables URL rewriting.
*/
@Override
protected WebResponse newWebResponse(final HttpServletResponse servletResponse)
{
if (isCookielessSupported())
return super.newWebResponse(servletResponse);
if (getRequestCycleSettings().getBufferResponse())
return new BufferedWebResponse(servletResponse) {
@Override
public CharSequence encodeURL(CharSequence url) {
return url;
}
};
else
return (new WebResponse(servletResponse) {
@Override
public CharSequence encodeURL(CharSequence url) {
return url;
}
});
}
/**
* @return true if cookieless use is supported through URL rewriting.
*/
public boolean isCookielessSupported() {
return cookielessSupported;
}
/**
* Set to false to disable URL rewriting and consequentally hamper cookieless
* browsing. Users with cookies disabled, and more importantly search engines,
* will still be able to browse the application through bookmarkable URLs. Because
* rewriting is disabled, these URLs will have no jsessionid appended and will
* remain static.
* The Application's "page expired" error page will be set to PageExpiredCookieless
* if cookielessSupported is false, unless an alternate error page has already been
* specified. This page will appear when cookieless users try to follow a link or
* form-submit that requires a session, informing them that cookies are required.
*
* @param cookielessSupported true if cookieless use is supported through
* URL rewriting
* @see net.databinder.components.PageExpiredCookieless
*/
protected void setCookielessSupported(boolean cookielessSupported) {
Class expected = this.cookielessSupported ?
PageExpiredErrorPage.class : PageExpiredCookieless.class;
this.cookielessSupported = cookielessSupported;
if (getApplicationSettings().getPageExpiredErrorPage().equals(expected))
getApplicationSettings().setPageExpiredErrorPage(cookielessSupported ?
PageExpiredErrorPage.class : PageExpiredCookieless.class);
}
}