io.rtdi.bigdata.connector.properties.ConnectionProperties Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of pipelinefoundation Show documentation

The abstraction of an Apache Kafka-like Pipeline and common classes/interfaces.

There is a newer version: 0.10.20

package io.rtdi.bigdata.connector.properties;

import java.io.File;
import java.util.List;

import io.rtdi.bigdata.connector.pipeline.foundation.exceptions.PropertiesException;
import io.rtdi.bigdata.connector.properties.atomic.IProperty;
import io.rtdi.bigdata.connector.properties.atomic.PropertyGroup;
import io.rtdi.bigdata.connector.properties.atomic.PropertyRoot;

/**
 * The design time object of the Connection. The actual data is all stored in a PropertyGroup.
 * This split is because the PropertyGroup has a JAXB reader/writer, this RemoteSourceProperties class does not.
 *
 */
public class ConnectionProperties {
	protected PropertyRoot properties;

	/**
	 * RemoteSourceProperties do have a unique name within an connector.
	 * 
	 * @param name of the properties
	 */
	public ConnectionProperties(String name) {
		super();
		properties = new PropertyRoot(name);
	}
		
	/**
	 * @return name of the RemoteSourceProperties
	 */
	public String getName() {
		return properties.getName();
	}

	/**
	 * Helper method to return a named value of the RemoteSourceProperties object.
	 * @see PropertyGroup#getValues()
	 * 
	 * @return List of all properties
	 */
	public List getValue() {
		return properties.getValues();
	}
		
	/**
	 * Helper method to set all named values of the RemoteSourceProperties object via a PropertyGroup.
	 * 
	 * @param pg set all values based on the contents of this PropertyRoot object
	 * @throws PropertiesException if one of the properties in invalid
	 */
	public void setValue(PropertyRoot pg) throws PropertiesException {
		properties.parseValue(pg, false);
	}

	
	/**
	 * @return The backing PropertyGroup containing the actual values
	 */
	public PropertyRoot getPropertyGroup() {
		return properties;
	}

	public PropertyRoot getPropertyGroupNoPasswords() throws PropertiesException {
		return properties.clone(true); 
	}

	@Override
	public String toString() {
		return properties.toString();
	}

	/**
	 * Read the individual connection properties from a directory. The file name is derived from the {@link #getName()}.
	 * @param directory of the properties file
	 * @throws PropertiesException if the file has invalid contents
	 */
	public void read(File directory) throws PropertiesException {
		properties.read(directory);
	}
	
	public boolean hasPropertiesFile(File webinfdir) {
		return properties.hasPropertiesFile(webinfdir);
	}

	/**
	 * Write the current connection properties into a directory. The file name is derived from the {@link #getName()}.
	 *  
	 * @param directory of the properties file
	 * @throws PropertiesException if one of the properties is invalid or the file is not write-able
	 */
	public void write(File directory) throws PropertiesException {
		properties.write(directory);
	}
}