org.eclipse.ditto.placeholders.PipelineFunctionBase64Encode Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of ditto-placeholders Show documentation

Eclipse Ditto is a framework for creating and managing digital twins in the IoT.

There is a newer version: 3.6.2

/*
 * Copyright (c) 2023 Contributors to the Eclipse Foundation
 *
 * See the NOTICE file(s) distributed with this work for additional
 * information regarding copyright ownership.
 *
 * This program and the accompanying materials are made available under the
 * terms of the Eclipse Public License 2.0 which is available at
 * http://www.eclipse.org/legal/epl-2.0
 *
 * SPDX-License-Identifier: EPL-2.0
 */
package org.eclipse.ditto.placeholders;

import java.nio.charset.StandardCharsets;
import java.util.Base64;
import java.util.Collections;
import java.util.List;

import javax.annotation.concurrent.Immutable;

/**
 * Provides the {@code fn:base64-encode()} function implementation.
 */
@Immutable
final class PipelineFunctionBase64Encode implements PipelineFunction {

    private static final String FUNCTION_NAME = "base64-encode";

    @Override
    public String getName() {
        return FUNCTION_NAME;
    }

    @Override
    public Base64EncodeSignature getSignature() {
        return Base64EncodeSignature.INSTANCE;
    }

    @Override
    public PipelineElement apply(final PipelineElement value, final String paramsIncludingParentheses,
            final ExpressionResolver expressionResolver) {

        // check if signature matches (empty params!)
        validateOrThrow(paramsIncludingParentheses);
        return value.map(v -> Base64.getEncoder().encodeToString(v.getBytes(StandardCharsets.UTF_8)));
    }

    private void validateOrThrow(final String paramsIncludingParentheses) {
        if (!PipelineFunctionParameterResolverFactory.forEmptyParameters().test(paramsIncludingParentheses)) {
            throw PlaceholderFunctionSignatureInvalidException.newBuilder(paramsIncludingParentheses, this)
                    .build();
        }
    }

    /**
     * Describes the signature of the {@code base64-encode()} function.
     */
    private static final class Base64EncodeSignature implements Signature {

        private static final Base64EncodeSignature INSTANCE = new Base64EncodeSignature();

        private Base64EncodeSignature() {
        }

        @Override
        public List> getParameterDefinitions() {
            return Collections.emptyList();
        }

        @Override
        public String toString() {
            return renderSignature();
        }
    }

}