/*
* 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.context.MessageContext;
import org.apache.axis2.deployment.util.PhasesInfo;
import org.apache.axis2.description.*;
import org.apache.axis2.i18n.Messages;
import org.apache.axis2.phaseresolver.PhaseResolver;
import org.apache.axis2.util.TargetResolver;
import org.apache.axis2.util.Utils;
import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
import org.apache.ws.java2wsdl.Java2WSDLConstants;
import javax.xml.namespace.QName;
import java.net.URL;
import java.util.*;
/**
* Class AxisConfiguration
*/
public class AxisConfiguration extends AxisDescription {
private static final Log log = LogFactory.getLog(AxisConfiguration.class);
/**
* Field modules
*/
// private final HashMap defaultModules = new HashMap();
//
// to store all the availble modules (including version)
private final HashMap allModules = new HashMap();
// to store mapping between default version to module name
private final HashMap nameToversionMap = new HashMap();
// private final HashMap serviceGroups = new HashMap();
private final HashMap transportsIn = new HashMap();
private final HashMap transportsOut = new HashMap();
private final HashMap policySupportedModules = new HashMap();
/**
* Stores the QNames of local policy assertions
*/
private final ArrayList localPolicyAssertions = new ArrayList();
// to store AxisObserver Objects
private ArrayList observersList = null;
private URL axis2Repository = null;
private HashMap allservices = new HashMap();
/**
* Stores the module specified in the server.xml at the document parsing time.
*/
private List globalModuleList;
/**
* Field engagedModules
*/
private final List engagedModules;
private Hashtable faultyModules;
/**
* To store faulty services
*/
private Hashtable faultyServices;
private ArrayList inFaultPhases;
private ArrayList inPhasesUptoAndIncludingPostDispatch;
private HashMap messageReceivers;
private ClassLoader moduleClassLoader;
private HashMap moduleConfigmap;
private ArrayList outFaultPhases;
private ArrayList outPhases;
protected PhasesInfo phasesinfo;
private ClassLoader serviceClassLoader;
private ClassLoader systemClassLoader;
// to keep track of need to manage transport session or not
private boolean manageTransportSession;
//to keep tarck of system start or not
private boolean start;
private ArrayList targetResolvers;
/**
* Constructor AxisConfigurationImpl.
*/
public AxisConfiguration() {
moduleConfigmap = new HashMap();
engagedModules = new ArrayList();
globalModuleList = new ArrayList();
messageReceivers = new HashMap();
outPhases = new ArrayList();
inFaultPhases = new ArrayList();
outFaultPhases = new ArrayList();
faultyServices = new Hashtable();
faultyModules = new Hashtable();
observersList = new ArrayList();
inPhasesUptoAndIncludingPostDispatch = new ArrayList();
systemClassLoader = Thread.currentThread().getContextClassLoader();
serviceClassLoader = Thread.currentThread().getContextClassLoader();
moduleClassLoader = Thread.currentThread().getContextClassLoader();
this.phasesinfo = new PhasesInfo();
targetResolvers = new ArrayList();
}
public void addMessageReceiver(String mepURL,
MessageReceiver messageReceiver) {
messageReceivers.put(mepURL, messageReceiver);
}
/**
* Method addModule.
*
* @param module
* @throws AxisFault
*/
public void addModule(AxisModule module) throws AxisFault {
module.setParent(this);
notifyObservers(AxisEvent.MODULE_DEPLOY, module);
String moduleName = module.getName().getLocalPart();
if (moduleName.endsWith("SNAPSHOT")) {
QName moduleQName = new QName(moduleName.substring(0, moduleName
.indexOf("SNAPSHOT") - 1));
module.setName(moduleQName);
allModules.put(moduleQName, module);
} else {
allModules.put(module.getName(), module);
}
// Registering the policy namespaces that the module understand
registerModulePolicySupport(module);
// Registering the policy assertions that are local to the system
registerLocalPolicyAssertions(module);
}
/**
* To remove a given module from the system
*
* @param module
*/
public void removeModule(QName module) {
allModules.remove(module);
// TODO dis-engage has to be done here
}
/**
* Adds module configuration, if there is moduleConfig tag in service.
*
* @param moduleConfiguration
*/
public void addModuleConfig(ModuleConfiguration moduleConfiguration) {
moduleConfigmap.put(moduleConfiguration.getModuleName(),
moduleConfiguration);
}
public void addObservers(AxisObserver axisObserver) {
observersList.add(axisObserver);
}
/**
* Method addService.
*
* @param service
* @throws AxisFault
*/
public synchronized void addService(AxisService service) throws AxisFault {
AxisServiceGroup axisServiceGroup = new AxisServiceGroup();
axisServiceGroup.setServiceGroupName(service.getName());
axisServiceGroup.setParent(this);
axisServiceGroup.addService(service);
addServiceGroup(axisServiceGroup);
}
/**
* This method will check whethere for a given service , can we ganerate
* valid wsdl or not. So if user derop a wsdl we print that out , else if
* all the operation uses RPC message recivers we will generate wsdl
*
* @param axisService
*/
private void isWSDLEnable(AxisService axisService) {
if (!axisService.isWsdlFound()) {
Iterator operatins = axisService.getOperations();
if (operatins.hasNext()) {
while (operatins.hasNext()) {
AxisOperation axisOperation = (AxisOperation) operatins
.next();
if (axisOperation.getMessageReceiver() == null) {
axisService.setWsdlFound(false);
return;
}
String messageReceiverClass = axisOperation
.getMessageReceiver().getClass().getName();
if (!("org.apache.axis2.rpc.receivers.RPCMessageReceiver"
.equals(messageReceiverClass)
|| "org.apache.axis2.rpc.receivers.RPCInOnlyMessageReceiver"
.equals(messageReceiverClass) || "org.apache.axis2.rpc.receivers.RPCInOutAsyncMessageReceiver"
.equals(messageReceiverClass))) {
axisService.setWsdlFound(false);
return;
}
}
axisService.setWsdlFound(true);
} else {
axisService.setWsdlFound(false);
}
}
}
public synchronized void addServiceGroup(AxisServiceGroup axisServiceGroup)
throws AxisFault {
notifyObservers(AxisEvent.SERVICE_DEPLOY, axisServiceGroup);
Iterator services = axisServiceGroup.getServices();
axisServiceGroup.setParent(this);
AxisService description;
while (services.hasNext()) {
description = (AxisService) services.next();
if (allservices.get(description.getName()) != null) {
throw new AxisFault(Messages.getMessage(
"twoservicecannothavesamename", description.getName()));
}
if (description.getSchematargetNamespace() == null) {
description
.setSchematargetNamespace(Java2WSDLConstants.AXIS2_XSD);
}
isWSDLEnable(description);
}
services = axisServiceGroup.getServices();
while (services.hasNext()) {
description = (AxisService) services.next();
if (description.isUseDefaultChains()) {
Iterator operations = description.getOperations();
while (operations.hasNext()) {
AxisOperation operation = (AxisOperation) operations.next();
phasesinfo.setOperationPhases(operation);
}
}
}
Iterator enModule = engagedModules.iterator();
while (enModule.hasNext()) {
QName moduleName = (QName) enModule.next();
axisServiceGroup.engageModule(getModule(moduleName), this);
}
services = axisServiceGroup.getServices();
while (services.hasNext()) {
description = (AxisService) services.next();
allservices.put(description.getName(), description);
if (!description.isClientSide()) {
notifyObservers(AxisEvent.SERVICE_DEPLOY, description);
}
}
// serviceGroups.put(axisServiceGroup.getServiceGroupName(),
// axisServiceGroup);
addChild(axisServiceGroup);
}
public void removeServiceGroup(String serviceGroupName) throws AxisFault {
AxisServiceGroup axisServiceGroup = (AxisServiceGroup) getChild(serviceGroupName);
if (axisServiceGroup == null) {
throw new AxisFault(Messages.getMessage("invalidservicegroupname",
serviceGroupName));
}
Iterator services = axisServiceGroup.getServices();
while (services.hasNext()) {
AxisService axisService = (AxisService) services.next();
allservices.remove(axisService.getName());
if (!axisService.isClientSide()) {
notifyObservers(AxisEvent.SERVICE_REMOVE, axisService);
}
}
removeChild(serviceGroupName);
notifyObservers(AxisEvent.SERVICE_REMOVE, axisServiceGroup);
}
/**
* Method addTransportIn.
*
* @param transport
* @throws AxisFault
*/
public void addTransportIn(TransportInDescription transport)
throws AxisFault {
if (transport.getReceiver() == null) {
throw new AxisFault(
"Transport Receiver can not be null for the transport "
+ transport.getName().getLocalPart());
}
transportsIn.put(transport.getName(), transport);
}
/**
* Method addTransportOut.
*
* @param transport
* @throws AxisFault
*/
public void addTransportOut(TransportOutDescription transport)
throws AxisFault {
if (transport.getSender() == null) {
throw new AxisFault(
"Transport sender can not be null for the transport "
+ transport.getName().getLocalPart());
}
transportsOut.put(transport.getName(), transport);
}
/**
* Engages the default module version corresponding to given module name ,
* or if the module name contains version number in it then it will engage
* the correct module. Both of the below two cases are valid 1.
* engageModule("addressing"); 2. engageModule("addressing-1.23");
*
* @param moduleref
* @throws AxisFault
*/
public void engageModule(QName moduleref) throws AxisFault {
AxisModule module = getModule(moduleref);
if (module != null) {
engageModule(module);
} else {
throw new AxisFault(Messages.getMessage("modulenotavailble",
moduleref.getLocalPart()));
}
}
/**
* Engages a module using give name and its version ID.
*
* @param moduleName
* @param versionID
* @throws AxisFault
*/
public void engageModule(String moduleName, String versionID)
throws AxisFault {
QName moduleQName = Utils.getModuleName(moduleName, versionID);
AxisModule module = getModule(moduleQName);
if (module != null) {
engageModule(module);
} else {
throw new AxisFault(Messages.getMessage("refertoinvalidmodule"));
}
}
public void engageModule(AxisModule axisModule, AxisConfiguration axisConfig)
throws AxisFault {
engageModule(axisModule);
}
private void engageModule(AxisModule module) throws AxisFault {
boolean isEngagable;
if (module != null) {
QName moduleQName = module.getName();
for (Iterator iterator = engagedModules.iterator(); iterator
.hasNext();) {
QName qName = (QName) iterator.next();
isEngagable = Utils.checkVersion(moduleQName, qName);
if (!isEngagable) {
return;
}
}
} else {
throw new AxisFault(Messages.getMessage("refertoinvalidmodule"));
}
Iterator servicegroups = getServiceGroups();
while (servicegroups.hasNext()) {
AxisServiceGroup serviceGroup = (AxisServiceGroup) servicegroups
.next();
serviceGroup.engageModule(module, this);
}
engagedModules.add(module.getName());
}
/**
* To dis-engage module from the system, this will remove all the handlers
* belongs to this module from all the handler chains
*
* @param module
*/
public void disengageModule(AxisModule module) {
if (module != null && isEngaged(module.getName())) {
PhaseResolver phaseResolver = new PhaseResolver(this);
phaseResolver.disengageModuleFromGlobalChains(module);
Iterator serviceItr = getServices().values().iterator();
while (serviceItr.hasNext()) {
AxisService axisService = (AxisService) serviceItr.next();
axisService.disengageModule(module);
}
Iterator serviceGroups = getServiceGroups();
while (serviceGroups.hasNext()) {
AxisServiceGroup axisServiceGroup = (AxisServiceGroup) serviceGroups
.next();
axisServiceGroup.removeFromEngageList(module.getName());
}
engagedModules.remove(module.getName());
}
}
public void notifyObservers(int event_type, AxisService service) {
AxisEvent event = new AxisEvent(event_type);
for (int i = 0; i < observersList.size(); i++) {
AxisObserver axisObserver = (AxisObserver) observersList.get(i);
try {
if (!service.isClientSide()) {
axisObserver.serviceUpdate(event, service);
}
} catch (Throwable e) {
// No need to stop the system due to this , So log and ignore
log.debug(e);
}
}
}
public void notifyObservers(int event_type, AxisModule moule) {
AxisEvent event = new AxisEvent(event_type);
for (int i = 0; i < observersList.size(); i++) {
AxisObserver axisObserver = (AxisObserver) observersList.get(i);
try {
axisObserver.moduleUpdate(event, moule);
} catch (Throwable e) {
// No need to stop the system due to this , So log and ignore
log.debug(e);
}
}
}
public void notifyObservers(int event_type, AxisServiceGroup serviceGroup) {
AxisEvent event = new AxisEvent(event_type);
for (int i = 0; i < observersList.size(); i++) {
AxisObserver axisObserver = (AxisObserver) observersList.get(i);
try {
axisObserver.serviceGroupUpdate(event, serviceGroup);
} catch (Throwable e) {
// No need to stop the system due to this , So log and ignore
log.debug(e);
}
}
}
/**
* Method removeService.
*
* @param name
* @throws AxisFault
*/
public synchronized void removeService(String name) throws AxisFault {
AxisService service = (AxisService) allservices.remove(name);
if (service != null) {
log.debug(Messages.getMessage("serviceremoved", name));
}
}
/**
* Method getEngagedModules.
*
* @return Collection
*/
public Collection getEngagedModules() {
return engagedModules;
}
public List getGlobalModules() {
return globalModuleList;
}
public Hashtable getFaultyModules() {
return faultyModules;
}
public Hashtable getFaultyServices() {
return faultyServices;
}
public void removeFaultyService(String key) {
Iterator itr = faultyServices.keySet().iterator();
while (itr.hasNext()) {
String fullFileName = (String) itr.next();
if (fullFileName.indexOf(key) > 0) {
faultyServices.remove(fullFileName);
return;
}
}
}
// to get the out flow correpodning to the global out flow;
public ArrayList getGlobalOutPhases() {
return this.outPhases;
}
/**
* @return Returns ArrayList.
*/
public ArrayList getInFaultFlow() {
return inFaultPhases;
}
public ArrayList getGlobalInFlow() {
return inPhasesUptoAndIncludingPostDispatch;
}
public MessageReceiver getMessageReceiver(String mepURL) {
return (MessageReceiver) messageReceivers.get(mepURL);
}
/**
* Method getModule. first it will check whether the given module is there
* in the hashMap , if so just return that and the name can be either with
* version string or without vresion string <p/> if it not found and , the
* nane does not have version string in it then try to check whether default
* vresion of module available in the sytem for the give name , if so return
* that
*
* @param name
* @return Returns ModuleDescription.
*/
public AxisModule getModule(QName name) {
AxisModule module = (AxisModule) allModules.get(name);
if (module != null) {
return module;
}
// checking whether the version string seperator is not there in the
// module name
String moduleName = name.getLocalPart();
String defaultModuleVersion = getDefaultModuleVersion(moduleName);
if (defaultModuleVersion != null) {
module = (AxisModule) allModules.get(Utils.getModuleName(
moduleName, defaultModuleVersion));
if (module != null) {
return module;
}
}
return null;
}
// the class loder that become the parent of all the modules
public ClassLoader getModuleClassLoader() {
return this.moduleClassLoader;
}
public ModuleConfiguration getModuleConfig(QName moduleName) {
return (ModuleConfiguration) moduleConfigmap.get(moduleName);
}
/**
* @return Returns HashMap.
*/
public HashMap getModules() {
return allModules;
}
/**
* @return Returns ArrayList.
*/
public ArrayList getOutFaultFlow() {
return outFaultPhases;
}
public PhasesInfo getPhasesInfo() {
return phasesinfo;
}
public URL getRepository() {
return axis2Repository;
}
/**
* Method getService.
*
* @param name
* @return Returns AxisService.
*/
public AxisService getService(String name) throws AxisFault {
AxisService axisService = (AxisService) allservices.get(name);
if (axisService != null) {
if (axisService.isActive()) {
return axisService;
} else {
throw new AxisFault(Messages
.getMessage("serviceinactive", name));
}
} else {
return null;
}
}
/**
* Service can start and stop , if once stop we can not acess that , so we
* need a way to get the service even if service is not active
*
* @return AxisService
*/
public AxisService getServiceForActivation(String serviceName) {
AxisService axisService = (AxisService) allservices.get(serviceName);
if (axisService != null) {
return axisService;
} else {
return null;
}
}
// the class loder that become the parent of all the services
public ClassLoader getServiceClassLoader() {
return this.serviceClassLoader;
}
public AxisServiceGroup getServiceGroup(String serviceNameAndGroupString) {
// return (AxisServiceGroup)
// serviceGroups.get(serviceNameAndGroupString);
return (AxisServiceGroup) getChild(serviceNameAndGroupString);
}
public Iterator getServiceGroups() {
// return serviceGroups.values().iterator();
return getChildren();
}
// 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(), axisService);
}
}
return allservices;
}
// the class loder which become the top most parent of all the modules and
// services
public ClassLoader getSystemClassLoader() {
return this.systemClassLoader;
}
public TransportInDescription getTransportIn(QName name) throws AxisFault {
return (TransportInDescription) transportsIn.get(name);
}
public TransportOutDescription getTransportOut(QName name) throws AxisFault {
return (TransportOutDescription) transportsOut.get(name);
}
public HashMap getTransportsIn() {
return transportsIn;
}
public HashMap getTransportsOut() {
return transportsOut;
}
public boolean isEngaged(QName moduleName) {
boolean b = engagedModules.contains(moduleName);
return b ? b : engagedModules.contains(this.getDefaultModule(
moduleName.getLocalPart()).getName());
}
public void setGlobalOutPhase(ArrayList outPhases) {
this.outPhases = outPhases;
}
/**
* @param list
*/
public void setInFaultPhases(ArrayList list) {
inFaultPhases = list;
}
public void setInPhasesUptoAndIncludingPostDispatch(
ArrayList inPhasesUptoAndIncludingPostDispatch) {
this.inPhasesUptoAndIncludingPostDispatch = inPhasesUptoAndIncludingPostDispatch;
}
public void setModuleClassLoader(ClassLoader classLoader) {
this.moduleClassLoader = classLoader;
}
/**
* @param list
*/
public void setOutFaultPhases(ArrayList list) {
outFaultPhases = list;
}
public void setPhasesInfo(PhasesInfo phasesInfo) {
this.phasesinfo = phasesInfo;
}
public void setRepository(URL axis2Repository) {
this.axis2Repository = axis2Repository;
}
public void setServiceClassLoader(ClassLoader classLoader) {
this.serviceClassLoader = classLoader;
}
public void setSystemClassLoader(ClassLoader classLoader) {
this.systemClassLoader = classLoader;
}
/**
* Adds a dafault module version , which can be done either programatically
* or by using axis2.xml . The default module version is important if user
* asks to engage a module without given version ID, in which case, we will
* engage the default version.
*
* @param moduleName
* @param moduleVersion
*/
public void addDefaultModuleVersion(String moduleName, String moduleVersion) {
if (nameToversionMap.get(moduleName) == null) {
nameToversionMap.put(moduleName, moduleVersion);
}
}
public String getDefaultModuleVersion(String moduleName) {
return (String) nameToversionMap.get(moduleName);
}
public AxisModule getDefaultModule(String moduleName) {
String defualtModuleVersion = getDefaultModuleVersion(moduleName);
if (defualtModuleVersion == null) {
return (AxisModule) allModules.get(new QName(moduleName));
} else {
return (AxisModule) allModules.get(new QName(moduleName + "-"
+ defualtModuleVersion));
}
}
public Object getKey() {
return toString();
}
public void stopService(String serviceName) throws AxisFault {
AxisService service = (AxisService) allservices.get(serviceName);
if (service == null) {
throw new AxisFault(Messages.getMessage("servicenamenotvalid",
serviceName));
}
service.setActive(false);
notifyObservers(AxisEvent.SERVICE_STOP, service);
}
public void startService(String serviceName) throws AxisFault {
AxisService service = (AxisService) allservices.get(serviceName);
if (service == null) {
throw new AxisFault(Messages.getMessage("servicenamenotvalid",
serviceName));
}
service.setActive(true);
notifyObservers(AxisEvent.SERVICE_START, service);
}
public boolean isManageTransportSession() {
return manageTransportSession;
}
public void setManageTransportSession(boolean manageTransportSession) {
this.manageTransportSession = manageTransportSession;
}
public List getModulesForPolicyNamesapce(String namesapce) {
return (List) policySupportedModules.get(namesapce);
}
public void registerModulePolicySupport(AxisModule axisModule) {
String[] namespaces = axisModule.getSupportedPolicyNamespaces();
if (namespaces == null) {
return;
}
List modulesList;
for (int i = 0; i < namespaces.length; i++) {
modulesList = (List) policySupportedModules.get(namespaces[i]);
if (modulesList != null) {
modulesList.add(axisModule);
} else {
modulesList = new ArrayList();
modulesList.add(axisModule);
policySupportedModules.put(namespaces[i], modulesList);
}
}
}
public void registerLocalPolicyAssertions(AxisModule axisModule) {
QName[] localPolicyAssertions = axisModule.getLocalPolicyAssertions();
if (localPolicyAssertions == null) {
return;
}
for (int i = 0; i < localPolicyAssertions.length; i++) {
addLocalPolicyAssertion(localPolicyAssertions[i]);
}
}
public ArrayList getObserversList() {
return observersList;
}
public boolean isStart() {
return start;
}
public void setStart(boolean start) {
this.start = start;
}
/**
* getTargetResolverChain returns and instance of
* TargetResolver which iterates over the registered
* TargetResolvers, calling each one in turn when
* resolveTarget is called
*/
public TargetResolver getTargetResolverChain() {
if(targetResolvers.isEmpty()){
return null;
}
return new TargetResolver() {
public void resolveTarget(MessageContext messageContext) {
Iterator iter = targetResolvers.iterator();
while (iter.hasNext()) {
TargetResolver tr = (TargetResolver) iter.next();
tr.resolveTarget(messageContext);
}
}
};
}
public void addTargetResolver(TargetResolver tr) {
targetResolvers.add(tr);
}
public void addLocalPolicyAssertion(QName name) {
this.localPolicyAssertions.add(name);
}
public List getLocalPolicyAssertions() {
return this.localPolicyAssertions;
}
public void removeLocalPolicyAssertion(QName name) {
this.localPolicyAssertions.remove(name);
}
public boolean isAssertionLocal(QName name) {
return this.localPolicyAssertions.contains(name);
}
}