Package org.codice.ddf.admin.core.api

Interface ConfigurationStatus

All Superinterfaces:

Map<String,String>

public interface ConfigurationStatus
extends Map<String,String>

Enabled or Disabled status of a configuration

This code is experimental. While this interface is functional and tested, it may change or be removed in a future version of the library.

Nested Class Summary

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K extends Object,V extends Object>

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DISABLED_EXTENSION
static final String	NEW_FACTORY_PID
static final String	NEW_PID
static final String	ORIGINAL_FACTORY_PID
static final String	ORIGINAL_PID

Method Summary

Modifier and Type	Method	Description
default String	getNewFactoryPid()	Returns the updated configuration PID after the configuration has been either enabled or disabled.
default String	getNewPid()	Returns the updated configuration PID after the configuration has been either enabled or disabled.
default String	getOriginalFactoryPid()	Returns the original configuration PID after the configuration has been either enabled or disabled.
default String	getOriginalPid()	Returns the original configuration PID after the configuration has been either enabled or disabled.
default boolean	isDisabled()	Returns true if the configuration is currently disabled
default void	setNewFactoryPid(String newFactoryPid)
default void	setNewPid(String newPid)
default void	setOriginalFactoryPid(String originalFactoryPid)
default void	setOriginalPid(String originalPid)

Methods inherited from interface java.util.Map

clear, compute, computeIfAbsent, computeIfPresent, containsKey, containsValue, entrySet, equals, forEach, get, getOrDefault, hashCode, isEmpty, keySet, merge, put, putAll, putIfAbsent, remove, remove, replace, replace, replaceAll, size, values

Field Details

DISABLED_EXTENSION

static final String DISABLED_EXTENSION

See Also:

• Constant Field Values

NEW_FACTORY_PID

static final String NEW_FACTORY_PID

See Also:

• Constant Field Values

NEW_PID

static final String NEW_PID

See Also:

• Constant Field Values

ORIGINAL_PID

static final String ORIGINAL_PID

See Also:

• Constant Field Values

ORIGINAL_FACTORY_PID

static final String ORIGINAL_FACTORY_PID

See Also:

• Constant Field Values

Method Details

getNewFactoryPid

default String getNewFactoryPid()

Returns the updated configuration PID after the configuration has been either enabled or disabled. This property is relevant only to managed service factory configurations.

Returns:

configuration PID

setNewFactoryPid

default void setNewFactoryPid(String newFactoryPid)

getNewPid

default String getNewPid()

Returns the updated configuration PID after the configuration has been either enabled or disabled. This property is relevant only to managed service configurations.

Returns:

configuration PID

setNewPid

default void setNewPid(String newPid)

getOriginalPid

default String getOriginalPid()

Returns the original configuration PID after the configuration has been either enabled or disabled. This property is relevant only to managed service configurations.

Returns:

configuration PID

setOriginalPid

default void setOriginalPid(String originalPid)

getOriginalFactoryPid

default String getOriginalFactoryPid()

Returns the original configuration PID after the configuration has been either enabled or disabled. This property is relevant only to managed service factory configurations.

Returns:

configuration PID

setOriginalFactoryPid

default void setOriginalFactoryPid(String originalFactoryPid)

isDisabled

default boolean isDisabled()

Returns true if the configuration is currently disabled

Returns:

true if the configuration is currently disabled