BasicHandler.java |
/* * The Apache Software License, Version 1.1 * * Copyright (c) 2001-2003 The Apache Software Foundation. All rights * reserved. * * 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 the * Apache Software Foundation (http://www.apache.org/)." * Alternately, this acknowledgment may appear in the software itself, * if and wherever such third-party acknowledgments normally appear. * * 4. The names "Axis" and "Apache Software Foundation" must * not be used to endorse or promote products derived from this * software without prior written permission. For written * permission, please contact apache@apache.org. * * 5. Products derived from this software may not be called "Apache", * nor may "Apache" appear in their name, without prior written * permission of the Apache Software Foundation. * * 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 THE APACHE SOFTWARE FOUNDATION 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. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation. For more * information on the Apache Software Foundation, please see * <http://www.apache.org/>. */ package org.jboss.axis.handlers; import org.jboss.axis.AxisFault; import org.jboss.axis.Handler; import org.jboss.axis.MessageContext; import org.jboss.axis.utils.LockableHashtable; import org.jboss.logging.Logger; import org.w3c.dom.Document; import org.w3c.dom.Element; import javax.xml.namespace.QName; import java.util.Enumeration; import java.util.Hashtable; import java.util.List; /** * <code>BasicHandler</code> is a utility class which implements simple * property setting/getting behavior, and stubs out a lot of the Handler * methods. Extend this class to make writing your Handlers easier, and * then override what you need to. * * @author Glen Daniels (gdaniels@allaire.com) * @author Doug Davis (dug@us.ibm.com */ public abstract class BasicHandler implements Handler { private static Logger log = Logger.getLogger(BasicHandler.class.getName()); protected boolean makeLockable = false; protected Hashtable options; protected String name; /** * Should this Handler use a LockableHashtable for options? * Default is 'false'. */ protected void setOptionsLockable(boolean makeLockable) { this.makeLockable = makeLockable; } protected void initHashtable() { if (makeLockable) { options = new LockableHashtable(); } else { options = new Hashtable(); } } /** * Stubbed-out methods. Override in your child class to implement * any real behavior. */ public void init() { } public void cleanup() { } public boolean canHandleBlock(QName qname) { return false; } public void onFault(MessageContext msgContext) { } /** * Must implement this in subclasses. */ public abstract void invoke(MessageContext msgContext) throws AxisFault; /** * Set the given option (name/value) in this handler's bag of options */ public void setOption(String name, Object value) { if (options == null) initHashtable(); options.put(name, value); } /** * Set a default value for the given option: * if the option is not already set, then set it. * if the option is already set, then do not set it. * <p/> * If this is called multiple times, the first with a non-null value * if 'value' will set the default, remaining calls will be ignored. * <p/> * Returns true if value set (by this call), otherwise false; */ public boolean setOptionDefault(String name, Object value) { boolean val = (options == null || options.get(name) == null) && value != null; if (val) { setOption(name, value); } return val; } /** * Returns the option corresponding to the 'name' given */ public Object getOption(String name) { if (options == null) return (null); return (options.get(name)); } /** * Return the entire list of options */ public Hashtable getOptions() { return (options); } public void setOptions(Hashtable opts) { options = opts; } /** * Set the name (i.e. registry key) of this Handler */ public void setName(String name) { this.name = name; } /** * Return the name (i.e. registry key) for this Handler */ public String getName() { return name; } public Element getDeploymentData(Document doc) { log.debug("Enter: BasicHandler::getDeploymentData"); Element root = doc.createElementNS("", "handler"); root.setAttribute("class", this.getClass().getName()); options = this.getOptions(); if (options != null) { Enumeration e = options.keys(); while (e.hasMoreElements()) { String k = (String)e.nextElement(); Object v = options.get(k); Element e1 = doc.createElementNS("", "option"); e1.setAttribute("name", k); e1.setAttribute("value", v.toString()); root.appendChild(e1); } } log.debug("Exit: BasicHandler::getDeploymentData"); return (root); } public void generateWSDL(MessageContext msgContext) throws AxisFault { } /** * Return a list of QNames which this Handler understands. By returning * a particular QName here, we are committing to fulfilling any contracts * defined in the specification of the SOAP header with that QName. */ public List getUnderstoodHeaders() { return null; } }
BasicHandler.java |