org.eclipse.jetty.webapp.JettyWebXmlConfiguration Maven / Gradle / Ivy
//
// ========================================================================
// Copyright (c) 1995-2013 Mort Bay Consulting Pty. Ltd.
// ------------------------------------------------------------------------
// All rights reserved. This program and the accompanying materials
// are made available under the terms of the Eclipse Public License v1.0
// and Apache License v2.0 which accompanies this distribution.
//
// The Eclipse Public License is available at
// http://www.eclipse.org/legal/epl-v10.html
//
// The Apache License v2.0 is available at
// http://www.opensource.org/licenses/apache2.0.php
//
// You may elect to redistribute this code under either of these licenses.
// ========================================================================
//
package org.eclipse.jetty.webapp;
import java.util.Map;
import org.eclipse.jetty.util.log.Log;
import org.eclipse.jetty.util.log.Logger;
import org.eclipse.jetty.util.resource.Resource;
import org.eclipse.jetty.xml.XmlConfiguration;
/**
*
* JettyWebConfiguration.
*
* Looks for Xmlconfiguration files in WEB-INF. Searches in order for the first of jettyX-web.xml, jetty-web.xml or web-jetty.xml
*
*
*
*/
public class JettyWebXmlConfiguration extends AbstractConfiguration
{
private static final Logger LOG = Log.getLogger(JettyWebXmlConfiguration.class);
/** The value of this property points to the WEB-INF directory of
* the web-app currently installed.
* it is passed as a property to the jetty-web.xml file */
public static final String PROPERTY_THIS_WEB_INF_URL = "this.web-inf.url";
public static final String XML_CONFIGURATION = "org.eclipse.jetty.webapp.JettyWebXmlConfiguration";
public static final String JETTY_WEB_XML = "jetty-web.xml";
/**
* Configure
* Apply web-jetty.xml configuration
* @see Configuration#configure(WebAppContext)
*/
@Override
public void configure (WebAppContext context) throws Exception
{
//cannot configure if the _context is already started
if (context.isStarted())
{
LOG.debug("Cannot configure webapp after it is started");
return;
}
LOG.debug("Configuring web-jetty.xml");
Resource web_inf = context.getWebInf();
// handle any WEB-INF descriptors
if(web_inf!=null&&web_inf.isDirectory())
{
// do jetty.xml file
Resource jetty=web_inf.addPath("jetty7-web.xml");
if(!jetty.exists())
jetty=web_inf.addPath(JETTY_WEB_XML);
if(!jetty.exists())
jetty=web_inf.addPath("web-jetty.xml");
if(jetty.exists())
{
// No server classes while configuring
String[] old_server_classes = context.getServerClasses();
try
{
context.setServerClasses(null);
if(LOG.isDebugEnabled())
LOG.debug("Configure: "+jetty);
XmlConfiguration jetty_config = (XmlConfiguration)context.getAttribute(XML_CONFIGURATION);
if (jetty_config==null)
{
jetty_config=new XmlConfiguration(jetty.getURL());
}
else
{
context.removeAttribute(XML_CONFIGURATION);
}
setupXmlConfiguration(context,jetty_config, web_inf);
try
{
jetty_config.configure(context);
}
catch (ClassNotFoundException e)
{
LOG.warn("Unable to process jetty-web.xml", e);
}
}
finally
{
if (context.getServerClasses()==null)
context.setServerClasses(old_server_classes);
}
}
}
}
/**
* Configures some well-known properties before the XmlConfiguration reads
* the configuration.
* @param jetty_config The configuration object.
*/
private void setupXmlConfiguration(WebAppContext context, XmlConfiguration jetty_config, Resource web_inf)
{
setupXmlConfiguration(jetty_config,web_inf);
}
/**
* Configures some well-known properties before the XmlConfiguration reads
* the configuration.
* @param jetty_config The configuration object.
*/
private void setupXmlConfiguration(XmlConfiguration jetty_config, Resource web_inf)
{
Map props = jetty_config.getProperties();
props.put(PROPERTY_THIS_WEB_INF_URL, String.valueOf(web_inf.getURL()));
}
}