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     * Remote file operations based on some backing framework
024     */
025    public interface RemoteFileOperations<T> extends GenericFileOperations<T> {
026    
027        /**
028         * Connects to the remote server
029         *
030         * @param configuration configuration
031         * @return true if connected
032         * @throws GenericFileOperationFailedException can be thrown
033         */
034        boolean connect(RemoteFileConfiguration configuration) throws GenericFileOperationFailedException;
035    
036        /**
037         * Returns whether we are connected to the remote server or not
038         *
039         * @return true if connected, false if not
040         * @throws GenericFileOperationFailedException can be thrown
041         */
042        boolean isConnected() throws GenericFileOperationFailedException;
043    
044        /**
045         * Disconnects from the remote server
046         *
047         * @throws GenericFileOperationFailedException can be thrown
048         */
049        void disconnect() throws GenericFileOperationFailedException;
050    
051        /**
052         * Sends a noop command to the remote server
053         *
054         * @throws GenericFileOperationFailedException can be thrown
055         * @return <tt>true</tt> if the noop was a success, <tt>false</tt> otherwise
056         */
057        boolean sendNoop() throws GenericFileOperationFailedException;
058    
059    }