/*
* 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.deployment;
import org.apache.axis2.AxisFault;
import org.apache.axis2.deployment.util.PhasesInfo;
import org.apache.axis2.deployment.util.Utils;
import org.apache.axis2.description.HandlerDescription;
import org.apache.axis2.description.ModuleConfiguration;
import org.apache.axis2.description.ParameterInclude;
import org.apache.axis2.description.PolicyInclude;
import org.apache.axis2.description.TransportInDescription;
import org.apache.axis2.description.TransportOutDescription;
import org.apache.axis2.engine.AxisConfiguration;
import org.apache.axis2.engine.AxisObserver;
import org.apache.axis2.engine.MessageReceiver;
import org.apache.axis2.engine.Phase;
import org.apache.axis2.i18n.Messages;
import org.apache.axis2.phaseresolver.PhaseException;
import org.apache.axis2.transport.TransportListener;
import org.apache.axis2.transport.TransportSender;
import org.apache.ws.commons.om.OMAttribute;
import org.apache.ws.commons.om.OMElement;
import javax.xml.namespace.QName;
import javax.xml.stream.XMLStreamException;
import java.io.InputStream;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.Iterator;
public class AxisConfigBuilder extends DescriptionBuilder {
private DeploymentEngine engine;
public AxisConfigBuilder(InputStream serviceInputStream, DeploymentEngine engine,
AxisConfiguration axisConfiguration) {
super(serviceInputStream, axisConfiguration);
this.engine = engine;
}
public void populateConfig() throws DeploymentException {
try {
OMElement config_element = buildOM();
// processing Parameters
// Processing service level parameters
Iterator itr = config_element.getChildrenWithName(new QName(TAG_PARAMETER));
processParameters(itr, axisConfig, axisConfig);
// process MessageReceiver
OMElement messageReceiver = config_element.getFirstChildWithName(new QName(TAG_MESSAGE_RECEIVERS));
if (messageReceiver != null) {
HashMap mrs = processMessageReceivers(messageReceiver);
Iterator keys = mrs.keySet().iterator();
while (keys.hasNext()) {
String key = (String) keys.next();
axisConfig.addMessageReceiver(key, (MessageReceiver) mrs.get(key));
}
}
// Process Module refs
Iterator moduleitr =
config_element.getChildrenWithName(new QName(DeploymentConstants.TAG_MODULE));
processModuleRefs(moduleitr);
// Proccessing Transport Senders
Iterator trs_senders = config_element.getChildrenWithName(new QName(TAG_TRANSPORT_SENDER));
processTransportSenders(trs_senders);
// Proccessing Transport Receivers
Iterator trs_Reivers = config_element.getChildrenWithName(new QName(TAG_TRANSPORT_RECEIVER));
processTransportReceivers(trs_Reivers);
// Process Observers
Iterator obs_ittr = config_element.getChildrenWithName(new QName(TAG_LISTENER));
processObservers(obs_ittr);
// processing Phase orders
Iterator phaseorders = config_element.getChildrenWithName(new QName(TAG_PHASE_ORDER));
processPhaseOrders(phaseorders);
Iterator moduleConfigs = config_element.getChildrenWithName(new QName(TAG_MODULE_CONFIG));
processModuleConfig(moduleConfigs, axisConfig, axisConfig);
// processing <wsp:Policy> .. </..> elements
Iterator policyElements = config_element.getChildrenWithName(new QName(POLICY_NS_URI,
TAG_POLICY));
if (policyElements != null) {
processPolicyElements(PolicyInclude.AXIS_POLICY, policyElements, axisConfig.getPolicyInclude());
}
// processing <wsp:PolicyReference> .. </..> elements
Iterator policyRefElements = config_element.getChildrenWithName(new QName(POLICY_NS_URI,
TAG_POLICY_REF));
if (policyRefElements != null) {
processPolicyRefElements(PolicyInclude.AXIS_POLICY, policyElements, axisConfig.getPolicyInclude());
}
//to process default module versions
OMElement defaultModuleVerionElement = config_element.getFirstChildWithName(new QName(
TAG_DEFAULT_MODULE_VERSION));
if (defaultModuleVerionElement != null) {
processDefaultModuleVersions(defaultModuleVerionElement);
}
} catch (XMLStreamException e) {
throw new DeploymentException(e);
}
}
protected void processModuleConfig(Iterator moduleConfigs, ParameterInclude parent,
AxisConfiguration config)
throws DeploymentException {
while (moduleConfigs.hasNext()) {
OMElement moduleConfig = (OMElement) moduleConfigs.next();
OMAttribute moduleName_att = moduleConfig.getAttribute(new QName(ATTRIBUTE_NAME));
if (moduleName_att == null) {
throw new DeploymentException(
Messages.getMessage(DeploymentErrorMsgs.INVALID_MODULE_CONFIG));
} else {
String module = moduleName_att.getAttributeValue();
ModuleConfiguration moduleConfiguration =
new ModuleConfiguration(new QName(module), parent);
Iterator parameters = moduleConfig.getChildrenWithName(new QName(TAG_PARAMETER));
processParameters(parameters, moduleConfiguration, parent);
config.addModuleConfig(moduleConfiguration);
}
}
}
/**
* Gets the list of modules that is required to be engaged globally.
*
* @param moduleRefs <code>java.util.Iterator</code>
*/
protected void processModuleRefs(Iterator moduleRefs) {
while (moduleRefs.hasNext()) {
OMElement moduleref = (OMElement) moduleRefs.next();
OMAttribute moduleRefAttribute = moduleref.getAttribute(new QName(TAG_REFERENCE));
String refName = moduleRefAttribute.getAttributeValue();
engine.addModule(new QName(refName));
}
}
/**
* Processes AxisObservers.
*
* @param oservers
*/
private void processObservers(Iterator oservers) {
while (oservers.hasNext()) {
try {
OMElement observerelement = (OMElement) oservers.next();
AxisObserver observer;
OMAttribute trsClas = observerelement.getAttribute(new QName(TAG_CLASS_NAME));
String clasName;
if (trsClas != null) {
clasName = trsClas.getAttributeValue();
} else {
log.info(Messages.getMessage(DeploymentErrorMsgs.OBSERVER_ERROR));
return;
}
Class observerclass = Class.forName(clasName, true,
Thread.currentThread().getContextClassLoader());
observer = (AxisObserver) observerclass.newInstance();
// processing Parameters
// Processing service level parameters
Iterator itr = observerelement.getChildrenWithName(new QName(TAG_PARAMETER));
processParameters(itr, observer, axisConfig);
// initialization
observer.init(axisConfig);
axisConfig.addObservers(observer);
} catch (Exception e) {
log.info(e.getMessage());
}
}
}
private ArrayList processPhaseList(OMElement phaseOrders) throws DeploymentException {
ArrayList phaselist = new ArrayList();
Iterator phases = phaseOrders.getChildrenWithName(new QName(TAG_PHASE));
while (phases.hasNext()) {
OMElement phaseelement = (OMElement) phases.next();
String phaseName =
phaseelement.getAttribute(new QName(ATTRIBUTE_NAME)).getAttributeValue();
String phaseClass = phaseelement.getAttributeValue(new QName(TAG_CLASS_NAME));
Phase phase;
try {
phase = getPhase(phaseClass);
} catch (Exception e) {
throw new DeploymentException(
Messages.getMessage("phaseclassnotfound", phaseClass, e.getMessage()));
}
phase.setName(phaseName);
Iterator handlers = phaseelement.getChildrenWithName(new QName(TAG_HANDLER));
while (handlers.hasNext()) {
OMElement omElement = (OMElement) handlers.next();
HandlerDescription handler = processHandler(omElement, axisConfig);
handler.getRules().setPhaseName(phaseName);
Utils.loadHandler(axisConfig.getSystemClassLoader(), handler);
try {
phase.addHandler(handler);
} catch (PhaseException e) {
throw new DeploymentException(e);
}
}
phaselist.add(phase);
}
return phaselist;
}
/**
* Processes all the phase orders which are defined in axis2.xml.
*
* @param phaserders
*/
private void processPhaseOrders(Iterator phaserders) throws DeploymentException {
PhasesInfo info = engine.getPhasesinfo();
while (phaserders.hasNext()) {
OMElement phaseOrders = (OMElement) phaserders.next();
String flowType = phaseOrders.getAttribute(new QName(TAG_TYPE)).getAttributeValue();
if (TAG_FLOW_IN.equals(flowType)) {
info.setINPhases(processPhaseList(phaseOrders));
} else if (TAG_FLOW_IN_FAULT.equals(flowType)) {
info.setIN_FaultPhases(processPhaseList(phaseOrders));
} else if (TAG_FLOW_OUT.equals(flowType)) {
info.setOUTPhases(processPhaseList(phaseOrders));
} else if (TAG_FLOW_OUT_FAULT.equals(flowType)) {
info.setOUT_FaultPhases(processPhaseList(phaseOrders));
}
}
}
private void processDefaultModuleVersions(OMElement defaultVersions) throws DeploymentException {
Iterator moduleVersions = defaultVersions.getChildrenWithName(new QName(TAG_MODULE));
while (moduleVersions.hasNext()) {
OMElement omElement = (OMElement) moduleVersions.next();
String name = omElement.getAttributeValue(new QName(ATTRIBUTE_NAME));
if (name == null) {
throw new DeploymentException(Messages.getMessage("modulenamecannotnull"));
}
String defaultVeriosn = omElement.getAttributeValue(new QName(ATTRIBUTE_DEFAULT_VERSION));
if (defaultVeriosn == null) {
throw new DeploymentException(Messages.getMessage("modulenamecannotnull"));
}
axisConfig.addDefaultModuleVersion(name, defaultVeriosn);
}
}
private void processTransportReceivers(Iterator trs_senders) throws DeploymentException {
while (trs_senders.hasNext()) {
TransportInDescription transportIN;
OMElement transport = (OMElement) trs_senders.next();
// getting transport Name
OMAttribute trsName = transport.getAttribute(new QName(ATTRIBUTE_NAME));
if (trsName != null) {
String name = trsName.getAttributeValue();
transportIN = new TransportInDescription(new QName(name));
// transport impl class
OMAttribute trsClas = transport.getAttribute(new QName(TAG_CLASS_NAME));
if (trsClas != null) {
try {
String clasName = trsClas.getAttributeValue();
Class receiverClass = Class.forName(clasName, true,
Thread.currentThread().getContextClassLoader());
TransportListener receiver =
(TransportListener) receiverClass.newInstance();
transportIN.setReceiver(receiver);
} catch (NoClassDefFoundError e) {
log.info(Messages.getMessage("classnotfound", trsClas.getAttributeValue()));
} catch (ClassNotFoundException e) {
throw new DeploymentException(e);
} catch (IllegalAccessException e) {
throw new DeploymentException(e);
} catch (InstantiationException e) {
throw new DeploymentException(e);
}
}
try {
Iterator itr = transport.getChildrenWithName(new QName(TAG_PARAMETER));
processParameters(itr, transportIN, axisConfig);
OMElement inFlow = transport.getFirstChildWithName(new QName(TAG_FLOW_IN));
if (inFlow != null) {
throw new DeploymentException(
Messages.getMessage(
DeploymentErrorMsgs.INFLOW_NOT_ALLOWED_IN_TRS_OUT, name));
}
OMElement outFlow = transport.getFirstChildWithName(new QName(TAG_FLOW_OUT));
if (outFlow != null) {
transportIN.setInFlow(processFlow(outFlow, axisConfig));
}
OMElement inFaultFlow =
transport.getFirstChildWithName(new QName(TAG_FLOW_IN_FAULT));
if (inFaultFlow != null) {
transportIN.setFaultFlow(processFlow(inFaultFlow, axisConfig));
}
OMElement outFaultFlow =
transport.getFirstChildWithName(new QName(TAG_FLOW_OUT_FAULT));
if (outFaultFlow != null) {
throw new DeploymentException(
Messages.getMessage(
DeploymentErrorMsgs.OUTFLOW_NOT_ALLOWED_IN_TRS_IN, name));
}
// adding to axis2 config
axisConfig.addTransportIn(transportIN);
} catch (AxisFault axisFault) {
throw new DeploymentException(axisFault);
}
}
}
}
private void processTransportSenders(Iterator trs_senders) throws DeploymentException {
while (trs_senders.hasNext()) {
TransportOutDescription transportout;
OMElement transport = (OMElement) trs_senders.next();
// getting transport Name
OMAttribute trsName = transport.getAttribute(new QName(ATTRIBUTE_NAME));
if (trsName != null) {
String name = trsName.getAttributeValue();
transportout = new TransportOutDescription(new QName(name));
// transport impl class
OMAttribute trsClas = transport.getAttribute(new QName(TAG_CLASS_NAME));
if (trsClas == null) {
throw new DeploymentException(
Messages.getMessage(DeploymentErrorMsgs.TRANSPORT_SENDER_ERROR, name));
}
String clasName = trsClas.getAttributeValue();
Class sender;
try {
sender = Class.forName(clasName, true,
Thread.currentThread().getContextClassLoader());
TransportSender transportSender = (TransportSender) sender.newInstance();
transportout.setSender(transportSender);
// process Parameters
// processing Parameters
// Processing service level parameters
Iterator itr = transport.getChildrenWithName(new QName(TAG_PARAMETER));
processParameters(itr, transportout, axisConfig);
// process INFLOW
OMElement inFlow = transport.getFirstChildWithName(new QName(TAG_FLOW_IN));
if (inFlow != null) {
throw new DeploymentException(
Messages.getMessage(
DeploymentErrorMsgs.INFLOW_NOT_ALLOWED_IN_TRS_OUT, name));
}
OMElement outFlow = transport.getFirstChildWithName(new QName(TAG_FLOW_OUT));
if (outFlow != null) {
transportout.setOutFlow(processFlow(outFlow, axisConfig));
}
OMElement inFaultFlow =
transport.getFirstChildWithName(new QName(TAG_FLOW_IN_FAULT));
if (inFaultFlow != null) {
throw new DeploymentException(
Messages.getMessage(
DeploymentErrorMsgs.INFLOW_NOT_ALLOWED_IN_TRS_OUT, name));
}
OMElement outFaultFlow =
transport.getFirstChildWithName(new QName(TAG_FLOW_OUT_FAULT));
if (outFaultFlow != null) {
transportout.setFaultFlow(processFlow(outFaultFlow, axisConfig));
}
// adding to axis2 config
axisConfig.addTransportOut(transportout);
} catch (ClassNotFoundException e) {
throw new DeploymentException(e);
} catch (IllegalAccessException e) {
throw new DeploymentException(e);
} catch (InstantiationException e) {
throw new DeploymentException(e);
} catch (AxisFault axisFault) {
throw new DeploymentException(axisFault);
}
}
}
}
private Phase getPhase(String className)
throws ClassNotFoundException, IllegalAccessException, InstantiationException {
if (className == null) {
return new Phase();
}
Class phaseClass = axisConfig.getSystemClassLoader().loadClass(className);
return (Phase) phaseClass.newInstance();
}
}