View Javadoc
1   /*
2    * junixsocket
3    *
4    * Copyright 2009-2024 Christian Kohlschütter
5    *
6    * Licensed under the Apache License, Version 2.0 (the "License");
7    * you may not use this file except in compliance with the License.
8    * You may obtain a copy of the License at
9    *
10   *     http://www.apache.org/licenses/LICENSE-2.0
11   *
12   * Unless required by applicable law or agreed to in writing, software
13   * distributed under the License is distributed on an "AS IS" BASIS,
14   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15   * See the License for the specific language governing permissions and
16   * limitations under the License.
17   */
18  package org.newsclub.net.unix.demo.rmi.services;
19  
20  import java.io.File;
21  import java.io.IOException;
22  import java.rmi.Remote;
23  
24  import org.newsclub.net.unix.demo.rmi.fd.StreamServer;
25  import org.newsclub.net.unix.rmi.RemoteCloseable;
26  import org.newsclub.net.unix.rmi.RemoteFileInput;
27  import org.newsclub.net.unix.rmi.RemoteFileOutput;
28  
29  /**
30   * The {@link StreamServer}'s RMI service.
31   *
32   * @author Christian Kohlschütter
33   * @see StreamServer
34   */
35  public interface StreamService extends Remote {
36    /**
37     * Opens the given file for reading.
38     *
39     * @param path The file to open.
40     * @return A remote instance for the file.
41     * @throws IOException on error.
42     */
43    RemoteCloseable<RemoteFileInput> openForReading(File path) throws IOException;
44  
45    /**
46     * Opens the given file for writing.
47     *
48     * @param path The file to open.
49     * @return A remote instance for the file.
50     * @throws IOException on error.
51     */
52    RemoteCloseable<RemoteFileOutput> openForWriting(File path) throws IOException;
53  }