io.pivotal.cfenv.spring.boot.CfServiceEnablingEnvironmentPostProcessor Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of java-cfenv-boot Show documentation

Java CF Env Boot Support

The newest version!

/*
 * Copyright 2019 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
 *
 *      https://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 io.pivotal.cfenv.spring.boot;

import org.springframework.boot.env.EnvironmentPostProcessor;
import org.springframework.core.env.Environment;

import io.pivotal.cfenv.core.CfService;

/**
 * Implementations can disable a service by setting a Spring boot property
 * {@code cfenv.service..enabled=false}.
 *
 * @author David Turanski
 */
public interface CfServiceEnablingEnvironmentPostProcessor extends EnvironmentPostProcessor {
	/**
	 * Determine if a service is enabled.
	 *
	 * @param service a service to inspect.
	 * @param environment the Environment.
	 * @return {@code true} if the service is enabled; {@code false} otherwise
	 */
	default boolean isEnabled(CfService service, Environment environment) {
		return Boolean.valueOf(
			environment.getProperty(String.format("cfenv.service.%s.enabled", service.getName()),
				"true"));
	}
}