Added the client API interfaces, and JSON implementation

Author: FileSysOrg

src/main/java/org/filesys/server/filesys/clientapi/ApiRequest.java

@@ -0,0 +1,37 @@
+/*
+ * Copyright (C) 2023 GK Spencer
+ *
+ * JFileServer is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Lesser General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * JFileServer is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public License
+ * along with JFileServer. If not, see <http://www.gnu.org/licenses/>.
+ */
+
+package org.filesys.server.filesys.clientapi;
+
+/**
+ * Client API Request Id Enum
+ *
+ * <p>List of basic requests that a client API may implement. The client application will probe the filesystem
+ * to see what requests the implementation supports</p>
+ *
+ * @author gkspencer
+ */
+public enum ApiRequest {
+    GetApiInfo,         // get API version and supported requests
+    CheckOutFile,       // check file(s) out
+    CheckInFile,        // check file(s) in
+    CancelCheckOut,     // cancel check out of file(s)
+    GetUrlForPath,      // return a URL for the specified path
+    GetPathStatus,      // return status for each path for a particular check type
+
+    Error               // error type for response only
+}

src/main/java/org/filesys/server/filesys/clientapi/ApiResponse.java

@@ -0,0 +1,37 @@
+/*
+ * Copyright (C) 2023 GK Spencer
+ *
+ * JFileServer is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Lesser General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * JFileServer is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public License
+ * along with JFileServer. If not, see <http://www.gnu.org/licenses/>.
+ */
+
+package org.filesys.server.filesys.clientapi;
+
+/**
+ * Client API Response Id Enum
+ *
+ * <p>List of responses that a client API may return.</p>
+ *
+ * @author gkspencer
+ */
+public enum ApiResponse {
+    GetApiInfo,         // return server API version and supported requests
+    CheckOutFile,       // checked a file out
+    CheckInFile,        // checked a file in
+    GetUrlForPath,      // return a URL for the specified path
+    GetPathStatus,      // return path status info
+    PathList,           // success response with a list of relative paths
+
+    Error,              // error message
+    Success             // when no values need to be returned
+}

src/main/java/org/filesys/server/filesys/clientapi/ClientAPI.java

@@ -0,0 +1,41 @@
+/*
+ * Copyright (C) 2023 GK Spencer
+ *
+ * JFileServer is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Lesser General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * JFileServer is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public License
+ * along with JFileServer. If not, see <http://www.gnu.org/licenses/>.
+ */
+
+package org.filesys.server.filesys.clientapi;
+
+import org.filesys.server.SrvSession;
+import org.filesys.server.filesys.TreeConnection;
+
+/**
+ * Client API Interface
+ *
+ * <p>Optional interface that a DiskInterface driver can implement to provide a client callable API where the
+ * requests/responses are tunnelled over an existing protocol connection.
+ *
+ * @author gkspencer
+ */
+public interface ClientAPI {
+
+    /**
+     * Return the client API implementation associated with this virtual filesystem
+     *
+     * @param sess SrvSession
+     * @param tree TreeConnection
+     * @return ClientAPIInterface
+     */
+    public ClientAPIInterface getClientAPI(SrvSession<?> sess, TreeConnection tree);
+}

src/main/java/org/filesys/server/filesys/clientapi/ClientAPIInterface.java

@@ -0,0 +1,64 @@
+/*
+ * Copyright (C) 2023 GK Spencer
+ *
+ * JFileServer is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Lesser General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * JFileServer is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public License
+ * along with JFileServer. If not, see <http://www.gnu.org/licenses/>.
+ */
+
+package org.filesys.server.filesys.clientapi;
+
+import org.filesys.server.SrvSession;
+import org.filesys.server.filesys.FileOpenParams;
+import org.filesys.server.filesys.NetworkFile;
+import org.filesys.server.filesys.TreeConnection;
+
+/**
+ * Client API Interface
+ *
+ * <p>Provides an optional interface that a filesystem can implement in order to handle requests from
+ * a client side application</p>
+ *
+ * @author gkspencer
+ */
+public interface ClientAPIInterface {
+
+    /**
+     * Return the path of the special file that is used to send the request to the API and receives the
+     * response data
+     *
+     * @return String
+     */
+    public String getClientAPIPath();
+
+    /**
+     * Open a network file that is used to send requests to the API from a client session, and receives the response
+     * via the file.
+     *
+     * @param sess   Server session
+     * @param tree   Tree connection
+     * @param params File open parameters
+     * @return ClientAPINetworkFile
+     * @throws java.io.IOException If an error occurs.
+     */
+    public ClientAPINetworkFile openClientAPIFile(SrvSession<?> sess, TreeConnection tree, FileOpenParams params)
+        throws java.io.IOException;
+
+    /**
+     * Process a client API request
+     *
+     * @param netFile ClientAPINetworkFile
+     * @throws java.io.IOException If an error occurs
+     */
+    public void processRequest( ClientAPINetworkFile netFile)
+        throws java.io.IOException;
+}