Merge pull request #66 from experiandataquality/release-2.1.0

Release 2.1.0
experiandataquality · Mar 16, 2020 · 324abb4 · 324abb4
2 parents 6887c98 + 296d6cd
commit 324abb4
Show file tree

Hide file tree

Showing 219 changed files with 1,609 additions and 477 deletions.
diff --git a/ExampleSteps/AddVAT/build.gradle b/ExampleSteps/AddVAT/build.gradle
@@ -11,10 +11,10 @@ repositories {
 
 dependencies {
     compileOnly(
-            "com.experian.datastudio:sdkapi:2.0.0",
-            "com.experian.datastudio:sdklib:2.0.0"
+            "com.experian.datastudio:sdkapi:2.1.0",
+            "com.experian.datastudio:sdklib:2.1.0"
     )
-    testImplementation "com.experian.datastudio:sdktestframework:2.0.0"
+    testImplementation "com.experian.datastudio:sdktestframework:2.1.0"
     testImplementation 'org.junit.jupiter:junit-jupiter-api:5.6.0'
     testRuntimeOnly 'org.junit.jupiter:junit-jupiter-engine:5.6.0'
 }

diff --git a/ExampleSteps/ConcatValues/build.gradle b/ExampleSteps/ConcatValues/build.gradle
@@ -11,10 +11,10 @@ repositories {
 
 dependencies {
     compileOnly(
-            "com.experian.datastudio:sdkapi:2.0.0",
-            "com.experian.datastudio:sdklib:2.0.0"
+            "com.experian.datastudio:sdkapi:2.1.0",
+            "com.experian.datastudio:sdklib:2.1.0"
     )
-    testImplementation "com.experian.datastudio:sdktestframework:2.0.0"
+    testImplementation "com.experian.datastudio:sdktestframework:2.1.0"
     testImplementation 'org.junit.jupiter:junit-jupiter-api:5.6.0'
     testRuntimeOnly 'org.junit.jupiter:junit-jupiter-engine:5.6.0'
 }

diff --git a/ExampleSteps/IPGeolocation/build.gradle b/ExampleSteps/IPGeolocation/build.gradle
@@ -18,15 +18,15 @@ repositories {
 
 dependencies {
     compileOnly(
-            "com.experian.datastudio:sdkapi:2.0.0",
-            "com.experian.datastudio:sdklib:2.0.0"
+            "com.experian.datastudio:sdkapi:2.1.0",
+            "com.experian.datastudio:sdklib:2.1.0"
     )
     implementation(
             'commons-io:commons-io:2.6',
             "org.json:json:20160810",
             "org.apache.commons:commons-lang3:3.9"
     )
-    testImplementation "com.experian.datastudio:sdktestframework:2.0.0"
+    testImplementation "com.experian.datastudio:sdktestframework:2.1.0"
     testImplementation 'org.junit.jupiter:junit-jupiter-api:5.6.0'
     testRuntimeOnly 'org.junit.jupiter:junit-jupiter-engine:5.6.0'
 }

diff --git a/...ation/src/main/java/com/experian/aperture/datastudio/sdk/step/examples/IPGeolocation.java b/...ation/src/main/java/com/experian/aperture/datastudio/sdk/step/examples/IPGeolocation.java
@@ -62,6 +62,7 @@ public StepConfiguration createConfiguration(StepConfigurationBuilder configurat
                                 .withId(SETTING_ID)
                                 .withName("Lang Localization Setting (e.g. en, de, zh-CN)")
                                 .withIsRequired(true)
+                                .withFieldType(StepSettingType.TEXT)
                                 .build())
                         .build())
                 .build();

diff --git a/README.md b/README.md
@@ -47,6 +47,7 @@ This repo contains the SDK JAR and a pre-configured Java project that uses Gradl
         - [Destroy cache](#destroy-cache)
         - [Assigning value to cache](#assigning-value-to-cache)
         - [Getting value from cache](#getting-value-from-cache)
+    - [Custom step exception](#custom-step-exception)
     - [Step setting](#step-setting)
         - [Creating step setting](#creating-step-setting)
         - [Accessing step setting](#accessing-step-setting)
@@ -76,7 +77,8 @@ This repo contains the SDK JAR and a pre-configured Java project that uses Gradl
 
 | Data Studio version | Compatible SDK version                                                                                                                                                      | 
 |:-------------------:|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------:|
-| 2.0.0               | [2.0.0](https://github.com/experiandataquality/aperture-data-studio-sdk)                                                                                                    |
+| 2.0.6               | [2.0.0](https://github.com/experiandataquality/aperture-data-studio-sdk/tree/v2.0.0) — [2.1.0](https://github.com/experiandataquality/aperture-data-studio-sdk)             |
+| 2.0.0               | [2.0.0](https://github.com/experiandataquality/aperture-data-studio-sdk/tree/v2.0.0)                                                                                        |
 | 1.6.2               | [1.5.0](https://github.com/experiandataquality/aperture-data-studio-sdk/tree/v1.5.0) — [1.6.2](https://github.com/experiandataquality/aperture-data-studio-sdk/tree/v1.6.2) |
 | 1.6.1               | [1.5.0](https://github.com/experiandataquality/aperture-data-studio-sdk/tree/v1.5.0) — [1.6.1](https://github.com/experiandataquality/aperture-data-studio-sdk/tree/v1.6.1) |
 | 1.6.0               | [1.5.0](https://github.com/experiandataquality/aperture-data-studio-sdk/tree/v1.5.0) — [1.6.0](https://github.com/experiandataquality/aperture-data-studio-sdk/tree/v1.6.0) |
@@ -107,14 +109,14 @@ This repo contains the SDK JAR and a pre-configured Java project that uses Gradl
    }
 
    dependencies {
-       compileOnly("com.experian.datastudio:sdkapi:2.0.0")
-       compileOnly("com.experian.datastudio:sdklib:2.0.0")
+       compileOnly("com.experian.datastudio:sdkapi:2.1.0")
+       compileOnly("com.experian.datastudio:sdklib:2.1.0")
    }
    ```
 
   If you don't want to use Gradle, you'll have to configure your own Java project to generate a compatible JAR artifact:
    - Create a new Java project or open an existing one.
-   - Download and install the [sdkapi.jar](https://raw.githubusercontent.com/experiandataquality/aperture-data-studio-sdk/github-maven-repository/maven/com/experian/datastudio/sdkapi/2.0.0/sdkapi-2.0.0.jar) file.
+   - Download and install the [sdkapi.jar](https://raw.githubusercontent.com/experiandataquality/aperture-data-studio-sdk/github-maven-repository/maven/com/experian/datastudio/sdkapi/2.1.0/sdkapi-2.1.0.jar) file.
 
   If using Maven, modify `pom.xml` to add the SDK GitHub repository:
 
@@ -149,13 +151,13 @@ This repo contains the SDK JAR and a pre-configured Java project that uses Gradl
            <dependency>
                <groupId>com.experian.datastudio</groupId>
                <artifactId>sdkapi</artifactId>
-               <version>2.0.0</version>
+               <version>2.1.0</version>
                <scope>provided</scope>
            </dependency>
            <dependency>
                 <groupId>com.experian.datastudio</groupId>
                 <artifactId>sdklib</artifactId>
-                <version>2.0.0</version>
+                <version>2.1.0</version>
            </dependency>
        </dependencies>
    </project>
@@ -623,6 +625,12 @@ If the cache contains no value for that key, `null` is returned.
 cache1.get(cacheKey);
 ```
 
+### Custom step exception
+You can raise custom step exception by throwing the following exception class.
+``` java
+throw new CustomStepException(401, "Authentication failed")
+```
+
 ### Step setting
 You may use step setting as a constant variable or as global setting across the Aperture Data Studio. The setting page will be appeared in *Step Setting* module.
 
@@ -633,19 +641,47 @@ Use `CustomStepSettingBuilder` in `createConfiguration` method to configure your
 | withId         | Set the Id for the field                            |
 | withName       | Set the name for the field                          |
 | withIsRequired | Set whether the field is mandatory                  |
+| withFieldType  | Set the field type (*PASSWORD*, *TEXT*, *TEXTAREA*) |
 
 ``` java
 .withStepSetting(builder -> builder
 	.addField(fieldBuilder -> fieldBuilder
 			.withId("stepsetting-1")
 			.withName("Step Setting 1")
 			.withIsRequired(true)
+			.withFieldType(StepSettingType.PASSWORD)
 			.build())
 	.build())
 ```
 
 #### Accessing step setting
-Step setting value can be accessed from *createProcessor* methods.
+Step setting value can be accessed from both *createConfiguration* and *createProcessor* methods.
+``` java
+.withStepProperties(stepPropertiesBuilder -> stepPropertiesBuilder
+	.addStepProperty(stepPropertyBuilder -> stepPropertyBuilder
+			.asCustomChooser("property-1")
+			.withAllowValuesProvider(uiCallbackContext -> {
+				final Optional<String> fieldValue1 = uiCallbackContext.getStepSettingFieldValueAsString("stepsetting-1");
+				return fieldValue1.map(s -> Arrays.asList(s.split(","))).orElse(Collections.emptyList());
+			})
+			.withIsRequired(true)
+			.build())
+	.build())
+```
+
+``` java
+.withOutputLayouts(outputLayoutBuilder -> outputLayoutBuilder
+	.forOutputNode("output-1", outputColumnBuilder -> outputColumnBuilder
+			.addColumns(context -> {
+				final Optional<String> fieldValue1 = context.getStepSettingFieldValueAsString("stepsetting-1");
+				List<Column> columnList = context.getInputContext(INPUT_ID).getColumns();
+				fieldValue1.ifPresent(s -> columnList.add(context.createNewColumn(s)));
+				return columnList;
+			})
+			.addColumn(COLUMN_HEADER)
+			.build())
+	.build())
+```
 
 ``` java
 public StepProcessor createProcessor(final StepProcessorBuilder processorBuilder) {
@@ -900,13 +936,13 @@ CompletableFuture<WebHttpResponse> webHttpResponse = client.sendAsync(request);
    }
 
    dependencies {
-       compileOnly("com.experian.datastudio:sdkapi:2.0.0")
+       compileOnly("com.experian.datastudio:sdkapi:2.1.0")
    }
    ```
 
   If you don't want to use Gradle, you'll have to configure your own Java project to generate a compatible JAR artifact:
    - Create a new Java project or open an existing one.
-   - Download and install the [sdkapi.jar](https://raw.githubusercontent.com/experiandataquality/aperture-data-studio-sdk/github-maven-repository/maven/com/experian/datastudio/sdkapi/2.0.0/sdkapi-2.0.0.jar) file.
+   - Download and install the [sdkapi.jar](https://raw.githubusercontent.com/experiandataquality/aperture-data-studio-sdk/github-maven-repository/maven/com/experian/datastudio/sdkapi/2.1.0/sdkapi-2.1.0.jar) file.
 
   If using Maven, modify `pom.xml` to add the SDK GitHub repository:
 
@@ -936,7 +972,7 @@ CompletableFuture<WebHttpResponse> webHttpResponse = client.sendAsync(request);
            <dependency>
                <groupId>com.experian.datastudio</groupId>
                <artifactId>sdkapi</artifactId>
-               <version>2.0.0</version>
+               <version>2.1.0</version>
                <scope>provided</scope>
            </dependency>
        </dependencies>

diff --git a/SDKTestFramework/build.gradle b/SDKTestFramework/build.gradle
@@ -11,10 +11,10 @@ repositories {
 
 dependencies {
     compileOnly(
-            "com.experian.datastudio:sdkapi:2.0.0",
-            "com.experian.datastudio:sdklib:2.0.0"
+            "com.experian.datastudio:sdkapi:2.1.0",
+            "com.experian.datastudio:sdklib:2.1.0"
     )
-    testImplementation "com.experian.datastudio:sdktestframework:2.0.0"
+    testImplementation "com.experian.datastudio:sdktestframework:2.1.0"
     testImplementation 'org.junit.jupiter:junit-jupiter-api:5.6.0'
     testRuntimeOnly 'org.junit.jupiter:junit-jupiter-engine:5.6.0'
 }

diff --git a/docs/index.html b/docs/index.html
@@ -10,8 +10,8 @@
 
 <div>
     <ul>
-        <li><a href="sdkapi/index.html">Aperture Data Studio SDKAPI 2.0.0 API</a></li>
-        <li><a href="sdklib/index.html">Aperture Data Studio SDKLIB 2.0.0 API</a></li>
+        <li><a href="sdkapi/index.html">Aperture Data Studio SDKAPI API</a></li>
+        <li><a href="sdklib/index.html">Aperture Data Studio SDKLIB API</a></li>
     </ul>
 </div>
 </body>

diff --git a/docs/sdkapi/allclasses-frame.html b/docs/sdkapi/allclasses-frame.html
@@ -3,7 +3,7 @@
 <html lang="en">
 <head>
 <!-- Generated by javadoc -->
-<title>All Classes (SDKAPI 2.0.0 API)</title>
+<title>All Classes (SDKAPI 2.1.0 API)</title>
 <link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
 <script type="text/javascript" src="script.js"></script>
 </head>
@@ -33,6 +33,7 @@ <h1 class="bar">All&nbsp;Classes</h1>
 <li><a href="com/experian/datastudio/sdk/api/CustomDefinition.html" title="interface in com.experian.datastudio.sdk.api" target="classFrame"><span class="interfaceName">CustomDefinition</span></a></li>
 <li><a href="com/experian/datastudio/sdk/api/parser/CustomParserDefinition.html" title="interface in com.experian.datastudio.sdk.api.parser" target="classFrame"><span class="interfaceName">CustomParserDefinition</span></a></li>
 <li><a href="com/experian/datastudio/sdk/api/step/CustomStepDefinition.html" title="interface in com.experian.datastudio.sdk.api.step" target="classFrame"><span class="interfaceName">CustomStepDefinition</span></a></li>
+<li><a href="com/experian/datastudio/sdk/api/step/CustomStepException.html" title="class in com.experian.datastudio.sdk.api.step" target="classFrame">CustomStepException</a></li>
 <li><a href="com/experian/datastudio/sdk/api/step/configuration/CustomStepSetting.html" title="interface in com.experian.datastudio.sdk.api.step.configuration" target="classFrame"><span class="interfaceName">CustomStepSetting</span></a></li>
 <li><a href="com/experian/datastudio/sdk/api/step/configuration/CustomStepSettingBuilder.html" title="interface in com.experian.datastudio.sdk.api.step.configuration" target="classFrame"><span class="interfaceName">CustomStepSettingBuilder</span></a></li>
 <li><a href="com/experian/datastudio/sdk/api/step/configuration/CustomStepSettingBuilder.Build.html" title="interface in com.experian.datastudio.sdk.api.step.configuration" target="classFrame"><span class="interfaceName">CustomStepSettingBuilder.Build</span></a></li>
@@ -140,6 +141,7 @@ <h1 class="bar">All&nbsp;Classes</h1>
 <li><a href="com/experian/datastudio/sdk/api/step/processor/StepResourceBuilder.Supplier.html" title="interface in com.experian.datastudio.sdk.api.step.processor" target="classFrame"><span class="interfaceName">StepResourceBuilder.Supplier</span></a></li>
 <li><a href="com/experian/datastudio/sdk/api/step/processor/StepResourceBuilderFactory.html" title="interface in com.experian.datastudio.sdk.api.step.processor" target="classFrame"><span class="interfaceName">StepResourceBuilderFactory</span></a></li>
 <li><a href="com/experian/datastudio/sdk/api/step/processor/StepResourceContext.html" title="interface in com.experian.datastudio.sdk.api.step.processor" target="classFrame"><span class="interfaceName">StepResourceContext</span></a></li>
+<li><a href="com/experian/datastudio/sdk/api/step/configuration/StepSettingType.html" title="enum in com.experian.datastudio.sdk.api.step.configuration" target="classFrame">StepSettingType</a></li>
 <li><a href="com/experian/datastudio/sdk/api/step/configuration/stepproperties/StringStepProperty.html" title="interface in com.experian.datastudio.sdk.api.step.configuration.stepproperties" target="classFrame"><span class="interfaceName">StringStepProperty</span></a></li>
 <li><a href="com/experian/datastudio/sdk/api/step/configuration/stepproperties/StringStepPropertyBuilder.html" title="interface in com.experian.datastudio.sdk.api.step.configuration.stepproperties" target="classFrame"><span class="interfaceName">StringStepPropertyBuilder</span></a></li>
 <li><a href="com/experian/datastudio/sdk/api/parser/configuration/SupportedFileExtension.html" title="interface in com.experian.datastudio.sdk.api.parser.configuration" target="classFrame"><span class="interfaceName">SupportedFileExtension</span></a></li>

diff --git a/docs/sdkapi/allclasses-noframe.html b/docs/sdkapi/allclasses-noframe.html
@@ -3,7 +3,7 @@
 <html lang="en">
 <head>
 <!-- Generated by javadoc -->
-<title>All Classes (SDKAPI 2.0.0 API)</title>
+<title>All Classes (SDKAPI 2.1.0 API)</title>
 <link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
 <script type="text/javascript" src="script.js"></script>
 </head>
@@ -33,6 +33,7 @@ <h1 class="bar">All&nbsp;Classes</h1>
 <li><a href="com/experian/datastudio/sdk/api/CustomDefinition.html" title="interface in com.experian.datastudio.sdk.api"><span class="interfaceName">CustomDefinition</span></a></li>
 <li><a href="com/experian/datastudio/sdk/api/parser/CustomParserDefinition.html" title="interface in com.experian.datastudio.sdk.api.parser"><span class="interfaceName">CustomParserDefinition</span></a></li>
 <li><a href="com/experian/datastudio/sdk/api/step/CustomStepDefinition.html" title="interface in com.experian.datastudio.sdk.api.step"><span class="interfaceName">CustomStepDefinition</span></a></li>
+<li><a href="com/experian/datastudio/sdk/api/step/CustomStepException.html" title="class in com.experian.datastudio.sdk.api.step">CustomStepException</a></li>
 <li><a href="com/experian/datastudio/sdk/api/step/configuration/CustomStepSetting.html" title="interface in com.experian.datastudio.sdk.api.step.configuration"><span class="interfaceName">CustomStepSetting</span></a></li>
 <li><a href="com/experian/datastudio/sdk/api/step/configuration/CustomStepSettingBuilder.html" title="interface in com.experian.datastudio.sdk.api.step.configuration"><span class="interfaceName">CustomStepSettingBuilder</span></a></li>
 <li><a href="com/experian/datastudio/sdk/api/step/configuration/CustomStepSettingBuilder.Build.html" title="interface in com.experian.datastudio.sdk.api.step.configuration"><span class="interfaceName">CustomStepSettingBuilder.Build</span></a></li>
@@ -140,6 +141,7 @@ <h1 class="bar">All&nbsp;Classes</h1>
 <li><a href="com/experian/datastudio/sdk/api/step/processor/StepResourceBuilder.Supplier.html" title="interface in com.experian.datastudio.sdk.api.step.processor"><span class="interfaceName">StepResourceBuilder.Supplier</span></a></li>
 <li><a href="com/experian/datastudio/sdk/api/step/processor/StepResourceBuilderFactory.html" title="interface in com.experian.datastudio.sdk.api.step.processor"><span class="interfaceName">StepResourceBuilderFactory</span></a></li>
 <li><a href="com/experian/datastudio/sdk/api/step/processor/StepResourceContext.html" title="interface in com.experian.datastudio.sdk.api.step.processor"><span class="interfaceName">StepResourceContext</span></a></li>
+<li><a href="com/experian/datastudio/sdk/api/step/configuration/StepSettingType.html" title="enum in com.experian.datastudio.sdk.api.step.configuration">StepSettingType</a></li>
 <li><a href="com/experian/datastudio/sdk/api/step/configuration/stepproperties/StringStepProperty.html" title="interface in com.experian.datastudio.sdk.api.step.configuration.stepproperties"><span class="interfaceName">StringStepProperty</span></a></li>
 <li><a href="com/experian/datastudio/sdk/api/step/configuration/stepproperties/StringStepPropertyBuilder.html" title="interface in com.experian.datastudio.sdk.api.step.configuration.stepproperties"><span class="interfaceName">StringStepPropertyBuilder</span></a></li>
 <li><a href="com/experian/datastudio/sdk/api/parser/configuration/SupportedFileExtension.html" title="interface in com.experian.datastudio.sdk.api.parser.configuration"><span class="interfaceName">SupportedFileExtension</span></a></li>

diff --git a/docs/sdkapi/com/experian/datastudio/sdk/api/CustomDefinition.html b/docs/sdkapi/com/experian/datastudio/sdk/api/CustomDefinition.html
@@ -3,15 +3,15 @@
 <html lang="en">
 <head>
 <!-- Generated by javadoc -->
-<title>CustomDefinition (SDKAPI 2.0.0 API)</title>
+<title>CustomDefinition (SDKAPI 2.1.0 API)</title>
 <link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
 <script type="text/javascript" src="../../../../../script.js"></script>
 </head>
 <body>
 <script type="text/javascript"><!--
     try {
         if (location.href.indexOf('is-external=true') == -1) {
-            parent.document.title="CustomDefinition (SDKAPI 2.0.0 API)";
+            parent.document.title="CustomDefinition (SDKAPI 2.1.0 API)";
         }
     }
     catch(err) {

diff --git a/docs/sdkapi/com/experian/datastudio/sdk/api/CustomTypeMetadata.html b/docs/sdkapi/com/experian/datastudio/sdk/api/CustomTypeMetadata.html
@@ -3,15 +3,15 @@
 <html lang="en">
 <head>
 <!-- Generated by javadoc -->
-<title>CustomTypeMetadata (SDKAPI 2.0.0 API)</title>
+<title>CustomTypeMetadata (SDKAPI 2.1.0 API)</title>
 <link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
 <script type="text/javascript" src="../../../../../script.js"></script>
 </head>
 <body>
 <script type="text/javascript"><!--
     try {
         if (location.href.indexOf('is-external=true') == -1) {
-            parent.document.title="CustomTypeMetadata (SDKAPI 2.0.0 API)";
+            parent.document.title="CustomTypeMetadata (SDKAPI 2.1.0 API)";
         }
     }
     catch(err) {

diff --git a/docs/sdkapi/com/experian/datastudio/sdk/api/CustomTypeMetadataBuilder.Builder.html b/docs/sdkapi/com/experian/datastudio/sdk/api/CustomTypeMetadataBuilder.Builder.html
@@ -3,15 +3,15 @@
 <html lang="en">
 <head>
 <!-- Generated by javadoc -->
-<title>CustomTypeMetadataBuilder.Builder (SDKAPI 2.0.0 API)</title>
+<title>CustomTypeMetadataBuilder.Builder (SDKAPI 2.1.0 API)</title>
 <link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
 <script type="text/javascript" src="../../../../../script.js"></script>
 </head>
 <body>
 <script type="text/javascript"><!--
     try {
         if (location.href.indexOf('is-external=true') == -1) {
-            parent.document.title="CustomTypeMetadataBuilder.Builder (SDKAPI 2.0.0 API)";
+            parent.document.title="CustomTypeMetadataBuilder.Builder (SDKAPI 2.1.0 API)";
         }
     }
     catch(err) {