hu.icellmobilsoft.coffee.module.redis.annotation.RedisConnection Maven / Gradle / Ivy

Go to download
/*-
 * #%L
 * Coffee
 * %%
 * Copyright (C) 2020 i-Cell Mobilsoft Zrt.
 * %%
 * 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.
 * #L%
 */
package hu.icellmobilsoft.coffee.module.redis.annotation;

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

import jakarta.enterprise.util.AnnotationLiteral;
import jakarta.enterprise.util.Nonbinding;
import jakarta.inject.Qualifier;

import hu.icellmobilsoft.coffee.module.redis.config.RedisConfig;
import hu.icellmobilsoft.coffee.module.redis.manager.RedisManager;

/**
 * Qualifier for instantiating {@link RedisManager}
 *
 * @author mark.petrenyi
 * @since 1.0.0
 */
@Qualifier
@Retention(RetentionPolicy.RUNTIME)
@Target({ ElementType.METHOD, ElementType.FIELD, ElementType.PARAMETER, ElementType.TYPE })
public @interface RedisConnection {

    /**
     * Config key of the desired redis connection. 

     * ie. if connection details are defined in the project-*.yml by the keys: {@code coffee.redis.auth.*=...} then configKey should be "auth"
     * 
     * @return config key
     */
    @Nonbinding
    String configKey();

    /**
     * Config key of the desired redis connection's pool setting. 

     * ie. if connection details are defined in the project-*.yml by the keys: {@code coffee.redis.auth.pool.default.*=...} then configKey should be
     * "default"
     *
     * @return poolConfigKey, default is {@value RedisConfig#POOL_CONFIG_KEY_DEFAULT_VALUE}
     * @since 1.11.0
     */
    @Nonbinding
    String poolConfigKey() default RedisConfig.POOL_CONFIG_KEY_DEFAULT_VALUE;

    /**
     * Supports inline instantiation of the {@link RedisConnection} qualifier.
     *
     * @author mark.petrenyi
     *
     */
    final class Literal extends AnnotationLiteral implements RedisConnection {

        private static final long serialVersionUID = 1L;

        /**
         * Redis configuration key
         */
        private final String configKey;
        /**
         * Redis pool configuration key
         */
        private final String poolConfigKey;

        /**
         * Annotation Literal for Redis configuration
         * 
         * @param configKey
         *            Redis configuration key
         * @param poolConfigKey
         *            Pool configuration key
         */
        public Literal(String configKey, String poolConfigKey) {
            this.configKey = configKey;
            this.poolConfigKey = poolConfigKey;
        }

        /**
         * Instantiates the literal with configKey
         *
         * @param configKey
         *            config key
         */
        public Literal(String configKey) {
            this.configKey = configKey;
            this.poolConfigKey = RedisConfig.POOL_CONFIG_KEY_DEFAULT_VALUE;
        }

        @Override
        @Nonbinding
        public String configKey() {
            return configKey;
        }

        @Override
        @Nonbinding
        public String poolConfigKey() {
            return poolConfigKey;
        }
    }
}