sis-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From desruisse...@apache.org
Subject [sis] 04/04: Prepare packaging of JavaFX application.
Date Wed, 12 Aug 2020 17:32:59 GMT
This is an automated email from the ASF dual-hosted git repository.

desruisseaux pushed a commit to branch geoapi-4.0
in repository https://gitbox.apache.org/repos/asf/sis.git

commit 39ec26db5db45d164ef9d87f63d15e90f92b7600
Author: Martin Desruisseaux <martin.desruisseaux@geomatys.com>
AuthorDate: Wed Aug 12 18:57:45 2020 +0200

    Prepare packaging of JavaFX application.
---
 application/sis-javafx/pom.xml                     | 30 ++++++++
 application/sis-javafx/src/main/artifact/LICENSE   |  1 +
 application/sis-javafx/src/main/artifact/NOTICE    |  1 +
 application/sis-javafx/src/main/artifact/README    | 86 ++++++++++++++++++++++
 application/sis-javafx/src/main/artifact/bin/sisfx | 33 +++++++++
 .../src/main/artifact/conf/logging.properties      | 62 ++++++++++++++++
 .../sis-javafx/src/main/artifact/data/README       |  1 +
 .../sis-javafx/src/main/artifact/lib/README        |  8 ++
 .../sis-javafx/src/main/artifact/log/README        |  3 +
 9 files changed, 225 insertions(+)

diff --git a/application/sis-javafx/pom.xml b/application/sis-javafx/pom.xml
index 11e905a..a46fb6e 100644
--- a/application/sis-javafx/pom.xml
+++ b/application/sis-javafx/pom.xml
@@ -147,12 +147,18 @@
     <dependency>
       <groupId>jakarta.xml.bind</groupId>
       <artifactId>jakarta.xml.bind-api</artifactId>
+      <scope>compile</scope>
     </dependency>
     <dependency>
       <groupId>org.glassfish.jaxb</groupId>
       <artifactId>jaxb-runtime</artifactId>
       <scope>runtime</scope>
     </dependency>
+    <dependency>
+      <groupId>org.apache.derby</groupId>
+      <artifactId>derby</artifactId>
+      <scope>runtime</scope>
+    </dependency>
 
     <!-- Test dependencies -->
     <dependency>
@@ -165,6 +171,30 @@
   </dependencies>
 
   <profiles>
+    <!--
+      Create the binary distribution file. Can also be launch from the command-line with:
+      mvn package org.apache.sis.core:sis-build-helper:dist
+    -->
+    <profile>
+      <id>apache-release</id>
+      <build>
+        <plugins>
+          <plugin>
+            <groupId>org.apache.sis.core</groupId>
+            <artifactId>sis-build-helper</artifactId>
+            <version>${sis.plugin.version}</version>
+            <executions>
+              <execution>
+                <goals>
+                  <goal>dist</goal>
+                </goals>
+              </execution>
+            </executions>
+          </plugin>
+        </plugins>
+      </build>
+    </profile>
+
     <!-- Dependencies under GPL + classpath exception included only if explicitly requested.
-->
     <profile>
       <id>javafx</id>
diff --git a/application/sis-javafx/src/main/artifact/LICENSE b/application/sis-javafx/src/main/artifact/LICENSE
new file mode 120000
index 0000000..2a64f9d
--- /dev/null
+++ b/application/sis-javafx/src/main/artifact/LICENSE
@@ -0,0 +1 @@
+../../../../../LICENSE
\ No newline at end of file
diff --git a/application/sis-javafx/src/main/artifact/NOTICE b/application/sis-javafx/src/main/artifact/NOTICE
new file mode 120000
index 0000000..1fb5281
--- /dev/null
+++ b/application/sis-javafx/src/main/artifact/NOTICE
@@ -0,0 +1 @@
+../../../../../NOTICE
\ No newline at end of file
diff --git a/application/sis-javafx/src/main/artifact/README b/application/sis-javafx/src/main/artifact/README
new file mode 100644
index 0000000..1ab254c
--- /dev/null
+++ b/application/sis-javafx/src/main/artifact/README
@@ -0,0 +1,86 @@
+=============================================
+Welcome to Apache SIS <http://sis.apache.org>
+=============================================
+
+SIS is a project of the Apache Software Foundation <https://www.apache.org>
+for developing geospatial applications in the Java programming language.
+The library can be used for desktop or server applications.
+
+Apache SIS, SIS, Apache, the Apache feather logo, and the Apache SIS
+project logo are trademarks of The Apache Software Foundation.
+
+
+Installation
+============
+
+For developing applications using the SIS library or for using on command-line,
+the only requirement is Java 8 or later. For launching the desktop application,
+requirements are Java 11 or later and JavaFX 13 or later.
+
+1) Unzip `apache-sis-1.1-bin.zip` in any directory.
+2) Add the `apache-sis-1.1/bin` directory to the path.
+3) Invoke `sis` or `sisfx` on the command line.
+
+
+Configuration (Unix only)
+=========================
+
+A `SIS_OPTS` environment variable can optionally be set for specifying options
+to be given to any execution of Apache SIS. For example for setting the
+encoding to UTF-8:
+
+    export SIS_OPTS="--encoding UTF-8"
+
+Optional dependencies can be added to the `lib` folder. For example adding the
+UCAR netCDF library in the `lib` folder will allow Apache SIS to decode a wider
+range of file formats like NcML files.
+
+
+License (see also LICENSE)
+==========================
+
+Collective work: Copyright 2010-2020 The Apache Software Foundation.
+
+Licensed to the Apache Software Foundation (ASF) under one or more
+contributor license agreements.  See the NOTICE file distributed with
+this work for additional information regarding copyright ownership.
+The ASF licenses this file to You under the Apache License, Version 2.0
+(the "License"); you may not use this file except in compliance with
+the License.  You may obtain a copy of the License at
+
+     http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+
+Apache SIS includes a number of subcomponents with separate copyright
+notices and license terms. Your use of these subcomponents is subject
+to the terms and conditions of the licenses listed in the LICENSE file.
+
+
+Mailing Lists
+=============
+
+Discussion about SIS takes place on the following mailing lists:
+
+    user@sis.apache.org    - About using SIS
+    dev@sis.apache.org     - About developing SIS
+
+The mailing lists are open to anyone and publicly archived.
+
+You can subscribe the mailing lists by sending a message to
+<LIST>-subscribe@sis.apache.org (for example user-subscribe@...).
+To unsubscribe, send a message to <LIST>-unsubscribe@sis.apache.org.
+For more instructions, send a message to <LIST>-help@sis.apache.org.
+
+
+Issue Tracker
+=============
+
+If you encounter errors in SIS or want to suggest an improvement or a new feature,
+please visit the SIS issue tracker at https://issues.apache.org/jira/browse/SIS
+There you can also find the latest information on known issues and recent bug fixes
+and enhancements.
diff --git a/application/sis-javafx/src/main/artifact/bin/sisfx b/application/sis-javafx/src/main/artifact/bin/sisfx
new file mode 100755
index 0000000..89b0086
--- /dev/null
+++ b/application/sis-javafx/src/main/artifact/bin/sisfx
@@ -0,0 +1,33 @@
+#!/bin/sh
+# ------------------------------------------------------------------------
+# Licensed to the Apache Software Foundation (ASF) under one or more
+# contributor license agreements.  See the NOTICE file distributed with
+# this work for additional information regarding copyright ownership.
+# The ASF licenses this file to you under the Apache License, Version 2.0
+# (the "License"); you may not use this file except in compliance with the
+# License.  You may obtain a copy of the License at
+#
+#    http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+# ------------------------------------------------------------------------
+
+set -o errexit
+
+BASE_DIR="`readlink --canonicalize-existing $0`"
+BASE_DIR="`dirname $BASE_DIR`/.."
+SIS_DATA="${SIS_DATA:-$BASE_DIR/data}"
+export SIS_DATA
+
+# Execute SIS with any optional JAR that the user may put in the `lib` directory.
+java --add-modules javafx.graphics,javafx.controls \
+     --module-path $PATH_TO_FX \
+     --class-path "$BASE_DIR/lib/*" \
+     -Djava.util.logging.config.file="$BASE_DIR/conf/logging.properties" \
+     -Djava.util.logging.FileHandler.pattern="$BASE_DIR/log/system.log" \
+     -Dderby.stream.error.file="$BASE_DIR/log/derby.log" \
+     org.apache.sis.gui.DataViewer $SIS_OPTS "$@"
diff --git a/application/sis-javafx/src/main/artifact/conf/logging.properties b/application/sis-javafx/src/main/artifact/conf/logging.properties
new file mode 100644
index 0000000..0ccf4a9
--- /dev/null
+++ b/application/sis-javafx/src/main/artifact/conf/logging.properties
@@ -0,0 +1,62 @@
+#
+# Logging configuration file for Apache SIS application.
+#
+# This file is similar to the default configuration file
+# provided in Java installation directory,  but contains
+# configuration that are specific to Apache SIS library.
+# The default configuration file is located at:
+#
+#   $JAVA_HOME/conf/logging.properties
+#
+# This file can be freely edited as documented below,
+# or as documented in the above-cited standard file.
+#
+
+
+# Comma separated list of log Handler classes.
+# Handlers specify where the logs will be sent.
+# Some available handlers are:
+#
+#   - java.util.logging.ConsoleHandler
+#   - java.util.logging.FileHandler
+#   - java.util.logging.SocketHandler
+#
+# See their javadoc for more information on those handlers.
+
+handlers = java.util.logging.FileHandler, \
+           java.util.logging.ConsoleHandler
+
+
+# Filter the log records according their logging levels.
+# Filtering is applied:
+#
+#   - By package (CONFIG for SIS, INFO for everything else).
+#   - By handler (WARNING for console, ALL for log file).
+
+.level = INFO
+org.apache.sis.level = CONFIG
+java.util.logging.ConsoleHandler.level = WARNING
+
+
+# Appearance of log messages. Some available formatters are:
+#
+#   - java.util.logging.XMLFormatter
+#   - java.util.logging.SimpleFormatter
+#   - org.apache.sis.util.logging.MonolineFormatter
+#
+# By default, MonolineFormatter displays only the log level
+# and the message. Additional options can be specified here:
+#
+# time:   If set, writes the time elapsed since initialization.
+#         The argument specifies the output pattern. For example,
+#         the "HH:mm:ss.SSSS" pattern displays the hours, minutes,
+#         seconds and milliseconds.
+#
+# source: If set, writes the source logger name or the source class name.
+#         Valid argument values are "none", "logger:short", "logger:long",
+#         "class:short", "class:long" and "class.method".
+
+java.util.logging.FileHandler.formatter    = org.apache.sis.util.logging.MonolineFormatter
+java.util.logging.ConsoleHandler.formatter = org.apache.sis.util.logging.MonolineFormatter
+org.apache.sis.util.logging.MonolineFormatter.source = logger:long
+org.apache.sis.util.logging.MonolineFormatter.colors = false
diff --git a/application/sis-javafx/src/main/artifact/data/README b/application/sis-javafx/src/main/artifact/data/README
new file mode 120000
index 0000000..3c37ba6
--- /dev/null
+++ b/application/sis-javafx/src/main/artifact/data/README
@@ -0,0 +1 @@
+../../../../../sis-console/src/main/artifact/data/README
\ No newline at end of file
diff --git a/application/sis-javafx/src/main/artifact/lib/README b/application/sis-javafx/src/main/artifact/lib/README
new file mode 100644
index 0000000..db5e0b1
--- /dev/null
+++ b/application/sis-javafx/src/main/artifact/lib/README
@@ -0,0 +1,8 @@
+This directory contains Apache SIS files together with dependencies.
+
+  - Derby database
+  - JAXB API
+  - JAXB implementation  (optional)
+  - UCAR netCDF library  (optional)
+  - ESRI Geometry API    (optional)
+  - Java Topology Suite  (optional)
diff --git a/application/sis-javafx/src/main/artifact/log/README b/application/sis-javafx/src/main/artifact/log/README
new file mode 100644
index 0000000..1a20bbf
--- /dev/null
+++ b/application/sis-javafx/src/main/artifact/log/README
@@ -0,0 +1,3 @@
+This directory contains log messages produced by the system
+(Java + SIS + other applications), and a separated file for
+logs from Derby database.


Mime
View raw message