/*
* JBoss, Home of Professional Open Source.
* Copyright 2014, Red Hat Middleware LLC, and individual contributors
* as indicated by the @author tags. See the copyright.txt file in the
* distribution for a full listing of individual contributors.
*
* This is free software; you can redistribute it and/or modify it
* under the terms of the GNU Lesser General Public License as
* published by the Free Software Foundation; either version 2.1 of
* the License, or (at your option) any later version.
*
* This software is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this software; if not, write to the Free
* Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
* 02110-1301 USA, or see the FSF site: http://www.fsf.org.
*/
package org.jboss.wsf.stack.cxf.client.serviceref;
import java.lang.reflect.Constructor;
import java.lang.reflect.InvocationTargetException;
import java.lang.reflect.Method;
import java.net.MalformedURLException;
import java.net.URL;
import java.security.AccessController;
import java.security.PrivilegedAction;
import java.util.Collection;
import java.util.HashSet;
import java.util.LinkedList;
import java.util.List;
import java.util.Set;
import javax.xml.namespace.QName;
import javax.xml.ws.BindingProvider;
import javax.xml.ws.RespectBindingFeature;
import javax.xml.ws.Service;
import javax.xml.ws.WebEndpoint;
import javax.xml.ws.WebServiceClient;
import javax.xml.ws.WebServiceFeature;
import javax.xml.ws.soap.AddressingFeature;
import javax.xml.ws.soap.MTOMFeature;
import org.apache.cxf.Bus;
import org.apache.cxf.BusFactory;
import org.apache.cxf.configuration.Configurer;
import org.jboss.ws.common.Messages;
import org.jboss.wsf.spi.WSFException;
import org.jboss.wsf.spi.metadata.j2ee.serviceref.UnifiedPortComponentRefMetaData;
import org.jboss.wsf.spi.metadata.j2ee.serviceref.UnifiedServiceRefMetaData;
import org.jboss.wsf.stack.cxf.client.ClientBusSelector;
import org.jboss.wsf.stack.cxf.client.Constants;
import org.jboss.wsf.stack.cxf.client.UseThreadBusFeature;
import org.jboss.logging.Logger;
/**
* This ServiceObjectFactory reconstructs a javax.xml.ws.Service
* for a given WSDL when the webservice client does a JNDI lookup.
*
* @author Thomas.Diesler@jboss.com
* @author Richard.Opalka@jboss.com
* @author alessio.soldano@jboss.com
*/
public final class CXFServiceObjectFactoryJAXWS
{
private static enum PortMatch {YES, NO, MAYBE};
public final Object getObjectInstance(UnifiedServiceRefMetaData serviceRef)
{
try
{
// class names
final String serviceImplClass = this.getServiceClassName(serviceRef);
final String targetClassName = this.getTargetClassName(serviceRef);
// class instances
final Class<?> serviceClass = this.getClass(serviceImplClass);
final Class<?> targetClass = this.getClass(targetClassName);
final Service serviceInstance;
BusFactory.setThreadDefaultBus(null);
final Bus bus = this.createNewBus(serviceRef);
try
{
serviceInstance = this.instantiateService(serviceRef, serviceClass);
if (serviceRef.getHandlerChain() != null)
{
serviceInstance.setHandlerResolver(new CXFHandlerResolverImpl(bus, serviceRef.getHandlerChain(),
serviceInstance.getClass()));
}
// construct port
final boolean instantiatePort = targetClassName != null && !Service.class.isAssignableFrom(targetClass);
if (instantiatePort)
{
final QName portQName = this.getPortQName(targetClassName, serviceImplClass, serviceRef);
final WebServiceFeature[] portFeatures = this.getFeatures(targetClassName, serviceImplClass, serviceRef);
String forcedAddress = null;
//if there is no wsdlLocation, always use the local deployed endpoint address to initialize port
if (getWsdlURL(serviceRef, serviceClass) == null)
{
final QName serviceQName = this.getServiceQName(serviceRef, serviceClass);
forcedAddress = serviceRef.getDeployedServiceAddress(serviceQName);
}
return instantiatePort(serviceClass, targetClass, serviceInstance, portQName, portFeatures,
forcedAddress);
}
}
finally
{
BusFactory.setThreadDefaultBus(null);
}
return serviceInstance;
}
catch (Exception ex)
{
WSFException.rethrow("Cannot create service", ex);
}
return null;
}
private Class<?> getClass(final String className) throws ClassNotFoundException
{
if (className != null)
{
return SecurityActions.getContextClassLoader().loadClass(className);
}
return null;
}
private String getServiceClassName(final UnifiedServiceRefMetaData serviceRefMD)
{
final String serviceImplClassName = serviceRefMD.getServiceImplClass();
if (serviceImplClassName != null)
return serviceImplClassName;
final String serviceInterfaceName = serviceRefMD.getServiceInterface();
if (serviceInterfaceName != null)
return serviceInterfaceName;
return Service.class.getName(); // fallback
}
private String getTargetClassName(final UnifiedServiceRefMetaData serviceRefMD)
{
return serviceRefMD.getServiceRefType();
}
private Object instantiatePort(final Class<?> serviceClass, final Class<?> targetClass, final Service target,
final QName portQName, final WebServiceFeature[] features, final String endpointAddress) throws NoSuchMethodException,
InstantiationException, IllegalAccessException, InvocationTargetException
{
Object port = null;
Object candidatePort = null;
if (serviceClass != Service.class)
{
final Set<Method> signatureMatchingMethods = new HashSet<Method>();
for (Method method : getDeclaredMethods(serviceClass))
{
String methodName = method.getName();
Class<?> retType = method.getReturnType();
if (methodName.startsWith("get") && targetClass.isAssignableFrom(retType))
{
final Method targetMethod = getMethodFor(methodName, features, serviceClass);
signatureMatchingMethods.add(targetMethod);
}
}
for (Method method : signatureMatchingMethods)
{
PortMatch matchResult = portNameMatches(portQName, method);
if (matchResult.equals(PortMatch.YES)) {
final Object[] args = getArgumentsFor(features);
port = method.invoke(target, args);
break;
} else if (matchResult.equals(PortMatch.MAYBE)) {
final Object[] args = getArgumentsFor(features);
candidatePort = method.invoke(target, args);
}
}
}
if (port == null)
{
port = candidatePort;
}
if (port == null)
{
Method method = getMethodFor("getPort", portQName, features, serviceClass);
Object[] args = getArgumentsFor(portQName, features, targetClass);
port = method.invoke(target, args);
}
if (endpointAddress != null)
{
((BindingProvider) port).getRequestContext().put(BindingProvider.ENDPOINT_ADDRESS_PROPERTY, endpointAddress);
}
return port;
}
private static PortMatch portNameMatches(final QName portQName, final Method targetMethod) {
final String portName = portQName != null ? portQName.getLocalPart() : null;
if (portName == null) { //no port specified, so we *might* have a valid match...
return PortMatch.MAYBE;
}
WebEndpoint webEndpointAnnotation = targetMethod.getAnnotation(WebEndpoint.class);
if (webEndpointAnnotation == null || webEndpointAnnotation.name() == null || webEndpointAnnotation.name().isEmpty()) {
return PortMatch.MAYBE; // no way to match, no port specified using @WebEndpoint
}
return webEndpointAnnotation.name().equals(portName) ? PortMatch.YES : PortMatch.NO;
}
private static Method[] getDeclaredMethods(final Class<?> cls) {
return AccessController.doPrivileged(new PrivilegedAction<Method[]>() {
public Method[] run() {
return cls.getDeclaredMethods();
}
});
}
private Service instantiateService(final UnifiedServiceRefMetaData serviceRefMD, final Class<?> serviceClass)
throws NoSuchMethodException, InstantiationException, IllegalAccessException, InvocationTargetException, WSFException
{
final List<WebServiceFeature> featuresList = getFeatures(serviceRefMD);
//force THREAD_BUS strategy so that the bus created before for this specific ref is used
if (!ClientBusSelector.getDefaultStrategy().equals(Constants.THREAD_BUS_STRATEGY)) {
featuresList.add(new UseThreadBusFeature());
}
final WebServiceFeature[] features = featuresList.size() == 0 ? null : featuresList.toArray(new WebServiceFeature[]{});
final QName serviceQName = this.getServiceQName(serviceRefMD, serviceClass);
URL wsdlURL = this.getWsdlURL(serviceRefMD, serviceClass);
if (wsdlURL == null)
{
final String deployedServiceAddress = serviceRefMD.getDeployedServiceAddress(serviceQName);
if (deployedServiceAddress != null)
{
try
{
wsdlURL = new URL(deployedServiceAddress + "?wsdl");
}
catch (MalformedURLException e)
{
//ignore
Logger.getLogger(CXFServiceObjectFactoryJAXWS.class).trace(e);
}
}
}
Service target = null;
if (serviceClass == Service.class)
{
// Generic javax.xml.ws.Service
if (wsdlURL != null)
{
if (features != null)
{
target = Service.create(wsdlURL, serviceQName, features);
}
else
{
target = Service.create(wsdlURL, serviceQName);
}
}
else
{
throw Messages.MESSAGES.cannotCreateServiceWithoutWsdlLocation(serviceRefMD);
}
}
else
{
// Generated javax.xml.ws.Service subclass
if (wsdlURL != null)
{
if (features != null)
{
try {
Constructor<?> ctor = serviceClass.getConstructor(new Class[] {URL.class, QName.class, WebServiceFeature[].class});
target = (Service) ctor.newInstance(new Object[] {wsdlURL, serviceQName, features});
} catch (NoSuchMethodException nsme) {
throw org.jboss.wsf.stack.cxf.Messages.MESSAGES.missingJAXWS22ServiceConstructor(serviceClass.getName(), nsme);
}
}
else
{
Constructor<?> ctor = serviceClass.getConstructor(new Class[]
{URL.class, QName.class});
target = (Service) ctor.newInstance(new Object[]
{wsdlURL, serviceQName});
}
}
else
{
if (features != null)
{
try {
Constructor<?> ctor = serviceClass.getConstructor(new Class[] {WebServiceFeature[].class});
target = (Service) ctor.newInstance(new Object[] {features});
} catch (NoSuchMethodException nsme) {
throw org.jboss.wsf.stack.cxf.Messages.MESSAGES.missingJAXWS22ServiceConstructor(serviceClass.getName(), nsme);
}
}
else
{
target = (Service) serviceClass.newInstance();
}
}
}
return target;
}
private URL getWsdlURL(final UnifiedServiceRefMetaData serviceRefMD, final Class<?> serviceClass)
{
if (serviceRefMD.getWsdlLocation() == null)
{
final WebServiceClient webServiceClientAnnotation = serviceClass.getAnnotation(WebServiceClient.class);
if (webServiceClientAnnotation != null)
{
// use the @WebServiceClien(wsdlLocation=...) if the service ref wsdl location returned at this time would be null
if (webServiceClientAnnotation.wsdlLocation().length() > 0)
{
return serviceRefMD.getWsdlLocation(webServiceClientAnnotation.wsdlLocation());
}
}
}
return serviceRefMD.getWsdlLocation();
}
private QName getServiceQName(final UnifiedServiceRefMetaData serviceRefMD, final Class<?> serviceClass)
{
QName retVal = serviceRefMD.getServiceQName();
if (retVal == null)
{
final WebServiceClient webServiceClientAnnotation = serviceClass.getAnnotation(WebServiceClient.class);
if (webServiceClientAnnotation != null)
{
retVal = new QName(webServiceClientAnnotation.targetNamespace(), webServiceClientAnnotation.name());
}
}
return retVal;
}
private WebServiceFeature[] getFeatures(final String targetClassName, final String serviceClassName,
final UnifiedServiceRefMetaData serviceRefMD)
{
if (targetClassName != null && !targetClassName.equals(serviceClassName))
{
final Collection<UnifiedPortComponentRefMetaData> portComponentRefs = serviceRefMD.getPortComponentRefs();
for (final UnifiedPortComponentRefMetaData portComponentRefMD : portComponentRefs)
{
if (targetClassName.equals(portComponentRefMD.getServiceEndpointInterface()))
{
return getFeatures(portComponentRefMD);
}
}
}
return null;
}
private QName getPortQName(final String targetClassName, final String serviceClassName,
final UnifiedServiceRefMetaData serviceRefMD)
{
if (targetClassName != null && !targetClassName.equals(serviceClassName))
{
final Collection<UnifiedPortComponentRefMetaData> portComponentRefs = serviceRefMD.getPortComponentRefs();
for (final UnifiedPortComponentRefMetaData portComponentRefMD : portComponentRefs)
{
if (targetClassName.equals(portComponentRefMD.getServiceEndpointInterface()))
{
return portComponentRefMD.getPortQName();
}
}
}
return null;
}
private Method getMethodFor(final String methodName, final QName portQName, final WebServiceFeature[] features, final Class<?> serviceClass)
throws NoSuchMethodException
{
if ((portQName == null) && (features == null))
return serviceClass.getMethod(methodName, new Class[]
{Class.class});
if ((portQName != null) && (features == null))
return serviceClass.getMethod(methodName, new Class[]
{QName.class, Class.class});
if ((portQName == null) && (features != null))
return serviceClass.getMethod(methodName, new Class[]
{Class.class, WebServiceFeature[].class});
if ((portQName != null) && (features != null))
return serviceClass.getMethod(methodName, new Class[]
{QName.class, Class.class, WebServiceFeature[].class});
throw new IllegalStateException();
}
private Method getMethodFor(final String methodName, final WebServiceFeature[] features, final Class<?> serviceClass)
throws NoSuchMethodException
{
if (features == null)
{
return serviceClass.getMethod(methodName, new Class[] {});
}
else
{
return serviceClass.getMethod(methodName, new Class[] { WebServiceFeature[].class } );
}
}
private Object[] getArgumentsFor(final QName portQName, final WebServiceFeature[] features,
final Class<?> targetClass) throws NoSuchMethodException
{
if ((portQName == null) && (features == null))
return new Object[]
{targetClass};
if ((portQName != null) && (features == null))
return new Object[]
{portQName, targetClass};
if ((portQName == null) && (features != null))
return new Object[]
{targetClass, features};
if ((portQName != null) && (features != null))
return new Object[]
{portQName, targetClass, features};
throw new IllegalStateException();
}
private Object[] getArgumentsFor(final WebServiceFeature[] features) throws NoSuchMethodException
{
if (features == null)
{
return new Object[] {};
}
else
{
return new Object[] {features};
}
}
private List<WebServiceFeature> getFeatures(final UnifiedServiceRefMetaData serviceRef)
{
List<WebServiceFeature> features = new LinkedList<WebServiceFeature>();
// configure @Addressing feature
if (serviceRef.isAddressingAnnotationSpecified())
{
final boolean enabled = serviceRef.isAddressingEnabled();
final boolean required = serviceRef.isAddressingRequired();
final String refResponses = serviceRef.getAddressingResponses();
AddressingFeature.Responses responses = AddressingFeature.Responses.ALL;
if ("ANONYMOUS".equals(refResponses))
responses = AddressingFeature.Responses.ANONYMOUS;
if ("NON_ANONYMOUS".equals(refResponses))
responses = AddressingFeature.Responses.NON_ANONYMOUS;
features.add(new AddressingFeature(enabled, required, responses));
}
// configure @MTOM feature
if (serviceRef.isMtomAnnotationSpecified())
{
final boolean enabled = serviceRef.isMtomEnabled();
final int threshold = serviceRef.getMtomThreshold();
features.add(new MTOMFeature(enabled, threshold));
}
// configure @RespectBinding feature
if (serviceRef.isRespectBindingAnnotationSpecified())
{
final boolean enabled = serviceRef.isRespectBindingEnabled();
features.add(new RespectBindingFeature(enabled));
}
return features;
}
private WebServiceFeature[] getFeatures(final UnifiedPortComponentRefMetaData portComponentRefMD)
{
List<WebServiceFeature> features = new LinkedList<WebServiceFeature>();
// configure @Addressing feature
if (portComponentRefMD.isAddressingAnnotationSpecified())
{
final boolean enabled = portComponentRefMD.isAddressingEnabled();
final boolean required = portComponentRefMD.isAddressingRequired();
final String refResponses = portComponentRefMD.getAddressingResponses();
AddressingFeature.Responses responses = AddressingFeature.Responses.ALL;
if ("ANONYMOUS".equals(refResponses))
responses = AddressingFeature.Responses.ANONYMOUS;
if ("NON_ANONYMOUS".equals(refResponses))
responses = AddressingFeature.Responses.NON_ANONYMOUS;
features.add(new AddressingFeature(enabled, required, responses));
}
// configure @MTOM feature
if (portComponentRefMD.isMtomEnabled())
{
features.add(new MTOMFeature(true, portComponentRefMD.getMtomThreshold()));
}
// configure @RespectBinding feature
if (portComponentRefMD.isRespectBindingAnnotationSpecified())
{
final boolean enabled = portComponentRefMD.isRespectBindingEnabled();
features.add(new RespectBindingFeature(enabled));
}
return features.size() == 0 ? null : features.toArray(new WebServiceFeature[]
{});
}
private Bus createNewBus(final UnifiedServiceRefMetaData serviceRefMD)
{
final Bus bus;
Bus threadBus = BusFactory.getThreadDefaultBus(false);
bus = threadBus != null ? threadBus : BusFactory.newInstance().createBus();
Configurer configurer = bus.getExtension(Configurer.class);
bus.setExtension(new CXFServiceRefStubPropertyConfigurer(serviceRefMD, configurer), Configurer.class);
return bus;
}
}