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 ) |
com.bea.wli.config.deployment.ConfigDeploymentInitiator |
getDeploymentInitiator()
Returns the
ConfigDeploymentInitiator for this instance |
com.bea.wli.config.derivedcache.DerivedResourceManager |
getDerivedResourceManager()
Returns the derived resource manager
|
com.bea.wli.config.spi.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<com.bea.wli.config.spi.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.
|
com.bea.wli.config.persistence.PersistenceService |
getPersistenceService()
returns the
PersistenceService for this instance |
com.bea.wli.config.spi.ProductInfo |
getProductInfo()
Returns product info of app using config service
|
java.util.List<com.bea.wli.config.spi.ResourceLifecycleListener> |
getResourceLifecycleListeners()
Returns a list of resource lifecycle listeners
|
com.bea.wli.config.spi.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
|
com.bea.wli.config.security.SecurityProvider |
getSecurityProvider()
Returns
SecurityProvider for this instance |
java.util.List<com.bea.wli.config.spi.SessionListener> |
getSessionListeners()
Returns a list of session listeners.
|
com.bea.wli.config.mbeans.SessionMBean |
getSessionMBean()
Returns the session MBean
|
com.bea.wli.config.spi.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(com.bea.wli.config.spi.ConfigServiceLifecycleListener listener)
Registers a config service lifecycle listener.
|
void |
registerConfigUpgrader(com.bea.wli.config.spi.ConfigUpgrader upgrader)
Registers a configuration upgrader/migrator.
|
void |
registerEnvValueMetadata(com.bea.wli.config.spi.EnvValueMetadata md)
Registers metadata about a particular kind of env value.
|
void |
registerExtensionTypeDef(com.bea.wli.config.spi.ExtensionTypeDef typedef)
Registers an extension typedef.
|
void |
registerImportHook(com.bea.wli.config.spi.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(com.bea.wli.config.spi.ResourceLifecycleListener listener)
Registers a resource life cycle listener.
|
void |
registerResourceTypeDef(com.bea.wli.config.spi.ResourceTypeDef typedef)
Registers a given typedef.
|
void |
registerSessionedDataProvider(com.bea.wli.config.spi.SessionedDataProvider provider)
Registers a SessionedDataProvider.
|
void |
registerSessionListener(com.bea.wli.config.spi.SessionListener listener)
Registers a listener for session events.
|
void |
registerSimpleTypeDef(com.bea.wli.config.spi.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(com.bea.wli.config.spi.ResourceLifecycleListener listener)
Unregisters a resource lifecycle listener
|
void |
unregisterSessionListener(com.bea.wli.config.spi.SessionListener listener)
unregisters a listener for session events
|
java.lang.String getName()
java.lang.String getNodeName()
com.bea.wli.config.spi.ProductInfo getProductInfo()
boolean isAdmin()
com.bea.wli.config.persistence.PersistenceService getPersistenceService()
PersistenceService
for this instancecom.bea.wli.config.deployment.ConfigDeploymentInitiator getDeploymentInitiator()
ConfigDeploymentInitiator
for this instancecom.bea.wli.config.security.SecurityProvider 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(com.bea.wli.config.spi.ConfigServiceLifecycleListener listener)
void registerSimpleTypeDef(com.bea.wli.config.spi.SimpleTypeDef typedef)
com.bea.wli.config.spi.SimpleTypeDef getSimpleTypeDef(java.lang.String typeId)
boolean isSimpleType(java.lang.String typeId)
java.util.Set<java.lang.String> getSimpleTypes()
void registerResourceTypeDef(com.bea.wli.config.spi.ResourceTypeDef typedef)
com.bea.wli.config.spi.ResourceTypeDef getResourceTypeDef(java.lang.String typeId)
boolean isResourceType(java.lang.String typeId)
java.util.Set<java.lang.String> getResourceTypes()
void registerExtensionTypeDef(com.bea.wli.config.spi.ExtensionTypeDef typedef)
java.util.List<com.bea.wli.config.spi.ExtensionTypeDef> getExtensionTypeDefs(java.lang.String typeId)
void registerEnvValueMetadata(com.bea.wli.config.spi.EnvValueMetadata md)
com.bea.wli.config.spi.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(com.bea.wli.config.spi.SessionedDataProvider provider)
void registerConfigUpgrader(com.bea.wli.config.spi.ConfigUpgrader upgrader)
void registerImportHook(com.bea.wli.config.spi.ConfigUpgrader upgrader)
void registerResourceLifecycleListener(com.bea.wli.config.spi.ResourceLifecycleListener listener)
void unregisterResourceLifecycleListener(com.bea.wli.config.spi.ResourceLifecycleListener listener)
java.util.List<com.bea.wli.config.spi.ResourceLifecycleListener> getResourceLifecycleListeners()
com.bea.wli.config.mbeans.SessionMBean getSessionMBean()
void registerSessionListener(com.bea.wli.config.spi.SessionListener listener)
void unregisterSessionListener(com.bea.wli.config.spi.SessionListener listener)
java.util.List<com.bea.wli.config.spi.SessionListener> getSessionListeners()
ConfigContext getConfigContext(java.lang.String session)
ConfigContext getConfigContext()
com.bea.wli.config.derivedcache.DerivedResourceManager getDerivedResourceManager()
TransactionManager getTransactionManager()
<T> void addUserService(java.lang.Class<T> clazz, T instance)
<T> T getUserService(java.lang.Class<T> clazz)