renewal for the migration to akamai

Author: AstinCHOI

.gitignore

@@ -20,6 +20,7 @@ bin/
 # Others
 .DS_Store
 .vscode
+.idea
 .classpath
 .settings
 .project

LICENSE

@@ -1,45 +1,49 @@
-# Akamai-EdgeAuth: Akamai Edge Authorization Token for Java
+# EdgeAuth-Token-Java: Akamai Edge Authorization Token for Java
 
-[![Maven Central](https://img.shields.io/badge/maven%20central-0.1.0-brightgreen.svg)](http://search.maven.org/#artifactdetails%7Cio.github.astinchoi%7CAkamai-EdgeAuth-Java%7C0.1.0%7C)
-[![Build Status](https://travis-ci.org/AstinCHOI/Akamai-EdgeAuth-Java.svg?branch=master)](https://travis-ci.org/AstinCHOI/Akamai-EdgeAuth-Java)
-[![License](http://img.shields.io/:license-apache-blue.svg)](https://github.com/AstinCHOI/Akamai-EdgeAuth-Java/blob/master/LICENSE)
+[![Maven Central](https://img.shields.io/badge/maven%20central-0.1.0-brightgreen.svg)](http://search.maven.org/#artifactdetails%7Ccom.akamai%7Cedgeauth%7C0.1.0%7C)
+[![Build Status](https://travis-ci.org/akamai/EdgeAuth-Token-Java.svg?branch=master)](https://travis-ci.org/akamai/EdgeAuth-Token-Java)
+[![License](http://img.shields.io/:license-apache-blue.svg)](https://github.com/akamai/EdgeAuth-Token-Java/blob/master/LICENSE)
 
-Akamai-EdgeAuth is Akamai Edge Authorization Token in the HTTP Cookie, Query String and Header for a client.
+EdgeAuth-Token-Java is Akamai Edge Authorization Token in the HTTP Cookie, Query String and Header for a client.
 You can configure it in the Property Manager at https://control.akamai.com.
 It's a behavior which is Auth Token 2.0 Verification.
 
-Akamai-EdgeAuth supports Java 1.6+. (This is Akamai unofficial code)
+EdgeAuth-Token-Java supports Java 1.6+.
 
 <div style="text-align:center"><img src=https://github.com/AstinCHOI/akamai-asset/blob/master/edgeauth/edgeauth.png?raw=true /></div>
 
 
 ## Build
-[Click Here](http://search.maven.org/#artifactdetails%7Cio.github.astinchoi%7CAkamai-EdgeAuth-Java%7C0.2.7%7C)
+[Click Here](http://search.maven.org/#artifactdetails%7Ccom.akamai%7Cedgeauth%7C0.1.0%7C)
 
 
 ## Example
 ```java
-import io.github.astinchoi.edgeauth.EdgeAuth;
-import io.github.astinchoi.edgeauth.EdgeAuthBuilder;
-import io.github.astinchoi.edgeauth.EdgeAuthException;
+import com.akamai.edgeauth.EdgeAuth;
+import com.akamai.edgeauth.EdgeAuthBuilder;
+import com.akamai.edgeauth.EdgeAuthException;
 
 
 public class EdgeAuthExample {
   public static void main(String[] args) {
     String hostname = "YourAkamaizedHostname";
-    String encrpytionKey = "YourEncryptionKey";
+    String ET_ENCRYPTION_KEY = "YourEncryptionKey";
     long duration = 500L; // 500 seconds
 
-    // => Option Code
+    // Below examples here ..
   }
 }
 ```
 
+* ET_ENCRYPTION_KEY must be hexadecimal digit string with even-length.
+* Don't expose ET_ENCRYPTION_KEY on the public repository.
+
+
 #### URL parameter option
 ```java
 try {
   EdgeAuth ea = new EdgeAuthBuilder()
-      .key(encrpytionKey)
+      .key(ET_ENCRYPTION_KEY)
       .windowSeconds(duration)
       .escapeEarly(true)
       .build();
@@ -65,17 +69,13 @@ try {
   e.printStackTrace();
 }
 ```
-```java
-// In the URL option,
-// It depends on turning on/off 'Escape token input' in the property manager. 
-// on: escapeEarly(true) / off: escapeEarly(false)
 
-// In the [2) Query String], 
-// it's only okay for 'Ignore query string' option on
+* 'Escape token input' option in the Property Manager corresponds to 'escape_early' in the code.
+    | Escape token input (on) == escape_early (True)
+    | Escape token input (off) == escape_early (False)
+* In [Example 2] for Query String, it's only okay for 'Ignore query string' option (on).
+* If you want to 'Ignore query string' option (off) using query string as your token, Please contact your Akamai representative.
 
-// If you want to 'Ignore query string' off using query string as your token, 
-// Please contact your Akamai representative.
-```
 
 #### ACL(Access Control List) parameter option
 ```java
@@ -98,19 +98,18 @@ try {
   4) Cookie Delimited by '!'
   **************************/
   String acl2[] = { "/akamai/edgeauth", "/akamai/edgeauth/list/*" };
-  String token = ea.generateACLToken(EdgeAuth.join(EdgeAuth.ACL_DELIMITER, acl2));
+  String token = ea.generateACLToken(acl2);
   String url = String.format("http(s)://%s%s", hostname, "/akamai/edgeauth/list/something2");
   String cookie = String.format("%s=%s", ea.getTokenName(), token);
   // => Link or Request "url" /w "cookie"
 } catch (EdgeAuthException e) {
   e.printStackTrace();
 }
 ```
-```java
-// In the ACL option,
-// It doesn't matter turning on/off 'Escape token input' in the property manager
-// but you should keep escapeEarly(false) as default
-```
+
+* ACL can use the wildcard(\*, ?) in the path.
+* Don't use '!' in your path because it's ACL Delimiter.
+* Use 'escape_early=False' as default setting but it doesn't matter turning on/off 'Escape token input' option in the Property Manager
 
 
 ## Usage
@@ -130,28 +129,38 @@ try {
 | endTime | When does this token expire? 'endTime' overrides 'windowSeconds' |
 | windowSeconds | How long is this token valid for? |
 | fieldDelimiter | Character used to delimit token body fields. [ Default: ~ ] |
+| aclDelimiter | Character used to delimit acl. [ Default: ! ] |
 | escapeEarly | Causes strings to be 'url' encoded before being used. |
 | verbose | Print all parameters. |
 
 #### EdgeAuth Static Variable
 ```java
-public static final Long NOW = 0L; // When using startTime
-public static String ACL_DELIMITER = "!"; // When using ACL
+public static final Long NOW = 0L; // When using startTime, 0L means "from NOW".
 ```
 
 
 #### EdgeAuth's Method
 | Method | Description |
 |--------|-------------|
 | generateURLToken(String url) | Single URL path. |
-| generateACLToken(String acl) | Access control list delimited by ! [ ie. /\* ] |
+| generateACLToken(String acl) | Single URL path - can use the wildcard (*, ?) |
+| generateACLToken(String[] acl) | Multi URL paths - can use the wildcard |
 
 Returns the authorization token string.
 
 
-## License
+## Test
+"src/test" directory is only for the internal test.
+
+
+## Others
+If you use the **Segmented Media Protection** behavior in AMD(Adaptive Media Delivery) Product, **tokenName(options.tokenName)** should be '**hdnts**'.
 
-Copyright 2017 Akamai Technologies, Inc.  All rights reserved.
+<div style="text-align:center"><img src=https://github.com/AstinCHOI/akamai-asset/blob/master/edgeauth/segmented_media_protection.png?raw=true/></div>
+
+
+## License
+Copyright 2018 Akamai Technologies, Inc.  All rights reserved.
 
 Licensed under the Apache License, Version 2.0 (the "License");
 you may not use this file except in compliance with the License.

README.md

@@ -1,9 +1,16 @@
-apply plugin:'java'
+plugins {
+    id 'java'
+}
+
+group 'com.akamai'
+version '0.3.0'
 
-repositories { 
-  jcenter() 
+sourceCompatibility = 1.8
+
+repositories {
+    mavenCentral()
 }
 
-dependencies { 
-  testCompile 'junit:junit:4.12' 
-}
+dependencies {
+    testCompile group: 'junit', name: 'junit', version: '4.12'
+}