org.eclipse.ditto.connectivity.model.LogEntry Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of ditto-connectivity-model Show documentation
Eclipse Ditto is a framework for creating and managing digital twins in the IoT.
There is a newer version: 3.6.2
Show newest version
/*
 * Copyright (c) 2019 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.connectivity.model;

import java.time.Instant;
import java.util.Optional;

import javax.annotation.concurrent.Immutable;

import org.eclipse.ditto.base.model.entity.id.EntityId;
import org.eclipse.ditto.base.model.json.FieldType;
import org.eclipse.ditto.base.model.json.JsonSchemaVersion;
import org.eclipse.ditto.base.model.json.Jsonifiable;
import org.eclipse.ditto.json.JsonFactory;
import org.eclipse.ditto.json.JsonField;
import org.eclipse.ditto.json.JsonFieldDefinition;
import org.eclipse.ditto.json.JsonFieldSelector;
import org.eclipse.ditto.json.JsonObject;

/**
 * Represents connection log entry.
 */
@Immutable
public interface LogEntry extends Jsonifiable.WithFieldSelectorAndPredicate {

    /**
     * @return correlation ID that is associated with the log entry.
     */
    String getCorrelationId();

    /**
     * @return timestamp of the log entry.
     */
    Instant getTimestamp();

    /**
     * @return category of the log entry.
     */
    LogCategory getLogCategory();

    /**
     * @return type of the log entry.
     */
    LogType getLogType();

    /**
     * @return the log level.
     */
    LogLevel getLogLevel();

    /**
     * @return the log message.
     */
    String getMessage();

    /**
     * @return address if the log can be correlated to a known source or target, empty otherwise.
     */
    Optional getAddress();

    /**
     * @return entity ID if the log can be correlated to a known entity (e.g. a Thing), empty otherwise.
     */
    Optional getEntityId();

    /**
     * Returns all non-hidden marked fields of this {@code LogEntry}.
     *
     * @return a JSON object representation of this LogEntry including only non-hidden marked fields.
     */
    @Override
    default JsonObject toJson() {
        return toJson(FieldType.notHidden());
    }

    @Override
    default JsonObject toJson(final JsonSchemaVersion schemaVersion, final JsonFieldSelector fieldSelector) {
        return toJson(schemaVersion, FieldType.notHidden()).get(fieldSelector);
    }

    /**
     * An enumeration of the known {@code JsonField}s of a {@code ConnectionMetrics}.
     */
    @Immutable
    final class JsonFields {

        /**
         * JSON field containing the correlation id.
         */
        public static final JsonFieldDefinition CORRELATION_ID =
                JsonFactory.newStringFieldDefinition("correlationId", FieldType.REGULAR,
                        JsonSchemaVersion.V_2);

        /**
         * JSON field containing the timestamp.
         */
        public static final JsonFieldDefinition TIMESTAMP =
                JsonFactory.newStringFieldDefinition("timestamp", FieldType.REGULAR,
                        JsonSchemaVersion.V_2);

        /**
         * JSON field containing the category.
         */
        public static final JsonFieldDefinition CATEGORY =
                JsonFactory.newStringFieldDefinition("category", FieldType.REGULAR,
                        JsonSchemaVersion.V_2);

        /**
         * JSON field containing the type.
         */
        public static final JsonFieldDefinition TYPE =
                JsonFactory.newStringFieldDefinition("type", FieldType.REGULAR,
                        JsonSchemaVersion.V_2);

        /**
         * JSON field containing the log level.
         */
        public static final JsonFieldDefinition LEVEL =
                JsonFactory.newStringFieldDefinition("level", FieldType.REGULAR,
                        JsonSchemaVersion.V_2);

        /**
         * JSON field containing the message.
         */
        public static final JsonFieldDefinition MESSAGE =
                JsonFactory.newStringFieldDefinition("message", FieldType.REGULAR,
                        JsonSchemaVersion.V_2);

        /**
         * JSON field containing the address.
         */
        public static final JsonFieldDefinition ADDRESS =
                JsonFactory.newStringFieldDefinition("address", FieldType.REGULAR,
                        JsonSchemaVersion.V_2);

        /**
         * JSON field containing the entity type.
         * @since 3.0.0
         */
        public static final JsonFieldDefinition ENTITY_TYPE =
                JsonFactory.newStringFieldDefinition("entityType", FieldType.REGULAR,
                        JsonSchemaVersion.V_2);


        /**
         * JSON field containing the entity ID.
         * @since 2.1.0
         */
        public static final JsonFieldDefinition ENTITY_ID =
                JsonFactory.newStringFieldDefinition("entityId", FieldType.REGULAR,
                        JsonSchemaVersion.V_2);

        private JsonFields() {
            throw new AssertionError();
        }

    }

}