org.apache.servicemix.eip.EIPEndpoint Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of servicemix-eip Show documentation
Show all versions of servicemix-eip Show documentation
The ServiceMix EIP component is a routing container where different routing patterns can be deployed as service unit.
The newest version!
/*
* 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.eip;
import java.net.URL;
import java.util.Set;
import javax.activation.DataHandler;
import javax.jbi.JBIException;
import javax.jbi.messaging.ExchangeStatus;
import javax.jbi.messaging.MessageExchange;
import javax.jbi.messaging.MessagingException;
import javax.jbi.messaging.MessageExchange.Role;
import javax.jbi.messaging.NormalizedMessage;
import javax.jbi.servicedesc.ServiceEndpoint;
import javax.wsdl.Definition;
import javax.wsdl.WSDLException;
import javax.wsdl.factory.WSDLFactory;
import javax.wsdl.xml.WSDLReader;
import org.apache.servicemix.common.JbiConstants;
import org.apache.servicemix.common.endpoints.ProviderEndpoint;
import org.apache.servicemix.common.locks.LockManager;
import org.apache.servicemix.common.locks.impl.SimpleLockManager;
import org.apache.servicemix.eip.support.ExchangeTarget;
import org.apache.servicemix.jbi.marshaler.PojoMarshaler;
import org.apache.servicemix.store.Store;
import org.apache.servicemix.store.StoreFactory;
import org.apache.servicemix.store.memory.MemoryStoreFactory;
import org.apache.servicemix.timers.TimerManager;
import org.apache.servicemix.timers.impl.TimerManagerImpl;
import org.springframework.core.io.Resource;
import org.w3c.dom.Document;
import com.ibm.wsdl.Constants;
/**
* @author gnodet
* @version $Revision: 376451 $
*/
public abstract class EIPEndpoint extends ProviderEndpoint {
/**
* The resource pointing to the WSDL for this endpoint
*/
protected Resource wsdlResource;
/**
* The store to keep pending exchanges
*/
protected Store store;
/**
* The store factory.
*/
protected StoreFactory storeFactory;
/**
* The lock manager.
*/
protected LockManager lockManager;
/**
* The timer manager.
*/
protected TimerManager timerManager;
/**
* The ExchangeTarget to use to get the WSDL
*/
protected ExchangeTarget wsdlExchangeTarget;
/**
* @return Returns the store.
*/
public Store getStore() {
return store;
}
/**
* Configure the store to use. If none is explicitely configured,
* the storeFactory will be used to create one.
*
* @param store The store to set.
* @org.apache.xbean.Property
* "
*/
public void setStore(Store store) {
this.store = store;
}
/**
* @return Returns the storeFactory.
*/
public StoreFactory getStoreFactory() {
return storeFactory;
}
/**
* The store factory to use when creating a store. If no factory
* is explicitely defined, an in-memory only factory will be created.
*
* @param storeFactory The storeFactory to set.
* @org.apache.xbean.Property
* "
*/
public void setStoreFactory(StoreFactory storeFactory) {
this.storeFactory = storeFactory;
}
/**
* The lock manager to use for this endpoint. If none is explicitely specified
* a default implementation will be provided.
*
* @return the lockManager
* @org.apache.xbean.Property
* "
*/
public LockManager getLockManager() {
return lockManager;
}
/**
* @param lockManager the lockManager to set
*/
public void setLockManager(LockManager lockManager) {
this.lockManager = lockManager;
}
/**
* @return the timerManager
*/
public TimerManager getTimerManager() {
return timerManager;
}
/**
* The timer manager to use for this endpoint. If none is explicitely configured,
* a default implementation will be provided.
*
* @param timerManager the timerManager to set
* @org.apache.xbean.Property
* "
*/
public void setTimerManager(TimerManager timerManager) {
this.timerManager = timerManager;
}
public void start() throws Exception {
super.start();
if (store == null) {
if (storeFactory == null) {
storeFactory = new MemoryStoreFactory();
}
store = storeFactory.open(getService().toString() + getEndpoint());
}
if (lockManager == null) {
lockManager = new SimpleLockManager();
}
if (timerManager == null) {
timerManager = new TimerManagerImpl();
}
timerManager.start();
}
public void stop() throws Exception {
if (timerManager != null) {
timerManager.stop();
}
super.stop();
}
/* (non-Javadoc)
* @see org.apache.servicemix.common.ExchangeProcessor#process(javax.jbi.messaging.MessageExchange)
*/
public void process(MessageExchange exchange) throws Exception {
boolean txSync = exchange.isTransacted() && Boolean.TRUE.equals(exchange.getProperty(JbiConstants.SEND_SYNC));
if (txSync && exchange.getRole() == Role.PROVIDER && exchange.getStatus() == ExchangeStatus.ACTIVE) {
processSync(exchange);
} else {
processAsync(exchange);
}
}
/**
* @return Returns the description.
*/
public Document getDescription() {
if (description == null) {
definition = getDefinition();
if (definition != null) {
try {
description = WSDLFactory.newInstance().newWSDLWriter().getDocument(definition);
} catch (WSDLException e) {
// Ignore
}
}
}
return description;
}
/**
* If the definition is not currently set, it tries to set it using
* the following sources in the order:
* description, wsdlResource, wsdlExchangeTarget
*
* @return Returns the definition.
*/
public Definition getDefinition() {
if (definition == null) {
definition = getDefinitionFromDescription();
if (definition == null) {
definition = getDefinitionFromWsdlResource();
if (definition == null) {
definition = getDefinitionFromWsdlExchangeTarget();
}
}
}
return definition;
}
protected Definition getDefinitionFromDescription() {
if (description != null) {
try {
WSDLReader reader = WSDLFactory.newInstance().newWSDLReader();
reader.setFeature(Constants.FEATURE_VERBOSE, false);
return reader.readWSDL(null, description);
} catch (WSDLException ignore) {
// Ignore
}
}
return null;
}
protected Definition getDefinitionFromWsdlResource() {
if (wsdlResource != null) {
try {
URL resource = wsdlResource.getURL();
WSDLReader reader = WSDLFactory.newInstance().newWSDLReader();
reader.setFeature(Constants.FEATURE_VERBOSE, false);
return reader.readWSDL(null, resource.toString());
} catch (Throwable ignore) {
// Ignore
}
}
return null;
}
protected Definition getDefinitionFromWsdlExchangeTarget() {
if (wsdlExchangeTarget != null) {
try {
Document description = getDescriptionForExchangeTarget(wsdlExchangeTarget);
WSDLReader reader = WSDLFactory.newInstance().newWSDLReader();
reader.setFeature(Constants.FEATURE_VERBOSE, false);
return reader.readWSDL(null, description);
} catch (Throwable ignore) {
// Ignore
}
}
return null;
}
/**
* @return Returns the wsdl's Resource.
*/
public Resource getWsdlResource() {
return wsdlResource;
}
/**
* When specified, this spring resource will be used to load the
* WSDL that will be exposed as a description for this endpoint.
* This property can be used to explicitely define the WSDL to be
* exposed by this endpoint. This property takes precedence over
* the wsdlExchangeTarget property.
*
* @param wsdlResource
* @org.apache.xbean.Property
*/
public void setWsdlResource(Resource wsdlResource) {
this.wsdlResource = wsdlResource;
}
protected Document getDescriptionForExchangeTarget(ExchangeTarget match) throws JBIException {
ServiceEndpoint[] endpoints = getEndpointsForExchangeTarget(match);
if (endpoints == null || endpoints.length == 0) {
return null;
}
ServiceEndpoint endpoint = chooseFirstEndpointWithDescriptor(endpoints);
if (endpoint == null) {
return null;
}
return getContext().getEndpointDescriptor(endpoint);
}
/**
*
* @param match
* @return an ServiceEndpoint[] of all the endpoints that matched.
* @throws JBIException
*/
protected ServiceEndpoint[] getEndpointsForExchangeTarget(ExchangeTarget match) throws JBIException {
ServiceEndpoint[] endpoints;
if (match.getEndpoint() != null && match.getService() != null) {
ServiceEndpoint endpoint = getContext().getEndpoint(match.getService(), match.getEndpoint());
if (endpoint == null) {
endpoints = new ServiceEndpoint[0];
} else {
endpoints = new ServiceEndpoint[] {endpoint };
}
} else if (match.getService() != null) {
endpoints = getContext().getEndpointsForService(match.getService());
} else if (interfaceName != null) {
endpoints = getContext().getEndpoints(interfaceName);
} else {
throw new IllegalStateException("One of interfaceName or serviceName should be provided");
}
return endpoints;
}
protected ServiceEndpoint chooseFirstEndpointWithDescriptor(ServiceEndpoint[] endpoints) throws JBIException {
for (int i = 0; i < endpoints.length; i++) {
if (getContext().getEndpointDescriptor(endpoints[i]) != null) {
return endpoints[i];
}
}
return null;
}
protected abstract void processAsync(MessageExchange exchange) throws Exception;
protected abstract void processSync(MessageExchange exchange) throws Exception;
public ExchangeTarget getWsdlExchangeTarget() {
return wsdlExchangeTarget;
}
/**
* An exchange target pointing to a JBI endpoint that
* will be used to load the WSDL describing this endpoint.
* This can be used when the endpoint proxies another endpoint
* so that the same WSDL definition will be exposed."
*/
public void setWsdlExchangeTarget(ExchangeTarget wsdlExchangeTarget) {
this.wsdlExchangeTarget = wsdlExchangeTarget;
}
/**
* Copies properties from one message to another that do not already exist
*
* @param from the message containing the properties
* @param to the destination message where the properties are set
*/
protected void copyProperties(NormalizedMessage from, NormalizedMessage to) {
for (String propertyName : (Set) from.getPropertyNames()) {
// Do not copy existing properties or transient properties
if (to.getProperty(propertyName) == null && !PojoMarshaler.BODY.equals(propertyName)) {
Object value = from.getProperty(propertyName);
to.setProperty(propertyName, value);
}
}
}
/**
* Copies attachments from one message to another that do not already exist
*
* @param from the message with the attachments
* @param to the destination message where the attachments are to be added
* @throws javax.jbi.messaging.MessagingException if an attachment could not be added
*/
protected void copyAttachments(NormalizedMessage from, NormalizedMessage to) throws MessagingException {
for (String attachmentName : (Set) from.getAttachmentNames()) {
// Do not copy existing attachments
if (to.getAttachment(attachmentName) == null) {
DataHandler value = from.getAttachment(attachmentName);
to.addAttachment(attachmentName, value);
}
}
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy