public interface ConfigurationService
Modifier and Type | Method and Description |
---|---|
Map<String,ConfigParameter> |
getAllConfigParameters(Locale locale,
boolean displayableInUI)
Returns all ConfigParameters.
|
ConfigParameter |
getConfigParameter(String parameterName,
Locale locale)
Returns the specified ConfigParameter.
|
Map<String,ConfigParameter> |
getConfigParameters(List<String> parametersName,
Locale locale)
Returns the specified ConfigParameters.
|
String |
getConfigParameterValue(String parameterName)
Returns default value for specified ConfigParameter.
|
DefaultOwnerSetting |
getDefaultOwnerCIPrototype()
Returns the default owner CI prototype for UCMDB.
|
ConfigurationFactory |
getFactory()
Returns configuration factory.
|
String |
registerConfigurationParametersListener(ConfigurationParametersListener listener,
ConfigurationParametersListenerFilter filter)
Registers a listener to be called when specified configuration parameters change.
|
void |
setConfigParameterDefaultValue(String parameterName,
String value)
Sets default value for the specified ConfigParameter.
|
void |
setConfigParameterValue(String parameterName,
String value)
Sets value for specified ConfigParameter for the current customer.
|
void |
setDefaultOwnerCIPrototype(CI defaultOwnerPrototype,
String ownershipRelationClassName,
boolean linkFromOwnerToCI)
Sets the default owner CI prototype for UCMDB.
|
void |
unregisterConfigurationParametersListener(String listenerId)
Unregisters the specified listener.
|
ConfigurationFactory getFactory()
Map<String,ConfigParameter> getAllConfigParameters(Locale locale, boolean displayableInUI)
locale
- Locale for retrieving display values; if null, no localization applieddisplayableInUI
- if true only ConfigParameters with isDisplayInUI=true return, else all available ConfigParametersConfigParameter getConfigParameter(String parameterName, Locale locale)
parameterName
- ConfigParameter namelocale
- Locale for retrieving display values; if null, no localization appliedMap<String,ConfigParameter> getConfigParameters(List<String> parametersName, Locale locale)
parametersName
- List of ConfigParameter nameslocale
- Locale for retrieving display values; if null, no localization appliedvoid setConfigParameterDefaultValue(String parameterName, String value)
parameterName
- ConfigParameter namevalue
- new default valueString getConfigParameterValue(String parameterName)
parameterName
- ConfigParameter namevoid setConfigParameterValue(String parameterName, String value)
parameterName
- ConfigParameter namevalue
- new valuevoid setDefaultOwnerCIPrototype(CI defaultOwnerPrototype, String ownershipRelationClassName, boolean linkFromOwnerToCI)
defaultOwnerPrototype
- the CI.ownershipRelationClassName
- the relation class name that will be used to create the relations between
the default owner and the CIs.linkFromOwnerToCI
- true if the link should be created from the owner to the CI, false if it should be created
in the other direction.DefaultOwnerSetting getDefaultOwnerCIPrototype()
setDefaultOwnerCIPrototype(com.hp.ucmdb.api.types.CI, java.lang.String, boolean)
for details.
Some or all of the values in the DefaultOwnerSetting
structure can
be null or empty, according to the parameters saved in the UCMDB.
The default owner CI may or may not exist in the UCMDB, or it may exist but have a different UcmdbId.
(It might have a different ID if it has been reconciled.) However, this prototype (if not null), can be used safely in data-in
operations (TopologyUpdateService
).String registerConfigurationParametersListener(ConfigurationParametersListener listener, ConfigurationParametersListenerFilter filter) throws UcmdbException
listener
- client-side implementation of the listener interface.filter
- notification filter instance obtained through {link ConfigurationFactory.createListenerFilter()
UcmdbException
void unregisterConfigurationParametersListener(String listenerId)
listenerId
- id returned by registeration function Documentation Feedback
Copyright 2011 - 2018 Micro Focus or one of its affiliates.