org.mule.endpoint.AbstractEndpoint Maven / Gradle / Ivy
/*
* $Id: AbstractEndpoint.java 22969 2011-09-16 18:02:51Z dfeist $
* --------------------------------------------------------------------------------------
* Copyright (c) MuleSoft, Inc. All rights reserved. http://www.mulesoft.com
*
* The software in this package is published under the terms of the CPAL v1.0
* license, a copy of which has been included with this distribution in the
* LICENSE.txt file.
*/
package org.mule.endpoint;
import org.mule.MessageExchangePattern;
import org.mule.api.AnnotatedObject;
import org.mule.api.MuleContext;
import org.mule.api.MuleException;
import org.mule.api.construct.FlowConstruct;
import org.mule.api.endpoint.EndpointMessageProcessorChainFactory;
import org.mule.api.endpoint.EndpointURI;
import org.mule.api.endpoint.ImmutableEndpoint;
import org.mule.api.lifecycle.Disposable;
import org.mule.api.processor.MessageProcessor;
import org.mule.api.processor.MessageProcessorChain;
import org.mule.api.retry.RetryPolicyTemplate;
import org.mule.api.routing.filter.Filter;
import org.mule.api.security.EndpointSecurityFilter;
import org.mule.api.security.SecurityFilter;
import org.mule.api.transaction.TransactionConfig;
import org.mule.api.transformer.Transformer;
import org.mule.api.transport.Connector;
import org.mule.processor.AbstractRedeliveryPolicy;
import org.mule.processor.SecurityFilterMessageProcessor;
import org.mule.routing.MessageFilter;
import org.mule.util.ClassUtils;
import java.net.URI;
import java.util.Collections;
import java.util.HashMap;
import java.util.LinkedList;
import java.util.List;
import java.util.Map;
import java.util.concurrent.ConcurrentHashMap;
import java.util.regex.Matcher;
import java.util.regex.Pattern;
import javax.xml.namespace.QName;
import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
/**
* ImmutableMuleEndpoint describes a Provider in the Mule Server. A
* endpoint is a grouping of an endpoint, an endpointUri and a transformer.
*/
public abstract class AbstractEndpoint implements ImmutableEndpoint, Disposable, AnnotatedObject
{
private static final long serialVersionUID = -1650380871293160973L;
public static final String PROPERTY_PROCESS_SYNCHRONOUSLY = "processSynchronously";
/**
* logger used by this class
*/
protected static final Log logger = LogFactory.getLog(AbstractEndpoint.class);
/**
* The endpoint used to communicate with the external system
*/
private final Connector connector;
/**
* The endpointUri on which to send or receive information
*/
private final EndpointURI endpointUri;
private final EndpointMessageProcessorChainFactory messageProcessorsFactory;
private final List messageProcessors;
private final List responseMessageProcessors;
private MessageProcessor messageProcessorChain;
/**
* The name for the endpoint
*/
private final String name;
/**
* Any additional properties for the endpoint
* // TODO This should be final. See MULE-3105
* // TODO Shouldn't this be guarded from concurrent writes?
*/
private Map properties = new HashMap();
/**
* The transaction configuration for this endpoint
*/
private final TransactionConfig transactionConfig;
/**
* determines whether unaccepted filtered events should be removed from the
* source. If they are not removed its up to the Message receiver to handle
* recieving the same message again
*/
private final boolean deleteUnacceptedMessages;
private final MessageExchangePattern messageExchangePattern;
/**
* How long to block when performing a remote synchronisation to a remote host.
* This property is optional and will be set to the default Synchonous MuleEvent
* time out value if not set
*/
private final int responseTimeout;
/**
* The state that the endpoint is initialised in such as started or stopped
*/
private final String initialState;
private final String endpointEncoding;
private MuleContext muleContext;
protected RetryPolicyTemplate retryPolicyTemplate;
private String endpointBuilderName;
private final String endpointMimeType;
private AbstractRedeliveryPolicy redeliveryPolicy;
private boolean disableTransportTransformer = false;
private final Map annotations = new ConcurrentHashMap();
public AbstractEndpoint(Connector connector,
EndpointURI endpointUri,
String name,
Map properties,
TransactionConfig transactionConfig,
boolean deleteUnacceptedMessages,
MessageExchangePattern messageExchangePattern,
int responseTimeout,
String initialState,
String endpointEncoding,
String endpointBuilderName,
MuleContext muleContext,
RetryPolicyTemplate retryPolicyTemplate,
AbstractRedeliveryPolicy redeliveryPolicy,
EndpointMessageProcessorChainFactory messageProcessorsFactory,
List messageProcessors,
List responseMessageProcessors,
boolean disableTransportTransformer,
String endpointMimeType)
{
this.connector = connector;
this.endpointUri = endpointUri;
this.name = name;
// TODO Properties should be immutable. See MULE-3105
// this.properties = Collections.unmodifiableMap(properties);
this.properties.putAll(properties);
this.transactionConfig = transactionConfig;
this.deleteUnacceptedMessages = deleteUnacceptedMessages;
this.responseTimeout = responseTimeout;
this.initialState = initialState;
this.endpointEncoding = endpointEncoding;
this.endpointBuilderName = endpointBuilderName;
this.muleContext = muleContext;
this.retryPolicyTemplate = retryPolicyTemplate;
this.redeliveryPolicy = redeliveryPolicy;
this.endpointMimeType = endpointMimeType;
this.disableTransportTransformer = disableTransportTransformer;
this.messageExchangePattern = messageExchangePattern;
this.messageProcessorsFactory = messageProcessorsFactory;
if (messageProcessors == null)
{
this.messageProcessors = Collections.emptyList();
}
else
{
this.messageProcessors = messageProcessors;
}
if (responseMessageProcessors == null)
{
this.responseMessageProcessors = Collections.emptyList();
}
else
{
this.responseMessageProcessors = responseMessageProcessors;
}
}
public EndpointURI getEndpointURI()
{
return endpointUri;
}
public String getAddress()
{
EndpointURI uri = getEndpointURI();
if (uri != null)
{
return uri.getUri().toString();
}
else
{
return null;
}
}
public String getEncoding()
{
return endpointEncoding;
}
public String getMimeType()
{
return endpointMimeType;
}
public Connector getConnector()
{
return connector;
}
public String getName()
{
return name;
}
public EndpointMessageProcessorChainFactory getMessageProcessorsFactory()
{
return messageProcessorsFactory;
}
public List getMessageProcessors()
{
return messageProcessors;
}
public List getResponseMessageProcessors()
{
return responseMessageProcessors;
}
/** @deprecated use getMessageProcessors() */
public List getTransformers()
{
return getTransformersFromProcessorList(messageProcessors);
}
public Map getProperties()
{
return properties;
}
public boolean isReadOnly()
{
return true;
}
@Override
public String toString()
{
// Use the interface to retrieve the string and set
// the endpoint uri to a default value
String sanitizedEndPointUri = null;
URI uri = null;
if (endpointUri != null)
{
sanitizedEndPointUri = endpointUri.toString();
uri = endpointUri.getUri();
}
// The following will further sanitize the endpointuri by removing
// the embedded password. This will only remove the password if the
// uri contains all the necessary information to successfully rebuild the url
if (uri != null && (uri.getRawUserInfo() != null) && (uri.getScheme() != null) && (uri.getHost() != null)
&& (uri.getRawPath() != null))
{
// build a pattern up that matches what we need tp strip out the password
Pattern sanitizerPattern = Pattern.compile("(.*):.*");
Matcher sanitizerMatcher = sanitizerPattern.matcher(uri.getRawUserInfo());
if (sanitizerMatcher.matches())
{
sanitizedEndPointUri = new StringBuffer(uri.getScheme()).append("://")
.append(sanitizerMatcher.group(1))
.append(":")
.append("@")
.append(uri.getHost())
.append(uri.getRawPath())
.toString();
}
if (uri.getRawQuery() != null)
{
sanitizedEndPointUri = sanitizedEndPointUri + "?" + uri.getRawQuery();
}
}
return ClassUtils.getClassName(getClass()) + "{endpointUri=" + sanitizedEndPointUri + ", connector="
+ connector + ", name='" + name + "', mep=" + messageExchangePattern + ", properties=" + properties
+ ", transactionConfig=" + transactionConfig + ", deleteUnacceptedMessages=" + deleteUnacceptedMessages
+ ", initialState=" + initialState + ", responseTimeout="
+ responseTimeout + ", endpointEncoding=" + endpointEncoding + ", disableTransportTransformer="
+ disableTransportTransformer + "}";
}
public String getProtocol()
{
return connector.getProtocol();
}
public TransactionConfig getTransactionConfig()
{
return transactionConfig;
}
protected static boolean equal(Object a, Object b)
{
return ClassUtils.equal(a, b);
}
@Override
public boolean equals(Object obj)
{
if (this == obj)
{
return true;
}
if (obj == null || getClass() != obj.getClass())
{
return false;
}
final AbstractEndpoint other = (AbstractEndpoint) obj;
return equal(retryPolicyTemplate, other.retryPolicyTemplate)
&& equal(connector, other.connector)
&& deleteUnacceptedMessages == other.deleteUnacceptedMessages
&& equal(endpointEncoding, other.endpointEncoding)
&& equal(endpointUri, other.endpointUri)
&& equal(initialState, other.initialState)
// don't include lifecycle state as lifecycle code includes hashing
// && equal(initialised, other.initialised)
&& equal(messageExchangePattern, other.messageExchangePattern)
&& equal(name, other.name)
&& equal(properties, other.properties)
&& responseTimeout == other.responseTimeout
&& equal(messageProcessors, other.messageProcessors)
&& equal(responseMessageProcessors, other.responseMessageProcessors)
&& equal(transactionConfig, other.transactionConfig)
&& disableTransportTransformer == other.disableTransportTransformer;
}
@Override
public int hashCode()
{
return ClassUtils.hash(new Object[]{this.getClass(), retryPolicyTemplate, connector,
deleteUnacceptedMessages ? Boolean.TRUE : Boolean.FALSE,
endpointEncoding,
endpointUri,
initialState,
// don't include lifecycle state as lifecycle code includes hashing
// initialised,
messageExchangePattern,
name,
properties,
Integer.valueOf(responseTimeout),
responseMessageProcessors,
transactionConfig,
messageProcessors,
disableTransportTransformer ? Boolean.TRUE : Boolean.FALSE});
}
public Filter getFilter()
{
// Call the first MessageFilter in the chain "the filter".
for (MessageProcessor mp : messageProcessors)
{
if (mp instanceof MessageFilter)
{
return ((MessageFilter) mp).getFilter();
}
}
return null;
}
public boolean isDeleteUnacceptedMessages()
{
return deleteUnacceptedMessages;
}
/**
* Returns an EndpointSecurityFilter for this endpoint. If one is not set, there
* will be no authentication on events sent via this endpoint
*
* @return EndpointSecurityFilter responsible for authenticating message flow via
* this endpoint.
* @see org.mule.api.security.EndpointSecurityFilter
*/
public EndpointSecurityFilter getSecurityFilter()
{
for (MessageProcessor mp : messageProcessors)
{
if (mp instanceof SecurityFilterMessageProcessor)
{
SecurityFilter filter = ((SecurityFilterMessageProcessor)mp).getFilter();
if (filter instanceof EndpointSecurityFilter)
{
return (EndpointSecurityFilter) filter;
}
}
}
return null;
}
public MessageExchangePattern getExchangePattern()
{
return messageExchangePattern;
}
/**
* The timeout value for remoteSync invocations
*
* @return the timeout in milliseconds
*/
public int getResponseTimeout()
{
return responseTimeout;
}
/**
* Sets the state the endpoint will be loaded in. The States are 'stopped' and
* 'started' (default)
*
* @return the endpoint starting state
*/
public String getInitialState()
{
return initialState;
}
/** @deprecated use getResponseMessageProcessors() */
public List getResponseTransformers()
{
return getTransformersFromProcessorList(responseMessageProcessors);
}
private List getTransformersFromProcessorList(List processors)
{
List transformers = new LinkedList();
for (MessageProcessor processor : processors)
{
if (processor instanceof Transformer)
{
transformers.add((Transformer) processor);
}
else if (processor instanceof MessageProcessorChain)
{
transformers.addAll(getTransformersFromProcessorList(((MessageProcessorChain) processor).getMessageProcessors()));
}
}
return transformers;
}
public Object getProperty(Object key)
{
return properties.get(key);
}
public MuleContext getMuleContext()
{
return muleContext;
}
public RetryPolicyTemplate getRetryPolicyTemplate()
{
return retryPolicyTemplate;
}
public AbstractRedeliveryPolicy getRedeliveryPolicy()
{
return redeliveryPolicy;
}
public String getEndpointBuilderName()
{
return endpointBuilderName;
}
public boolean isProtocolSupported(String protocol)
{
return connector.supportsProtocol(protocol);
}
public boolean isDisableTransportTransformer()
{
return disableTransportTransformer;
}
public void dispose()
{
this.muleContext = null;
// this.messageProcessors.clear();
// Don't clear this, since it changes the hash code, which can foul up shutdown processing
// when objects have been keyed by endpoint, e.g. dispatchers
this.messageProcessorChain = null;
}
public MessageProcessor getMessageProcessorChain(FlowConstruct flowContruct) throws MuleException
{
if (messageProcessorChain == null)
{
messageProcessorChain = createMessageProcessorChain(flowContruct);
}
return messageProcessorChain;
}
public final Object getAnnotation(QName name)
{
return annotations.get(name);
}
public final Map getAnnotations()
{
return Collections.unmodifiableMap(annotations);
}
public synchronized final void setAnnotations(Map newAnnotations)
{
annotations.clear();
annotations.putAll(newAnnotations);
}
abstract protected MessageProcessor createMessageProcessorChain(FlowConstruct flowContruct) throws MuleException;
}
© 2015 - 2024 Weber Informatics LLC | Privacy Policy