CombusEndpointProperties.java

/*******************************************************************************
 * Copyright (c) 2007-2008 Cambridge Semantics Incorporated.
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 * 
 * File:        $Source$
 * Created by:  Generated Source from org.openanzo.rdf.utils.properties.jet
 * Created on:  Generated Source from org.openanzo.rdf.utils.properties.jet
 * Revision:	$Id$
 * 
 * Contributors:
 *     Cambridge Semantics Incorporated - initial API and implementation
 *******************************************************************************/
package org.openanzo.combus.endpoint;
import java.util.Properties;
/**
 *   Bayeux Bridge Config Properties.
 *	@author Generated Source from org.openanzo.rdf.utils.properties.jet
 */
 
 public class CombusEndpointProperties{
 	
	/**
	 * Key for property "org.openanzo.combus.endpoint.recorder.enabled"
	 * True to enabled analysis recording
	 *
	 */
	public static final String	KEY_RECORDER_ENABLED	= "org.openanzo.combus.endpoint.recorder.enabled";
 	
	/**
	 * Key for property "org.openanzo.combus.endpoint.recorder.output"
	 * Recorder output file location
	 *
	 */
	public static final String	KEY_RECORDER_OUTPUT	= "org.openanzo.combus.endpoint.recorder.output";
 	
	/**
	 * Key for property "org.openanzo.combus.endpoint.recorder.excludedQueues"
	 * Queue names to exclude from recorder
	 *
	 */
	public static final String	KEY_RECORDER_EXCLUDED_QUEUES	= "org.openanzo.combus.endpoint.recorder.excludedQueues";
 	
 	/**
	 * Get {@link #KEY_RECORDER_ENABLED} property from properties
	 * 
	 * @param properties
	 *            containing configuration data
	 * 
	 * @return value of {@link #KEY_RECORDER_ENABLED}, or false  if not present
	 */
	static public boolean getRecorderEnabled(Properties properties) {
		return Boolean.valueOf(properties.getProperty(KEY_RECORDER_ENABLED,"false")).booleanValue();		
	}

	/**
	 * Set {@link #KEY_RECORDER_ENABLED} property to recorder.enabled in properties
	 * 
	 * @param properties
	 *            containing configuration data
	 * @param recorderEnabled
	 *           value for recorder.enabled
	 */
	static public void setRecorderEnabled(Properties properties, boolean recorderEnabled) {
		properties.setProperty(KEY_RECORDER_ENABLED, Boolean.toString(recorderEnabled));
	}
 	
 	
 	/**
	 * Get {@link #KEY_RECORDER_OUTPUT} property from properties
	 * 
	 * @param properties
	 *            containing configuration data
	 * 
	 * @return value of {@link #KEY_RECORDER_OUTPUT} if not present
	 */
	static public String getRecorderOutput(Properties properties) {
		return properties.getProperty(KEY_RECORDER_OUTPUT);
	}
	
	/**
	 * Set {@link #KEY_RECORDER_OUTPUT} property to recorder.output in properties
	 * 
	 * @param properties
	 *            containing configuration data
	 * @param recorderOutput
	 *            value for recorder.output
	 */
	static public void setRecorderOutput(Properties properties, String recorderOutput) {
		if(recorderOutput==null){
			properties.remove(KEY_RECORDER_OUTPUT);
		}else{
			properties.setProperty(KEY_RECORDER_OUTPUT, recorderOutput);
		}
	}
 	
 	
 	/**
	 * Get {@link #KEY_RECORDER_EXCLUDED_QUEUES} property from properties
	 * 
	 * @param properties
	 *            containing configuration data
	 * 
	 * @return value of {@link #KEY_RECORDER_EXCLUDED_QUEUES} if not present
	 */
	static public String getRecorderExcludedQueues(Properties properties) {
		return properties.getProperty(KEY_RECORDER_EXCLUDED_QUEUES);
	}
	
	/**
	 * Set {@link #KEY_RECORDER_EXCLUDED_QUEUES} property to recorder.excludedQueues in properties
	 * 
	 * @param properties
	 *            containing configuration data
	 * @param recorderExcludedQueues
	 *            value for recorder.excludedQueues
	 */
	static public void setRecorderExcludedQueues(Properties properties, String recorderExcludedQueues) {
		if(recorderExcludedQueues==null){
			properties.remove(KEY_RECORDER_EXCLUDED_QUEUES);
		}else{
			properties.setProperty(KEY_RECORDER_EXCLUDED_QUEUES, recorderExcludedQueues);
		}
	}
 	
 	
 }