Merge pull request #22 from Nike-Inc/feature/add_client_version_heade…

…r_to_all_calls

Allow X-Cerberus-Client override + update copyright

build.gradle

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2016 Nike, Inc.
+ * Copyright (c) 2017 Nike, Inc.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

codequality/suppressions.xml

@@ -1,7 +1,7 @@
 <?xml version="1.0"?>
 
 <!--
-  ~ Copyright (c) 2016 Nike, Inc.
+  ~ Copyright (c) 2017 Nike, Inc.
   ~
   ~ Licensed under the Apache License, Version 2.0 (the "License");
   ~ you may not use this file except in compliance with the License.

gradle.properties

@@ -1,5 +1,5 @@
 #
-# Copyright (c) 2016 Nike, Inc.
+# Copyright (c) 2017 Nike, Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -13,6 +13,6 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 #
-version=2.4.0
+version=3.0.0
 groupId=com.nike
 artifactId=cerberus-client

gradle/bintray.gradle

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2016 Nike, Inc.
+ * Copyright (c) 2017 Nike, Inc.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

gradle/buildscript.gradle

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2016 Nike, Inc.
+ * Copyright (c) 2017 Nike, Inc.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

gradle/check.gradle

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2016 Nike, Inc.
+ * Copyright (c) 2017 Nike, Inc.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

gradle/dependencies.gradle

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2016 Nike, Inc.
+ * Copyright (c) 2017 Nike, Inc.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

gradle/integration.gradle

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2016 Nike, Inc.
+ * Copyright (c) 2017 Nike, Inc.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

gradle/wrapper/gradle-wrapper.properties

@@ -1,5 +1,5 @@
 #
-# Copyright (c) 2016 Nike, Inc.
+# Copyright (c) 2017 Nike, Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

settings.gradle

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2016 Nike, Inc.
+ * Copyright (c) 2017 Nike, Inc.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

src/integration/java/com/nike/cerberus/client/auth/aws/VaultClientTest.java

@@ -1,3 +1,19 @@
+/*
+ * Copyright (c) 2017 Nike, Inc.
+ *
+ * Licensed 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.
+ */
+
 package com.nike.cerberus.client.auth.aws;
 
 import com.fieldju.commons.EnvUtils;

src/main/java/com/nike/cerberus/client/ClientVersion.java

@@ -1,3 +1,19 @@
+/*
+ * Copyright (c) 2017 Nike, Inc.
+ *
+ * Licensed 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.
+ */
+
 package com.nike.cerberus.client;
 
 import org.slf4j.Logger;

src/main/java/com/nike/cerberus/client/DefaultCerberusClientFactory.java

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2016 Nike, Inc.
+ * Copyright (c) 2017 Nike, Inc.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

src/main/java/com/nike/cerberus/client/DefaultCerberusUrlResolver.java

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2016 Nike, Inc.
+ * Copyright (c) 2017 Nike, Inc.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

src/main/java/com/nike/cerberus/client/auth/DefaultCerberusCredentialsProviderChain.java

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2016 Nike, Inc.
+ * Copyright (c) 2017 Nike, Inc.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -57,4 +57,27 @@ public DefaultCerberusCredentialsProviderChain(UrlResolver urlResolver) {
                 new InstanceProfileArnVaultCredentialsProvider(urlResolver),
                 new InstanceRoleVaultCredentialsProvider(urlResolver));
     }
+
+    /**
+     * Constructor that sets up a provider chain using the specified implementation of UrlResolver.
+     *
+     * @param xCerberusClientOverride - Overrides the default header value for the 'X-Cerberus-Client' header
+     */
+    public DefaultCerberusCredentialsProviderChain(String xCerberusClientOverride) {
+        this(new DefaultCerberusUrlResolver(), xCerberusClientOverride);
+    }
+
+    /**
+     * Constructor that sets up a provider chain using the specified implementation of UrlResolver.
+     *
+     * @param urlResolver Resolves the Cerberus URL
+     * @param xCerberusClientOverride - Overrides the default header value for the 'X-Cerberus-Client' header
+     */
+    public DefaultCerberusCredentialsProviderChain(UrlResolver urlResolver, String xCerberusClientOverride) {
+        super(new EnvironmentCerberusCredentialsProvider(),
+                new SystemPropertyCerberusCredentialsProvider(),
+                new InstanceProfileVaultCredentialsProvider(urlResolver, xCerberusClientOverride),
+                new InstanceProfileArnVaultCredentialsProvider(urlResolver, xCerberusClientOverride),
+                new InstanceRoleVaultCredentialsProvider(urlResolver, xCerberusClientOverride));
+    }
 }

src/main/java/com/nike/cerberus/client/auth/EnvironmentCerberusCredentialsProvider.java

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2016 Nike, Inc.
+ * Copyright (c) 2017 Nike, Inc.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

src/main/java/com/nike/cerberus/client/auth/SystemPropertyCerberusCredentialsProvider.java

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2016 Nike, Inc.
+ * Copyright (c) 2017 Nike, Inc.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

src/main/java/com/nike/cerberus/client/auth/aws/BaseAwsCredentialsProvider.java

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2016 Nike, Inc.
+ * Copyright (c) 2017 Nike, Inc.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -107,6 +107,20 @@ public BaseAwsCredentialsProvider(UrlResolver urlResolver) {
         LOGGER.info("Cerberus URL={}", urlResolver.resolve());
     }
 
+    /**
+     * Constructor to setup credentials provider using the specified
+     * implementation of {@link UrlResolver}
+     *
+     * @param urlResolver Resolver for resolving the Cerberus URL
+     * @param xCerberusClientOverride - Overrides the default header value for the 'X-Cerberus-Client' header
+     */
+    public BaseAwsCredentialsProvider(UrlResolver urlResolver, String xCerberusClientOverride) {
+        super();
+        this.urlResolver = urlResolver;
+        cerberusJavaClientHeaderValue = xCerberusClientOverride;
+        LOGGER.info("Cerberus URL={}", urlResolver.resolve());
+    }
+
     /**
      * Returns the Vault credentials. If none have been acquired yet or has
      * expired, triggers a refresh.

src/main/java/com/nike/cerberus/client/auth/aws/InstanceProfileArnVaultCredentialsProvider.java

@@ -1,3 +1,19 @@
+/*
+ * Copyright (c) 2017 Nike, Inc.
+ *
+ * Licensed 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.
+ */
+
 package com.nike.cerberus.client.auth.aws;
 
 import com.amazonaws.regions.Region;
@@ -22,6 +38,17 @@ public InstanceProfileArnVaultCredentialsProvider(UrlResolver urlResolver) {
         super(urlResolver);
     }
 
+    /**
+     * Constructor to setup credentials provider using the specified
+     * implementation of {@link UrlResolver}
+     *
+     * @param urlResolver Resolver for resolving the Cerberus URL
+     * @param xCerberusClientOverride - Overrides the default header value for the 'X-Cerberus-Client' header
+     */
+    public InstanceProfileArnVaultCredentialsProvider(UrlResolver urlResolver, String xCerberusClientOverride) {
+        super(urlResolver, xCerberusClientOverride);
+    }
+
     @Override
     protected void authenticate() {
         EC2MetadataUtils.IAMInfo iamInfo = getIamInfo();

src/main/java/com/nike/cerberus/client/auth/aws/InstanceProfileVaultCredentialsProvider.java

@@ -1,3 +1,19 @@
+/*
+ * Copyright (c) 2017 Nike, Inc.
+ *
+ * Licensed 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.
+ */
+
 package com.nike.cerberus.client.auth.aws;
 
 import com.amazonaws.regions.Region;
@@ -25,6 +41,17 @@ public InstanceProfileVaultCredentialsProvider(UrlResolver urlResolver) {
         super(urlResolver);
     }
 
+    /**
+     * Constructor to setup credentials provider using the specified
+     * implementation of {@link UrlResolver}
+     *
+     * @param urlResolver Resolver for resolving the Cerberus URL
+     * @param xCerberusClientOverride - Overrides the default header value for the 'X-Cerberus-Client' header
+     */
+    public InstanceProfileVaultCredentialsProvider(UrlResolver urlResolver, String xCerberusClientOverride) {
+        super(urlResolver, xCerberusClientOverride);
+    }
+
     @Override
     protected void authenticate() {
         EC2MetadataUtils.IAMInfo iamInfo = getIamInfo();

src/main/java/com/nike/cerberus/client/auth/aws/InstanceRoleVaultCredentialsProvider.java

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2016 Nike, Inc.
+ * Copyright (c) 2017 Nike, Inc.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -54,6 +54,17 @@ public InstanceRoleVaultCredentialsProvider(UrlResolver urlResolver) {
         super(urlResolver);
     }
 
+    /**
+     * Constructor to setup credentials provider using the specified
+     * implementation of {@link UrlResolver}
+     *
+     * @param urlResolver Resolver for resolving the Cerberus URL
+     * @param xCerberusClientOverride - Overrides the default header value for the 'X-Cerberus-Client' header
+     */
+    public InstanceRoleVaultCredentialsProvider(UrlResolver urlResolver, String xCerberusClientOverride) {
+        super(urlResolver, xCerberusClientOverride);
+    }
+
     /**
      * Looks up the IAM roles assigned to the instance via the EC2 metadata
      * service. For each role assigned, an attempt is made to authenticate and

src/main/java/com/nike/cerberus/client/auth/aws/LambdaRoleVaultCredentialsProvider.java

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2016 Nike, Inc.
+ * Copyright (c) 2017 Nike, Inc.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

src/main/java/com/nike/cerberus/client/auth/aws/StaticIamRoleVaultCredentialsProvider.java

@@ -1,3 +1,19 @@
+/*
+ * Copyright (c) 2017 Nike, Inc.
+ *
+ * Licensed 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.
+ */
+
 package com.nike.cerberus.client.auth.aws;
 
 import com.amazonaws.regions.Region;

src/main/resources/cerberus-java-client.properties

@@ -1 +1,17 @@
+#
+# Copyright (c) 2017 Nike, Inc.
+#
+# Licensed 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.
+#
+
 cerberus_java_client.version = @@JAVA_CLIENT_RELEASE@@

src/test/java/com/nike/cerberus/client/ClientVersionTest.java

@@ -1,3 +1,19 @@
+/*
+ * Copyright (c) 2017 Nike, Inc.
+ *
+ * Licensed 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.
+ */
+
 package com.nike.cerberus.client;
 
 import org.apache.commons.lang3.StringUtils;

src/test/java/com/nike/cerberus/client/DefaultCerberusClientFactoryTest.java

@@ -1,3 +1,19 @@
+/*
+ * Copyright (c) 2017 Nike, Inc.
+ *
+ * Licensed 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.
+ */
+
 package com.nike.cerberus.client;
 
 import com.nike.vault.client.VaultClient;