io.dropwizard.redis.AbstractRedisClientFactory Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of dropwizard-redis Show documentation
Provides easy integration for Dropwizard applications with Redis
The newest version!
package io.dropwizard.redis;

import brave.Tracing;
import com.codahale.metrics.MetricRegistry;
import com.codahale.metrics.health.HealthCheckRegistry;
import com.fasterxml.jackson.annotation.JsonProperty;
import com.fasterxml.jackson.annotation.JsonTypeInfo;
import com.google.common.collect.ImmutableList;
import io.dropwizard.jackson.Discoverable;
import io.dropwizard.lifecycle.setup.LifecycleEnvironment;
import io.dropwizard.redis.clientresources.ClientResourcesFactory;
import io.dropwizard.redis.clientresources.DefaultClientResourcesFactory;
import io.dropwizard.redis.codec.RedisCodecFactory;
import io.dropwizard.redis.metrics.event.visitor.ClusterTopologyChangedEventVisitor;
import io.dropwizard.redis.metrics.event.visitor.CommandLatencyEventVisitor;
import io.dropwizard.redis.metrics.event.visitor.ConnectedEventVisitor;
import io.dropwizard.redis.metrics.event.visitor.ConnectionActivatedEventVisitor;
import io.dropwizard.redis.metrics.event.visitor.ConnectionDeactivatedEventVisitor;
import io.dropwizard.redis.metrics.event.visitor.DisconnectedEventVisitor;
import io.dropwizard.redis.metrics.event.visitor.EventVisitor;
import io.lettuce.core.api.StatefulConnection;
import io.lettuce.core.cluster.ClusterTopologyRefreshOptions;
import org.checkerframework.checker.nullness.qual.Nullable;

import java.util.List;

import jakarta.validation.Valid;
import jakarta.validation.constraints.NotNull;

@JsonTypeInfo(use = JsonTypeInfo.Id.NAME, property = "type")
public abstract class AbstractRedisClientFactory implements Discoverable {
    @NotNull
    @JsonProperty
    protected String name;

    @Valid
    @JsonProperty
    protected ClusterTopologyRefreshOptions clusterTopologyRefreshOptions;

    @Valid
    @NotNull
    @JsonProperty
    protected ClientResourcesFactory clientResources = new DefaultClientResourcesFactory();

    @Valid
    @NotNull
    @JsonProperty
    protected RedisCodecFactory redisCodec;

    public String getName() {
        return name;
    }

    public void setName(final String name) {
        this.name = name;
    }

    public ClusterTopologyRefreshOptions getClusterTopologyRefreshOptions() {
        return clusterTopologyRefreshOptions;
    }

    public void setClusterTopologyRefreshOptions(final ClusterTopologyRefreshOptions clusterTopologyRefreshOptions) {
        this.clusterTopologyRefreshOptions = clusterTopologyRefreshOptions;
    }

    public ClientResourcesFactory getClientResources() {
        return clientResources;
    }

    public void setClientResources(final ClientResourcesFactory clientResources) {
        this.clientResources = clientResources;
    }

    public RedisCodecFactory getRedisCodec() {
        return redisCodec;
    }

    public void setRedisCodec(final RedisCodecFactory redisCodec) {
        this.redisCodec = redisCodec;
    }

    public StatefulConnection build(final HealthCheckRegistry healthChecks, final LifecycleEnvironment lifecycle,
                                          final MetricRegistry metrics) {
        return build(healthChecks, lifecycle, metrics, null);
    }

    public abstract StatefulConnection build(final HealthCheckRegistry healthChecks, final LifecycleEnvironment lifecycle,
                                                   final MetricRegistry metrics, @Nullable final Tracing tracing);

    protected List buildEventVisitors(final MetricRegistry metrics) {
        // Extract this, and the event wrapper builders, to Dropwizard factories, if more event types are added frequently enough?
        return ImmutableList.of(
                new ClusterTopologyChangedEventVisitor(name, metrics),
                new CommandLatencyEventVisitor(name, metrics),
                new ConnectedEventVisitor(name, metrics),
                new ConnectionActivatedEventVisitor(name, metrics),
                new ConnectionDeactivatedEventVisitor(name, metrics),
                new DisconnectedEventVisitor(name, metrics)
        );
    }
}