/*
* Copyright 2004,2005 The Apache Software Foundation.
*
* Licensed 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.engine;
import org.apache.axis2.AxisFault;
import org.apache.axis2.deployment.DeploymentEngine;
import org.apache.axis2.deployment.repository.util.ArchiveReader;
import org.apache.axis2.deployment.util.PhasesInfo;
import org.apache.axis2.description.*;
import org.apache.axis2.om.OMElement;
import org.apache.axis2.phaseresolver.PhaseMetadata;
import org.apache.axis2.util.HostConfiguration;
import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
import javax.xml.namespace.QName;
import java.io.File;
import java.util.*;
/**
* Class AxisConfigurationImpl
*/
public class AxisConfiguration implements ParameterInclude{
/**
* To store faulty services
*/
private Hashtable faultyServices;
private HashMap moduleConfigmap;
private Hashtable faultyModules;
private Log log = LogFactory.getLog(getClass());
//to store hots configuration if any
HostConfiguration hostConfiguration;
/**
* Field modules
*/
private final HashMap modules = new HashMap();
private final HashMap serviceGroups = new HashMap();
private final HashMap transportsIn = new HashMap();
private final HashMap transportsOut = new HashMap();
/**
* Field phases
*/
// private ArrayList inPhases;
private ArrayList outPhases;
private ArrayList inFaultPhases;
private ArrayList outFaultPhases;
private ArrayList inPhasesUptoAndIncludingPostDispatch;
/////////////////////// From AxisGlobal /////////////////////////////////////
/**
* Field paramInclude
*/
protected final ParameterInclude paramInclude;
protected PhasesInfo phasesinfo;
/**
* Field engagedModules
*/
protected final List engagedModules;
private String axis2Repository = null;
//to store AxisObserver Objects
private ArrayList observersList = null;
private HashMap allservices = new HashMap();
private ClassLoader systemClassLoader;
private ClassLoader serviceClassLoader;
private ClassLoader moduleClassLoader;
protected HashMap messagReceivers;
/////////////////////// From AxisGlobal /////////////////////////////////////
/**
* Constructor AxisConfigurationImpl
*/
public AxisConfiguration() {
moduleConfigmap = new HashMap();
paramInclude = new ParameterIncludeImpl();
engagedModules = new ArrayList();
messagReceivers = new HashMap();
outPhases = new ArrayList();
inFaultPhases = new ArrayList();
outFaultPhases = new ArrayList();
faultyServices = new Hashtable();
faultyModules = new Hashtable();
observersList = new ArrayList();
inPhasesUptoAndIncludingPostDispatch = new ArrayList();
inPhasesUptoAndIncludingPostDispatch.add(
new Phase(PhaseMetadata.PHASE_TRANSPORTIN));
inPhasesUptoAndIncludingPostDispatch.add(
new Phase(PhaseMetadata.PHASE_PRE_DISPATCH));
systemClassLoader = Thread.currentThread().getContextClassLoader();
serviceClassLoader = Thread.currentThread().getContextClassLoader();
moduleClassLoader = Thread.currentThread().getContextClassLoader();
// setting the dafualt flow , if some one creat AxisConfig programatically
// most requird handles will be there in the flow.
setDefaultGlobalFlow();
}
/**
* to set the default global flow if some one create a AxisConfiguration by hand.
*/
private void setDefaultGlobalFlow() {
Phase dispatch = new Phase(PhaseMetadata.PHASE_DISPATCH);
AddressingBasedDispatcher add_dispatch = new AddressingBasedDispatcher();
add_dispatch.initDispatcher();
add_dispatch.getHandlerDesc().setParent(this);
dispatch.addHandler(add_dispatch, 0);
RequestURIBasedDispatcher uri_diaptch = new RequestURIBasedDispatcher();
uri_diaptch.getHandlerDesc().setParent(this);
uri_diaptch.initDispatcher();
dispatch.addHandler(uri_diaptch, 1);
SOAPActionBasedDispatcher soapActionBased_dispatch = new SOAPActionBasedDispatcher();
soapActionBased_dispatch.getHandlerDesc().setParent(this);
soapActionBased_dispatch.initDispatcher();
dispatch.addHandler(soapActionBased_dispatch, 2);
SOAPMessageBodyBasedDispatcher soapMessageBodybased_dispatch =
new SOAPMessageBodyBasedDispatcher();
soapMessageBodybased_dispatch.getHandlerDesc().setParent(this);
soapMessageBodybased_dispatch.initDispatcher();
dispatch.addHandler(soapMessageBodybased_dispatch, 3);
inPhasesUptoAndIncludingPostDispatch.add(dispatch);
Phase postDispatch = new Phase(PhaseMetadata.PHASE_POST_DISPATCH);
DispatchingChecker dispatchingChecker = new DispatchingChecker();
dispatchingChecker.getHandlerDesc().setParent(this);
InstanceDispatcher instanceDispatcher = new org.apache.axis2.engine.InstanceDispatcher();
instanceDispatcher.getHandlerDesc().setParent(this);
postDispatch.addHandler(dispatchingChecker, 0);
postDispatch.addHandler(instanceDispatcher, 1);
inPhasesUptoAndIncludingPostDispatch.add(postDispatch);
}
public Hashtable getFaultyServices() {
return faultyServices;
}
public Hashtable getFaultyModules() {
return faultyModules;
}
/**
* Method addModule.
*
* @param module
* @throws AxisFault
*/
public synchronized void addModule(ModuleDescription module) throws AxisFault {
module.setParent(this);
modules.put(module.getName(), module);
}
/**
* Method addService.
*
* @param service
* @throws AxisFault
*/
public synchronized void addService(AxisService service) throws AxisFault {
AxisServiceGroup axisServiceGroup = new AxisServiceGroup();
axisServiceGroup.setServiceGroupName(service.getName().getLocalPart());
axisServiceGroup.setParent(this);
axisServiceGroup.addService(service);
addServiceGroup(axisServiceGroup);
}
public void addServiceGroup(AxisServiceGroup axisServiceGroup) throws AxisFault {
Iterator services = axisServiceGroup.getServices();
axisServiceGroup.setParent(this);
AxisService description;
while (services.hasNext()) {
description = (AxisService) services.next();
if (allservices.get(description.getName().getLocalPart()) != null) {
throw new AxisFault("Two services can not have same name, a service with " +
description.getName().getLocalPart() + " alredy exist in the system");
}
}
services = axisServiceGroup.getServices();
while (services.hasNext()) {
description = (AxisService) services.next();
allservices.put(description.getName().getLocalPart(), description);
notifyObservers(AxisEvent.SERVICE_DEPLOY, description);
}
Iterator enModule = engagedModules.iterator();
while (enModule.hasNext()) {
QName moduleDescription = (QName) enModule.next();
axisServiceGroup.engageModuleToGroup(moduleDescription);
}
serviceGroups.put(axisServiceGroup.getServiceGroupName(), axisServiceGroup);
}
/**
* Method getModule.
*
* @param name
* @return Returns ModuleDescription.
*/
public ModuleDescription getModule(QName name) {
return (ModuleDescription) modules.get(name);
}
/**
* @return Returns HashMap.
*/
public HashMap getModules() {
return modules;
}
/**
* Method getService.
*
* @param name
* @return Returns AxisService.
* @throws AxisFault
*/
public AxisService getService(String name) throws AxisFault {
return (AxisService) allservices.get(name);
}
/**
* Method removeService.
*
* @param name
* @throws AxisFault
*/
public synchronized void removeService(String name) throws AxisFault {
AxisService service = (AxisService) allservices.remove(name);
if (service != null) {
log.info("Removed service " + name);
}
}
public TransportInDescription getTransportIn(QName name) throws AxisFault {
return (TransportInDescription) transportsIn.get(name);
}
/**
* Method addTransportIn.
*
* @param transport
* @throws AxisFault
*/
public synchronized void addTransportIn(TransportInDescription transport)
throws AxisFault {
transportsIn.put(transport.getName(), transport);
}
public TransportOutDescription getTransportOut(QName name) throws AxisFault {
return (TransportOutDescription) transportsOut.get(name);
}
/**
* Method addTransportOut.
*
* @param transport
* @throws AxisFault
*/
public synchronized void addTransportOut(TransportOutDescription transport)
throws AxisFault {
transportsOut.put(transport.getName(), transport);
}
public HashMap getTransportsIn() {
return transportsIn;
}
public HashMap getTransportsOut() {
return transportsOut;
}
/**
* Checks whether a given parameter is locked.
*
* @param parameterName
* @return Returns boolean
*/
public boolean isParameterLocked(String parameterName) {
Parameter parameter = getParameter(parameterName);
return parameter != null && parameter.isLocked();
}
public void deserializeParameters(OMElement paramters) throws AxisFault {
this.paramInclude.deserializeParameters(paramters);
}
public AxisServiceGroup getServiceGroup(String serviceNameAndGroupString) {
return (AxisServiceGroup) serviceGroups.get(serviceNameAndGroupString);
}
public Iterator getServiceGroups() {
return serviceGroups.values().iterator();
}
public ArrayList getInPhasesUptoAndIncludingPostDispatch() {
return inPhasesUptoAndIncludingPostDispatch;
}
//to get the out flow correpodning to the global out flow;
public ArrayList getGlobalOutPhases() {
return this.outPhases;
}
public void setGlobalOutPhase(ArrayList outPhases) {
this.outPhases = outPhases;
}
public void setInPhasesUptoAndIncludingPostDispatch(ArrayList inPhasesUptoAndIncludingPostDispatch) {
this.inPhasesUptoAndIncludingPostDispatch = inPhasesUptoAndIncludingPostDispatch;
}
/**
* @return Returns ArrayList
*/
public ArrayList getInFaultFlow() {
return inFaultPhases;
}
/**
* @return Returns ArrayList
*/
public ArrayList getOutFaultFlow() {
return outFaultPhases;
}
/**
* @param list
*/
public void setInFaultPhases(ArrayList list) {
inFaultPhases = list;
}
/**
* @param list
*/
public void setOutFaultPhases(ArrayList list) {
outFaultPhases = list;
}
////////////////////////// Form Axis Global
public void addMessageReceiver(String key,
MessageReceiver messageReceiver) {
messagReceivers.put(key, messageReceiver);
}
public MessageReceiver getMessageReceiver(String key) {
return (MessageReceiver) messagReceivers.get(key);
}
/**
* Method getParameter.
*
* @param name
* @return Returns Parameter
*/
public Parameter getParameter(String name) {
return paramInclude.getParameter(name);
}
public ArrayList getParameters() {
return paramInclude.getParameters();
}
/**
* Method addParameter.
*
* @param param
*/
public void addParameter(Parameter param) throws AxisFault {
if (isParameterLocked(param.getName())) {
throw new AxisFault("Parmter is locked can not overide: " + param.getName());
} else {
paramInclude.addParameter(param);
}
}
/**
* Method getEngagedModules.
*
* @return Collection
*/
public Collection getEngagedModules() {
return engagedModules;
}
public void engageModule(QName moduleref) throws AxisFault {
ModuleDescription module = getModule(moduleref);
boolean isNewmodule = false;
if (module == null) {
File file = new ArchiveReader().creatModuleArchivefromResource(
moduleref.getLocalPart(), getRepository());
module = new DeploymentEngine().buildModule(file, this);
isNewmodule = true;
}
if (module != null) {
for (Iterator iterator = engagedModules.iterator();
iterator.hasNext();) {
QName qName = (QName) iterator.next();
if (moduleref.equals(qName)) {
log.info("Attempt to engage an already engaged module " + qName);
return;
}
}
} else {
throw new AxisFault(
this + " Refer to invalid module "
+ moduleref.getLocalPart() +
" has not bean deployed yet !");
}
Iterator servicegroups = getServiceGroups();
while (servicegroups.hasNext()) {
AxisServiceGroup serviceGroup = (AxisServiceGroup) servicegroups.next();
serviceGroup.engageModuleToGroup(module.getName());
}
if (isNewmodule) {
addModule(module);
}
engagedModules.add(moduleref);
}
//to get all the services in the system
public HashMap getServices() {
Iterator sgs = getServiceGroups();
while (sgs.hasNext()) {
AxisServiceGroup axisServiceGroup = (AxisServiceGroup) sgs.next();
Iterator servics = axisServiceGroup.getServices();
while (servics.hasNext()) {
AxisService axisService = (AxisService) servics.next();
allservices.put(axisService.getName().getLocalPart(), axisService);
}
}
return allservices;
}
public boolean isEngaged(QName moduleName) {
return engagedModules.contains(moduleName);
}
public PhasesInfo getPhasesinfo() {
return phasesinfo;
}
public void setPhasesinfo(PhasesInfo phasesinfo) {
this.phasesinfo = phasesinfo;
}
public String getRepository() {
return axis2Repository;
}
public void setRepository(String axis2Repository) {
this.axis2Repository = axis2Repository;
}
public void notifyObservers(int event_type, AxisService service) {
AxisEvent event = new AxisEvent(service, event_type);
for (int i = 0; i < observersList.size(); i++) {
AxisObserver axisObserver = (AxisObserver) observersList.get(i);
axisObserver.update(event);
}
}
//the class loder which become the top most parent of all the modules and services
public ClassLoader getSystemClassLoader() {
return this.systemClassLoader;
}
public void setSystemClassLoader(ClassLoader classLoader) {
this.systemClassLoader = classLoader;
}
// the class loder that become the paranet of all the services
public ClassLoader getServiceClassLoader() {
return this.serviceClassLoader;
}
public void setServiceClassLoader(ClassLoader classLoader) {
this.serviceClassLoader = classLoader;
}
// the class loder that become the paranet of all the moduels
public ClassLoader getModuleClassLoader() {
return this.moduleClassLoader;
}
public void setModuleClassLoader(ClassLoader classLoader) {
this.moduleClassLoader = classLoader;
}
//to set and get host configuration
public void setHostConfiguration(HostConfiguration hostConfiguration) {
this.hostConfiguration = hostConfiguration;
}
public HostConfiguration getHostConfiguration() {
return this.hostConfiguration;
}
public void addObservers(AxisObserver axisObserver) {
observersList.add(axisObserver);
}
/**
* Adds module configuration, if there is moduleConfig tag in service.
*
* @param moduleConfiguration
*/
public void addModuleConfig(ModuleConfiguration moduleConfiguration) {
moduleConfigmap.put(moduleConfiguration.getModuleName(), moduleConfiguration);
}
public ModuleConfiguration getModuleConfig(QName moduleName) {
return (ModuleConfiguration) moduleConfigmap.get(moduleName);
}
}