net.roboconf.dm.management.api.IPreferencesMngr Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of roboconf-dm Show documentation
There is a newer version: 0.9.1
/**
 * Copyright 2015-2016 Linagora, Université Joseph Fourier, Floralis
 *
 * The present code is developed in the scope of the joint LINAGORA -
 * Université Joseph Fourier - Floralis research program and is designated
 * as a "Result" pursuant to the terms and conditions of the LINAGORA
 * - Université Joseph Fourier - Floralis research program. Each copyright
 * holder of Results enumerated here above fully & independently holds complete
 * ownership of the complete Intellectual Property rights applicable to the whole
 * of said Results, and may freely exploit it in any manner which does not infringe
 * the moral rights of the other copyright holders.
 *
 * 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 net.roboconf.dm.management.api;

import java.io.IOException;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.Properties;

import net.roboconf.core.model.runtime.Preference;
import net.roboconf.core.model.runtime.Preference.PreferenceKeyCategory;

/**
 * An API to store and retrieve DM preferences.
 * @author Vincent Zurczak - Linagora
 */
public interface IPreferencesMngr {

	// javax.mail keys.
	String JAVAX_MAIL_FROM = "mail.from";
	String JAVAX_MAIL_SMTP_USER = "mail.user";
	String JAVAX_MAIL_SMTP_PWD = "mail.password";
	String JAVAX_MAIL_SMTP_AUTH = "mail.smtp.auth";
	String JAVAX_MAIL_SMTP_HOST = "mail.smtp.host";
	String JAVAX_MAIL_SMTP_PORT = "mail.smtp.port";
	String JAVAX_MAIL_START_SSL_ENABLE = "mail.smtp.starttls.enable";
	String JAVAX_MAIL_SSL_TRUST = "mail.smtp.ssl.trust";

	// General keys.
	// These properties are specific to Roboconf.

	/**
	 * Default email recipients.
	 */
	String EMAIL_DEFAULT_RECIPIENTS = "email.default.recipients";

	/**
	 * The ports that must be excluded from random port generation.
	 */
	String FORBIDDEN_RANDOM_PORTS = "forbidden.random.ports";

	/**
	 * The maximum number of VM the autonomic can create.
	 */
	String AUTONOMIC_MAX_VM_NUMBER = "autonomic.maximum.vm.number";

	/**
	 * A boolean value indicating if the maximum number of VM must be strict or not.
	 * 
	 * When a given event is processed, one or several command scripts can be executed.
	 * If the maximum is reached before the execution starts, then it is dropped. Otherwise,
	 * it may happen that the scripts create several VMs. If this preference is set to true,
	 * then the script execution will be interrupted. Otherwise, it will continue, with the side
	 * effect that the autonomic may create more VM than the maximum.
	 * 
	 * 
	 * Said differently, when set to false, this property makes the maximum an ideal barrier.
	 * It thus prevents started scripts from interrupting, even if the maximum was reached during
	 * their execution.
	 * 
	 */
	String AUTONOMIC_STRICT_MAX_VM_NUMBER = "autonomic.strict.maximum.vm.number";


	/**
	 * Loads the properties.
	 * 
	 * This method is not invoked in the constructor.
	 * It must be explicitly be run by the DM when it starts, or by any client (e.g. in tests).
	 * 
	 */
	void loadProperties();


	/**
	 * Gets a value by key.
	 * @param key a non-null key
	 * @return a value, potentially null
	 */
	String get( String key );

	/**
	 * Gets a value by key.
	 * @param key a non-null key
	 * @param defaultValue a default value in case where the key was not found
	 * @return a value, or the default value if the key was not found
	 */
	String get( String key, String defaultValue );

	/**
	 * Saves a key and its value.
	 * @param key a non-null key
	 * @param value a non-null value
	 * @throws IOException if something went wrong
	 */
	void save( String key, String value ) throws IOException;

	/**
	 * Deletes a key.
	 * @param key a non-null key
	 * @return the deleted value
	 */
	String delete( String key );

	/**
	 * A convenience method to gather javax.mail properties.
	 * @return a non-null properties with all the javax.mail keys.
	 */
	Properties getJavaxMailProperties();

	/**
	 * @return all the preferences that are editable / public (never null)
	 */
	List getAllPreferences();


	/**
	 * @author Vincent Zurczak - Linagora
	 */
	public static final class Defaults {

		public final Map keyToCategory = new HashMap<> ();
		public final Map keyToDefaultValue = new HashMap<> ();

		/**
		 * Constructor.
		 */
		public Defaults() {

			// Define categories.
			// Some keys may have no category.
			this.keyToCategory.put( JAVAX_MAIL_FROM, PreferenceKeyCategory.EMAIL );
			this.keyToCategory.put( JAVAX_MAIL_SMTP_USER, PreferenceKeyCategory.EMAIL );
			this.keyToCategory.put( JAVAX_MAIL_SMTP_PWD, PreferenceKeyCategory.EMAIL );
			this.keyToCategory.put( JAVAX_MAIL_SMTP_AUTH, PreferenceKeyCategory.EMAIL );
			this.keyToCategory.put( JAVAX_MAIL_SMTP_HOST, PreferenceKeyCategory.EMAIL );
			this.keyToCategory.put( JAVAX_MAIL_SMTP_PORT, PreferenceKeyCategory.EMAIL );
			this.keyToCategory.put( JAVAX_MAIL_SSL_TRUST, PreferenceKeyCategory.EMAIL );
			this.keyToCategory.put( JAVAX_MAIL_START_SSL_ENABLE, PreferenceKeyCategory.EMAIL );
			this.keyToCategory.put( EMAIL_DEFAULT_RECIPIENTS, PreferenceKeyCategory.EMAIL );

			this.keyToCategory.put( AUTONOMIC_MAX_VM_NUMBER, PreferenceKeyCategory.AUTONOMIC );

			// Define default values
			this.keyToDefaultValue.put( JAVAX_MAIL_FROM, "[email protected]" );
			this.keyToDefaultValue.put( JAVAX_MAIL_SMTP_AUTH, "true" );
			this.keyToDefaultValue.put( JAVAX_MAIL_SMTP_HOST, "smtp.gmail.com" );
			this.keyToDefaultValue.put( JAVAX_MAIL_SMTP_PORT, "587" );
			this.keyToDefaultValue.put( JAVAX_MAIL_SSL_TRUST, "smtp.gmail.com" );
			this.keyToDefaultValue.put( JAVAX_MAIL_START_SSL_ENABLE, "true" );
		}
	}
}