Package org.onosproject.cfg

Interface ComponentConfigStore

All Superinterfaces:

Store<ComponentConfigEvent,ComponentConfigStoreDelegate>

All Known Implementing Classes:

DistributedComponentConfigStore

public interface ComponentConfigStore
extends Store<ComponentConfigEvent,ComponentConfigStoreDelegate>

Service for storing and distributing system-wide configurations for various software components.

Method Summary

Modifier and Type	Method	Description
default java.util.Set<java.lang.String>	getProperties(java.lang.String component)	Returns set of component configuration property names.
default java.lang.String	getProperty(java.lang.String component, java.lang.String name)	Returns the string value of the given component configuration property.
void	setProperty(java.lang.String componentName, java.lang.String name, java.lang.String value)	Sets the value of the specified configuration property.
void	setProperty(java.lang.String componentName, java.lang.String name, java.lang.String value, boolean override)	Sets the value of the specified configuration property.
void	unsetProperty(java.lang.String componentName, java.lang.String name)	Clears the value of the specified configuration property thus making the property take on its default value.

Methods inherited from interface org.onosproject.store.Store

hasDelegate, setDelegate, unsetDelegate

Method Detail

setProperty

void setProperty(java.lang.String componentName,
                 java.lang.String name,
                 java.lang.String value)

Sets the value of the specified configuration property.

Parameters:

componentName - component name

name - property name

value - new property value

setProperty

void setProperty(java.lang.String componentName,
                 java.lang.String name,
                 java.lang.String value,
                 boolean override)

Sets the value of the specified configuration property.

Parameters:

componentName - component name

name - property name

value - new property value

override - true to override even if the property has been set to other value

unsetProperty

void unsetProperty(java.lang.String componentName,
                   java.lang.String name)

Clears the value of the specified configuration property thus making the property take on its default value.

Parameters:

componentName - component name

name - property name

getProperties

default java.util.Set<java.lang.String> getProperties(java.lang.String component)

Returns set of component configuration property names. This includes only the names of properties whose values depart from their default.

Parameters:

component - component name

Returns:

set of property names whose values are set to non-default values

getProperty

default java.lang.String getProperty(java.lang.String component,
                                     java.lang.String name)

Returns the string value of the given component configuration property. For properties whose values are set to their default this may return null.

Parameters:

component - component name

name - property name; null if no property found or if value is default

Returns:

set of property names