alvinalexander.com | career | drupal | java | mac | mysql | perl | scala | uml | unix  

What this is

This file is included in the DevDaily.com "Java Source Code Warehouse" project. The intent of this project is to help you "Learn Java by Example" TM.

Other links

The source code

/*
 *                 Sun Public License Notice
 * 
 * The contents of this file are subject to the Sun Public License
 * Version 1.0 (the "License"). You may not use this file except in
 * compliance with the License. A copy of the License is available at
 * http://www.sun.com/
 * 
 * The Original Code is NetBeans. The Initial Developer of the Original
 * Code is Sun Microsystems, Inc. Portions Copyright 1997-2004 Sun
 * Microsystems, Inc. All Rights Reserved.
 */
package org.netbeans.modules.web.dd.wizards;

import org.openide.src.*;
import java.util.List;
import java.util.ArrayList;
import org.openide.util.NbBundle;
/**
 * Generator for servlet listener class
 *
 * @author  milan.kuchtiak@sun.com
 * Created on March, 2004
 */
public class ListenerGenerator {
    boolean isContext,isContextAttr,isSession,isSessionAttr,isRequest,isRequestAttr;
    private ClassElement clazz;
    /** Creates a new instance of ListenerGenerator */
    public ListenerGenerator(boolean isContext, boolean isContextAttr, boolean isSession, boolean isSessionAttr,
                             boolean isRequest, boolean isRequestAttr) {
        this.isContext=isContext;
        this.isContextAttr=isContextAttr;
        this.isSession=isSession;
        this.isSessionAttr=isSessionAttr;
        this.isRequest=isRequest;
        this.isRequestAttr=isRequestAttr;
    }
    
    public void generate(ClassElement clazz) throws SourceException {
        this.clazz=clazz;
        generateImports();
        generateInterfaces();
        if (isContext) addContextListenerMethods();
        if (isContextAttr) addContextAttrListenerMethods();
        if (isSession) addSessionListenerMethods();
        if (isSessionAttr) addSessionAttrListenerMethods();
        if (isRequest) addRequestListenerMethods();
        if (isRequestAttr) addRequestAttrListenerMethods();
    }
    
    private void generateImports() throws SourceException {
        SourceElement srcEl = clazz.getSource();
        List imports = new ArrayList();
        if (isContext) {
            imports.add(new Import(Identifier.create("javax.servlet.ServletContextListener"), false)); //NOI18N
            imports.add(new Import(Identifier.create("javax.servlet.ServletContextEvent"), false)); //NOI18N
        }
        if (isContextAttr) {
            imports.add(new Import(Identifier.create("javax.servlet.ServletContextAttributeListener"), false)); //NOI18N
            imports.add(new Import(Identifier.create("javax.servlet.ServletContextAttributeEvent"), false)); //NOI18N
        }
        if (isSession) {
            imports.add(new Import(Identifier.create("javax.servlet.http.HttpSessionListener"), false)); //NOI18N
            imports.add(new Import(Identifier.create("javax.servlet.http.HttpSessionEvent"), false)); //NOI18N
        }
        if (isSessionAttr) {
            imports.add(new Import(Identifier.create("javax.servlet.http.HttpSessionAttributeListener"), false)); //NOI18N
            imports.add(new Import(Identifier.create("javax.servlet.http.HttpSessionBindingEvent"), false)); //NOI18N
        }
        if (isRequest) {
            imports.add(new Import(Identifier.create("javax.servlet.ServletRequestListener"), false)); //NOI18N
            imports.add(new Import(Identifier.create("javax.servlet.ServletRequestEvent"), false)); //NOI18N
        }
        if (isRequestAttr) {
            imports.add(new Import(Identifier.create("javax.servlet.ServletRequestAttributeListener"), false)); //NOI18N
            imports.add(new Import(Identifier.create("javax.servlet.ServletRequestAttributeEvent"), false)); //NOI18N
        }
        Import[] imp = new Import[imports.size()];
        imports.toArray(imp);
        srcEl.addImports(imp);
    }

    private void generateInterfaces() throws SourceException {
        if (isContext) clazz.addInterface(Identifier.create("ServletContextListener")); //NOI18N
        if (isContextAttr) clazz.addInterface(Identifier.create("ServletContextAttributeListener")); //NOI18N
        if (isSession) clazz.addInterface(Identifier.create("HttpSessionListener")); //NOI18N
        if (isSessionAttr) clazz.addInterface(Identifier.create("HttpSessionAttributeListener")); //NOI18N
        if (isRequest) clazz.addInterface(Identifier.create("ServletRequestListener")); //NOI18N
        if (isRequestAttr) clazz.addInterface(Identifier.create("ServletRequestAttributeListener")); //NOI18N   
    }
    
    private void addContextListenerMethods() throws SourceException {
        StringBuffer docBuf = new StringBuffer();
        docBuf.append(NbBundle.getMessage(ListenerGenerator.class,"TXT_DOC_contextListener_m1"));
        StringBuffer bodyBuf = new StringBuffer();
        bodyBuf.append("// "+NbBundle.getMessage(ListenerGenerator.class,"TXT_todo_eg")); //NOI18N
        bodyBuf.append("\n/*\n"); //NOI18N
        bodyBuf.append("    Connection con = // create connection\n"); //NOI18N
        bodyBuf.append("    evt.getServletContext().setAttribute(\"con\", con);\n"); //NOI18N
        bodyBuf.append("*/\n"); //NOI18N
        addMethod("contextInitialized","ServletContextEvent",docBuf,bodyBuf); //NOI18N
 
        docBuf = new StringBuffer();
        docBuf.append(NbBundle.getMessage(ListenerGenerator.class,"TXT_DOC_contextListener_m2"));
        bodyBuf = new StringBuffer();
        bodyBuf.append("// "+NbBundle.getMessage(ListenerGenerator.class,"TXT_todo_eg")); //NOI18N
        bodyBuf.append("\n/*\n"); //NOI18N
        bodyBuf.append("        Connection con = (Connection) e.getServletContext().getAttribute(\"con\");\n"); //NOI18N
        bodyBuf.append("        try { con.close(); } catch (SQLException ignored) { } // close connection\n"); //NOI18N
        bodyBuf.append("*/\n"); //NOI18N
        addMethod("contextDestroyed","ServletContextEvent",docBuf,bodyBuf); //NOI18N
    }
    private void addContextAttrListenerMethods() throws SourceException {
        StringBuffer docBuf = new StringBuffer();
        docBuf.append(NbBundle.getMessage(ListenerGenerator.class,"TXT_DOC_contextAttrListener_m1"));
        StringBuffer bodyBuf = new StringBuffer();
        bodyBuf.append("// "+NbBundle.getMessage(ListenerGenerator.class,"TXT_todo")+"\n"); //NOI18N
        addMethod("attributeAdded","ServletContextAttributeEvent",docBuf,bodyBuf); //NOI18N
        
        docBuf = new StringBuffer();
        docBuf.append(NbBundle.getMessage(ListenerGenerator.class,"TXT_DOC_contextAttrListener_m2"));
        bodyBuf = new StringBuffer();
        bodyBuf.append("// "+NbBundle.getMessage(ListenerGenerator.class,"TXT_todo")+"\n"); //NOI18N
        addMethod("attributeRemoved","ServletContextAttributeEvent",docBuf,bodyBuf); //NOI18N
        
        docBuf = new StringBuffer();
        docBuf.append(NbBundle.getMessage(ListenerGenerator.class,"TXT_DOC_contextAttrListener_m3"));
        bodyBuf = new StringBuffer();
        bodyBuf.append("// "+NbBundle.getMessage(ListenerGenerator.class,"TXT_todo")+"\n"); //NOI18N
        addMethod("attributeReplaced","ServletContextAttributeEvent",docBuf,bodyBuf); //NOI18N
    }
    private void addSessionListenerMethods() throws SourceException {
        StringBuffer docBuf = new StringBuffer();
        docBuf.append(NbBundle.getMessage(ListenerGenerator.class,"TXT_DOC_sessionListener_m1"));
        StringBuffer bodyBuf = new StringBuffer();
        bodyBuf.append("// "+NbBundle.getMessage(ListenerGenerator.class,"TXT_todo")+"\n"); //NOI18N
        addMethod("sessionCreated","HttpSessionEvent",docBuf,bodyBuf); //NOI18N
 
        docBuf = new StringBuffer();
        docBuf.append(NbBundle.getMessage(ListenerGenerator.class,"TXT_DOC_sessionListener_m2"));
        bodyBuf = new StringBuffer();
        bodyBuf.append("// "+NbBundle.getMessage(ListenerGenerator.class,"TXT_todo")+"\n"); //NOI18N
        addMethod("sessionDestroyed","HttpSessionEvent",docBuf,bodyBuf); //NOI18N
    }
    private void addSessionAttrListenerMethods() throws SourceException {
        StringBuffer docBuf = new StringBuffer();
        docBuf.append(NbBundle.getMessage(ListenerGenerator.class,"TXT_DOC_sessionAttrListener_m1"));
        StringBuffer bodyBuf = new StringBuffer();
        bodyBuf.append("// "+NbBundle.getMessage(ListenerGenerator.class,"TXT_todo")+"\n"); //NOI18N
        addMethod("attributeAdded","HttpSessionBindingEvent",docBuf,bodyBuf); //NOI18N
        
        docBuf = new StringBuffer();
        docBuf.append(NbBundle.getMessage(ListenerGenerator.class,"TXT_DOC_sessionAttrListener_m2"));
        bodyBuf = new StringBuffer();
        bodyBuf.append("// "+NbBundle.getMessage(ListenerGenerator.class,"TXT_todo")+"\n"); //NOI18N
        addMethod("attributeRemoved","HttpSessionBindingEvent",docBuf,bodyBuf); //NOI18N
        
        docBuf = new StringBuffer();
        docBuf.append(NbBundle.getMessage(ListenerGenerator.class,"TXT_DOC_sessionAttrListener_m3"));
        bodyBuf = new StringBuffer();
        bodyBuf.append("// "+NbBundle.getMessage(ListenerGenerator.class,"TXT_todo")+"\n"); //NOI18N
        addMethod("attributeReplaced","HttpSessionBindingEvent",docBuf,bodyBuf); //NOI18N
    }
    private void addRequestListenerMethods() throws SourceException {
        StringBuffer docBuf = new StringBuffer();
        docBuf.append(NbBundle.getMessage(ListenerGenerator.class,"TXT_DOC_requestListener_m1"));
        StringBuffer bodyBuf = new StringBuffer();
        bodyBuf.append("// "+NbBundle.getMessage(ListenerGenerator.class,"TXT_todo")+"\n"); //NOI18N
        addMethod("requestInitialized","ServletRequestEvent",docBuf,bodyBuf); //NOI18N
 
        docBuf = new StringBuffer();
        docBuf.append(NbBundle.getMessage(ListenerGenerator.class,"TXT_DOC_requestListener_m2"));
        bodyBuf = new StringBuffer();
        bodyBuf.append("// "+NbBundle.getMessage(ListenerGenerator.class,"TXT_todo")+"\n"); //NOI18N
        addMethod("requestDestroyed","ServletRequestEvent",docBuf,bodyBuf); //NOI18N
    }
    private void addRequestAttrListenerMethods() throws SourceException {
        StringBuffer docBuf = new StringBuffer();
        docBuf.append(NbBundle.getMessage(ListenerGenerator.class,"TXT_DOC_requestAttrListener_m1"));
        StringBuffer bodyBuf = new StringBuffer();
        bodyBuf.append("// "+NbBundle.getMessage(ListenerGenerator.class,"TXT_todo")+"\n"); //NOI18N
        addMethod("attributeAdded","ServletRequestAttributeEvent",docBuf,bodyBuf); //NOI18N
        
        docBuf = new StringBuffer();
        docBuf.append(NbBundle.getMessage(ListenerGenerator.class,"TXT_DOC_requestAttrListener_m2"));
        bodyBuf = new StringBuffer();
        bodyBuf.append("// "+NbBundle.getMessage(ListenerGenerator.class,"TXT_todo")+"\n"); //NOI18N
        addMethod("attributeRemoved","ServletRequestAttributeEvent",docBuf,bodyBuf); //NOI18N
        
        docBuf = new StringBuffer();
        docBuf.append(NbBundle.getMessage(ListenerGenerator.class,"TXT_DOC_requestAttrListener_m3"));
        bodyBuf = new StringBuffer();
        bodyBuf.append("// "+NbBundle.getMessage(ListenerGenerator.class,"TXT_todo")+"\n"); //NOI18N
        addMethod("attributeReplaced","ServletRequestAttributeEvent",docBuf,bodyBuf); //NOI18N
    }
    private void addMethod(String methodName, 
                            String eventName,
                            StringBuffer javadoc,
                            StringBuffer body) throws SourceException {
        MethodElement method = new MethodElement();
        method.setName(Identifier.create(methodName));
        method.setReturn(Type.VOID);
        method.setModifiers(java.lang.reflect.Modifier.PUBLIC);
        MethodParameter mp = MethodParameter.parse(eventName+" evt"); //NOI18N
        method.setParameters(new MethodParameter[]{mp});       
        JavaDoc doc = method.getJavaDoc();
        doc.setRawText(javadoc.toString());
        method.setBody(body.toString());
        clazz.addMethod(method);
    }
}
... this post is sponsored by my books ...

#1 New Release!

FP Best Seller

 

new blog posts

 

Copyright 1998-2021 Alvin Alexander, alvinalexander.com
All Rights Reserved.

A percentage of advertising revenue from
pages under the /java/jwarehouse URI on this website is
paid back to open source projects.