Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $
You can buy this project and download/modify it how often you want.
io.cdap.plugin.Encoder Maven / Gradle / Ivy
/*
* Copyright © 2015-2019 Cask Data, 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 io.cdap.plugin;
import io.cdap.cdap.api.annotation.Description;
import io.cdap.cdap.api.annotation.Name;
import io.cdap.cdap.api.annotation.Plugin;
import io.cdap.cdap.api.data.format.StructuredRecord;
import io.cdap.cdap.api.data.schema.Schema;
import io.cdap.cdap.api.data.schema.Schema.Field;
import io.cdap.cdap.api.plugin.PluginConfig;
import io.cdap.cdap.etl.api.Emitter;
import io.cdap.cdap.etl.api.FailureCollector;
import io.cdap.cdap.etl.api.PipelineConfigurer;
import io.cdap.cdap.etl.api.StageSubmitterContext;
import io.cdap.cdap.etl.api.Transform;
import io.cdap.cdap.etl.api.TransformContext;
import io.cdap.cdap.etl.api.lineage.field.FieldOperation;
import io.cdap.plugin.common.TransformLineageRecorderUtils;
import org.apache.commons.codec.binary.Base32;
import org.apache.commons.codec.binary.Base64;
import org.apache.commons.codec.binary.Hex;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import java.io.IOException;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.TreeMap;
import java.util.stream.Collectors;
/**
* Encodes the input fields as BASE64, BASE32 or HEX.
*/
@Plugin(type = "transform")
@Name("Encoder")
@Description("Encodes the input field(s) using Base64, Base32 or Hex")
public final class Encoder extends Transform {
private static final Logger LOG = LoggerFactory.getLogger(Encoder.class);
private final Config config;
// Output Schema associated with transform output.
private Schema outSchema;
// Mapping of input field to encoder type.
private final Map encodeMap = new TreeMap<>();
// Encoder handlers.
private final Base64 base64Encoder = new Base64();
private final Base32 base32Encoder = new Base32();
private final Hex hexEncoder = new Hex();
// Output Field name to type map
private final Map outSchemaMap = new HashMap<>();
// This is used only for tests, otherwise this is being injected by the ingestion framework.
public Encoder(Config config) {
this.config = config;
}
private void parseConfiguration(String config, FailureCollector collector) throws IllegalArgumentException {
String[] mappings = config.split(",");
for (String mapping : mappings) {
String[] params = mapping.split(":");
// If format is not right, then we throw an exception.
if (params.length < 2) {
collector.addFailure("Both field name and encoder type must be specified.", null)
.withConfigElement(Config.ENCODE, mapping);
} else {
String field = params[0];
String type = params[1].toUpperCase();
EncodeType eType = EncodeType.valueOf(type);
if (encodeMap.containsKey(field)) {
collector.addFailure(String.format("Field '%s' already has an encoder set.", field), null)
.withConfigElement(Config.ENCODE, mapping);
} else {
encodeMap.put(field, eType);
}
}
}
}
@Override
public void prepareRun(StageSubmitterContext context) throws Exception {
super.prepareRun(context);
parseConfiguration(config.encode, context.getFailureCollector());
// Initialize the required member maps and then: if a field is in input and output and encode, then
// set it to transform; if it's in input and output but not encode, ignore it; if it's in input and
// not output, drop it.
List inFields = TransformLineageRecorderUtils.getFields(context.getInputSchema());
List outFields = TransformLineageRecorderUtils.getFields(context.getOutputSchema());
List identityFields = outFields.stream()
.filter(field -> !encodeMap.containsKey(field) || encodeMap.get(field) == EncodeType.NONE)
.collect(Collectors.toList());
List processedFields = new ArrayList<>(outFields);
processedFields.removeAll(identityFields);
List droppedFields = new ArrayList<>(inFields);
droppedFields.removeAll(outFields);
List output = new ArrayList<>();
output.addAll(TransformLineageRecorderUtils.generateOneToOnes(processedFields, "encode",
"Encoded the input fields based on expected encoder."));
output.addAll(TransformLineageRecorderUtils.generateDrops(droppedFields));
output.addAll(TransformLineageRecorderUtils.generateOneToOnes(identityFields, "identity",
TransformLineageRecorderUtils.IDENTITY_TRANSFORM_DESCRIPTION));
context.record(output);
}
@Override
public void configurePipeline(PipelineConfigurer pipelineConfigurer) throws IllegalArgumentException {
super.configurePipeline(pipelineConfigurer);
FailureCollector collector = pipelineConfigurer.getStageConfigurer().getFailureCollector();
parseConfiguration(config.encode, collector);
Schema inputSchema = pipelineConfigurer.getStageConfigurer().getInputSchema();
// for the fields in input schema, if they are to be encoded (if present in encodeMap)
// make sure their type is either String or Bytes and throw exception otherwise
if (inputSchema != null) {
for (Schema.Field field : inputSchema.getFields()) {
if (encodeMap.containsKey(field.getName())) {
Schema.Type type = field.getSchema().getType();
if (!type.equals(Schema.Type.BYTES) && !type.equals(Schema.Type.STRING)) {
collector.addFailure(String.format("Field '%s' has invalid input type '%s'.",
field.getName(), type.toString().toLowerCase()),
"Input schema field must be of type string or bytes.")
.withConfigElement(Config.ENCODE, String.format("%s:%s", field.getName(), type.toString().toLowerCase()))
.withInputSchemaField(field.getName());
}
}
}
}
// Check if schema specified is a valid schema or no.
try {
Schema outputSchema = Schema.parseJson(config.schema);
pipelineConfigurer.getStageConfigurer().setOutputSchema(outputSchema);
} catch (IOException e) {
collector.addFailure("Invalid schema format.", null).withConfigProperty(Config.SCHEMA);
}
}
@Override
public void initialize(TransformContext context) throws Exception {
super.initialize(context);
FailureCollector collector = getContext().getFailureCollector();
parseConfiguration(config.encode, collector);
collector.getOrThrowException();
try {
outSchema = Schema.parseJson(config.schema);
List outFields = outSchema.getFields();
for (Field field : outFields) {
outSchemaMap.put(field.getName(), field.getSchema().getType());
}
} catch (IOException e) {
collector.addFailure("Invalid schema format.", null).withConfigProperty(Config.SCHEMA);
collector.getOrThrowException();
}
}
@Override
public void transform(StructuredRecord in, Emitter emitter) throws Exception {
StructuredRecord.Builder builder = StructuredRecord.builder(outSchema);
Schema inSchema = in.getSchema();
List inFields = inSchema.getFields();
// Iterate through input fields. Check if field name is present
// in the fields that need to be encoded, if it's not then write
// to output as it is.
for (Field field : inFields) {
String name = field.getName();
// Check if output schema also have the same field name. If it's not
// then throw an exception.
if (!outSchemaMap.containsKey(name)) {
continue;
}
Schema.Type outFieldType = outSchemaMap.get(name);
// Check if the input field name is configured to be encoded. If the field is not
// present or is defined as none, then pass through the field as is.
if (!encodeMap.containsKey(name) || encodeMap.get(name) == EncodeType.NONE) {
builder.set(name, in.get(name));
} else {
// Now, the input field could be of type String or byte[], so transform everything
// to byte[]
byte[] obj = new byte[0];
if (field.getSchema().getType() == Schema.Type.STRING) {
obj = ((String) in.get(name)).getBytes();
} else if (field.getSchema().getType() == Schema.Type.BYTES) {
obj = in.get(name);
}
// Now, based on the encode type configured for the field - encode the byte[] of the
// value.
byte[] outValue = new byte[0];
EncodeType type = encodeMap.get(name);
if (type == EncodeType.STRING_BASE32) {
outValue = base32Encoder.encodeAsString(obj).getBytes();
} else if (type == EncodeType.BASE32) {
outValue = base32Encoder.encode(obj);
} else if (type == EncodeType.STRING_BASE64) {
outValue = base64Encoder.encodeAsString(obj).getBytes();
} else if (type == EncodeType.BASE64) {
outValue = base64Encoder.encode(obj);
} else if (type == EncodeType.HEX) {
outValue = hexEncoder.encode(obj);
}
// Depending on the output field type, either convert it to
// Bytes or to String.
if (outFieldType == Schema.Type.BYTES) {
builder.set(name, outValue);
} else if (outFieldType == Schema.Type.STRING) {
builder.set(name, new String(outValue, "UTF-8"));
}
}
}
emitter.emit(builder.build());
}
/**
* Defines encoding types supported.
*/
private enum EncodeType {
STRING_BASE64("STRING_BASE64"),
STRING_BASE32("STRING_BASE32"),
BASE64("BASE64"),
BASE32("BASE32"),
HEX("HEX"),
NONE("NONE");
private String type;
EncodeType(String type) {
this.type = type;
}
String getType() {
return type;
}
}
/**
* Encoder Plugin config.
*/
public static class Config extends PluginConfig {
public static final String ENCODE = "encode";
public static final String SCHEMA = "schema";
@Name("encode")
@Description("Specify the field and encode type combination. " +
"Format is :[,:]*")
private final String encode;
@Name("schema")
@Description("Specifies the output schema")
private final String schema;
public Config(String encode, String schema) {
this.encode = encode;
this.schema = schema;
}
}
}
