Merge pull request #2 from xdev-software/develop

v0.0.1

Author: JohannesRabauer

CONTRIBUTING.md

@@ -33,10 +33,13 @@ You should have the following things installed:
   * Ensure that the JDK/Java-Version is correct
 
 
-## Releasing [![Build](https://img.shields.io/github/actions/workflow/status/xdev-software/standard-maven-template/release.yml?branch=master)](https://github.com/xdev-software/standard-maven-template/actions/workflows/release.yml)
+## Releasing [![Build](https://img.shields.io/github/actions/workflow/status/xdev-software/eclipse-store-afs-ibm-cos/release.yml?branch=master)](https://github.com/xdev-software/eclipse-store-afs-ibm-cos/actions/workflows/release.yml)
 
 Before releasing:
-* Consider doing a [test-deployment](https://github.com/xdev-software/standard-maven-template/actions/workflows/test-deploy.yml?query=branch%3Adevelop) before actually releasing.
+
+* Consider doing
+  a [test-deployment](https://github.com/xdev-software/eclipse-store-afs-ibm-cos/actions/workflows/test-deploy.yml?query=branch%3Adevelop)
+  before actually releasing.
 * Check the [changelog](CHANGELOG.md)
 
 If the ``develop`` is ready for release, create a pull request to the ``master``-Branch and merge the changes

README.md

@@ -1,19 +1,44 @@
-[![Latest version](https://img.shields.io/maven-central/v/com.xdev-software/standard-maven-template?logo=apache%20maven)](https://mvnrepository.com/artifact/com.xdev-software/standard-maven-template)
-[![Build](https://img.shields.io/github/actions/workflow/status/xdev-software/standard-maven-template/checkBuild.yml?branch=develop)](https://github.com/xdev-software/standard-maven-template/actions/workflows/checkBuild.yml?query=branch%3Adevelop)
-[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=xdev-software_standard-maven-template&metric=alert_status)](https://sonarcloud.io/dashboard?id=xdev-software_standard-maven-template)
+[![Latest version](https://img.shields.io/maven-central/v/com.xdev-software/eclipse-store-afs-ibm-cos?logo=apache%20maven)](https://mvnrepository.com/artifact/com.xdev-software/eclipse-store-afs-ibm-cos)
+[![Build](https://img.shields.io/github/actions/workflow/status/xdev-software/eclipse-store-afs-ibm-cos/checkBuild.yml?branch=develop)](https://github.com/xdev-software/eclipse-store-afs-ibm-cos/actions/workflows/checkBuild.yml?query=branch%3Adevelop)
+[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=xdev-software_eclipse-store-afs-ibm-cos&metric=alert_status)](https://sonarcloud.io/dashboard?id=xdev-software_eclipse-store-afs-ibm-cos)
 
-# standard-maven-template
+# eclipse-store-afs-ibm-cos
 
+A connector for the [EclipseStore](https://eclipsestore.io/) which allows storing data in
+the [IBM Cloud Object Storage](https://www.ibm.com/cloud/object-storage).
+
+It uses the [IBM-provided Java SDK](https://github.com/IBM/ibm-cos-sdk-java).
+
+The connector works virtually identical to
+the [AWS S3 Connector](https://docs.eclipsestore.io/manual/storage/storage-targets/blob-stores/aws-s3.html) of
+EclipseStore
+but for IBM COS instead of AWS S3.
+
+> **Note**
+> This library is still version 0.0.1 since EclipseStore is not yet released in version 1.0.0.
 
 ## Installation
-[Installation guide for the latest release](https://github.com/xdev-software/standard-maven-template/releases/latest#Installation)
 
+[Installation guide for the latest release](https://github.com/xdev-software/eclipse-store-afs-ibm-cos/releases/latest#Installation)
+
+## Supported EclipseStore versions
+
+The connector supports
+[version 1.0.0 of the EclipseStore](https://central.sonatype.com//artifact/org.eclipse.store/storage-embedded/01.00.00).
+
+If you are using a different, not listed version of EclipseStore, this shouldn't be a problem.
+Usually you can simply exclude the dependent version of EclipseStore.
 
 ## Support
-If you need support as soon as possible and you can't wait for any pull request, feel free to use [our support](https://xdev.software/en/services/support).
+
+If you need support as soon as possible and you can't wait for any pull request, feel free to
+use [our support](https://xdev.software/en/services/support).
 
 ## Contributing
+
 See the [contributing guide](./CONTRIBUTING.md) for detailed instructions on how to get started with our project.
 
 ## Dependencies and Licenses
-View the [license of the current project](LICENSE) or the [summary including all dependencies](https://xdev-software.github.io/standard-maven-template/dependencies/)
+
+View the [license of the current project](LICENSE) or
+the [summary including all dependencies](https://xdev-software.github.io/eclipse-store-afs-ibm-cos/dependencies/)

SECURITY.md

@@ -2,4 +2,5 @@
 
 ## Reporting a Vulnerability
 
-Please report a security vulnerability [on GitHub Security Advisories](https://github.com/xdev-software/standard-maven-template/security/advisories/new).
+Please report a security
+vulnerability [on GitHub Security Advisories](https://github.com/xdev-software/eclipse-store-afs-ibm-cos/security/advisories/new).

eclipse-store-afs-ibm-cos-demo/pom.xml

@@ -6,15 +6,15 @@
 
 	<groupId>com.xdev-software</groupId>
 	<artifactId>eclipse-store-afs-ibm-cos-demo</artifactId>
-	<version>1.0.0-SNAPSHOT</version>
+	<version>0.0.1-SNAPSHOT</version>
 	<packaging>jar</packaging>
 
 	<inceptionYear>2023</inceptionYear>
 
 	<parent>
 		<groupId>com.xdev-software</groupId>
 		<artifactId>eclipse-store-afs-ibm-cos-root</artifactId>
-		<version>1.0.0-SNAPSHOT</version>
+		<version>0.0.1-SNAPSHOT</version>
 	</parent>
 
 	<organization>

eclipse-store-afs-ibm-cos-demo/src/main/java/software/xdev/eclipse/store/App.java

@@ -30,6 +30,9 @@ public class App
 
 	private static final Logger LOG = LoggerFactory.getLogger(App.class);
 
+	/**
+	 * This function connects to the IBM COS and writes one million String-Entries on it.
+	 */
 	public static void main(final String[] args)
 	{
 		final List<String> stringList = new ArrayList<>();
@@ -67,13 +70,11 @@ public static AmazonS3 createClient(
 		final ClientConfiguration clientConfig = new ClientConfiguration().withRequestTimeout(-1);
 		clientConfig.setUseTcpKeepAlive(true);
 
-		final AmazonS3 cos = AmazonS3ClientBuilder.standard()
+		return AmazonS3ClientBuilder.standard()
 			.withCredentials(new AWSStaticCredentialsProvider(credentials))
 			.withEndpointConfiguration(new AwsClientBuilder.EndpointConfiguration(endpoint_url, location))
 			.withPathStyleAccessEnabled(true)
 			.withClientConfiguration(clientConfig)
 			.build();
-		
-		return cos;
 	}
 }

eclipse-store-afs-ibm-cos/pom.xml

@@ -6,13 +6,13 @@
 
 	<groupId>com.xdev-software</groupId>
 	<artifactId>eclipse-store-afs-ibm-cos</artifactId>
-	<version>1.0.0-SNAPSHOT</version>
+	<version>0.0.1-SNAPSHOT</version>
 	<packaging>jar</packaging>
 
 	<parent>
 		<groupId>com.xdev-software</groupId>
 		<artifactId>eclipse-store-afs-ibm-cos-root</artifactId>
-		<version>1.0.0-SNAPSHOT</version>
+		<version>0.0.1-SNAPSHOT</version>
 	</parent>
 
 	<name>eclipse-store-afs-ibm-cos</name>

pom.xml

@@ -6,7 +6,7 @@
 
 	<groupId>com.xdev-software</groupId>
 	<artifactId>eclipse-store-afs-ibm-cos-root</artifactId>
-	<version>1.0.0-SNAPSHOT</version>
+	<version>0.0.1-SNAPSHOT</version>
 	<packaging>pom</packaging>
 
 	<organization>