/*
* Copyright (c) 2001-2007 Sun Microsystems, Inc. All rights reserved.
*
* The Sun Project JXTA(TM) Software License
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
*
* 1. Redistributions of source code must retain the above copyright notice,
* this list of conditions and the following disclaimer.
*
* 2. Redistributions in binary form must reproduce the above copyright notice,
* this list of conditions and the following disclaimer in the documentation
* and/or other materials provided with the distribution.
*
* 3. The end-user documentation included with the redistribution, if any, must
* include the following acknowledgment: "This product includes software
* developed by Sun Microsystems, Inc. for JXTA(TM) technology."
* Alternately, this acknowledgment may appear in the software itself, if
* and wherever such third-party acknowledgments normally appear.
*
* 4. The names "Sun", "Sun Microsystems, Inc.", "JXTA" and "Project JXTA" must
* not be used to endorse or promote products derived from this software
* without prior written permission. For written permission, please contact
* Project JXTA at http://www.jxta.org.
*
* 5. Products derived from this software may not be called "JXTA", nor may
* "JXTA" appear in their name, without prior written permission of Sun.
*
* THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED WARRANTIES,
* INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
* FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SUN
* MICROSYSTEMS OR ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
* INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA,
* OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
* LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
* NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
* EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*
* JXTA is a registered trademark of Sun Microsystems, Inc. in the United
* States and other countries.
*
* Please see the license information page at :
* <http://www.jxta.org/project/www/license.html> for instructions on use of
* the license in source files.
*
* ====================================================================
*
* This software consists of voluntary contributions made by many individuals
* on behalf of Project JXTA. For more information on Project JXTA, please see
* http://www.jxta.org.
*
* This license is based on the BSD license adopted by the Apache Foundation.
*/
package net.jxta.impl.endpoint.servlethttp;
import java.io.File;
import java.io.FileInputStream;
import java.io.FileNotFoundException;
import java.io.IOException;
import java.io.InputStream;
import java.net.InetAddress;
import java.net.InetSocketAddress;
import java.util.Collections;
import java.util.Iterator;
import java.util.List;
import java.util.Properties;
import net.jxta.endpoint.EndpointAddress;
import net.jxta.endpoint.EndpointService;
import net.jxta.endpoint.MessageReceiver;
import net.jxta.endpoint.MessengerEvent;
import net.jxta.endpoint.MessengerEventListener;
import net.jxta.exception.PeerGroupException;
import net.jxta.impl.util.TimeUtils;
import net.jxta.logging.Logger;
import net.jxta.logging.Logging;
import org.eclipse.jetty.server.Server;
import org.eclipse.jetty.server.handler.HandlerCollection;
import org.eclipse.jetty.server.handler.ResourceHandler;
import org.eclipse.jetty.servlet.ServletContextHandler;
import org.eclipse.jetty.servlet.ServletHandler;
import org.eclipse.jetty.util.thread.QueuedThreadPool;
/**
* Simple Message Receiver for server side.
*/
class HttpMessageReceiver implements MessageReceiver {
private final static transient Logger LOG = Logging.getLogger(HttpMessageReceiver.class.getName());
/**
* the relative URI of where the message receiver servlet will be mounted.
*/
private final static String MSG_RECEIVER_RELATIVE_URI = "/*";
/**
* The ServletHttpTransport that created this MessageReceiver.
*/
private final ServletHttpTransport servletHttpTransport;
/**
* The public addresses for the this transport.
*/
private final List<EndpointAddress> publicAddresses;
/**
* The min threads that the HTTP server will use for handling requests.
*/
private static int MIN_LISTENER_THREADS = 10;
/**
* The max threads that the HTTP server will use for handling requests.
*/
private static int MAX_LISTENER_THREADS = 200;
/**
* How long a thread can remain idle until the worker thread is let go.
*/
private static long MAX_THREAD_IDLE_DURATION = 30 * TimeUtils.ASECOND;
/**
* The Jetty HTTP Server instance.
*/
private final Server server;
/**
* The listener to invoke when making an incoming messenger.
*/
private MessengerEventListener messengerEventListener;
public HttpMessageReceiver(ServletHttpTransport servletHttpTransport, List<EndpointAddress> publicAddresses, InetAddress useInterface, int port, ClassLoader classLoader) throws PeerGroupException {
this.servletHttpTransport = servletHttpTransport;
this.publicAddresses = publicAddresses;
// read settings from the properties file
Properties prop = getJxtaProperties(
new File(new File(servletHttpTransport.getEndpointService().getGroup().getStoreHome()), "jxta.properties"));
initFromProperties(prop);
if (Logging.SHOW_CONFIG && LOG.isConfigEnabled()) {
StringBuilder configInfo = new StringBuilder("Configuring HTTP Servlet Message Transport : " + servletHttpTransport.getAssignedID());
configInfo.append("\n\tMin threads=").append(MIN_LISTENER_THREADS);
configInfo.append("\n\tMax threads=").append(MAX_LISTENER_THREADS);
configInfo.append("\n\tMax thread idle time=").append(MAX_THREAD_IDLE_DURATION).append("ms");
LOG.config(configInfo.toString());
}
// Initialize the Jetty HTTP Server
InetSocketAddress addrPort = new InetSocketAddress(useInterface, port);
server = new Server(addrPort);
// Jetty 8 doesn't initialise its own thread pool, so do that here:
server.setThreadPool(new QueuedThreadPool());
// Jetty 9 does initialise a QueuedThreadPool for us, so we wouldn't need to create one above.
final QueuedThreadPool threadPool = (QueuedThreadPool) server.getThreadPool();
threadPool.setMinThreads(MIN_LISTENER_THREADS);
threadPool.setMaxThreads(MAX_LISTENER_THREADS);
// Jetty 8:
threadPool.setMaxIdleTimeMs((int) MAX_THREAD_IDLE_DURATION);
// Jetty 9:
// threadPool.setIdleTimeout((int) MAX_THREAD_IDLE_DURATION);
final HandlerCollection handlers = new HandlerCollection();
// Create a context/servlet handler at the root for the specified
// servlet class and add it to the list of handlers the server manages.
final ServletContextHandler servletContextHandler = new ServletContextHandler();
// By default, no session tracking (cookies) is used.
servletContextHandler.setContextPath("/");
// The ClassLoader used to load classes by the HttpContext, from
// the peer group (useful for HttpMessageServlet).
servletContextHandler.setClassLoader(classLoader);
servletContextHandler.setHandler(new ServletHandler());
servletContextHandler.addServlet(HttpMessageServlet.class.getName(), MSG_RECEIVER_RELATIVE_URI);
servletContextHandler.setAttribute("HttpMessageReceiver", this);
handlers.addHandler(servletContextHandler);
// Set up support for downloading midlets.
// TODO need a test for midlet downloading
if (System.getProperty("net.jxta.http.allowdownload") != null) {
final ServletContextHandler resourceContextHandler = new ServletContextHandler();
resourceContextHandler.setContextPath("/midlets/*");
resourceContextHandler.setResourceBase("./midlets/");
resourceContextHandler.setHandler(new ResourceHandler());
handlers.addHandler(resourceContextHandler);
// MJG these were commented out... not sure about them....
// context.setDirAllowed(false);
// context.setServingResources(true);
// String methods[] = {"GET"};
// resHandler.setAllowedMethods(methods);
}
server.setHandler(handlers);
}
synchronized void start() throws PeerGroupException {
try {
server.start();
} catch (Exception e) {
Logging.logCheckedError(LOG, "Could not start server\n", e);
PeerGroupException failure = new PeerGroupException("Could not start server");
failure.initCause(e);
throw failure;
}
messengerEventListener = servletHttpTransport.getEndpointService().addMessageTransport(this);
if (messengerEventListener == null) {
throw new PeerGroupException("Transport registration refused");
}
Logging.logCheckedInfo(LOG, "HTTP Servlet Transport started.");
}
synchronized void stop() {
servletHttpTransport.getEndpointService().removeMessageTransport(this);
messengerEventListener = null;
try {
server.stop();
} catch (InterruptedException e) {
Logging.logCheckedError(LOG, "Interrupted during stop()\n", e);
} catch (Exception e) {
Logging.logCheckedError(LOG, "Exception during stop()\n", e);
}
Logging.logCheckedInfo(LOG, "HTTP Servlet Transport stopped.");
}
/**
* Notify messenger listener that we are ready.
*
* @param newMessenger new messenger
* @param connAddr connection endpoint address
* @return {@code true} if the listener claimed the messenger, {@code false}
* otherwise
*/
boolean messengerReadyEvent(HttpServletMessenger newMessenger, EndpointAddress connAddr) {
MessengerEventListener temp = messengerEventListener;
return null != temp && temp.messengerReady(new MessengerEvent(this, newMessenger, connAddr));
}
/**
* {@inheritDoc}
*/
public Iterator<EndpointAddress> getPublicAddresses() {
return Collections.unmodifiableList(publicAddresses).iterator();
}
/**
* {@inheritDoc}
*/
public String getProtocolName() {
return servletHttpTransport.getConfiguredHttpProtocolName();
}
/**
* {@inheritDoc}
*/
public EndpointService getEndpointService() {
return servletHttpTransport.getEndpointService();
}
/**
* Get the ServletHttpTransport used by this receiver.
* @return the 'parent' ServletHttpTransport.
*/
ServletHttpTransport getServletHttpTransport() {
return servletHttpTransport;
}
/**
* Returns a Properties instance for jxta.properties if the file exists;
* otherwise, returns null.
*
* @param fromFile properties file
* @return the properties object or null if properties file was not found
*/
private static Properties getJxtaProperties(File fromFile) {
Properties prop = new Properties();
InputStream in = null;
try {
in = new FileInputStream(fromFile);
Logging.logCheckedDebug(LOG, "Read properties from ", fromFile.getPath());
} catch (FileNotFoundException e) {
return null;
}
try {
prop.load(in);
} catch (IOException e) {
Logging.logCheckedError(LOG, "Error reading ", fromFile.getPath(), "\n", e);
} finally {
try {
in.close();
} catch (IOException ignored) {
//ignored
}
in = null;
}
return prop;
}
/**
* Reads the properties from the jxta.properties file
*
* @param prop properties to init from
*/
private void initFromProperties(Properties prop) {
if (prop == null) {
Logging.logCheckedConfig(LOG, "jxta.properties not found: using default values");
} else {
Logging.logCheckedConfig(LOG, "Using jxta.properties to configure HTTP server");
String minThreadsStr = prop.getProperty("HttpServer.MinThreads");
String maxThreadsStr = prop.getProperty("HttpServer.MaxThreads");
String maxThreadIdleTimeStr = prop.getProperty("HttpServer.MaxThreadIdleTime");
try {
if (minThreadsStr != null) MIN_LISTENER_THREADS = Integer.parseInt(minThreadsStr);
} catch (NumberFormatException e) {
Logging.logCheckedWarning(LOG, "Invalid HttpServer.MinThreads value; using default");
}
try {
if (maxThreadsStr != null)
MAX_LISTENER_THREADS = Integer.parseInt(maxThreadsStr);
} catch (NumberFormatException e) {
Logging.logCheckedWarning(LOG, "Invalid HttpServer.MaxThreads value; using default");
}
try {
if (maxThreadIdleTimeStr != null)
MAX_THREAD_IDLE_DURATION = Integer.parseInt(maxThreadIdleTimeStr);
} catch (NumberFormatException e) {
Logging.logCheckedWarning(LOG, "Invalid HttpServer.MaxThreadIdleTime value; using default");
}
}
}
}