Version 1.0.0 of the SNSExtendedClient

.gitignore

@@ -0,0 +1,4 @@
+/target/
+.idea
+*.iml
+*.DS_Store

README.md

@@ -1,13 +1,29 @@
-## My Project
+## Amazon SNS Extended Client Library for Java
 
-TODO: Fill this README out!
+The **Amazon SNS Extended Client Library for Java** enables you to publish messages that are greater than the current SNS limit of 256 KB, up to a maximum of 2 GB.
+It saves the actual payload in S3 and publishes the reference of the stored S3 object to the topic. Subscribed SQS queues can use SQSExtendedClient to dereference and retrieve the payload from S3.
 
-Be sure to:
+You can download release builds through the [releases section of this](https://github.com/awslabs/amazon-sns-java-extended-client-lib) project.
 
-* Change the title in this README
-* Edit your repository description on GitHub
+For more information on using the amazon-sns-java-extended-client-lib, see our getting started guide [here](blog post url will be added here).
 
-## License
+## Getting Started
 
-This project is licensed under the Apache-2.0 License.
+* **Sign up for AWS** -- Before you begin, you need an AWS account. For more information about creating an AWS account, see [create and activate aws account](https://aws.amazon.com/premiumsupport/knowledge-center/create-and-activate-aws-account/).
+* **Minimum requirements** Java 8 (or later) and [Maven 3](http://maven.apache.org/).
+* **Download** -- Download the [latest preview release](https://github.com/awslabs/amazon-sns-java-extended-client-lib/releases) or pick it up from Maven:
+```xml
+  <dependency>
+    <groupId>software.amazon.sns</groupId>
+    <artifactId>sns-extended-client</artifactId>
+    <version>1.0.0</version>
+    <type>jar</type>
+  </dependency>
+```
+* **Further information about Amazon SNS** - Read the [API documentation](http://aws.amazon.com/documentation/sns/).
+
+## Contribution
+See [CONTRIBUTING](CONTRIBUTING.md#security-issue-notifications) for more information.
 
+## License
+This project is licensed under the Apache-2.0 License.

VERSIONING.md

@@ -0,0 +1,20 @@
+## Versioning Policy
+
+We use a three-part X.Y.Z (Major.Minor.Patch) versioning definition, as follows:
+* X (Major) version changes are significant and expected to break backwards compatibility.
+* Y (Minor) version changes are moderate changes. These include:
+    * Significant non-breaking feature additions.
+    * Any change to the version of a dependency.
+    * Possible backwards-incompatible changes. These changes will be noted and explained in detail in the release notes.
+* Z (Patch) version changes are small changes. These changes will not break backwards compatibility.
+    * Z releases will also include warning of upcoming breaking changes, whenever possible.
+
+## What this means for you
+
+We recommend running the most recent version. Here are our suggestions for managing updates:
+
+* X changes will require some effort to incorporate.
+* Y changes will not require significant effort to incorporate.
+    * If you have good unit and integration tests, these changes are generally safe to pick up automatically.
+* Z changes will not require any changes to your code. Z changes are intended to be picked up automatically.
+    * Good unit and integration tests are always recommended.

pom.xml

@@ -0,0 +1,189 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project xmlns="http://maven.apache.org/POM/4.0.0"
+         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
+    <modelVersion>4.0.0</modelVersion>
+
+    <groupId>software.amazon.sns</groupId>
+    <artifactId>sns-extended-client</artifactId>
+    <version>1.0.0</version>
+    <packaging>jar</packaging>
+    <name>Amazon SNS Extended Client Library for Java</name>
+    <description>An extension to the Amazon SNS client that enables sending messages up to 2GB via Amazon S3.
+    </description>
+    <url>https://github.com/awslabs/amazon-sns-java-extended-client-lib</url>
+
+    <scm>
+        <url>https://github.com/awslabs/amazon-sns-java-extended-client-lib</url>
+    </scm>
+
+    <licenses>
+        <license>
+            <name>Apache License, Version 2.0</name>
+            <url>https://aws.amazon.com/apache2.0</url>
+            <distribution>repo</distribution>
+        </license>
+    </licenses>
+
+    <properties>
+        <aws-java-sdk.version>1.11.817</aws-java-sdk.version>
+    </properties>
+
+    <developers>
+        <developer>
+            <id>amazonwebservices</id>
+            <organization>Amazon Web Services</organization>
+            <organizationUrl>https://aws.amazon.com</organizationUrl>
+            <roles>
+                <role>developer</role>
+            </roles>
+        </developer>
+    </developers>
+
+    <dependencies>
+        <dependency>
+            <groupId>software.amazon.payloadoffloading</groupId>
+            <artifactId>payloadoffloading-common</artifactId>
+            <version>1.0.0</version>
+        </dependency>
+        <dependency>
+            <groupId>com.amazonaws</groupId>
+            <artifactId>amazon-sqs-java-extended-client-lib</artifactId>
+            <version>1.1.0</version>
+            <type>jar</type>
+        </dependency>
+        <dependency>
+            <groupId>com.amazonaws</groupId>
+            <artifactId>aws-java-sdk-sns</artifactId>
+            <version>${aws-java-sdk.version}</version>
+        </dependency>
+        <dependency>
+            <groupId>com.amazonaws</groupId>
+            <artifactId>aws-java-sdk-s3</artifactId>
+            <version>${aws-java-sdk.version}</version>
+        </dependency>
+        <dependency>
+            <groupId>junit</groupId>
+            <artifactId>junit</artifactId>
+            <version>4.12</version>
+            <scope>test</scope>
+        </dependency>
+        <dependency>
+            <groupId>org.mockito</groupId>
+            <artifactId>mockito-core</artifactId>
+            <version>3.3.3</version>
+            <scope>test</scope>
+        </dependency>
+        <dependency>
+            <groupId>org.hamcrest</groupId>
+            <artifactId>hamcrest-all</artifactId>
+            <version>1.3</version>
+            <scope>test</scope>
+        </dependency>
+        <dependency>
+            <groupId>pl.pragmatists</groupId>
+            <artifactId>JUnitParams</artifactId>
+            <version>1.1.1</version>
+            <scope>test</scope>
+        </dependency>
+    </dependencies>
+
+    <build>
+        <pluginManagement>
+            <plugins>
+                <plugin>
+                    <groupId>org.apache.maven.plugins</groupId>
+                    <artifactId>maven-compiler-plugin</artifactId>
+                    <version>3.8.1</version>
+                    <configuration>
+                        <source>1.8</source>
+                        <target>1.8</target>
+                        <encoding>UTF-8</encoding>
+                    </configuration>
+                </plugin>
+            </plugins>
+        </pluginManagement>
+        <plugins>
+            <plugin>
+                <groupId>org.apache.maven.plugins</groupId>
+                <artifactId>maven-source-plugin</artifactId>
+                <version>2.2.1</version>
+                <executions>
+                    <execution>
+                        <id>attach-sources</id>
+                        <goals>
+                            <goal>jar-no-fork</goal>
+                        </goals>
+                    </execution>
+                </executions>
+            </plugin>
+            <plugin>
+                <groupId>org.apache.maven.plugins</groupId>
+                <artifactId>maven-javadoc-plugin</artifactId>
+                <version>2.9.1</version>
+                <executions>
+                    <execution>
+                        <id>attach-javadocs</id>
+                        <goals>
+                            <goal>jar</goal>
+                        </goals>
+                        <configuration>
+                            <additionalparam>-Xdoclint:none</additionalparam>
+                        </configuration>
+                    </execution>
+                </executions>
+            </plugin>
+            <plugin>
+                <groupId>org.sonatype.plugins</groupId>
+                <artifactId>nexus-staging-maven-plugin</artifactId>
+                <version>1.6.7</version>
+                <extensions>true</extensions>
+                <configuration>
+                    <serverId>ossrh</serverId>
+                    <nexusUrl>https://aws.oss.sonatype.org</nexusUrl>
+                    <autoReleaseAfterClose>true</autoReleaseAfterClose>
+                </configuration>
+            </plugin>
+        </plugins>
+    </build>
+
+    <profiles>
+        <profile>
+            <id>publishing</id>
+            <distributionManagement>
+                <snapshotRepository>
+                    <id>ossrh</id>
+                    <url>https://aws.oss.sonatype.org/content/repositories/snapshots</url>
+                </snapshotRepository>
+                <repository>
+                    <id>ossrh</id>
+                    <url>https://aws.oss.sonatype.org/service/local/staging/deploy/maven2/</url>
+                </repository>
+            </distributionManagement>
+            <build>
+                <plugins>
+                    <plugin>
+                        <groupId>org.apache.maven.plugins</groupId>
+                        <artifactId>maven-gpg-plugin</artifactId>
+                        <version>1.6</version>
+                        <executions>
+                            <execution>
+                                <id>sign-artifacts</id>
+                                <phase>verify</phase>
+                                <goals>
+                                    <goal>sign</goal>
+                                </goals>
+                                <configuration>
+                                    <gpgArguments>
+                                        <gpgArgument>--pinentry-mode</gpgArgument>
+                                        <gpgArgument>loopback</gpgArgument>
+                                    </gpgArguments>
+                                </configuration>
+                            </execution>
+                        </executions>
+                    </plugin>
+                </plugins>
+            </build>
+        </profile>
+    </profiles>
+</project>