org.apache.camel.component.directvm.DirectVmEndpoint 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.directvm;
import org.apache.camel.Consumer;
import org.apache.camel.Processor;
import org.apache.camel.Producer;
import org.apache.camel.component.direct.DirectConsumer;
import org.apache.camel.impl.DefaultEndpoint;
import org.apache.camel.spi.Metadata;
import org.apache.camel.spi.UriEndpoint;
import org.apache.camel.spi.UriParam;
import org.apache.camel.spi.UriPath;
/**
* The direct-vm component provides direct, synchronous call to another endpoint from any CamelContext in the same JVM.
*
* This endpoint can be used to connect existing routes in the same JVM between different CamelContexts.
*/
@UriEndpoint(scheme = "direct-vm", title = "Direct VM", syntax = "direct-vm:name", consumerClass = DirectConsumer.class, label = "core,endpoint")
public class DirectVmEndpoint extends DefaultEndpoint {
@UriPath(description = "Name of direct-vm endpoint") @Metadata(required = "true")
private String name;
@UriParam(label = "producer")
private boolean block;
@UriParam(label = "producer", defaultValue = "30000")
private long timeout = 30000L;
@UriParam(label = "producer")
private boolean failIfNoConsumers = true;
public DirectVmEndpoint(String endpointUri, DirectVmComponent component) {
super(endpointUri, component);
}
@Override
public DirectVmComponent getComponent() {
return (DirectVmComponent) super.getComponent();
}
@Override
public Producer createProducer() throws Exception {
if (block) {
return new DirectVmBlockingProducer(this);
} else {
return new DirectVmProducer(this);
}
}
@Override
public Consumer createConsumer(Processor processor) throws Exception {
Consumer answer = new DirectVmConsumer(this, new DirectVmProcessor(processor, this));
configureConsumer(answer);
return answer;
}
@Override
public boolean isSingleton() {
return true;
}
public DirectVmConsumer getConsumer() {
return getComponent().getConsumer(this);
}
public boolean isBlock() {
return block;
}
/**
* If sending a message to a direct endpoint which has no active consumer,
* then we can tell the producer to block and wait for the consumer to become active.
*/
public void setBlock(boolean block) {
this.block = block;
}
public long getTimeout() {
return timeout;
}
/**
* The timeout value to use if block is enabled.
*/
public void setTimeout(long timeout) {
this.timeout = timeout;
}
public boolean isFailIfNoConsumers() {
return failIfNoConsumers;
}
/**
* Whether the producer should fail by throwing an exception, when sending to a DIRECT-VM endpoint with no active consumers.
*/
public void setFailIfNoConsumers(boolean failIfNoConsumers) {
this.failIfNoConsumers = failIfNoConsumers;
}
}