es.osoco.logging.adapter.elasticsearch.ElasticSearchLoggingConfiguration Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of java-logging Show documentation
The newest version!
/*
  This program is free software: you can redistribute it and/or modify
  it under the terms of the GNU General Public License as published by
  the Free Software Foundation, either version 3 of the License, or
  (at your option) any later version.

  This program is distributed in the hope that it will be useful,
  but WITHOUT ANY WARRANTY; without even the implied warranty of
  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  GNU General Public License for more details.

  You should have received a copy of the GNU General Public License
  along with this program.  If not, see .
*/
package es.osoco.logging.adapter.elasticsearch;

import es.osoco.logging.adapter.AbstractLoggingConfiguration;
import es.osoco.logging.config.LoggingConfiguration;
import org.checkerframework.checker.nullness.qual.NonNull;

import lombok.EqualsAndHashCode;
import lombok.ToString;

/**
 * Required configuration for ElasticSearch logging.
 */
public interface ElasticSearchLoggingConfiguration
    extends LoggingConfiguration {
    /**
     * Retrieves the ElasticSearch host.
     * @return such host.
     */
    String getHost();

    /**
     * Retrieves the ElasticSearch port.
     * @return such port.
     */
    int getPort();

    /**
     * Retrieves the ElasticSearch scheme.
     * @return such scheme.
     */
    String getScheme();

    @ToString
    @EqualsAndHashCode(callSuper = true)
    class ElasticSearchLoggingConfigurationData
        extends AbstractLoggingConfiguration
        implements ElasticSearchLoggingConfiguration {
        /**
         * The host.
         */
        private String host;

        /**
         * The port.
         */
        private int port;

        /**
         * The scheme.
         */
        private String scheme;

        /**
         * Creates a new instance.
         * @param key the key.
         * @param host the host.
         * @param port the port.
         * @param scheme the scheme.
         */
        public ElasticSearchLoggingConfigurationData(
            @NonNull final String key, @NonNull final String host, final int port, @NonNull final String scheme) {
            super(key);
            this.host = host;
            this.port = port;
            this.scheme = scheme;
        }

        /**
         * Specifies the host.
         * @param host such host.
         */
        protected final void immutableSetHost(@NonNull final String host) {
            this.host = host;
        }

        /**
         * Specifies the host. Override me if necessary.
         * @param host such host.
         */
        @SuppressWarnings("unused")
        protected void setHost(@NonNull final String host) {
            immutableSetHost(host);
        }

        @Override
        @NonNull
        public String getHost() {
            return host;
        }

        /**
         * Specifies the port.
         * @param port such port.
         */
        protected final void immutableSetPort(final int port) {
            this.port = port;
        }

        /**
         * Specifies the port. Override me if necessary.
         * @param port such port.
         */
        @SuppressWarnings("unused")
        protected void setPort(final int port) {
            immutableSetPort(port);
        }

        @Override
        public int getPort() {
            return port;
        }

        /**
         * Specifies the scheme.
         * @param scheme such scheme.
         */
        protected final void immutableSetScheme(@NonNull final String scheme) {
            this.scheme = scheme;
        }

        /**
         * Specifies the scheme. Override me if necessary.
         * @param scheme such scheme.
         */
        @SuppressWarnings("unused")
        protected void setScheme(@NonNull final String scheme) {
            immutableSetScheme(scheme);
        }

        @Override
        @NonNull
        public String getScheme() {
            return scheme;
        }
    }
}