diff --git a/ccm-xafilesystemadapter/pom.xml b/ccm-xafilesystemadapter/pom.xml index 49e4bacf0..612e4ce8e 100644 --- a/ccm-xafilesystemadapter/pom.xml +++ b/ccm-xafilesystemadapter/pom.xml @@ -15,10 +15,18 @@ 1.0.0-SNAPSHOT ccm-xafilesystemadapter - http://www.libreccm.org + + + + Lesser GPL 2.1 + http://www.gnu.org/licenses/old-licenses/lgpl-2.1 + + UTF-8 + ${maven.build.timestamp} + yyyy-MM-dd'T'HH:mm:ss'Z'Z @@ -49,4 +57,156 @@ + + ccm-xafilesystemadapter + + + + org.apache.maven.plugins + maven-compiler-plugin + + 1.8 + 1.8 + true + true + ${project.build.sourceEncoding} + + + + org.apache.maven.plugins + maven-surefire-plugin + + org.libreccm.tests.categories.UnitTest + false + + + + + + + + + org.apache.maven.plugins + maven-javadoc-plugin + 2.10.3 + + true + true + + http://docs.oracle.com/javase/7/docs/api/ + http://docs.oracle.com/javaee/7/api/ + http://docs.jboss.org/hibernate/orm/4.3/javadocs/ + + private + true + UTF-8 + UTF-8 + UTF-8 + true + true + true + true + false + org.jboss.apiviz.APIviz + + org.jboss.apiviz + apiviz + 1.3.2.GA + + true + + -sourceclasspath ${project.build.outputDirectory} + + + + + + org.apache.maven.plugins + maven-jxr-plugin + 2.5 + + + org.apache.maven.plugins + maven-surefire-report-plugin + 2.19.1 + + false + + + + org.jacoco + jacoco-maven-plugin + 0.7.8 + + + org.codehaus.mojo + findbugs-maven-plugin + 3.0.3 + + + + org.apache.maven.plugins + maven-pmd-plugin + 3.7 + + true + utf-8 + 1.8 + + /rulesets/java/basic.xml + /rulesets/java/braces.xml + /rulesets/java/clone.xml + /rulesets/java/codesize.xml + /rulesets/java/design.xml + /rulesets/java/empty.xml + /rulesets/java/finalizers.xml + /rulesets/java/imports.xml + /rulesets/java/junit.xml + /rulesets/java/naming.xml + /rulesets/java/optimizations.xml + /rulesets/java/strictexception.xml + /rulesets/java/strings.xml + /rulesets/java/sunsecure.xml + /rulesets/java/typeresolution.xml + /rulesets/java/unnecessary.xml + /rulesets/java/unusedcode.xml + + + + + org.codehaus.mojo + jdepend-maven-plugin + 2.0 + + + org.codehaus.mojo + taglist-maven-plugin + 2.4 + + + org.apache.maven.plugins + maven-project-info-reports-plugin + 2.9 + + + + dependencies + + license + + + + + + false + + + + + diff --git a/ccm-xafilesystemadapter/src/main/java/org/libreccm/files/XAFileSystemAdapter.java b/ccm-xafilesystemadapter/src/main/java/org/libreccm/files/XAFileSystemAdapter.java index cf5f8b77b..2f3b6618e 100644 --- a/ccm-xafilesystemadapter/src/main/java/org/libreccm/files/XAFileSystemAdapter.java +++ b/ccm-xafilesystemadapter/src/main/java/org/libreccm/files/XAFileSystemAdapter.java @@ -40,7 +40,8 @@ import javax.transaction.Transactional; * application server and that a resource adapter is configured to provided * access to the file system. Please refer the documentation of this module * for more information. - * + * + * @see http://xadisk.java.net * * @author Jens Pelzetter */ diff --git a/ccm-xafilesystemadapter/src/site/markdown/conf-wildfly_10_1_0.md b/ccm-xafilesystemadapter/src/site/markdown/conf-wildfly_10_1_0.md new file mode 100644 index 000000000..18e2324e7 --- /dev/null +++ b/ccm-xafilesystemadapter/src/site/markdown/conf-wildfly_10_1_0.md @@ -0,0 +1,66 @@ +XAFileSystem configuration for Wildfly +====================================== + +The following instructions are for Wildfly 10.1.0.FINAL but should also work on +earlier or later versions. + +1. Download XADisk from [xadisk.java.net]: [http://java.net/projects/xadisk/downloads/download/XADisk%201.2.2%20Everything.zip] + +2. Extract the ZIP file + +3. Deploy the `XADisk.rar` file found in `binaries` directory of the extracted + ZIP file to your Wildfly installation, either by using the administration UI + of Wildfly or by copying the file to the `deployments` directory of your + Wildfly installation. + +4. Create a new resource adapter, either by using the Wildfly administration UI + or the editing the configuration file of your Wildfly installation. + + Configuration of the resource adapter via the Wildfly Administration Console: + + ![Wildfly Configuration Attributes](resources/wildfly_conf_attributes.png) + + ![Wildfly Configuration Properties](resources/wildfly_conf_properties.png) + + ![Wildfly Connection Definition Attributes](resources/wildfly_connectiondef_attributes.png) + + ![Wildfly Connection Definition Properties](resources/wildfly_connectiondef_properties.png) + + Or if you prefer to edit the XML file add the following configuration in + the subsystem section for resource adapters: + + + + + + XADisk.rar + + XATransaction + + xadisk1 + + + /path/to/xahome + + + + + xadisk1 + + + 1 + 5 + + + + + + + + The name of the instance id can be choosen freely, as the id of the resource + adapter. The `xaDiskHome` property must point to an existing directory. This + directory is used by XADisk to store various data. The property does *not* + limit the paths XADisk can access. + +5. Configure the directory where LibreCCM should store its data by setting + the `dataPath` property of the `CcmFilesConfiguration`. diff --git a/ccm-xafilesystemadapter/src/site/markdown/index.md b/ccm-xafilesystemadapter/src/site/markdown/index.md new file mode 100644 index 000000000..7d69a971a --- /dev/null +++ b/ccm-xafilesystemadapter/src/site/markdown/index.md @@ -0,0 +1,24 @@ + ----------------------- + The XAFileSystemAdapter + ----------------------- + Jens Pelzetter + ----------------------- + 2017-03-27 + ----------------------- + +This (Maven) module provides an implementation of the {@link FileSystemAdapter} +which uses [XADisk](http://xadisk.java.net) to provides a transaction safe +access to the file system. + +# Including into a CCM Bundle + +Simply add the `ccm-xafilesystemadapter` as a dependency in the bundle. The +`CCMFiles` class in ccm-core will automatically find and use the adapter. + +# Configuration + +The XADisk file system adapter uses a JCA resource adapter which needs to be +installed and configured into the application server. Pleae refer to the +installation guides for your application server for more information. + + diff --git a/ccm-xafilesystemadapter/src/site/resources/wildfly_conf_attributes.png b/ccm-xafilesystemadapter/src/site/resources/wildfly_conf_attributes.png new file mode 100644 index 000000000..b58738568 Binary files /dev/null and b/ccm-xafilesystemadapter/src/site/resources/wildfly_conf_attributes.png differ diff --git a/ccm-xafilesystemadapter/src/site/resources/wildfly_conf_properties.png b/ccm-xafilesystemadapter/src/site/resources/wildfly_conf_properties.png new file mode 100644 index 000000000..280e67b39 Binary files /dev/null and b/ccm-xafilesystemadapter/src/site/resources/wildfly_conf_properties.png differ diff --git a/ccm-xafilesystemadapter/src/site/resources/wildfly_connectiondef_attributes.png b/ccm-xafilesystemadapter/src/site/resources/wildfly_connectiondef_attributes.png new file mode 100644 index 000000000..d88b9b59c Binary files /dev/null and b/ccm-xafilesystemadapter/src/site/resources/wildfly_connectiondef_attributes.png differ diff --git a/ccm-xafilesystemadapter/src/site/resources/wildfly_connectiondef_properties.png b/ccm-xafilesystemadapter/src/site/resources/wildfly_connectiondef_properties.png new file mode 100644 index 000000000..d8f172f9d Binary files /dev/null and b/ccm-xafilesystemadapter/src/site/resources/wildfly_connectiondef_properties.png differ diff --git a/ccm-xafilesystemadapter/src/site/site.xml b/ccm-xafilesystemadapter/src/site/site.xml new file mode 100644 index 000000000..16f4228dd --- /dev/null +++ b/ccm-xafilesystemadapter/src/site/site.xml @@ -0,0 +1,28 @@ + + + + + + + + + + + + + + + + + +