You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@felix.apache.org by fm...@apache.org on 2009/06/29 09:48:06 UTC
svn commit: r789246 - in
/felix/trunk/webconsole/src/main/java/org/apache/felix/webconsole:
AbstractWebConsolePlugin.java internal/WebConsolePluginAdapter.java
Author: fmeschbe
Date: Mon Jun 29 07:48:06 2009
New Revision: 789246
URL: http://svn.apache.org/viewvc?rev=789246&view=rev
Log:
FELIX-1211 Add support for plugins to provide a getResource method
which is called when a resource might have to be provided.
Modified:
felix/trunk/webconsole/src/main/java/org/apache/felix/webconsole/AbstractWebConsolePlugin.java
felix/trunk/webconsole/src/main/java/org/apache/felix/webconsole/internal/WebConsolePluginAdapter.java
Modified: felix/trunk/webconsole/src/main/java/org/apache/felix/webconsole/AbstractWebConsolePlugin.java
URL: http://svn.apache.org/viewvc/felix/trunk/webconsole/src/main/java/org/apache/felix/webconsole/AbstractWebConsolePlugin.java?rev=789246&r1=789245&r2=789246&view=diff
==============================================================================
--- felix/trunk/webconsole/src/main/java/org/apache/felix/webconsole/AbstractWebConsolePlugin.java (original)
+++ felix/trunk/webconsole/src/main/java/org/apache/felix/webconsole/AbstractWebConsolePlugin.java Mon Jun 29 07:48:06 2009
@@ -18,19 +18,33 @@
import java.io.IOException;
+import java.io.InputStream;
+import java.io.OutputStream;
import java.io.PrintWriter;
+import java.lang.reflect.InvocationTargetException;
+import java.lang.reflect.Method;
+import java.lang.reflect.Modifier;
+import java.net.URL;
+import java.net.URLConnection;
import java.text.MessageFormat;
-import java.util.*;
+import java.util.Dictionary;
+import java.util.HashMap;
+import java.util.Iterator;
+import java.util.List;
+import java.util.Map;
+import java.util.SortedMap;
+import java.util.TreeMap;
import javax.servlet.ServletException;
-import javax.servlet.http.*;
+import javax.servlet.http.HttpServlet;
+import javax.servlet.http.HttpServletRequest;
+import javax.servlet.http.HttpServletResponse;
import org.apache.commons.fileupload.FileItem;
import org.apache.commons.fileupload.FileUploadException;
import org.apache.commons.fileupload.disk.DiskFileItemFactory;
import org.apache.commons.fileupload.servlet.ServletFileUpload;
import org.apache.commons.fileupload.servlet.ServletRequestContext;
-import org.apache.felix.webconsole.internal.servlet.OsgiManager;
import org.osgi.framework.BundleContext;
import org.osgi.framework.Constants;
@@ -71,11 +85,16 @@
+ "<a target=\"_blank\" href=\"{3}\" title=\"{1}\"><img src=\"{5}/res/imgs/logo.png\" width=\"165\" height=\"63\" border=\"0\"></a>"
+ "</p>" + "</div>";
- /**
+ /*
String header = MessageFormat.format( HEADER, new Object[]
{ adminTitle, productName, getTitle(), productWeb, vendorName,
( String ) request.getAttribute( OsgiManager.ATTR_APP_ROOT ), getLabel() } );
*/
+
+ public static final String GET_RESOURCE_METHOD_NAME = "getResource";
+
+ private final Method getResourceMethod;
+
private BundleContext bundleContext;
private String adminTitle;
@@ -83,6 +102,10 @@
private String productWeb;
private String vendorName;
+ {
+ getResourceMethod = getGetResourceMethod();
+ }
+
//---------- HttpServlet Overwrites ----------------------------------------
@@ -97,21 +120,29 @@
/**
* Renders the web console page for the request. This consist of the following
- * four parts called in order:
+ * five parts called in order:
* <ol>
+ * <li>Send back a requested resource
* <li>{@link #startResponse(HttpServletRequest, HttpServletResponse)}</li>
* <li>{@link #renderTopNavigation(HttpServletRequest, PrintWriter)}</li>
* <li>{@link #renderContent(HttpServletRequest, HttpServletResponse)}</li>
* <li>{@link #endResponse(PrintWriter)}</li>
* </ol>
+ * <p>
+ * <b>Note</b>: If a resource is sent back for the request only the first
+ * step is executed. Otherwise the first step is a null-operation actually
+ * and the latter four steps are executed in order.
*/
protected void doGet( HttpServletRequest request, HttpServletResponse response ) throws ServletException,
IOException
{
- PrintWriter pw = startResponse( request, response );
- renderTopNavigation( request, pw );
- renderContent( request, response );
- endResponse( pw );
+ if ( !spoolResource( request, response ) )
+ {
+ PrintWriter pw = startResponse( request, response );
+ renderTopNavigation( request, pw );
+ renderContent( request, response );
+ endResponse( pw );
+ }
}
@@ -151,6 +182,178 @@
return bundleContext;
}
+ protected Object getResourceProvider() {
+ return this;
+ }
+
+ /**
+ * Returns a method which is called on the
+ * {@link #getResourceProvider() resource provder} class to return an URL
+ * to a resource which may be spooled when requested. The method has the
+ * following signature:
+ * <pre>
+ * [modifier] URL getResource(String path);
+ * </pre>
+ * Where the <i>[modifier]</i> may be <code>public</code>, <code>protected</code>
+ * or <code>private</code> (if the method is declared in the class of the
+ * resource provider). It is suggested to use the <code>private</code>
+ * modifier if the method is declared in the resource provider class or
+ * the <code>protected</code> modifier if the method is declared in a
+ * base class of the resource provider.
+ *
+ * @return The <code>getResource(String)</code> method or <code>null</code>
+ * if the {@link #getResourceProvider() resource provider} is
+ * <code>null</code> or does not provide such a method.
+ */
+ private Method getGetResourceMethod()
+ {
+ Method tmpGetResourceMethod = null;
+
+ Object resourceProvider = getResourceProvider();
+ if ( resourceProvider != null )
+ {
+ try
+ {
+ Class cl = resourceProvider.getClass();
+ while ( tmpGetResourceMethod == null && cl != Object.class )
+ {
+ Method[] methods = cl.getDeclaredMethods();
+ for ( int i = 0; i < methods.length; i++ )
+ {
+ Method m = methods[i];
+ if ( GET_RESOURCE_METHOD_NAME.equals( m.getName() ) && m.getParameterTypes().length == 1
+ && m.getParameterTypes()[0] == String.class && m.getReturnType() == URL.class )
+ {
+ // ensure modifier is protected or public or the private
+ // method is defined in the plugin class itself
+ int mod = m.getModifiers();
+ if ( Modifier.isProtected( mod ) || Modifier.isPublic( mod )
+ || ( Modifier.isPrivate( mod ) && cl == resourceProvider.getClass() ) )
+ {
+ m.setAccessible( true );
+ tmpGetResourceMethod = m;
+ break;
+ }
+ }
+ }
+ cl = cl.getSuperclass();
+ }
+ }
+ catch ( Throwable t )
+ {
+ tmpGetResourceMethod = null;
+ }
+ }
+
+ return tmpGetResourceMethod;
+ }
+
+
+ /**
+ * If the request addresses a resource which may be served by the
+ * <code>getResource</code> method of the
+ * {@link #getResourceProvider() resource provider}, this method serves it
+ * and returns <code>true</code>. Otherwise <code>false</code> is returned.
+ * <code>false</code> is also returned if the resource provider has no
+ * <code>getResource</code> method.
+ * <p>
+ * If <code>true</code> is returned, the request is considered complete and
+ * request processing terminates. Otherwise request processing continues
+ * with normal plugin rendering.
+ *
+ * @param request The request object
+ * @param response The response object
+ * @return <code>true</code> if the request causes a resource to be sent back.
+ *
+ * @throws IOException If an error occurrs accessing or spooling the resource.
+ */
+ private boolean spoolResource( HttpServletRequest request, HttpServletResponse response ) throws IOException
+ {
+ // no resource if no resource accessor
+ if ( getResourceMethod == null )
+ {
+ return false;
+ }
+
+ String pi = request.getPathInfo();
+ InputStream ins = null;
+ try
+ {
+
+ // check for a resource, fail if none
+ URL url = ( URL ) getResourceMethod.invoke( getResourceProvider(), new Object[]
+ { pi } );
+ if ( url == null )
+ {
+ return false;
+ }
+
+ // open the connection and the stream (we use the stream to be able
+ // to at least hint to close the connection because there is no
+ // method to explicitly close the conneciton, unfortunately)
+ URLConnection connection = url.openConnection();
+ ins = connection.getInputStream();
+
+ // check whether we may return 304/UNMODIFIED
+ long lastModified = connection.getLastModified();
+ if ( lastModified > 0 )
+ {
+ long ifModifiedSince = request.getDateHeader( "If-Modified-Since" );
+ if ( ifModifiedSince >= ( lastModified / 1000 * 1000 ) )
+ {
+ // Round down to the nearest second for a proper compare
+ // A ifModifiedSince of -1 will always be less
+ response.setStatus( HttpServletResponse.SC_NOT_MODIFIED );
+
+ return true;
+ }
+
+ // have to send, so set the last modified header now
+ response.setDateHeader( "Last-Modified", lastModified );
+ }
+
+ // describe the contents
+ response.setContentType( getServletContext().getMimeType( pi ) );
+ response.setIntHeader( "Content-Length", connection.getContentLength() );
+
+ // spool the actual contents
+ OutputStream out = response.getOutputStream();
+ byte[] buf = new byte[2048];
+ int rd;
+ while ( ( rd = ins.read( buf ) ) >= 0 )
+ {
+ out.write( buf, 0, rd );
+ }
+
+ // over and out ...
+ return true;
+ }
+ catch ( IllegalAccessException iae )
+ {
+ // log or throw ???
+ }
+ catch ( InvocationTargetException ite )
+ {
+ // log or throw ???
+ // Throwable cause = ite.getTargetException();
+ }
+ finally
+ {
+ if ( ins != null )
+ {
+ try
+ {
+ ins.close();
+ }
+ catch ( IOException ignore )
+ {
+ }
+ }
+ }
+
+ return false;
+ }
+
protected PrintWriter startResponse( HttpServletRequest request, HttpServletResponse response ) throws IOException
{
@@ -161,7 +364,7 @@
String header = MessageFormat.format( HEADER, new Object[]
{ adminTitle, productName, getTitle(), productWeb, vendorName,
- ( String ) request.getAttribute( OsgiManager.ATTR_APP_ROOT ), getLabel() } );
+ ( String ) request.getAttribute( WebConsoleConstants.ATTR_APP_ROOT ), getLabel() } );
pw.println( header );
return pw;
@@ -182,8 +385,8 @@
current = current.substring( 1, slash );
boolean disabled = false;
- String appRoot = ( String ) request.getAttribute( OsgiManager.ATTR_APP_ROOT );
- Map labelMap = ( Map ) request.getAttribute( OsgiManager.ATTR_LABEL_MAP );
+ String appRoot = ( String ) request.getAttribute( WebConsoleConstants.ATTR_APP_ROOT );
+ Map labelMap = ( Map ) request.getAttribute( WebConsoleConstants.ATTR_LABEL_MAP );
if ( labelMap != null )
{
pw.println( "<div id='technav'>" );
Modified: felix/trunk/webconsole/src/main/java/org/apache/felix/webconsole/internal/WebConsolePluginAdapter.java
URL: http://svn.apache.org/viewvc/felix/trunk/webconsole/src/main/java/org/apache/felix/webconsole/internal/WebConsolePluginAdapter.java?rev=789246&r1=789245&r2=789246&view=diff
==============================================================================
--- felix/trunk/webconsole/src/main/java/org/apache/felix/webconsole/internal/WebConsolePluginAdapter.java (original)
+++ felix/trunk/webconsole/src/main/java/org/apache/felix/webconsole/internal/WebConsolePluginAdapter.java Mon Jun 29 07:48:06 2009
@@ -91,6 +91,17 @@
}
+ /**
+ * Returns the registered plugin class to be able to call the
+ * <code>getResource()</code> method on that object for this plugin to
+ * provide additional resources.
+ */
+ protected Object getResourceProvider()
+ {
+ return plugin;
+ }
+
+
//---------- Servlet API overwrite
/**