com.dynatrace.openkit.core.objects.EventPayloadBuilder Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of openkit-java Show documentation
Dynatrace OpenKit - Java Reference Implementation
The newest version!
/**
 * Copyright 2018-2021 Dynatrace LLC
 *
 * 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.dynatrace.openkit.core.objects;

import com.dynatrace.openkit.api.Logger;
import com.dynatrace.openkit.util.json.objects.JSONObjectValue;
import com.dynatrace.openkit.util.json.objects.JSONValue;

import java.util.*;

import static com.dynatrace.openkit.core.util.EventPayloadBuilderUtil.isItemContainingNonFiniteNumericValues;

public class EventPayloadBuilder {

    /** {@link Logger} for tracing log message */
    private final Logger logger;

    /** Map containing attributes for sendEvent API */
    private final Map attributes;

    public EventPayloadBuilder(Logger logger, Map attributes) {
        this.logger = logger;

        if(attributes == null) {
            this.attributes = new HashMap<>();
        } else {
            this.attributes = new HashMap<>(attributes);
        }
    }

    public EventPayloadBuilder addOverridableAttribute(String key, JSONValue value) {
        if (value != null) {
            if (!attributes.containsKey(key)) {
                attributes.put(key, value);
            }
        }

        return this;
    }

    public EventPayloadBuilder addNonOverridableAttribute(String key, JSONValue value) {
        if (value != null) {
            if (attributes.containsKey(key)) {
                logger.warning("EventPayloadBuilder addNonOverrideableAttribute: " + key + " is reserved for internal values!");
            }
            attributes.put(key, value);
        }

        return this;
    }

    public String build() {
        return JSONObjectValue.fromMap(attributes).toString();
    }

    /**
     * Removes reservered internal attributes from the provided attributes
     */
    public EventPayloadBuilder cleanReservedInternalAttributes() {
        Iterator it = this.attributes.keySet().iterator();

        while (it.hasNext()) {
            String key = it.next();

            if (isReservedForInternalAttributes(key)) {
                logger.warning("EventPayloadBuilder cleanReservedInternalAttributes: " + key + " is reserved for internal values!");
                it.remove();
            }
        }

        return this;
    }

    /**
     * Checks if an attribute is actually reserved for internal purpose 
     * @param key Key to check
     * @return True means the key is in use for internal purpose
     */
    public static boolean isReservedForInternalAttributes(String key) {
        return (key.equals("dt") || key.startsWith("dt."));
    }

    /**
     * Checks if the attributes contain a non-finite value
     * @return True if non-finite values is within attributes
     */
    public boolean isEventPayloadContainingNonFiniteValues() {
        for (JSONValue value : attributes.values()) {
            if(isItemContainingNonFiniteNumericValues(value)) {
                return true;
            }
        }

        return false;
    }
}