/*
* 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.receivers;
import org.apache.axiom.om.OMAbstractFactory;
import org.apache.axiom.soap.SOAP11Constants;
import org.apache.axiom.soap.SOAP12Constants;
import org.apache.axiom.soap.SOAPFactory;
import org.apache.axis2.AxisFault;
import org.apache.axis2.Constants;
import org.apache.axis2.addressing.EndpointReference;
import org.apache.axis2.classloader.MultiParentClassLoader;
import org.apache.axis2.clustering.ClusteringFault;
import org.apache.axis2.clustering.context.Replicator;
import org.apache.axis2.context.MessageContext;
import org.apache.axis2.context.ServiceContext;
import org.apache.axis2.description.AxisService;
import org.apache.axis2.description.InOnlyAxisOperation;
import org.apache.axis2.description.Parameter;
import org.apache.axis2.description.WSDL2Constants;
import org.apache.axis2.engine.AxisEngine;
import org.apache.axis2.engine.DependencyManager;
import org.apache.axis2.engine.MessageReceiver;
import org.apache.axis2.i18n.Messages;
import org.apache.axis2.util.Loader;
import org.apache.axis2.util.MessageContextBuilder;
import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
import java.lang.reflect.Method;
import java.lang.reflect.InvocationTargetException;
import java.net.URL;
import java.security.AccessController;
import java.security.PrivilegedAction;
import java.security.PrivilegedExceptionAction;
public abstract class AbstractMessageReceiver implements MessageReceiver {
protected static final Log log = LogFactory.getLog(AbstractMessageReceiver.class);
public static final String SCOPE = "scope";
protected String serviceTCCL = null;
public static final String SAVED_TCCL = "_SAVED_TCCL_";
public static final String SAVED_MC = "_SAVED_MC_";
public static final String DO_ASYNC = "messageReceiver.invokeOnSeparateThread";
// Place to store previous values
public static class ThreadContextDescriptor {
public ClassLoader oldClassLoader;
public MessageContext oldMessageContext;
}
protected void replicateState(MessageContext messageContext) throws ClusteringFault {
Replicator.replicate(messageContext);
}
/**
* Do the actual work of the MessageReceiver. Must be overridden by concrete subclasses.
*
* @param messageCtx active MessageContext
* @throws AxisFault if a problem occurred
*/
protected abstract void invokeBusinessLogic(MessageContext messageCtx) throws AxisFault;
/**
*
* @param messageCtx active MessageContext
* @throws AxisFault if a problem occurred
*/
public void receive(final MessageContext messageCtx) throws AxisFault {
if (messageCtx.isPropertyTrue(DO_ASYNC)) {
EndpointReference replyTo = messageCtx.getReplyTo();
if (replyTo != null && !replyTo.hasAnonymousAddress()) {
AsyncMessageReceiverWorker worker = new AsyncMessageReceiverWorker(messageCtx);
messageCtx.getEnvelope().build();
messageCtx.getConfigurationContext().getThreadPool().execute(worker);
return;
}
}
ThreadContextDescriptor tc = setThreadContext(messageCtx);
try {
invokeBusinessLogic(messageCtx);
} catch (AxisFault fault) {
// If we're in-only, eat this. Otherwise, toss it upwards!
if ((messageCtx.getAxisOperation() instanceof InOnlyAxisOperation) &&
!WSDL2Constants.MEP_URI_ROBUST_IN_ONLY.equals(messageCtx.getAxisOperation().getMessageExchangePattern())) {
log.error(fault);
} else {
fault.setFaultType(Constants.APPLICATION_FAULT);
throw fault;
}
} finally {
restoreThreadContext(tc);
}
}
/**
* Several pieces of information need to be available to the service
* implementation class. For one, the ThreadContextClassLoader needs
* to be correct, and for another we need to give the service code
* access to the MessageContext (getCurrentContext()). So we toss these
* things in TLS.
*
* @param msgContext the current MessageContext
* @return a ThreadContextDescriptor containing the old values
*/
protected ThreadContextDescriptor setThreadContext(final MessageContext msgContext) {
ThreadContextDescriptor tc = new ThreadContextDescriptor();
tc.oldMessageContext = (MessageContext) MessageContext.currentMessageContext.get();
final ClassLoader contextClassLoader = getContextClassLoader_doPriv();
tc.oldClassLoader = contextClassLoader;
AxisService service = msgContext.getAxisService();
String serviceTCCL = (String) service.getParameterValue(Constants.SERVICE_TCCL);
if (serviceTCCL != null) {
serviceTCCL = serviceTCCL.trim().toLowerCase();
if (serviceTCCL.equals(Constants.TCCL_COMPOSITE)) {
final ClassLoader loader = (ClassLoader) AccessController.doPrivileged(new PrivilegedAction() {
public Object run() {
return new MultiParentClassLoader(new URL[]{},
new ClassLoader[]{
msgContext.getAxisService().getClassLoader(),
contextClassLoader
});
}
});
org.apache.axis2.java.security.AccessController.doPrivileged(
new PrivilegedAction() {
public Object run() {
Thread.currentThread().setContextClassLoader(
loader);
return null;
}
}
);
} else if (serviceTCCL.equals(Constants.TCCL_SERVICE)) {
org.apache.axis2.java.security.AccessController.doPrivileged(
new PrivilegedAction() {
public Object run() {
Thread.currentThread().setContextClassLoader(
msgContext.getAxisService().getClassLoader()
);
return null;
}
}
);
}
}
MessageContext.setCurrentMessageContext(msgContext);
return tc;
}
private ClassLoader getContextClassLoader_doPriv() {
return (ClassLoader) org.apache.axis2.java.security.AccessController.doPrivileged(
new PrivilegedAction() {
public Object run() {
return Thread.currentThread().getContextClassLoader();
}
}
);
}
protected void restoreThreadContext(final ThreadContextDescriptor tc) {
org.apache.axis2.java.security.AccessController.doPrivileged(
new PrivilegedAction() {
public Object run() {
Thread.currentThread().setContextClassLoader(tc.oldClassLoader);
return null;
}
}
);
MessageContext.currentMessageContext.set(tc.oldMessageContext);
}
/**
* Create a new service object. Override if you want to customize how
* this happens in your own MessageReceiver.
*
* @param msgContext
* @return Returns Object.
* @throws AxisFault
*/
protected Object makeNewServiceObject(MessageContext msgContext) throws AxisFault {
try {
final AxisService service = msgContext.getAxisService();
ClassLoader classLoader = service.getClassLoader();
// allow alternative definition of makeNewServiceObject
if (service.getParameter(Constants.SERVICE_OBJECT_SUPPLIER) != null) {
Parameter serviceObjectParam =
service.getParameter(Constants.SERVICE_OBJECT_SUPPLIER);
final Class serviceObjectMaker = Loader.loadClass(classLoader, ((String)
serviceObjectParam.getValue()).trim());
// Find static getServiceObject() method, call it if there
final Method method = (Method) org.apache.axis2.java.security.AccessController.doPrivileged(
new PrivilegedExceptionAction() {
public Object run() throws NoSuchMethodException {
return serviceObjectMaker.getMethod("getServiceObject",
new Class[]{AxisService.class});
}
}
);
if (method != null) {
return org.apache.axis2.java.security.AccessController.doPrivileged(
new PrivilegedExceptionAction() {
public Object run() throws InvocationTargetException, IllegalAccessException, InstantiationException {
return method.invoke(serviceObjectMaker.newInstance(), new Object[]{service});
}
}
);
}
}
Parameter implInfoParam = service.getParameter(Constants.SERVICE_CLASS);
if (implInfoParam != null) {
final Class implClass = Loader.loadClass(
classLoader,
((String) implInfoParam.getValue()).trim());
return org.apache.axis2.java.security.AccessController.doPrivileged(
new PrivilegedExceptionAction() {
public Object run() throws InstantiationException, IllegalAccessException {
return implClass.newInstance();
}
}
);
} else {
throw new AxisFault(
Messages.getMessage("paramIsNotSpecified", "SERVICE_OBJECT_SUPPLIER"));
}
} catch (Exception e) {
throw AxisFault.makeFault(e);
}
}
public SOAPFactory getSOAPFactory(MessageContext msgContext) throws AxisFault {
String nsURI = msgContext.getEnvelope().getNamespace().getNamespaceURI();
if (SOAP12Constants.SOAP_ENVELOPE_NAMESPACE_URI.equals(nsURI)) {
return OMAbstractFactory.getSOAP12Factory();
} else if (SOAP11Constants.SOAP_ENVELOPE_NAMESPACE_URI.equals(nsURI)) {
return OMAbstractFactory.getSOAP11Factory();
} else {
throw new AxisFault(Messages.getMessage("invalidSOAPversion"));
}
}
/**
* Retrieve the implementation object. This will either return a cached
* object if present in the ServiceContext, or create a new one via
* makeNewServiceObject() (and then cache that).
*
* @param msgContext the active MessageContext
* @return the appropriate back-end service object.
* @throws AxisFault if there's a problem
*/
protected Object getTheImplementationObject(MessageContext msgContext) throws AxisFault {
ServiceContext serviceContext = msgContext.getServiceContext();
Object serviceimpl = serviceContext.getProperty(ServiceContext.SERVICE_OBJECT);
if (serviceimpl != null) {
// since service impl is there in service context , take that from there
return serviceimpl;
} else {
// create a new service impl class for that service
serviceimpl = makeNewServiceObject(msgContext);
//Service initialization
DependencyManager.initServiceObject(serviceimpl, msgContext.getServiceContext());
serviceContext.setProperty(ServiceContext.SERVICE_OBJECT, serviceimpl);
return serviceimpl;
}
}
public class AsyncMessageReceiverWorker implements Runnable {
private MessageContext messageCtx;
public AsyncMessageReceiverWorker(MessageContext messageCtx){
this.messageCtx = messageCtx;
}
public void run() {
try {
ThreadContextDescriptor tc = setThreadContext(messageCtx);
try {
invokeBusinessLogic(messageCtx);
} finally {
restoreThreadContext(tc);
}
} catch (AxisFault e) {
// If we're IN-ONLY, swallow this. Otherwise, send it.
if (messageCtx.getAxisOperation() instanceof InOnlyAxisOperation) {
log.debug(e.getMessage(), e);
} else {
try {
MessageContext faultContext =
MessageContextBuilder.createFaultMessageContext(messageCtx, e);
AxisEngine.sendFault(faultContext);
} catch (AxisFault axisFault) {
log.error(e.getMessage(), e);
}
log.error(e.getMessage(), e);
}
}
}
}
}