org.apache.axis2.context.ConfigurationContextFactory Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of axis2-kernel Show documentation
Show all versions of axis2-kernel Show documentation
Core Parts of Axis2. This includes Axis2 engine, Client API, Addressing support, etc.,
/*
* 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.axis2.context;
import org.apache.axis2.AxisFault;
import org.apache.axis2.Constants;
import org.apache.axis2.deployment.*;
import org.apache.axis2.deployment.util.Utils;
import org.apache.axis2.description.AxisModule;
import org.apache.axis2.description.AxisServiceGroup;
import org.apache.axis2.description.Parameter;
import org.apache.axis2.description.TransportOutDescription;
import org.apache.axis2.engine.AxisConfiguration;
import org.apache.axis2.engine.AxisConfigurator;
import org.apache.axis2.engine.DependencyManager;
import org.apache.axis2.i18n.Messages;
import org.apache.axis2.modules.Module;
import org.apache.axis2.transport.TransportSender;
import org.apache.axis2.util.Loader;
import org.apache.axis2.util.SessionUtils;
import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
import java.io.InputStream;
import java.net.URL;
import java.util.Collection;
import java.util.HashMap;
import java.util.Iterator;
import java.util.Map;
public class ConfigurationContextFactory {
protected static final Log log = LogFactory.getLog(ConfigurationContextFactory.class);
/**
* Creates a AxisConfiguration depending on the user requirement.
* First creates an AxisConfigurator object with appropriate parameters.
* Depending on the implementation getAxisConfiguration(), gets
* the AxisConfiguration and uses it to create the ConfigurationContext.
*
* @param axisConfigurator : AxisConfigurator
* @return Returns ConfigurationContext.
* @throws AxisFault : If somthing goes wrong
*/
public static ConfigurationContext createConfigurationContext(
AxisConfigurator axisConfigurator) throws AxisFault {
AxisConfiguration axisConfig = axisConfigurator.getAxisConfiguration();
// call to the deployment listners
Parameter param = axisConfig.getParameter(Constants.Configuration.DEPLOYMENT_LIFE_CYCLE_LISTENER);
DeploymentLifeCycleListener deploymentLifeCycleListener = null;
if (param != null){
String className = (String) param.getValue();
try {
deploymentLifeCycleListener = (DeploymentLifeCycleListener) Class.forName(className).newInstance();
} catch (InstantiationException e) {
log.error("Can not instantiate deployment Listener " + className, e);
throw new AxisFault("Can not instantiate deployment Listener " + className);
} catch (IllegalAccessException e) {
log.error("Illegal Access deployment Listener " + className, e);
throw new AxisFault("Illegal Access deployment Listener " + className);
} catch (ClassNotFoundException e) {
log.error("Class not found deployment Listener " + className, e);
throw new AxisFault("Class not found deployment Listener " + className);
}
}
if (deploymentLifeCycleListener != null){
deploymentLifeCycleListener.preDeploy(axisConfig);
}
ConfigurationContext configContext = new ConfigurationContext(axisConfig);
if (axisConfigurator instanceof DeploymentEngine) {
((DeploymentEngine) axisConfigurator).setConfigContext(configContext);
}
//To override context path
setContextPaths(axisConfig, configContext);
init(configContext);
axisConfigurator.engageGlobalModules();
axisConfigurator.loadServices();
addModuleService(configContext);
// TODO: THIS NEEDS A TEST CASE!
initApplicationScopeServices(configContext);
//Check whether there are any faulty services due to modules and trasports,
//If any, let the user know.
Utils.logFaultyServiceInfo(axisConfig);
axisConfig.setStart(true);
if (deploymentLifeCycleListener != null){
deploymentLifeCycleListener.postDeploy(configContext);
}
// Finally initialize the cluster
if (axisConfig.getClusteringAgent() != null) {
configContext.initCluster();
}
return configContext;
}
private static void initApplicationScopeServices(ConfigurationContext configCtx)
throws AxisFault {
Iterator serviceGroups = configCtx.getAxisConfiguration().getServiceGroups();
while (serviceGroups.hasNext()) {
AxisServiceGroup axisServiceGroup = (AxisServiceGroup) serviceGroups.next();
String maxScope = SessionUtils.calculateMaxScopeForServiceGroup(axisServiceGroup);
if (Constants.SCOPE_APPLICATION.equals(maxScope)) {
ServiceGroupContext serviceGroupContext =
configCtx.createServiceGroupContext(axisServiceGroup);
configCtx.addServiceGroupContextIntoApplicationScopeTable(serviceGroupContext);
DependencyManager.initService(serviceGroupContext);
}
}
}
private static void addModuleService(ConfigurationContext configCtx) throws AxisFault {
AxisConfiguration axisConfig = configCtx.getAxisConfiguration();
HashMap modules = axisConfig.getModules();
if (modules != null && modules.size() > 0) {
Iterator mpduleItr = modules.values().iterator();
while (mpduleItr.hasNext()) {
AxisModule axisModule = (AxisModule) mpduleItr.next();
Utils.deployModuleServices(axisModule, configCtx);
}
}
}
private static void setContextPaths(AxisConfiguration axisConfig,
ConfigurationContext configContext) {
// Checking for context path
Parameter servicePath = axisConfig.getParameter(Constants.PARAM_SERVICE_PATH);
if (servicePath != null) {
String spath = ((String) servicePath.getValue()).trim();
if (spath.length() > 0) {
configContext.setServicePath(spath);
}
} else {
configContext.setServicePath(Constants.DEFAULT_SERVICES_PATH);
}
Parameter contextPath = axisConfig.getParameter(Constants.PARAM_CONTEXT_ROOT);
if (contextPath != null) {
String cpath = ((String) contextPath.getValue()).trim();
if (cpath.length() > 0) {
configContext.setContextRoot(cpath);
}
} else {
configContext.setContextRoot("axis2");
}
}
/**
* To get a ConfigurationContext for given data , and underline implementation
* is Axis2 default impl which is file system based deployment model to create
* an AxisConfiguration.
*
* Here either or both parameter can be null. So that boil down to following
* scenarios and it should note that parameter value should be full path ,
* you are not allowed to give one relative to other. And these two can be located
* in completely different locations.
*
* - If none of them are null , then AxisConfiguration will be based on the
* value of axis2xml , and the repository will be the value specified by the
* path parameter and there will not be any assumptions.
* - If axis2xml is null , then the repository will be the value specfied by
* path parameter and AxisConfiguration will be created using default_axis2.xml
* - If path parameter is null , then AxisConfiguration will be created using
* that axis2.xml. And after creating AxisConfiguration system will try to
* find user has specified repository parameter in axis2.xml
* (<parameter name="repository">location of the repo</parameter>) , if it
* find that then repository will be the value specified by that parameter.
* - If both are null , then it is simple , AixsConfiguration will be created
* using default_axis2.xml and thats it.
*
*
* Note : rather than passing any parameters you can give them as System
* properties. Simple you can add following system properties before
* you call this.
*
* - axis2.repo : same as path parameter
* - axis2.xml : same as axis2xml
*
*
* @param path : location of the repository
* @param axis2xml : location of the axis2.xml (configuration) , you can not give
* axis2xml relative to repository.
* @return Returns the built ConfigurationContext.
* @throws AxisFault in case of problems
*/
public static ConfigurationContext createConfigurationContextFromFileSystem(
String path,
String axis2xml) throws AxisFault {
return createConfigurationContext(new FileSystemConfigurator(path, axis2xml));
}
public static ConfigurationContext createConfigurationContextFromFileSystem(String path)
throws AxisFault {
return createConfigurationContextFromFileSystem(path, null);
}
public static ConfigurationContext createConfigurationContextFromURIs(
URL axis2xml, URL repositoy) throws AxisFault {
return createConfigurationContext(new URLBasedAxisConfigurator(axis2xml, repositoy));
}
/**
* Initializes modules and creates Transports.
*
* @param configContext ConfigurationContext
*/
private static void init(ConfigurationContext configContext) {
initModules(configContext);
initTransportSenders(configContext);
}
/**
* Initializes the modules. If the module needs to perform some recovery process
* it can do so in init and this is different from module.engage().
*
* @param context : ConfigurationContext
*/
private static void initModules(ConfigurationContext context) {
AxisConfiguration configuration = context.getAxisConfiguration();
HashMap modules = configuration.getModules();
Collection col = modules.values();
Map faultyModule = new HashMap();
for (Iterator iterator = col.iterator(); iterator.hasNext();) {
AxisModule axismodule = (AxisModule) iterator.next();
Module module = axismodule.getModule();
if (module != null) {
try {
module.init(context, axismodule);
} catch (AxisFault axisFault) {
log.info(axisFault.getMessage());
faultyModule.put(axismodule, axisFault);
}
}
}
//Checking whether we have found any faulty services during the module initilization ,
// if so we need to mark them as fautyModule and need to remove from the modules list
if (faultyModule.size() > 0) {
Iterator axisModules = faultyModule.keySet().iterator();
while (axisModules.hasNext()) {
AxisModule axisModule = (AxisModule) axisModules.next();
String fileName;
if (axisModule.getFileName() != null) {
fileName = axisModule.getFileName().toString();
} else {
fileName = axisModule.getName();
}
configuration.getFaultyModules().put(fileName, faultyModule.get(axisModule).toString());
//removing from original list
configuration.removeModule(axisModule.getName(), axisModule.getName());
}
}
}
/**
* Initializes TransportSenders and TransportListeners with appropriate configuration information
*
* @param configContext : ConfigurationContext
*/
private static void initTransportSenders(ConfigurationContext configContext) {
AxisConfiguration axisConf = configContext.getAxisConfiguration();
// Initialize Transport Outs
HashMap transportOuts = axisConf.getTransportsOut();
Iterator values = transportOuts.values().iterator();
while (values.hasNext()) {
TransportOutDescription transportOut = (TransportOutDescription) values.next();
TransportSender sender = transportOut.getSender();
if (sender != null) {
try {
sender.init(configContext, transportOut);
} catch (AxisFault axisFault) {
log.info(Messages.getMessage("transportiniterror", transportOut.getName()));
}
}
}
}
/**
* creates an empty configuration context.
*
* @return Returns ConfigurationContext.
*/
public static ConfigurationContext createEmptyConfigurationContext() throws AxisFault {
AxisConfiguration axisConfiguration = new AxisConfiguration();
ConfigurationContext configContext = new ConfigurationContext(axisConfiguration);
if (axisConfiguration.getClusteringAgent() != null) {
configContext.initCluster();
}
setContextPaths(axisConfiguration, configContext);
return configContext;
}
/**
* Gets the default configuration context by using Axis2.xml in the classpath
*
* @return Returns ConfigurationContext.
*/
public static ConfigurationContext createDefaultConfigurationContext() throws Exception {
return createBasicConfigurationContext(DeploymentConstants.AXIS2_CONFIGURATION_RESOURCE);
}
/**
* Creates configuration context using resource file found in the classpath.
*
* @return Returns ConfigurationContext.
*/
public static ConfigurationContext createBasicConfigurationContext(String resourceName) throws Exception {
InputStream in = Loader.getResourceAsStream(resourceName);
AxisConfiguration axisConfig = new AxisConfiguration();
AxisConfigBuilder builder = new AxisConfigBuilder(in, axisConfig, null);
builder.populateConfig();
axisConfig.validateSystemPredefinedPhases();
ConfigurationContext configContext = new ConfigurationContext(axisConfig);
if (axisConfig.getClusteringAgent() != null) {
configContext.initCluster();
}
setContextPaths(axisConfig, configContext);
return configContext;
}
}