com.mongodb.internal.logging.StructuredLogMessage Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of mongodb-driver-core Show documentation

The Java operations layer for the MongoDB Java Driver. Third parties can ' + 'wrap this layer to provide custom higher-level APIs

There is a newer version: 5.3.0-beta0

Show newest version

/*
 * Copyright 2008-present MongoDB, 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 com.mongodb.internal.logging;

import com.mongodb.connection.ClusterId;
import com.mongodb.lang.Nullable;

import java.util.List;

/**
 * This class is not part of the public API and may be removed or changed at any time
 */
public final class StructuredLogMessage {

    private final Component component;
    private final Level level;
    private final String messageId;
    private final ClusterId clusterId;
    private final Throwable exception;
    private final List entries;

    public enum Component {
        COMMAND
    }

    public enum Level {
        DEBUG
    }

    public static final class Entry {
        private final String name;
        private final Object value;

        public Entry(final String name, final Object value) {
            this.name = name;
            this.value = value;
        }

        public String getName() {
            return name;
        }

        public Object getValue() {
            return value;
        }
    }

    public StructuredLogMessage(final Component component, final Level level, final String messageId, final ClusterId clusterId,
            final List entries) {
        this(component, level, messageId, clusterId, null, entries);
    }

    public StructuredLogMessage(final Component component, final Level level, final String messageId, final ClusterId clusterId,
                                @Nullable final Throwable exception, final List entries) {
        this.component = component;
        this.level = level;
        this.messageId = messageId;
        this.clusterId = clusterId;
        this.exception = exception;
        this.entries = entries;
    }

    public Component getComponent() {
        return component;
    }

    public Level getLevel() {
        return level;
    }

    public String getMessageId() {
        return messageId;
    }

    public ClusterId getClusterId() {
        return clusterId;
    }

    @Nullable
    public Throwable getException() {
        return exception;
    }

    public List getEntries() {
        return entries;
    }
}