public interface ConfigService
Modifier and Type | Method and Description |
---|---|
<T> void |
addUserService(java.lang.Class<T> clazz, T instance)
sets the service instance for the given API
|
ConfigContext |
getConfigContext()
Returns the config context for the current session (if we are in a session) or return core config context if there is no session
|
ConfigContext |
getConfigContext(java.lang.String session)
Returns config context for specified session
|
java.util.logging.Logger |
getDebugLogger(java.lang.String name)
returns the debug logger for the given name (as defined in
LoggerFactory ) |
ConfigDeploymentInitiator |
getDeploymentInitiator()
Returns the
ConfigDeploymentInitiator for this instance |
DerivedResourceManager |
getDerivedResourceManager()
Returns the derived resource manager
|
EnvValueMetadata |
getEnvValueMetadata(java.lang.String envValueType)
Returns the metadata for the given env value
|
java.util.Set<java.lang.String> |
getEnvValueTypes()
Returns a set of registered env value metadata
|
java.util.List<ExtensionTypeDef> |
getExtensionTypeDefs(java.lang.String typeId)
returns the list of extensions for the given type
|
java.util.logging.Logger |
getLogLogger()
returns the log logger
|
java.lang.String |
getName()
Returns the name for this instance.
|
java.lang.String |
getNodeName()
returns the logical node name this instance is running on.
|
PersistenceService |
getPersistenceService()
returns the
PersistenceService for this instance |
ProductInfo |
getProductInfo()
Returns product info of app using config service
|
java.util.List<ResourceLifecycleListener> |
getResourceLifecycleListeners()
Returns a list of resource lifecycle listeners
|
ResourceTypeDef |
getResourceTypeDef(java.lang.String typeId)
Returns the typedef for the given type id
|
java.util.Set<java.lang.String> |
getResourceTypes()
Returns a set of registered resource types
|
SecurityProvider |
getSecurityProvider()
Returns
SecurityProvider for this instance |
java.util.List<SessionListener> |
getSessionListeners()
Returns a list of session listeners.
|
SessionMBean |
getSessionMBean()
Returns the session MBean
|
SimpleTypeDef |
getSimpleTypeDef(java.lang.String typeId)
returns the simple type def for the given id
|
java.util.Set<java.lang.String> |
getSimpleTypes()
returns the list of simple types
|
TransactionManager |
getTransactionManager()
Returns transaction manager
|
<T> T |
getUserService(java.lang.Class<T> clazz)
returns the service instance for the given API
|
boolean |
isAdmin()
returns whether this instance is running in admin mode
|
boolean |
isResourceType(java.lang.String typeId)
Returns whether the given id represents a registered resource type
|
boolean |
isSimpleType(java.lang.String typeId)
returns whether the given id represents a registered simple type
|
boolean |
listenersStarted()
Check whether config service listeners are started
|
void |
registerConfigServiceLifecycleListener(ConfigServiceLifecycleListener listener)
Registers a config service lifecycle listener.
|
void |
registerConfigUpgrader(ConfigUpgrader upgrader)
Registers a configuration upgrader/migrator.
|
void |
registerEnvValueMetadata(EnvValueMetadata md)
Registers metadata about a particular kind of env value.
|
void |
registerExtensionTypeDef(ExtensionTypeDef typedef)
Registers an extension typedef.
|
void |
registerImportHook(ConfigUpgrader upgrader)
Registers a configuration upgrader/migrator.
|
void |
registerOOTBLocation(Ref location, LocationProperties props)
Registers an OOTB location (project or folder) with the given properties.
|
void |
registerOOTBResource(Ref resource, java.lang.Object data)
Registers an OOTB resource with the given data.
|
void |
registerResourceLifecycleListener(ResourceLifecycleListener listener)
Registers a resource life cycle listener.
|
void |
registerResourceLifecycleListener(ResourceLifecycleListener listener, boolean beginning)
Registers a resource life cycle listener at the beginnning
|
void |
registerResourceLifecycleListenerbeforepurgers(ResourceLifecycleListener listener) |
void |
registerResourceTypeDef(ResourceTypeDef typedef)
Registers a given typedef.
|
void |
registerSessionedDataProvider(SessionedDataProvider provider)
Registers a SessionedDataProvider.
|
void |
registerSessionListener(SessionListener listener)
Registers a listener for session events.
|
void |
registerSimpleTypeDef(SimpleTypeDef typedef)
Registers a given simple type def.
|
void |
shutdown()
Shuts down the config service instance
|
void |
start()
Starts the config service
|
boolean |
started()
Check whether config service is started
|
void |
startListeners()
Starts transaction listener
|
void |
unregisterResourceLifecycleListener(ResourceLifecycleListener listener)
Unregisters a resource lifecycle listener
|
void |
unregisterSessionListener(SessionListener listener)
unregisters a listener for session events
|
java.lang.String getName()
java.lang.String getNodeName()
ProductInfo getProductInfo()
boolean isAdmin()
PersistenceService getPersistenceService()
PersistenceService
for this instanceConfigDeploymentInitiator getDeploymentInitiator()
ConfigDeploymentInitiator
for this instanceSecurityProvider getSecurityProvider()
SecurityProvider
for this instancejava.util.logging.Logger getLogLogger()
java.util.logging.Logger getDebugLogger(java.lang.String name)
LoggerFactory
)void start() throws java.lang.Exception
java.lang.Exception
- if service fails to startboolean started()
void startListeners() throws java.lang.Exception
java.lang.Exception
- if an error occurs starting listenersboolean listenersStarted()
void shutdown()
void registerConfigServiceLifecycleListener(ConfigServiceLifecycleListener listener)
void registerSimpleTypeDef(SimpleTypeDef typedef)
SimpleTypeDef getSimpleTypeDef(java.lang.String typeId)
boolean isSimpleType(java.lang.String typeId)
java.util.Set<java.lang.String> getSimpleTypes()
void registerResourceTypeDef(ResourceTypeDef typedef)
ResourceTypeDef getResourceTypeDef(java.lang.String typeId)
boolean isResourceType(java.lang.String typeId)
java.util.Set<java.lang.String> getResourceTypes()
void registerExtensionTypeDef(ExtensionTypeDef typedef)
java.util.List<ExtensionTypeDef> getExtensionTypeDefs(java.lang.String typeId)
void registerEnvValueMetadata(EnvValueMetadata md)
EnvValueMetadata getEnvValueMetadata(java.lang.String envValueType)
java.util.Set<java.lang.String> getEnvValueTypes()
void registerOOTBLocation(Ref location, LocationProperties props)
location
- the location to registerprops
- the location's propertiesvoid registerOOTBResource(Ref resource, java.lang.Object data)
resource
- the resource to registerdata
- the resource's datavoid registerSessionedDataProvider(SessionedDataProvider provider)
void registerConfigUpgrader(ConfigUpgrader upgrader)
void registerImportHook(ConfigUpgrader upgrader)
void registerResourceLifecycleListenerbeforepurgers(ResourceLifecycleListener listener)
void registerResourceLifecycleListener(ResourceLifecycleListener listener)
void registerResourceLifecycleListener(ResourceLifecycleListener listener, boolean beginning)
void unregisterResourceLifecycleListener(ResourceLifecycleListener listener)
java.util.List<ResourceLifecycleListener> getResourceLifecycleListeners()
SessionMBean getSessionMBean()
void registerSessionListener(SessionListener listener)
void unregisterSessionListener(SessionListener listener)
java.util.List<SessionListener> getSessionListeners()
ConfigContext getConfigContext(java.lang.String session)
ConfigContext getConfigContext()
DerivedResourceManager getDerivedResourceManager()
TransactionManager getTransactionManager()
<T> void addUserService(java.lang.Class<T> clazz, T instance)
<T> T getUserService(java.lang.Class<T> clazz)