-
Notifications
You must be signed in to change notification settings - Fork 21
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
1232b7d
commit 3298cfc
Showing
31 changed files
with
95 additions
and
797 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,24 +1 @@ | ||
|
|
||
| <h1 class="d-xl-block d-none">Java WebDAV Server Example for Android</h1> | ||
| <p><span>This sample is a Class 2 WebDAV server that runs on Android. It uses modified </span>NanoHTTPD as an application server and publishes files from a mobile application folder or from media folder. L<span>ocks and properties in SQLite database.</span></p> | ||
| <p><span>To see the documents a user opens a sample web page served by this server sample in a web browser on any machine in the local network. A user can open, edit and save documents back to the device as well as a user can upload, download and manage documents using any WebDAV client.</span></p> | ||
| <h2>Requirements</h2> | ||
| <ul> | ||
| <li>Android API Level 19</li> | ||
| </ul> | ||
| <h2>Setting the License</h2> | ||
| <p>To run the example, you will need a valid IT Hit WebDAV Server Engine License. You can download the license in the <a title="Download" href="https://www.webdavsystem.com/javaserver/download/">product download area</a>. Note that the Engine is fully functional with a trial license and does not have any limitations. The trial license is valid for one month and the engine will stop working after this. You can check the expiration date inside the license file. Download the license file and specify it's content in <code class="code">License</code> field under <code class="code">DavEngineOptions</code> in <code class="code">/androidfsstorage/app/src/main/assets/webdavsettings.json</code> file.</p> | ||
| <p>You can also run the sample without explicitly specifying a license for 5 days. In this case the Engine will automatically request the trial license from IT Hit website https://www.webdavsystem.com. Make sure it is accessible via firewalls, if any. After 5 days the Engine will stop working. To extend the trial period you will need to download a license in a <a title="Download" href="https://www.webdavsystem.com/javaserver/download/">product download area</a> and specify it in <code class="code">webdavsettings.json</code></p> | ||
| <h2>Accessing files via WebDAV</h2> | ||
| <p>By default your server runs on port 8181. After running the application on Android you will see the following screen with the instructions about ho to connect:</p> | ||
| <p style="text-align: center;"><img id="__mcenew" alt="Connection instructions are displayed when you run the Android WebDAV Server." src="https://www.webdavsystem.com/media/1653/androidwebdavserver.png" rel="111413"></p> | ||
| <p>Open a web browser on any machine on the network and navigate to the WebDAV server. </p> | ||
| <h3>See Also:</h3> | ||
| <ul> | ||
| <li><a title="Running" href="https://www.webdavsystem.com/javaserver/server_examples/running_webdav_samples/">Running the WebDAV Samples</a></li> | ||
| <li><a title="Troubleshooting" href="https://www.webdavsystem.com/javaserver/server_examples/troubleshooting/">WebDAV Server Samples Problems and Troubleshooting</a></li> | ||
| </ul> | ||
| <p> </p> | ||
| <p> </p> | ||
| <h3 class="para d-inline next-article-heading">Next Article:</h3> | ||
| <a title="WebDAV Server with Versioning Example, Java" href="https://www.webdavsystem.com/javaserver/server_examples/deltav_storage/">WebDAV Server Example with Versioning, Java</a> | ||
| �� |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,87 +1 @@ | ||
|
|
||
| <h1 class="d-xl-block d-none">WebDAV Server Example with Collection Synchronization Support</h1> | ||
| <p><span>This sample is a fully functional Class 2 WebDAV server with collection synchronization support (RFC 6578) that stores all data in the file system. This sample is similar to what is provided by the Java demo WebDAV server at: https://webdavserver.com </span></p> | ||
| <p><span></span>To access this sample server and test synchronization you can use the WebDAV Drive sample for <a href="https://www.userfilesystem.com/examples/webdav_drive/">Windows</a> and <a href="https://www.userfilesystem.com/examples/webdav_drive_mac/">macOS</a>.</p> | ||
| <p><span>This sample can be downloaded in the <a title="Download" href="https://www.webdavsystem.com/javaserver/download/">product download area</a> as well as it is published on GitHub. It is available for both <a href="https://github.com/ITHit/WebDAVServerSamplesJava/tree/master/Java/jakarta/collectionsync">jakarta</a> and <a href="https://github.com/ITHit/WebDAVServerSamplesJava/tree/master/Java/javax/collectionsync">javax</a>.</span></p> | ||
| <h2>Requirements</h2> | ||
| <ul> | ||
| <li>Java 1.8.</li> | ||
| <li>Apache Tomcat 7.0+ or GlassFish v4.1.1+ or WebLogic 12c+ or JBoss WildFly 9+ or WebSphere 16.0.0.2+.</li> | ||
| <li>Windows OS</li> | ||
| <li>NTFS</li> | ||
| </ul> | ||
| <p>You will also need the <a title="AJAX Library" href="https://www.webdavsystem.com/ajax/">IT Hit WebDAV Ajax Library</a> to display JavaScript UI on a default web page. You can install it from NPM using NPM command line tool, see below. Node.js is <strong>ONLY</strong> required to download the JavaScript files used in the project. Node.js is <strong>NOT</strong> required to run the server.</p> | ||
| <h2>Running the sample</h2> | ||
| <ol> | ||
| <li><strong>Set license.</strong> Download your license file <a href="https://www.webdavsystem.com/javaserver/download/">here</a>. To set the license, edit the 'license' section in \collectionsync<em>\WEB-INF\web.xml</em> and specify the path to the <em>license.lic</em> file. <br> | ||
| <pre class="brush:xml;auto-links:false;toolbar:false"><init-param> | ||
| <param-name>license</param-name> | ||
| <param-value>C:\License.lic</param-value> | ||
| </init-param></pre> | ||
| The IT Hit Java WebDAV Server Library is fully functional and does not have any limitations. However, the trial period is limited to 1 month. After the trial period expires the Java WebDAV Server will stop working.</li> | ||
| <li><strong>Download the IT Hit WebDAV Ajax Library.</strong> You can do this with NPM command-line tool, which is included with Node.js. Install the <a href="https://nodejs.org/en/download/">Node.js</a> and navigate to <code class="code">\collectionsync\WEB-INF\wwwroot\js\</code> folder. Run: | ||
| <pre class="brush:html;auto-links:false;toolbar:false">npm install webdav.client</pre> | ||
| This will download IT Hit WebDAV Ajax Library files into your project. Note that Node.js itself is <strong>NOT</strong> required to run the server, it is used <strong>ONLY</strong> to install the required JavaScript files.</li> | ||
| <li><strong>Configure the storage folder.</strong> By default, this sample publishes documents from the <code class="code">WEB-INF/Storage</code> folder. For the sake of configuration simplicity, documents are extracted from project resources during the first run. You can publish documents from any other folder specifying a path in the 'root' section in <code class="code">web.xml</code>:<br> | ||
| <pre class="brush:xml;auto-links:false;toolbar:false"><init-param> | ||
| <param-name>root</param-name> | ||
| <param-value>C:\Storage\</param-value> | ||
| </init-param></pre> | ||
| </li> | ||
| <li><strong>Configure the application server.</strong> Here we will configure WebDAV server to run on the website root (<code class="code">http://server.com/</code>). <span class="warn"><strong>Note:</strong> While you can configure WebDAV server to run on site non-root (for instance on <code class="code">http://server.com/webdavroot/</code>) some WebDAV clients (such as some old versions or Mini-redirector, Microsoft Web Folders and MS Office 2007 and earlier) will fail to connect to non-root server. They submit configuration requests to server root and if they do not get the response they will not be able to connect. See also <a title="Working with MS Office" href="https://www.webdavsystem.com/javaserver/doc/ms_office_read_only/">Making Microsoft Office to Work with WebDAV Server</a> and <a title="Opening Docs" href="https://www.webdavsystem.com/ajax/programming/open-doc-webpage/opening_ms_office_docs/">Opening Microsoft Office Documents and Other Types of Files for Editing From a Web Page</a>.</span> | ||
| <ul> | ||
| <li><strong>In the case of Tomcat:</strong><br>Copy <em>\collectionsync</em> folder to <em><Your Tomcat location>\Tomcat x.x\webapps</em> folder. Add the following lines under the <Host> tag in <em><Your Tomcat location></em><em>\Tomcat x.x\conf\server.xml</em>:<br> | ||
| <pre class="brush:csharp;auto-links:false;toolbar:false"><Context path="" debug="0" docBase="collectionsync"> | ||
| </Context></pre> | ||
| <p><span>To see if your server is running type the root URL of your WebDAV site in a browser and you will see the list of folders. Now </span><a href="https://www.webdavsystem.com/server/access/">connect to the server with any WebDAV client</a><span>.</span></p> | ||
| <p>If you experience any problems examine the log created by tomcat: <code class="code"><Your Tomcat location>\Tomcat x.x\logs\localhost.xxxx-xx-xx.log</code>.</p> | ||
| </li> | ||
| <li><strong>In the case of Glassfish:</strong><ol type="a"> | ||
| <li>Deploy the collectionsync application. | ||
| <p>From the main tree (<em>Common Tasks</em>) goto <em>Applications</em>.</p> | ||
| <p>Press <em>Deploy</em> and specify following properties:</p> | ||
| <p> - Local Packaged File or Directory That Is Accessible from the Enterprise Server = <path to collectionsync directory></p> | ||
| <p> - Type = Web Application</p> | ||
| <p> - Context Root = /</p> | ||
| <p> Note: sample can be deployed to a non-root context, but some clients work only with servers deployed to root the context.</p> | ||
| <p> - Application Name = collectionsync</p> | ||
| </li> | ||
| <li>Launch the sample. | ||
| <p>From the main tree (<em>Common Tasks</em>) go to <em>Applications</em>.</p> | ||
| <p>Press <em>Launch</em> on collectionsync application.</p> | ||
| <p>If everything was set up properly you should see a sample page with a list of sample files and folders. Now <a href="https://www.webdavsystem.com/server/access/">connect to the server with any WebDAV client</a>.</p> | ||
| <p>If anything goes wrong please consult log usually located at <em><GLASSFISH_INSTANCE_ROOT>/logs/server.log.</em></p> | ||
| </li> | ||
| </ol></li> | ||
| <li><strong>In the case of JBoss WildFly:</strong><ol type="a"> | ||
| <li>By default WildFly restricts access to certain packages from Java SDK. So you need to allow <strong>com.sun.nio.file</strong> package in the <strong>sun/jdk </strong>module by adding the following line in the module.xml file: | ||
| <pre class="brush:xml;auto-links:false;toolbar:false"><path name="com/sun/nio/file"/></pre> | ||
| <p>Restart WildFly.</p> | ||
| </li> | ||
| <li>Deploy the collectionsync application. | ||
| <p>Create folder collectionsync<em>.war </em>under <em><em><WILDFLY_ROOT>/deployments.</em></em></p> | ||
| <p>Copy content of <em>samples/collectionsync </em>to <em><em><em><<em><em>WILDFLY_ROOT</em></em>>/deployments/collectionsync<em>.war.</em></em></em></em></p> | ||
| <p>Create file collectionsync<em>.war.dodeploy in <em><em><<em><em>WILDFLY_ROOT</em></em>>/deployments/collectionsync<em>.war.</em></em></em></em></p> | ||
| <p><span>If everything was set up properly you should see a sample page on the WildFly root context with a list of sample files and folders. Now </span><a href="https://www.webdavsystem.com/server/access/">connect to the server with any WebDAV client</a><span>.</span></p> | ||
| <p>If anything goes wrong please consult log usually located at <em><<em><em>WILDFLY_ROOT</em></em>>/log/server.log.</em></p> | ||
| </li> | ||
| </ol></li> | ||
| </ul> | ||
| </li> | ||
| </ol> | ||
| <h2>The Project Classes</h2> | ||
| <p>On the diagram below you can see the classes in the WebDAV Collectionsyncproject:</p> | ||
| <p><img id="__mcenew" alt="" src="https://www.webdavsystem.com/media/2195/syncdiagram.png" rel="124998"></p> | ||
| <p>To adapt the sample to your needs, you will modify these classes to read and write data from and into your storage. You can find more about this in <a title="Creating WebDAV Server" href="https://www.webdavsystem.com/javaserver/doc/">Creating a Class 1 WebDAV Server</a> and <a title="Class 2 / 3 Server" href="https://www.webdavsystem.com/javaserver/doc/create_class_2_webdav_server/">Creating Class 2 WebDAV Server</a> article as well as in the <a href="http://java.webdavsystem.com/">class reference documentation</a>.</p> | ||
| <p> </p> | ||
| <h3>See Also:</h3> | ||
| <ul> | ||
| <li><a title="Running" href="https://www.webdavsystem.com/javaserver/server_examples/running_webdav_samples/">Running the WebDAV Samples</a></li> | ||
| <li><a title="Troubleshooting" href="https://www.webdavsystem.com/javaserver/server_examples/troubleshooting/">WebDAV Server Samples Problems and Troubleshooting</a></li> | ||
| <li><a title="Creating WebDAV Server" href="https://www.webdavsystem.com/javaserver/doc/">Creating a Class 1 WebDAV Server</a> </li> | ||
| <li><a title="Class 2 / 3 Server" href="https://www.webdavsystem.com/javaserver/doc/create_class_2_webdav_server/">Creating a Class 2 WebDAV Server</a></li> | ||
| </ul> | ||
| <p> </p> | ||
| <p class="p1" style='color: rgba(0, 0, 0, 0.85); line-height: normal; font-family: ".SF NS"; font-size: 26px; margin-bottom: 0px; margin-left: 0px; font-stretch: normal; font-feature-settings: normal; font-variant-numeric: normal; font-variant-east-asian: normal; font-variant-alternates: normal; font-kerning: auto; font-optical-sizing: auto; font-variation-settings: normal;'>collectionsync</p> | ||
| <h3 class="para d-inline next-article-heading">Next Article:</h3> | ||
| <a title="Java WebDAV Server for Android" href="https://www.webdavsystem.com/javaserver/server_examples/android/">Java WebDAV Server Example for Android</a> | ||
| �� |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.