You are viewing a plain text version of this content. The canonical link for it is here.
Posted to java-dev@axis.apache.org by st...@apache.org on 2003/07/15 07:03:45 UTC
cvs commit: xml-axis/java/src/org/apache/axis/transport/http AutoRegisterServlet.java
stevel 2003/07/14 22:03:44
Added: java/src/org/apache/axis/transport/http
AutoRegisterServlet.java
Log:
starting to put together an autoregister system, the aim being that on system boot we autoregister everything into the system.wsdd. To use this you have to subclass it and somehow call it on startup.
NB, I want to pull some of the AxisServletBase class into a utility class so that you dont need to depend on AxisServletBase to start up the Engine...this lets me init axis from a JSP page if need be.
Revision Changes Path
1.1 xml-axis/java/src/org/apache/axis/transport/http/AutoRegisterServlet.java
Index: AutoRegisterServlet.java
===================================================================
/*
* The Apache Software License, Version 1.1
*
*
* Copyright (c) 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.apache.axis.transport.http;
import org.apache.commons.logging.Log;
import org.apache.axis.components.logger.LogFactory;
import org.apache.axis.deployment.wsdd.WSDDDocument;
import org.apache.axis.deployment.wsdd.WSDDDeployment;
import org.apache.axis.utils.XMLUtils;
import org.apache.axis.AxisEngine;
import org.apache.axis.AxisFault;
import org.apache.axis.ConfigurationException;
import org.apache.axis.EngineConfiguration;
import org.apache.axis.WSDDEngineConfiguration;
import org.w3c.dom.Document;
import org.xml.sax.SAXException;
import javax.xml.parsers.ParserConfigurationException;
import java.io.InputStream;
import java.io.IOException;
import java.io.FileNotFoundException;
import java.io.File;
import java.io.BufferedInputStream;
import java.io.FileInputStream;
/**
* Servlet that autoregisters
* @author Steve Loughran
* xdoclet tags are not active yet; keep web.xml in sync
* @web.servlet name="AutoRegisterServlet" display-name="Axis Autoregister Servlet" load-on-startup="30"
*/
public class AutoRegisterServlet extends AxisServletBase {
private static Log log =
LogFactory.getLog(AutoRegisterServlet.class.getName());
/**
* init by registering
*/
public void init() {
log.debug("Auto registering WSDD files");
autoRegister();
}
/**
* register an open stream, which we close afterwards
* @param instream
* @throws SAXException
* @throws ParserConfigurationException
* @throws IOException
*/
public void registerStream(InputStream instream) throws SAXException, ParserConfigurationException, IOException {
try {
Document doc=XMLUtils.newDocument(instream);
WSDDDocument wsddDoc = new WSDDDocument(doc);
WSDDDeployment deployment;
deployment = getDeployment();
if(deployment!=null) {
wsddDoc.deploy(deployment);
}
} finally {
instream.close();
}
}
/**
* register a resource
* @param resourcename
* @throws SAXException
* @throws ParserConfigurationException
* @throws IOException
*/
public void registerResource(String resourcename)
throws SAXException, ParserConfigurationException, IOException {
InputStream in=getServletContext().getResourceAsStream(resourcename);
if(in==null) {
throw new FileNotFoundException(resourcename);
}
registerStream(in);
}
/**
* register a file
* @param file
* @throws IOException
* @throws SAXException
* @throws ParserConfigurationException
*/
public void registerFile(File file) throws IOException, SAXException, ParserConfigurationException {
InputStream in=new BufferedInputStream(new FileInputStream(file));
registerStream(in);
}
/**
* subclass this to return an array of resource names.
* @return array of resource names of wsdd files, or null
*/
public String[] getResourcesToRegister() {
return null;
}
/**
* get deployment
* @return
* @throws AxisFault
*/
private WSDDDeployment getDeployment() throws AxisFault {
WSDDDeployment deployment;
AxisEngine engine = getEngine();
EngineConfiguration config = engine.getConfig();
if (config instanceof WSDDEngineConfiguration) {
deployment = ((WSDDEngineConfiguration) config).getDeployment();
} else {
deployment=null;
}
return deployment;
}
/**
* handler for logging trouble, defaults to handing off to logging
* @param item what were we loading?
* @param throwable
*/
protected void logException(String item,Throwable throwable) {
log.error(item,throwable);
}
/**
* handler for logging success, defaults to handing off to logging
* at debug level
* @param item what were we loading?
*/
protected void logSuccess(String item) {
log.debug("Loaded "+item);
}
/**
* register classes, log exceptions
*/
protected void autoRegister() {
String[] resources=getResourcesToRegister();
if(resources==null || resources.length==0) {
return;
}
for(int i=0;i<resources.length;i++) {
final String resource = resources[i];
registerAndLogResource(resource);
}
registerAnythingElse();
try {
applyAndSaveSettings();
} catch (Exception e) {
logException("applyAndSaveSettings()", e);
}
}
/**
* override point for subclasses to add other registration stuff
*/
protected void registerAnythingElse() {
}
/**
* register a single resource; log trouble and success.
* @param resource
*/
public void registerAndLogResource(final String resource) {
try {
registerResource(resource);
logSuccess(resource);
} catch (Exception e) {
logException(resource,e);
}
}
/**
* actually update the engine and save the settings
* @throws AxisFault
* @throws ConfigurationException
*/
protected void applyAndSaveSettings()
throws AxisFault, ConfigurationException {
AxisEngine engine = getEngine();
engine.refreshGlobalOptions();
engine.saveConfiguration();
}
}