readme update with install and configure instructions. support for bintray deployments

Author: glicht

README.md

@@ -10,13 +10,28 @@ This project aims at providing an alternate parameter whitelist with support for
 Services added in the provided parameter whitelist:
 * S3 - Request parameters: BucketName, Key, VersionId, Prefix
 
+Parameter whitelist file is available: [here](https://github.com/functionalone/aws-xray-parameter-whitelist-java/blob/master/src/main/resources/com/github/functionalone/xray/handlers/ExtendedOperationParameterWhitelist.json).
+
 # Installation
 
-Project provides a drop-in replacement jar which should be used instead of the AWS X-Ray SDK jar of: `aws-xray-recorder-sdk-aws-sdk-instrumentor`. The project jar includes the alternate configuration for the X-Ray tracing request handler. 
+Project provides a drop-in replacement jar which should be used instead of the AWS X-Ray SDK jar of: `aws-xray-recorder-sdk-aws-sdk-instrumentor`. The project jar includes the alternate configuration for the X-Ray tracing request handler. This means that you can simply use the provided jar without any source code modifications, same way as the original `aws-xray-recorder-sdk-aws-sdk-instrumentor` is used.
 
 ## Adding the Jar as a Dependency
 
-Stay tuned. We are still in the process of publishing the project to JCenter.
+Build artifacts are available via Bintray's JCenter. Project binary distributions are available at: https://bintray.com/functionalone/maven/aws-xray-parameter-whitelist-instrumentor. To add the jar as a dependency, you will need to use the jcenter repository. For example, if you are using Gradle you will need to add the following section to the repositories closure:
+
+```
+repositories {
+    jcenter()
+}
+```
+
+And then add the following compilation dependency:
+```
+compile 'com.github.functionalone:aws-xray-parameter-whitelist-instrumentor:<version>'
+```
+
+Make sure to remove the `aws-xray-recorder-sdk-aws-sdk-instrumentor` compile dependency.
 
 ## Compiling from Source
 
@@ -27,4 +42,9 @@ Clone (or download) the project. Then run:
 ```
 Target jar will be created at: `build/lib`. Jar will be named: `aws-xray-parameter-whitelist-instrumentor-<version>.jar`. Add the jar to your application classpath and make sure to remove: `aws-xray-recorder-sdk-aws-sdk-instrumentor`.
 
+# Parameter Whitelist Configuration
+
+It is possible to configure a custom parameter whitelist file instead of the default one provided with the package. This can be done either via a the environment variable: `AWS_XRAY_WHITELIST_URL` or the System property: `alt.aws.xray.whitelist.url`. The System property takes precedence over the environment variable. Value should be set to a resource path as specified by [Class.getResource()](https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html#getResource-java.lang.String-). For example: `/com/myconpany/mypackage/MyParameterWhitelist.json`.
+
+**Note**: If setting the System property programmatically, you need to set this before using the AWS SDK. The configuration is evaluated once upon first usage of the AWS SDK.  
 

build.gradle

@@ -1,5 +1,17 @@
+buildscript {
+    repositories {        
+        jcenter()        
+    }
+    dependencies {        
+        classpath("com.jfrog.bintray.gradle:gradle-bintray-plugin:1.7.3")                
+    }
+}
+
 apply plugin: 'java-library'
 apply plugin: 'eclipse'
+apply plugin: 'maven-publish'
+apply plugin: 'com.jfrog.bintray'
+
 
 // In this section you declare where to find the dependencies of your project
 repositories {
@@ -8,10 +20,12 @@ repositories {
     jcenter()
 }
 
+version = '0.1.1'
+
 sourceCompatibility = 1.8
 targetCompatibility = 1.8
 
-archivesBaseName = 'aws-xray-parameter-whitelist-instrumentor'
+
 
 dependencies {
     // This dependency is exported to consumers, that is to say found on their compile classpath.
@@ -27,14 +41,92 @@ dependencies {
     )
 }
 
+archivesBaseName = 'aws-xray-parameter-whitelist-instrumentor'
+def githubUrl = 'https://github.com/functionalone/aws-xray-parameter-whitelist-java'
+
+task sourceJar(type: Jar) {
+	classifier = 'sources'
+    from sourceSets.main.allSource
+}
+
+task javadocJar(type: Jar, dependsOn: javadoc) {
+    classifier = 'javadoc'
+    from javadoc.destinationDir
+}
+
+// Create the pom configuration:
+def pomConfig = {
+    licenses {
+        license {
+            name "MIT"
+            url "https://opensource.org/licenses/MIT"
+            distribution "repo"
+        }
+    }
+    scm {
+       url githubUrl
+    }
+}
+
+publishing {
+	publications {
+		MyPublication(MavenPublication) {
+			from components.java
+			artifact sourceJar
+            artifact javadocJar
+			groupId 'com.github.functionalone'
+           	artifactId project.archivesBaseName
+            version project.version
+			pom.withXml {
+                def root = asNode()
+                root.appendNode('description', 'Configure AWS X-Ray (Java) with an alternate parameter whitelist')
+                root.appendNode('name', project.archivesBaseName)
+                root.appendNode('url', githubUrl)
+                root.children().last() + pomConfig
+            }                        	
+		}
+	}
+}
+
+
+model {
+    tasks.generatePomFileForMyPublicationPublication {
+        destination = file("$buildDir/libs/${project.archivesBaseName}-${project.version}.pom")
+    }
+}
+
+
+bintray {
+    user = System.getProperty("bintray.user")
+    key = System.getProperty("bintray.api_key")    
+    publications = ['MyPublication']
+    publish = true //[Default: false] Whether version should be auto published after an upload
+	pkg {
+		repo = 'maven'
+		name = project.archivesBaseName
+		userOrg = 'functionalone'
+		desc = 'Configure AWS X-Ray (Java) with an alternate parameter whitelist'
+		licenses = ['MIT']
+		vcsUrl = githubUrl
+		labels = ['aws', 'xray', 'whitelist']
+		publicDownloadNumbers = false		
+		version {
+			name = project.version
+			desc = project.version
+			vcsTag = 'master'
+			//attributes = ['gradle-plugin': 'com.use.less:com.use.less.gradle:gradle-useless-plugin']
+		}
+	}
+}
+
 test {
 	testLogging {
         events "passed", "skipped", "failed"
     }
     systemProperty "aws-xray-whitelist.s3-bucket", System.getProperty("aws-xray-whitelist.s3-bucket")
 }
 
-version = '0.1.0'
+
 
 jar {
     manifest {

settings.gradle

@@ -15,4 +15,4 @@ include 'api'
 include 'services:webservice'
 */
 
-rootProject.name = 'aws-xray-whitelist-java'
+rootProject.name = 'aws-xray-parameter-whitelist-java'

src/main/java/com/github/functionalone/xray/handlers/TracingHandlerExtended.java

@@ -32,8 +32,8 @@ private static URL newUrlWithLog(String s) {
       return null;
     }
     try {
-      URL res = new URL(s);
-      logger.info("Whitelist url set to: " + s);
+      URL res = TracingHandler.class.getResource(s);
+      logger.debug("Whitelist url set to: " + res);
       return res;
     } catch (Exception e) {
       logger.error("Failed setting whitelist url with value: [" + s + "].", e);
@@ -43,9 +43,9 @@ private static URL newUrlWithLog(String s) {
 
   /**
    * Will try to resolve in this order: 
-   * - system property: aws-xray-whitelist.url
+   * - system property: alt.aws.xray.whitelist.url
    * - environment property: AWS_XRAY_WHITELIST_URL
-   * - default: resource:/com/github/functionalone/xray/handlers/ExtendedOperationParameterWhitelist.json
+   * - default: resource: /com/github/functionalone/xray/handlers/ExtendedOperationParameterWhitelist.json
    * @return the found url or null if there is a problem
    */
   private static URL getConfiguredWhitelistUrl() {    
@@ -57,13 +57,7 @@ private static URL getConfiguredWhitelistUrl() {
     if(null != res) {
       return res;
     }
-    //use default
-    try {
-      return TracingHandler.class.getResource(DEFAULT_WHITELIST_RESOURCE_URL);      
-    } catch (Exception e) {
-      logger.error("Failed getting url resource of default whitelist url: " + DEFAULT_WHITELIST_RESOURCE_URL, e);
-    }
-    return null;
+    return newUrlWithLog(DEFAULT_WHITELIST_RESOURCE_URL);    
   }
 
   private static final URL OPERATION_PARAMETER_WHITELIST = getConfiguredWhitelistUrl();