/**
* 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.openejb.webadmin;
import org.apache.openejb.loader.SystemInstance;
import org.apache.openejb.spi.ContainerSystem;
import org.apache.openejb.util.OpenEjbVersion;
import java.io.IOException;
import java.io.InputStream;
import java.io.PrintWriter;
import java.net.URL;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.Map;
import javax.ejb.CreateException;
import javax.ejb.SessionContext;
import javax.naming.Context;
import javax.naming.NameClassPair;
import javax.naming.NamingEnumeration;
/** This is the template web admin bean to extend from. It contains all the functionality for the webadministration. To use
* this class, simply sub-class it:<br><br>
*
* <code>
* public class MyBean extends WebAdminBean {
* ...
* }
* </code>
* <br><br>
* and declare the following methods:<br><br>
*
* <code>
* public void ejbCreate() {}<br>
* public void preProcess(HttpRequest request, HttpResponse response) throws IOException {}<br>
* public void postProcess(HttpRequest request, HttpResponse response) throws IOException {}<br>
* public void writeBody(PrintWriter body) throws IOException {}<br>
* public void writeHtmlTitle(PrintWriter body) throws IOException {}<br>
* public void writePageTitle(PrintWriter body) throws IOException {}<br>
* public void writeSubMenuItems(PrintWriter body) throws IOException {}<br>
* </code>
*
* @author <a href="mailto:david.blevins@visi.com">David Blevins</a>
* @author <a href="mailto:tim_urberg@yahoo.com">Tim Urberg</a>
*/
public abstract class WebAdminBean implements HttpBean {
/** used for the session context
*/
protected SessionContext ejbContext;
/** the substitue
*/
public static final int SUBSTITUTE = 26;
/** the navigation sections
*/
public static HashMap sections;
/** the menu section
*/
protected String section = "";
/** the HTTP request
*/
protected HttpRequest request;
/** the HTTP response
*/
protected HttpResponse response;
/** the standard title */
public static final String HTML_TITLE = "OpenEJB Web Administration Console";
/** the main method of this bean, it takes care of the processing
* @param request the http request
* @param response the http response
* @throws IOException if an exception is thrown
*/
public void onMessage(HttpRequest request, HttpResponse response) throws IOException{
this.request = request;
this.response = response;
preProcess(request, response);
// Assuming things are good
java.io.PrintWriter body = response.getPrintWriter();
InputStream template = getTemplate();
// Write till PAGETITLE
writeTemplate(body, template);
writeHtmlTitle(body);
// Write till TOP_NAV_BAR
writeTemplate(body, template);
writeTopNavBar(body);
// Write till LEFT_NAV_BAR
writeTemplate(body, template);
writeLeftNavBar(body);
// Write till TITLE
writeTemplate(body, template);
writePageTitle(body);
// Write till BODY
writeTemplate(body, template);
writeBody(body);
// Write till FOOTER
writeTemplate(body, template);
writeFooter(body);
// Write the rest
writeTemplate(body, template);
postProcess(request, response);
}
/** called before any content is written to the browser
* @param request the http request
* @param response the http response
* @throws IOException if an exception is thrown
*/
public abstract void preProcess(HttpRequest request, HttpResponse response) throws IOException;
/** called after all content is written to the browser
* @param request the http request
* @param response the http response
* @throws IOException if an exception is thrown
*/
public abstract void postProcess(HttpRequest request, HttpResponse response) throws IOException;
/** Write the TITLE of the HTML document. This is the part
* that goes into the <code><head><title>
* </title></head></code> tags
*
* @param body the output to write to
* @exception IOException of an exception is thrown
*
*/
public abstract void writeHtmlTitle(PrintWriter body) throws IOException;
/** Write the title of the page. This is displayed right
* above the main block of content.
*
* @param body the output to write to
* @exception IOException if an exception is thrown
*/
public abstract void writePageTitle(PrintWriter body) throws IOException;
/** Write the top navigation bar of the page. This should look somthing
* like the one below:
*
* <code>
* <a href="system?show=server">
* <span class="menuTopOff">Remote Server</span>
* </a>
* <a href="system?show=containers">
* <span class="menuTopOff">Containers</span>
* </a>
* <a href="system?show=deployments">
* <span class="menuTopOff">Deployments</span>
* </a>
* <a href="system?show=logs">
* <span class="menuTopOff">Logs</span>
* </a>
* </code>
*
* @param body the output to write to
* @exception IOException if an exception is thrown
*/
public void writeTopNavBar(PrintWriter body) throws IOException{
// for (int i=0; i < navSections.length; i+=2){
// body.print("<a href=\"");
// body.print(navSections[i]);
// body.print("\" class=\"menuTopOff\">");
// body.print(navSections[i+1]);
// if(i == (navSections.length-2))
// body.print("</a>");
// else
// body.print("</a> | ");
// }
}
/** Write the left navigation bar of the page. This should look somthing
* like the one below:
*
* <code>
* <tr>
* <td valign="top" align="left">
* <span class="subMenuOn">
* Admin
* </span>
* </td>
* </tr>
* <tr>
* <td valign="top" align="left">
* <a href="system?show=status"><span class="subMenuOff">
* Status
* </span>
* </a></td>
* </tr>
* <tr>
* <<td valign="top" align="left">
* <a href="system?show=deployments"><span class="subMenuOff">
* Deployments
* </span>
* </a></td>
* </tr>
* </code>
*
* @param body the output to write to
* @exception IOException if an exception is thrown
*/
public void writeLeftNavBar(PrintWriter body) throws IOException{
Object[] entries = sections.entrySet().toArray();
for (int i = 0; i < entries.length; i++) {
Map.Entry entry = (Map.Entry)entries[i];
String section = (String)entry.getKey();
String[] subSections = (String[])entry.getValue();
body.println("<tr><td valign=\"top\" align=\"left\">");
body.print("<span class=\"subMenuOn\">");
body.print(section);
body.print("</td></tr>");
for (int j=0; j < subSections.length; j+=2){
String name = subSections[j];
String url = subSections[j+1];
body.print("<tr>");
body.print("<td valign=\"top\" align=\"left\">");
body.print("<a href=\"/");
body.print(section);
body.print('/');
body.print(url);
body.print("\" class=\"subMenuOff\">");
body.print(" ");
body.print(name);
body.print("</a></td></tr>");
}
}
}
/** formats a sub menu item for the left navigation
* @param itemName the name for display
* @param url the url to link
* @return the html that is formatted
*/
public String formatSubMenuItem(String itemName, String url){
StringBuffer buff = new StringBuffer();
return buff.toString();
}
/** writes the main body content to the broswer. This content is inside a <code><p></code> block
*
*
* @param body the output to write to
* @exception IOException if an exception is thrown
*/
public abstract void writeBody(PrintWriter body) throws IOException;
/** Write the footer
*
* @param body the output to write to
* @exception IOException if an exception is thrown
*/
public void writeFooter(PrintWriter body) throws IOException{
body.print(footer);
}
/** the footer
*/
protected static String footer = getFooter();
/** gets a footer for the document
* @return the footer string
*/
public static String getFooter(){
StringBuffer out = new StringBuffer(100);
OpenEjbVersion info = OpenEjbVersion.get();
out.append( "<a href=\"" + info.getUrl() + "\">OpenEJB</a> ");
out.append( info.getVersion() +"<br>");
out.append( "build: " + info.getDate() +"-"+ info.getTime());
return out.toString();
}
/** writes a template from the input stream to the output stream
* @param out the output to write to
* @param template the template to read
* @throws IOException if an exception is thrown
*/
public void writeTemplate(PrintWriter out, InputStream template) throws IOException{
int b = template.read();
//System.out.println("[] read");
while (b != -1 && b != SUBSTITUTE) {
out.write( b );
b = template.read();
}
//System.out.println("[] done reading");
}
/** gets an html template which is the content of the pages written to the browser
* @throws IOException if an exception is thrown
* @return the template
*/
public InputStream getTemplate() throws IOException{
//System.out.println("[] get template");
// ClassLoader classLoader = Thread.currentThread().getContextClassLoader();
ClassLoader classLoader = this.getClass().getClassLoader();
URL url = classLoader.getResource("/htdocs/template.html");
return url.openConnection().getInputStream();
}
/** initalizes the left and top menu navigation
*/
public HashMap initNavSections(){
HashMap sections = new HashMap();
try{
ContainerSystem containerSystem = SystemInstance.get().getComponent(ContainerSystem.class);
Context ctx = containerSystem.getJNDIContext();
ctx = (Context) ctx.lookup("openejb/ejb");
NamingEnumeration enumeration = ctx.list("");
//System.out.println("\n\nENUM "+enumeration);
if ( enumeration == null){
return sections;
}
while (enumeration.hasMore()) {
NameClassPair entry = (NameClassPair)enumeration.next();
//System.out.println("ITEM NAME "+entry.getName());
//System.out.println("ITEM CLASS "+entry.getClassName());
if ( !entry.getClassName().equals("org.apache.openejb.core.ivm.naming.IvmContext") ) {
continue;
}
Context subCtx = (Context) ctx.lookup(entry.getName());
String[] subSections = getSubsections(subCtx);
if (subSections.length > 0){
sections.put(entry.getName(), subSections );
}
}
} catch (Exception e){
e.printStackTrace();
}
return sections;
}
private String[] getSubsections(Context ctx){
ArrayList sections = new ArrayList();
try{
NamingEnumeration enumeration = ctx.list("");
if ( enumeration == null){
return new String[0];
}
while (enumeration.hasMore()) {
NameClassPair entry = (NameClassPair)enumeration.next();
//System.out.println("ITEM NAME "+entry.getName());
//System.out.println("ITEM CLASS "+entry.getClassName());
if ( !entry.getClassName().equals("org.apache.openejb.core.stateless.EncReference") ) {
continue;
}
if ( entry.getName().startsWith("Default") ) {
continue;
}
Object obj = ctx.lookup(entry.getName());
if (obj instanceof HttpHome){
String beanName = entry.getName();
sections.add(beanName);
sections.add(beanName);
}
}
} catch (Exception e){
e.printStackTrace();
}
return (String[]) sections.toArray(new String[0]);
}
/** prints a table row similar to this
*
* <tr>
* <td>some info</td>
* <td>some more info</td>
* </tr>
* @param col1 the first column
* @param col2 the second column
* @param out the output to write to
* @throws IOException if an exception is thrown
*/
protected void printRow(String col1, String col2, PrintWriter out) throws IOException{
out.println("<tr>" );
out.print("<td class=\"bodyBlack\">");
out.print(col1);
out.println("</td>");
out.print("<td class=\"bodyBlack\">");
out.print(col2);
out.println("</td>");
out.println("</tr>");
}
/** prints a table row similar to this
*
* <tr>
* <td>some info</td>
* <td>some more info</td>
* <td>yet some more info</td>
* </tr>
* @param col1 the first column
* @param col2 the second column
* @param col3 the third column
* @param out the output to write to
* @throws IOException if an exception is thrown
*/
protected void printRow(String col1, String col2, String col3, PrintWriter out) throws IOException{
out.println("<tr>");
out.print("<td class=\"bodyBlack\">");
out.print(col1);
out.println("</td>");
out.print("<td class=\"bodyBlack\">");
out.print(col2);
out.println("</td>");
out.print("<td class=\"bodyBlack\">");
out.print(col3);
out.println("</td>");
out.println("</tr>");
}
/*---------------------------------------------------------------*/
/* EJB API Callbacks */
/*---------------------------------------------------------------*/
/** called with the bean is created
* @throws CreateException if the bean cannot be created
*/
public void ejbCreate() throws CreateException {}
/** called on a stateful sessionbean after the bean is
* deserialized from storage and put back into use.
*/
public void ejbActivate() {}
/** called on a stateful sessionbean before the bean is
* removed from memory and serialized to a temporary store.
* This method is never called on a stateless sessionbean
*/
public void ejbPassivate() {}
/** called when the bean is about to be garbage collected
*/
public void ejbRemove() {}
/** sets the session context
* @param sessionContext the session context
*/
public void setSessionContext(SessionContext sessionContext) {
ejbContext = sessionContext;
if (sections == null) {
sections = initNavSections();
}
}
}