com.arpnetworking.metrics.common.sources.BaseSource Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of metrics-aggregator-daemon Show documentation
Aggregates samples published by metrics client libraries and writes to destinations.
There is a newer version: 1.22.6
Show newest version
/*
 * Copyright 2014 Groupon.com
 *
 * 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.arpnetworking.metrics.common.sources;

import com.arpnetworking.commons.builder.OvalBuilder;
import com.arpnetworking.commons.observer.ObservableDelegate;
import com.arpnetworking.commons.observer.Observer;
import com.arpnetworking.logback.annotations.LogValue;
import com.arpnetworking.steno.LogValueMapFactory;
import net.sf.oval.constraint.NotEmpty;
import net.sf.oval.constraint.NotNull;

import java.util.function.Function;

/**
 * Abstract base class for common functionality for obtaining
 * {@link com.arpnetworking.metrics.mad.model.Record}. This
 * class is thread safe.
 *
 * @author Ville Koskela (ville dot koskela at inscopemetrics dot io)
 */
public abstract class BaseSource implements Source {

    @Override
    public void attach(final Observer observer) {
        _observable.attach(observer);
    }

    @Override
    public void detach(final Observer observer) {
        _observable.detach(observer);
    }

    /**
     * Dispatch an event to all attached {@link Observer} instances.
     *
     * @param event The event to dispatch.
     */
    protected void notify(final Object event) {
        _observable.notify(this, event);
    }

    public String getName() {
        return _name;
    }

    public String getMetricSafeName() {
        return getName().replaceAll("[/\\. ]", "_");
    }

    /**
     * Generate a Steno log compatible representation.
     *
     * @return Steno log compatible representation.
     */
    @LogValue
    public Object toLogValue() {
        return LogValueMapFactory.builder(this)
                .put("name", _name)
                .build();
    }

    @Override
    public String toString() {
        return toLogValue().toString();
    }

    /**
     * Protected constructor.
     *
     * @param builder Instance of {@link Builder}.
     */
    protected BaseSource(final Builder builder) {
        _name = builder._name;
    }

    private final String _name;
    private final ObservableDelegate _observable = ObservableDelegate.newInstance();

    /**
     * Base {@link com.arpnetworking.commons.builder.Builder} implementation for
     * {@link Source} subclasses.
     *
     * @param  type of the builder
     * @param  type of the source to build
     * @author Ville Koskela (ville dot koskela at inscopemetrics dot io)
     */
    protected abstract static class Builder, S extends Source> extends OvalBuilder {

        /**
         * Sets name. Cannot be null or empty.
         *
         * @param value The name.
         * @return This instance of {@link Builder}.
         */
        public final B setName(final String value) {
            _name = value;
            return self();
        }

        /**
         * Called by setters to always return appropriate subclass of
         * {@link Builder}, even from setters of base class.
         *
         * @return instance with correct {@link Builder} class type.
         */
        protected abstract B self();

        /**
         * Protected constructor for subclasses.
         *
         * @param targetConstructor The constructor for the concrete type to be created by this builder.
         */
        protected Builder(final Function targetConstructor) {
            super(targetConstructor);
        }

        @NotNull
        @NotEmpty
        private String _name;
    }
}