001    /**
002     * Licensed to the Apache Software Foundation (ASF) under one or more
003     * contributor license agreements.  See the NOTICE file distributed with
004     * this work for additional information regarding copyright ownership.
005     * The ASF licenses this file to You under the Apache License, Version 2.0
006     * (the "License"); you may not use this file except in compliance with
007     * the License.  You may obtain a copy of the License at
008     *
009     *      http://www.apache.org/licenses/LICENSE-2.0
010     *
011     * Unless required by applicable law or agreed to in writing, software
012     * distributed under the License is distributed on an "AS IS" BASIS,
013     * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
014     * See the License for the specific language governing permissions and
015     * limitations under the License.
016     */
017    package org.apache.camel.component.file.remote;
018    
019    import org.apache.camel.component.file.GenericFileOperationFailedException;
020    import org.apache.camel.component.file.GenericFileOperations;
021    
022    
023    /**
024     * Remote file operations based on some backing framework
025     */
026    public interface RemoteFileOperations<T> extends GenericFileOperations<T> {
027    
028        /**
029         * Connects to the remote server
030         *
031         * @param configuration configuraiton
032         * @return true if connected
033         * @throws GenericFileOperationFailedException can be thrown
034         */
035        boolean connect(RemoteFileConfiguration configuration) throws GenericFileOperationFailedException;
036    
037        /**
038         * Returns whether we are connected to the remote server or not
039         *
040         * @return true if connected, false if not
041         * @throws GenericFileOperationFailedException can be thrown
042         */
043        boolean isConnected() throws GenericFileOperationFailedException;
044    
045        /**
046         * Discconects from the remote server
047         *
048         * @throws GenericFileOperationFailedException can be thrown
049         */
050        void disconnect() throws GenericFileOperationFailedException;
051    
052    }