com.foreach.across.modules.debugweb.DebugWebModuleSettings Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of debug-web-module Show documentation
Debug Web Module
The newest version!
/*
 * Copyright 2014 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.foreach.across.modules.debugweb;

import com.foreach.across.core.annotations.Exposed;
import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.stereotype.Component;

/**
 * @author Arne Vandamme
 */
@Exposed
@Component
@ConfigurationProperties(prefix = "debug-web-module")
public class DebugWebModuleSettings
{
	public static final String DEFAULT_DASHBOARD = "/";

	public static final String ROLE_DEBUG_USER = "ROLE_DEBUG_USER";

	@SuppressWarnings("unused")
	public static final String DASHBOARD_PATH = "debug-web-module.dashboard";

	public static final String SECURITY_ENABLED = "debug-web-module.security.enabled";
	public static final String SECURITY_USERNAME = "debug-web-module.security.username";
	public static final String SECURITY_PASSWORD = "debug-web-module.security.password";
	public static final String SECURITY_AUTHORITY = "debug-web-module.security.authority";
	public static final String SECURITY_IP_ADDRESSES = "debug-web-module.security.ip-addresses";

	/**
	 * Path within the debug web context for the initial dashboard.
	 */
	private String dashboard = DEFAULT_DASHBOARD;

	/**
	 * Root path for all debug web controllers.  All mappings will be relative to this path.
	 */
	private String rootPath = "/debug";

	public String getDashboard() {
		return dashboard;
	}

	public void setDashboard( String dashboard ) {
		this.dashboard = dashboard;
	}

	public String getRootPath() {
		return rootPath;
	}

	public void setRootPath( String rootPath ) {
		this.rootPath = rootPath;
	}

	@Exposed
	@Component
	@ConfigurationProperties(prefix = "debug-web-module.security")
	public static class SecuritySettings
	{
		/**
		 * Enable Basic Authentication for debug web controllers
		 */
		private Boolean enabled = true;

		/**
		 * The username to use for Basic Authentication
		 */
		private String username = "debug";

		/**
		 * The password to use for Basic Authentication
		 */
		private String password;

		/**
		 * A comma separated list of IP Addresses to allow without Basic Authentication
		 */
		private String[] ipAddresses = new String[] { "127.0.0.0/8", "::1" };

		/**
		 * Authority that the authenticated principal should have for accessing debug web controllers.
		 */
		private String authority = ROLE_DEBUG_USER;

		public Boolean getEnabled() {
			return enabled;
		}

		public void setEnabled( Boolean enabled ) {
			this.enabled = enabled;
		}

		public String getUsername() {
			return username;
		}

		public void setUsername( String username ) {
			this.username = username;
		}

		public String getPassword() {
			return password;
		}

		public void setPassword( String password ) {
			this.password = password;
		}

		public String[] getIpAddresses() {
			return ipAddresses.clone();
		}

		public void setIpAddresses( String[] ipAddresses ) {
			this.ipAddresses = ipAddresses.clone();
		}

		public String getAuthority() {
			return authority;
		}

		public void setAuthority( String authority ) {
			this.authority = authority;
		}
	}
}