com.github.enadim.spring.cloud.ribbon.context.ExecutionContextHolder Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of spring-cloud-ribbon-extensions Show documentation

Netflix ribbon extensions.

There is a newer version: 2.0.0

Show newest version

/*
 * Copyright (c) 2017 the original author or authors
 *
 * 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.github.enadim.spring.cloud.ribbon.context;

/**
 * The Ribbon rule context holder.
 *
 * @author Nadim Benabdenbi
 */
public interface ExecutionContextHolder {

    /**
     * Stores the {@link ExecutionContext} for current thread.
     */
    ThreadLocal CONTEXT = new InheritableThreadLocal() {
        @Override
        protected ExecutionContext initialValue() {
            return new DefaultExecutionContext();
        }
    };

    /**
     * Retrieves the current context
     *
     * @return the current context
     */
    static ExecutionContext current() {
        return CONTEXT.get();
    }

    /**
     * switches the current context to the provided one
     *
     * @param context the current context replacement
     * @return the current context
     */
    static ExecutionContext switchTo(ExecutionContext context) {
        CONTEXT.set(context);
        return context;
    }

    /**
     * removes the current context.
     *
     * @return the context before removal
     */
    static ExecutionContext remove() {
        ExecutionContext current = CONTEXT.get();
        CONTEXT.remove();
        return current;
    }
}