org.codice.ddf.itests.common.callables

Class GetConfigurationProperties

java.lang.Object

org.codice.ddf.itests.common.callables.GetConfigurationProperties

All Implemented Interfaces:

Callable<Dictionary<String,Object>>

public class GetConfigurationProperties
extends Object
implements Callable<Dictionary<String,Object>>

Callable that retrieves the properties of a Configuration object. The search is done by looking for the Configuration object that has a property set to a specific value. If multiple objects match the criteria, an IllegalArgumentException will be thrown. For that reason, care should be taken to use a property name whose value is known to be unique.

Constructor Summary

Constructors

Constructor and Description
GetConfigurationProperties(org.osgi.service.cm.ConfigurationAdmin configAdmin, String propertyName, String propertyValue) Constructor.

Method Summary

Modifier and Type	Method and Description
Dictionary<String,Object>	call() Retrieves the Configuration object's properties.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

GetConfigurationProperties

public GetConfigurationProperties(org.osgi.service.cm.ConfigurationAdmin configAdmin,
                                  String propertyName,
                                  String propertyValue)

Constructor.

Parameters:

configAdmin - reference to the container's ConfigurationAdmin

propertyName - name of the property to use for the search

propertyValue - property value to search for

Method Detail

call

public Dictionary<String,Object> call()
                               throws Exception

Retrieves the Configuration object's properties.

Specified by:

call in interface Callable<Dictionary<String,Object>>

Returns:

Configuration object's properties. null if the Configuration object does not exist or has no properties.

Throws:

IllegalArgumentException - thrown if multiple Configuration objects match the search criteria, i.e., have the same property name/value pair

Exception - thrown for any other reasons