org.apache.camel.component.language.LanguageEndpoint Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of camel-core Show documentation
Show all versions of camel-core Show documentation
The Core Camel Java DSL based router
/**
* 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.camel.component.language;
import java.io.IOException;
import java.io.InputStream;
import java.io.UnsupportedEncodingException;
import java.net.URLEncoder;
import org.apache.camel.Component;
import org.apache.camel.Consumer;
import org.apache.camel.Expression;
import org.apache.camel.Processor;
import org.apache.camel.Producer;
import org.apache.camel.RuntimeCamelException;
import org.apache.camel.component.ResourceEndpoint;
import org.apache.camel.spi.Language;
import org.apache.camel.spi.Metadata;
import org.apache.camel.spi.UriEndpoint;
import org.apache.camel.spi.UriParam;
import org.apache.camel.spi.UriPath;
import org.apache.camel.util.IOHelper;
import org.apache.camel.util.ObjectHelper;
import org.apache.camel.util.ResourceHelper;
/**
* The language component allows you to send a message to an endpoint which executes a script by any of the supported Languages in Camel.
*
* By having a component to execute language scripts, it allows more dynamic routing capabilities.
* For example by using the Routing Slip or Dynamic Router EIPs you can send messages to language endpoints
* where the script is dynamic defined as well.
*
* This component is provided out of the box in camel-core and hence no additional JARs is needed.
* You only have to include additional Camel components if the language of choice mandates it,
* such as using Groovy or JavaScript languages.
*/
@UriEndpoint(scheme = "language", title = "Language", syntax = "language:languageName:resourceUri", producerOnly = true, label = "core,script")
public class LanguageEndpoint extends ResourceEndpoint {
private Language language;
private Expression expression;
private boolean contentResolvedFromResource;
@UriPath(enums = "bean,constant,el,exchangeProperty,file,groovy,header,javascript,jsonpath,jxpath,mvel,ognl,php,python"
+ ",ref,ruby,simple,spel,sql,terser,tokenize,xpath,xquery,xtokenize")
@Metadata(required = "true")
private String languageName;
// resourceUri is optional in the language endpoint
@UriPath(description = "Path to the resource, or a reference to lookup a bean in the Registry to use as the resource")
@Metadata(required = "false")
private String resourceUri;
@UriParam
private String script;
@UriParam(defaultValue = "true")
private boolean transform = true;
@UriParam
private boolean binary;
@UriParam
private boolean cacheScript;
public LanguageEndpoint() {
// enable cache by default
setContentCache(true);
}
public LanguageEndpoint(String endpointUri, Component component, Language language, Expression expression, String resourceUri) {
super(endpointUri, component, resourceUri);
this.language = language;
this.expression = expression;
// enable cache by default
setContentCache(true);
}
public Producer createProducer() throws Exception {
ObjectHelper.notNull(getCamelContext(), "CamelContext", this);
if (language == null && languageName != null) {
language = getCamelContext().resolveLanguage(languageName);
}
ObjectHelper.notNull(language, "language", this);
if (cacheScript && expression == null && script != null) {
script = resolveScript(script);
expression = language.createExpression(script);
}
return new LanguageProducer(this);
}
public Consumer createConsumer(Processor processor) throws Exception {
throw new RuntimeCamelException("Cannot consume to a LanguageEndpoint: " + getEndpointUri());
}
/**
* Resolves the script.
*
* @param script script or uri for a script to load
* @return the script
* @throws IOException is thrown if error loading the script
*/
protected String resolveScript(String script) throws IOException {
String answer;
if (ResourceHelper.hasScheme(script)) {
InputStream is = loadResource(script);
answer = getCamelContext().getTypeConverter().convertTo(String.class, is);
IOHelper.close(is);
} else {
answer = script;
}
return answer;
}
public boolean isSingleton() {
return true;
}
@Override
protected String createEndpointUri() {
String s = script;
try {
s = URLEncoder.encode(s, "UTF-8");
} catch (UnsupportedEncodingException e) {
// ignore
}
return languageName + ":" + s;
}
public Language getLanguage() {
return language;
}
public Expression getExpression() {
if (isContentResolvedFromResource() && isContentCacheCleared()) {
return null;
}
return expression;
}
public void setExpression(Expression expression) {
this.expression = expression;
}
public boolean isTransform() {
return transform;
}
/**
* Whether or not the result of the script should be used as message body.
*
* This options is default true.
*
* @param transform true to use result as new message body, false to keep the existing message body
*/
public void setTransform(boolean transform) {
this.transform = transform;
}
public boolean isBinary() {
return binary;
}
/**
* Whether the script is binary content or text content.
*
* By default the script is read as text content (eg java.lang.String)
*
* @param binary true to read the script as binary, instead of text based.
*/
public void setBinary(boolean binary) {
this.binary = binary;
}
/**
* Sets the name of the language to use
*
* @param languageName the name of the language
*/
public void setLanguageName(String languageName) {
this.languageName = languageName;
}
/**
* Path to the resource, or a reference to lookup a bean in the Registry to use as the resource
*
* @param resourceUri the resource path
*/
@Override
public void setResourceUri(String resourceUri) {
super.setResourceUri(resourceUri);
}
@Override
public String getResourceUri() {
return super.getResourceUri();
}
/**
* Sets the script to execute
*
* @param script the script
*/
public void setScript(String script) {
this.script = script;
}
public String getScript() {
return script;
}
public boolean isContentResolvedFromResource() {
return contentResolvedFromResource;
}
public void setContentResolvedFromResource(boolean contentResolvedFromResource) {
this.contentResolvedFromResource = contentResolvedFromResource;
}
public boolean isCacheScript() {
return cacheScript;
}
/**
* Whether to cache the compiled script and reuse
*
* Notice reusing the script can cause side effects from processing one Camel
* {@link org.apache.camel.Exchange} to the next {@link org.apache.camel.Exchange}.
*/
public void setCacheScript(boolean cacheScript) {
this.cacheScript = cacheScript;
}
public void clearContentCache() {
super.clearContentCache();
// must also clear expression and script
expression = null;
script = null;
}
}