com.github.petruki.switcher.client.SwitcherFactory Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of switcher-client Show documentation
Switcher Client for working with Switcher API
There is a newer version: 1.0.6
package com.github.petruki.switcher.client;

import java.util.Map;

import org.apache.log4j.Logger;

import com.github.petruki.switcher.client.domain.Switcher;
import com.github.petruki.switcher.client.exception.SwitcherFactoryContextException;
import com.github.petruki.switcher.client.factory.SwitcherExecutor;
import com.github.petruki.switcher.client.factory.SwitcherOffline;
import com.github.petruki.switcher.client.factory.SwitcherOnline;
import com.github.petruki.switcher.client.utils.SwitcherContextParam;

/**
 * Configure context (using {@link #buildContext(Map, boolean)} and claim switcher (using {@link #getSwitcher(String)} by using this factory.
 * 
 * @author rogerio
 * @since 2019-12-24
 * 
 * @see #buildContext(Map, boolean)
 * @see #getSwitcher(String)
 */
public class SwitcherFactory {
	
	private static final Logger logger = Logger.getLogger(SwitcherFactory.class);
	
	private static SwitcherExecutor instance;
	
	private SwitcherFactory() {}
	
	/**
	 * Configure the context by populating these required informations
	 * 
	 * @param properties 
	 * 
 Required
	 * 
	{@link SwitcherContextParam#URL}
	 * 
 {@link SwitcherContextParam#APIKEY}
	 * 
 {@link SwitcherContextParam#DOMAIN}
	 * 
 {@link SwitcherContextParam#COMPONENT}
	 * 
 {@link SwitcherContextParam#ENVIRONMENT}
	 * 

	 * 
 Optional
	 * 
 {@link SwitcherContextParam#SNAPSHOT_LOCATION}
	 * 
 {@link SwitcherContextParam#SILENT_MODE}
	 * 
 {@link SwitcherContextParam#RETRY_AFTER}
	 * 

	 * @param offline If set to true, this client will find the configuration inside the configured snapshot file
	 * 
	 * @see SwitcherContextParam
	 */
	public static void buildContext(final Map properties, boolean offline) {
		
		if (logger.isDebugEnabled()) {
			logger.debug(String.format("properties: %s", properties));
			logger.debug(String.format("offline: %s", offline));
		}
		
		if (instance == null) {
			if (offline) {
				instance = new SwitcherOffline((String) properties.get(SwitcherContextParam.SNAPSHOT_LOCATION));
			} else {
				instance = new SwitcherOnline(properties);
			}
		} else {
			instance.updateContext(properties);
		}
	}
	
	/**
	 * Return a ready-to-use Switcher that will invoke the criteria configured into the Switcher API or Snapshot
	 * 
	 * @param key name of the key created
	 * @return a ready to use Switcher
	 * @throws SwitcherFactoryContextException If the context hasn't been configured. To avoid this exception, it's required to invoke {@link #buildContext(Map, boolean)} first
	 */
	public static Switcher getSwitcher(final String key) throws SwitcherFactoryContextException {
		
		if (logger.isDebugEnabled()) {
			logger.debug(String.format("key: %s", key));
		}
		
		if (instance == null) {
			throw new SwitcherFactoryContextException();
		}
		
		return new Switcher(key, instance);
	}

}