org.apache.servicemix.cxfse.CxfSeEndpoint Maven / Gradle / Ivy
/*
* 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.servicemix.cxfse;
import java.lang.reflect.Field;
import java.lang.reflect.Method;
import java.util.List;
import java.util.Map;
import java.util.concurrent.CopyOnWriteArrayList;
import javax.annotation.PostConstruct;
import javax.annotation.PreDestroy;
import javax.jbi.component.ComponentContext;
import javax.jbi.management.DeploymentException;
import javax.jbi.messaging.DeliveryChannel;
import javax.jbi.messaging.ExchangeStatus;
import javax.jbi.messaging.MessageExchange;
import javax.wsdl.WSDLException;
import javax.wsdl.factory.WSDLFactory;
import javax.xml.namespace.QName;
import javax.xml.ws.WebServiceRef;
import org.apache.cxf.Bus;
import org.apache.cxf.interceptor.Fault;
import org.apache.cxf.interceptor.Interceptor;
import org.apache.cxf.interceptor.InterceptorProvider;
import org.apache.cxf.jaxws.EndpointImpl;
import org.apache.cxf.jaxws.JaxWsServerFactoryBean;
import org.apache.cxf.jaxws.ServiceImpl;
import org.apache.cxf.jaxws.support.JaxWsImplementorInfo;
import org.apache.cxf.jaxws.support.JaxWsServiceFactoryBean;
import org.apache.cxf.service.model.EndpointInfo;
import org.apache.cxf.transport.ConduitInitiatorManager;
import org.apache.cxf.transport.jbi.JBIDestination;
import org.apache.cxf.transport.jbi.JBIDispatcherUtil;
import org.apache.cxf.transport.jbi.JBITransportFactory;
import org.apache.cxf.wsdl11.ServiceWSDLBuilder;
import org.apache.servicemix.common.endpoints.ProviderEndpoint;
import org.apache.servicemix.cxfse.interceptors.AttachmentInInterceptor;
import org.apache.servicemix.cxfse.interceptors.AttachmentOutInterceptor;
import org.apache.servicemix.cxfse.support.ReflectionUtils;
import org.apache.servicemix.id.IdGenerator;
import org.springframework.util.ReflectionUtils.FieldCallback;
/**
*
* @author gnodet
* @org.apache.xbean.XBean element="endpoint" description="an endpoint using CXF's JAX-WS frontend"
*/
public class CxfSeEndpoint extends ProviderEndpoint implements
InterceptorProvider {
private static final IdGenerator ID_GENERATOR = new IdGenerator();
private Object pojo;
private EndpointImpl endpoint;
private String address;
private List in = new CopyOnWriteArrayList();
private List out = new CopyOnWriteArrayList();
private List outFault = new CopyOnWriteArrayList();
private List inFault = new CopyOnWriteArrayList();
private Map properties;
private boolean mtomEnabled;
private boolean useJBIWrapper = true;
/**
* Returns the object implementing the endpoint's functionality. It is
* returned as a generic Java Object that can be cast to
* the proper type.
*
* @return the pojo
*/
public Object getPojo() {
return pojo;
}
/**
* Specifies the object implementing the endpoint's functionality. This
* object should use the JAX-WS annotations.
*
* @param pojo a JAX-WS annotated object
* @org.apache.xbean.Property description="a bean configuring the JAX-WS annotated implementation for the endpoint"
*/
public void setPojo(Object pojo) {
this.pojo = pojo;
}
/**
* Returns the list of interceptors used to process fault messages being
* sent back to the consumer.
*
* @return a list of Interceptor objects
* */
public List getOutFaultInterceptors() {
return outFault;
}
/**
* Returns the list of interceptors used to process fault messages being
* recieved by the endpoint.
*
* @return a list of Interceptor objects
* */
public List getInFaultInterceptors() {
return inFault;
}
/**
* Returns the list of interceptors used to process messages being
* recieved by the endpoint.
*
* @return a list of Interceptor objects
* */
public List getInInterceptors() {
return in;
}
/**
* Returns the list of interceptors used to process responses being
* sent back to the consumer.
*
* @return a list of Interceptor objects
* */
public List getOutInterceptors() {
return out;
}
/**
* Specifies a list of interceptors used to process requests recieved
* by the endpoint.
*
* @param interceptors a list of Interceptor objects
* @org.apache.xbean.Property description="a list of beans configuring interceptors that process incoming requests"
* */
public void setInInterceptors(List interceptors) {
in = interceptors;
}
/**
* Specifies a list of interceptors used to process faults recieved by
* the endpoint.
*
* @param interceptors a list of Interceptor objects
* @org.apache.xbean.Property description="a list of beans configuring interceptors that process incoming faults"
* */
public void setInFaultInterceptors(List interceptors) {
inFault = interceptors;
}
/**
* Specifies a list of interceptors used to process responses sent by
* the endpoint.
*
* @param interceptors a list of Interceptor objects
* @org.apache.xbean.Property description="a list of beans configuring interceptors that process response messages"
* */
public void setOutInterceptors(List interceptors) {
out = interceptors;
}
/**
* Specifies a list of interceptors used to process faults sent by
* the endpoint.
*
* @param interceptors a list of Interceptor objects
* @org.apache.xbean.Property description="a list of beans configuring interceptors that process
* fault messages being returned to the consumer"
* */
public void setOutFaultInterceptors(List interceptors) {
outFault = interceptors;
}
public Map getProperties() {
return properties;
}
public void setProperties(Map properties) {
this.properties = properties;
}
/*
* (non-Javadoc)
*
* @see org.apache.servicemix.common.Endpoint#validate()
*/
@Override
public void validate() throws DeploymentException {
if (getPojo() == null) {
throw new DeploymentException("pojo must be set");
}
JaxWsServiceFactoryBean serviceFactory = new JaxWsServiceFactoryBean();
serviceFactory.setPopulateFromClass(true);
endpoint = new EndpointImpl(getBus(), getPojo(),
new JaxWsServerFactoryBean(serviceFactory));
if (isUseJBIWrapper()) {
endpoint.setBindingUri(org.apache.cxf.binding.jbi.JBIConstants.NS_JBI_BINDING);
}
endpoint.setInInterceptors(getInInterceptors());
endpoint.setInFaultInterceptors(getInFaultInterceptors());
endpoint.setOutInterceptors(getOutInterceptors());
endpoint.setOutFaultInterceptors(getOutFaultInterceptors());
if (isMtomEnabled()) {
endpoint.getInInterceptors().add(new AttachmentInInterceptor());
endpoint.getOutInterceptors().add(new AttachmentOutInterceptor());
}
JaxWsImplementorInfo implInfo = new JaxWsImplementorInfo(getPojo()
.getClass());
setService(implInfo.getServiceName());
setInterfaceName(implInfo.getInterfaceName());
setEndpoint(implInfo.getEndpointName().getLocalPart());
super.validate();
}
/*
* (non-Javadoc)
*
* @see org.apache.servicemix.common.endpoints.ProviderEndpoint#process(javax.jbi.messaging.MessageExchange)
*/
@Override
public void process(MessageExchange exchange) throws Exception {
QName opeName = exchange.getOperation();
EndpointInfo ei = endpoint.getServer().getEndpoint().getEndpointInfo();
if (opeName == null) {
// if interface only have one operation, may not specify the opeName in MessageExchange
if (ei.getBinding().getOperations().size() == 1) {
opeName = ei.getBinding().getOperations().iterator().next().getName();
exchange.setOperation(opeName);
} else {
throw new Fault(
new Exception("Operation not bound on this MessageExchange"));
}
}
JBITransportFactory jbiTransportFactory = (JBITransportFactory) getBus()
.getExtension(ConduitInitiatorManager.class)
.getConduitInitiator(CxfSeComponent.JBI_TRANSPORT_ID);
QName serviceName = exchange.getService();
if (serviceName == null) {
serviceName = getService();
exchange.setService(serviceName);
}
QName interfaceName = exchange.getInterfaceName();
if (interfaceName == null) {
interfaceName = getInterfaceName();
exchange.setInterfaceName(interfaceName);
}
JBIDestination jbiDestination = jbiTransportFactory
.getDestination(serviceName.toString()
+ interfaceName.toString());
DeliveryChannel dc = getContext().getDeliveryChannel();
jbiTransportFactory.setDeliveryChannel(dc);
jbiDestination.setDeliveryChannel(dc);
if (exchange.getStatus() == ExchangeStatus.ACTIVE) {
jbiDestination.getJBIDispatcherUtil().dispatch(exchange);
}
}
/*
* (non-Javadoc)
*
* @see org.apache.servicemix.common.endpoints.ProviderEndpoint#start()
*/
@Override
public void start() throws Exception {
super.start();
address = "jbi://" + ID_GENERATOR.generateSanitizedId();
try {
endpoint.publish(address);
} catch (Exception e) {
e.printStackTrace();
}
setService(endpoint.getServer().getEndpoint().getService().getName());
setEndpoint(endpoint.getServer().getEndpoint().getEndpointInfo()
.getName().getLocalPart());
try {
definition = new ServiceWSDLBuilder(getBus(), endpoint.getServer()
.getEndpoint().getService().getServiceInfos().iterator()
.next()).build();
description = WSDLFactory.newInstance().newWSDLWriter().getDocument(definition);
} catch (WSDLException e) {
throw new DeploymentException(e);
}
ReflectionUtils.doWithFields(getPojo().getClass(), new FieldCallback() {
public void doWith(Field field) throws IllegalArgumentException,
IllegalAccessException {
if (field.getAnnotation(WebServiceRef.class) != null) {
ServiceImpl s = new ServiceImpl(getBus(), null, null, field
.getType());
s.addPort(new QName("port"),
JBITransportFactory.TRANSPORT_ID, "jbi://"
+ ID_GENERATOR.generateSanitizedId());
Object o = s.getPort(new QName("port"), field.getType());
field.setAccessible(true);
field.set(getPojo(), o);
}
}
});
ReflectionUtils.callLifecycleMethod(getPojo(), PostConstruct.class);
injectPojo();
}
/*
* (non-Javadoc)
*
* @see org.apache.servicemix.common.endpoints.ProviderEndpoint#stop()
*/
@Override
public void stop() throws Exception {
endpoint.stop();
ReflectionUtils.callLifecycleMethod(getPojo(), PreDestroy.class);
JBIDispatcherUtil.clean();
JBITransportFactory jbiTransportFactory = (JBITransportFactory) getBus()
.getExtension(ConduitInitiatorManager.class)
.getConduitInitiator(CxfSeComponent.JBI_TRANSPORT_ID);
jbiTransportFactory.setDeliveryChannel(null);
jbiTransportFactory.removeDestination(getService().toString()
+ getInterfaceName().toString());
super.stop();
}
protected Bus getBus() {
return ((CxfSeComponent) getServiceUnit().getComponent()).getBus();
}
@PostConstruct
protected void injectPojo() {
try {
ComponentContext context = getContext();
Method mth = pojo.getClass().getMethod("setContext", new Class[] {ComponentContext.class });
if (mth != null) {
mth.invoke(pojo, new Object[] {context});
}
} catch (Exception e) {
logger.debug("Unable to inject ComponentContext: " + e.getMessage());
}
}
/**
* Specifies if the endpoint can process messages with binary data.
*
* @param mtomEnabled a boolean
* @org.apache.xbean.Property description="Specifies if the service can consume MTOM formatted binary data.
* The default is false."
* */
public void setMtomEnabled(boolean mtomEnabled) {
this.mtomEnabled = mtomEnabled;
}
public boolean isMtomEnabled() {
return mtomEnabled;
}
/**
* Specifies if the endpoint expects messages that are encased in the
* JBI wrapper used for SOAP messages.
*
* @param mtomEnabled a boolean
* @org.apache.xbean.Property description="Specifies if the endpoint expects to receive the JBI wrapper in
* the message received from the NMR. The default is true."
* */
public void setUseJBIWrapper(boolean useJBIWrapper) {
this.useJBIWrapper = useJBIWrapper;
}
public boolean isUseJBIWrapper() {
return useJBIWrapper;
}
}