org.apache.camel.component.file.remote.RemoteFileEndpoint 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.camel.component.file.remote;
import java.util.Map;
import org.apache.camel.Exchange;
import org.apache.camel.Processor;
import org.apache.camel.component.file.GenericFile;
import org.apache.camel.component.file.GenericFileEndpoint;
import org.apache.camel.component.file.GenericFileExist;
import org.apache.camel.component.file.GenericFileProducer;
import org.apache.camel.processor.idempotent.MemoryIdempotentRepository;
import org.apache.camel.spi.UriParam;
import org.apache.camel.util.ObjectHelper;
/**
* Remote file endpoint.
*/
public abstract class RemoteFileEndpoint extends GenericFileEndpoint {
@UriParam(label = "advanced")
private int maximumReconnectAttempts = 3;
@UriParam(label = "advanced")
private long reconnectDelay = 1000;
@UriParam(label = "common")
private boolean disconnect;
@UriParam(label = "producer,advanced")
private boolean disconnectOnBatchComplete;
@UriParam(label = "common,advanced")
private boolean fastExistsCheck;
@UriParam(label = "consumer,advanced")
private boolean download = true;
public RemoteFileEndpoint() {
// no args constructor for spring bean endpoint configuration
// for ftp we need to use higher interval/checkout that for files
setReadLockTimeout(20000);
setReadLockCheckInterval(5000);
// explicitly set RemoteFilePollingConsumerPollStrategy otherwise
// DefaultPollingConsumerPollStrategy is be used
setPollStrategy(new RemoteFilePollingConsumerPollStrategy());
}
public RemoteFileEndpoint(String uri, RemoteFileComponent component, RemoteFileConfiguration configuration) {
super(uri, component);
this.configuration = configuration;
// for ftp we need to use higher interval/checkout that for files
setReadLockTimeout(20000);
setReadLockCheckInterval(5000);
// explicitly set RemoteFilePollingConsumerPollStrategy otherwise
// DefaultPollingConsumerPollStrategy is be used
setPollStrategy(new RemoteFilePollingConsumerPollStrategy());
}
@Override
public RemoteFileConfiguration getConfiguration() {
return (RemoteFileConfiguration) this.configuration;
}
@Override
public Exchange createExchange(GenericFile file) {
Exchange answer = super.createExchange();
if (file != null) {
file.bindToExchange(answer);
}
return answer;
}
@Override
public GenericFileProducer createProducer() throws Exception {
afterPropertiesSet();
// ensure fileExist and moveExisting is configured correctly if in use
if (getFileExist() == GenericFileExist.Move && getMoveExisting() == null) {
throw new IllegalArgumentException("You must configure moveExisting option when fileExist=Move");
} else if (getMoveExisting() != null && getFileExist() != GenericFileExist.Move) {
throw new IllegalArgumentException("You must configure fileExist=Move when moveExisting has been set");
}
return buildProducer();
}
@Override
public RemoteFileConsumer createConsumer(Processor processor) throws Exception {
afterPropertiesSet();
RemoteFileConsumer consumer = buildConsumer(processor);
if (isDelete() && getMove() != null) {
throw new IllegalArgumentException("You cannot both set delete=true and move options");
}
// if noop=true then idempotent should also be configured
if (isNoop() && !isIdempotentSet()) {
log.info("Endpoint is configured with noop=true so forcing endpoint to be idempotent as well");
setIdempotent(true);
}
// if idempotent and no repository set then create a default one
if (isIdempotentSet() && isIdempotent() && idempotentRepository == null) {
log.info("Using default memory based idempotent repository with cache max size: " + DEFAULT_IDEMPOTENT_CACHE_SIZE);
idempotentRepository = MemoryIdempotentRepository.memoryIdempotentRepository(DEFAULT_IDEMPOTENT_CACHE_SIZE);
}
if (!getConfiguration().isUseList() && getFileName() == null) {
throw new IllegalArgumentException("Endpoint is configured with useList=false, then fileName must be configured also");
}
// set max messages per poll
consumer.setMaxMessagesPerPoll(getMaxMessagesPerPoll());
consumer.setEagerLimitMaxMessagesPerPoll(isEagerMaxMessagesPerPoll());
configureConsumer(consumer);
return consumer;
}
/**
* Validates this endpoint if its configured properly.
*
* @throws Exception is thrown if endpoint is invalid configured for its mandatory options
*/
protected void afterPropertiesSet() throws Exception {
RemoteFileConfiguration config = getConfiguration();
ObjectHelper.notEmpty(config.getHost(), "host");
ObjectHelper.notEmpty(config.getProtocol(), "protocol");
}
@Override
protected Map getParamsAsMap() {
Map map = super.getParamsAsMap();
map.put("fastExistsCheck", fastExistsCheck);
return map;
}
/**
* Remote File Endpoints, impl this method to create a custom consumer specific to their "protocol" etc.
*
* @param processor the processor
* @return the created consumer
*/
protected abstract RemoteFileConsumer buildConsumer(Processor processor);
/**
* Remote File Endpoints, impl this method to create a custom producer specific to their "protocol" etc.
*
* @return the created producer
*/
protected abstract GenericFileProducer buildProducer();
/**
* Creates the operations to be used by the consumer or producer.
*
* @return a new created operations
* @throws Exception is thrown if error creating operations.
*/
public abstract RemoteFileOperations createRemoteFileOperations() throws Exception;
/**
* Returns human readable server information for logging purpose
*/
public String remoteServerInformation() {
return ((RemoteFileConfiguration) configuration).remoteServerInformation();
}
@Override
public char getFileSeparator() {
return '/';
}
@Override
public boolean isAbsolute(String name) {
return name.startsWith("/");
}
public int getMaximumReconnectAttempts() {
return maximumReconnectAttempts;
}
/**
* Specifies the maximum reconnect attempts Camel performs when it tries to connect to the remote FTP server. Use 0 to disable this behavior.
*/
public void setMaximumReconnectAttempts(int maximumReconnectAttempts) {
this.maximumReconnectAttempts = maximumReconnectAttempts;
}
public long getReconnectDelay() {
return reconnectDelay;
}
/**
* Delay in millis Camel will wait before performing a reconnect attempt.
*/
public void setReconnectDelay(long reconnectDelay) {
this.reconnectDelay = reconnectDelay;
}
public boolean isDisconnect() {
return disconnect;
}
/**
* Whether or not to disconnect from remote FTP server right after use.
* Disconnect will only disconnect the current connection to the FTP server.
* If you have a consumer which you want to stop, then you need to stop the consumer/route instead.
*/
public void setDisconnect(boolean disconnect) {
this.disconnect = disconnect;
}
public boolean isDisconnectOnBatchComplete() {
return disconnectOnBatchComplete;
}
/**
* Whether or not to disconnect from remote FTP server right after a Batch upload is complete.
* disconnectOnBatchComplete will only disconnect the current connection to the FTP server.
*/
public void setDisconnectOnBatchComplete(boolean disconnectOnBatchComplete) {
this.disconnectOnBatchComplete = disconnectOnBatchComplete;
}
public boolean isFastExistsCheck() {
return fastExistsCheck;
}
/**
* If set this option to be true, camel-ftp will use the list file directly to check if the file exists.
* Since some FTP server may not support to list the file directly, if the option is false,
* camel-ftp will use the old way to list the directory and check if the file exists.
* This option also influences readLock=changed to control whether it performs a fast check to update file information or not.
* This can be used to speed up the process if the FTP server has a lot of files.
*/
public void setFastExistsCheck(boolean fastExistsCheck) {
this.fastExistsCheck = fastExistsCheck;
}
public boolean isDownload() {
return this.download;
}
/**
* Whether the FTP consumer should download the file.
* If this option is set to false, then the message body will be null, but the consumer will still trigger a Camel
* Exchange that has details about the file such as file name, file size, etc. It's just that the file will not be downloaded.
*/
public void setDownload(boolean download) {
this.download = download;
}
}