ConfigServiceImpl (Java API Reference for Oracle Service Bus)

java.lang.Object
- com.bea.wli.config.impl.ConfigServiceImpl

All Implemented Interfaces:

ConfigService
```
public class ConfigServiceImpl
extends java.lang.Object
implements ConfigService
```
The main class for the Config Service. An instance of this class is instantiated for each application that wishes to use the service.

Field Summary

Fields
Modifier and Type Field and Description

static java.lang.String TEMP_UNDO_SESSION_PREFIX
Prefix for undo sessions

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`TEMP_UNDO_SESSION_PREFIX` Prefix for undo sessions

Constructor Summary

Constructors
Constructor and Description

ConfigServiceImpl(java.lang.String name, ConfigServiceConfiguration config)
Constructs a new instance of the Config Service

Constructors
Constructor and Description
`ConfigServiceImpl(java.lang.String name, ConfigServiceConfiguration config)` Constructs a new instance of the Config Service

Method Summary

All Methods Instance Methods Concrete Methods
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`	`createNewConfigContext(java.lang.String session, boolean isTransient)` Creates config context for a session this call is expected to be under the SessionManager session lock, which we use as the implicit writelock for the configContextMap.
`void`	`discardConfigContextForSession(java.lang.String session)` Discards config context for a session.
`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
`ConfigContextImpl`	`getConfigContextImpl()` provides access ot the internal config context instance for the current session
`ConfigContextImpl`	`getConfigContextImpl(java.lang.String session)` provides access ot the internal config context instance for the given session
`ComponentType`	`getCoreComponentType(java.lang.String typeId)` Returns the component type for the given id that works on core state
`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 deployment initiator 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
`LoggerFactoryImpl`	`getLoggerFactory()` internal debug logger factory
`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 node name for this instance
`PersistenceService`	`getPersistenceService()` returns the persistance handler factory for this instance
`Plugins`	`getPlugins()` returns plugins manager
`ProductInfo`	`getProductInfo()` returns the product info for this instance
`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 the security provider for this instance
`java.util.List<SessionListener>`	`getSessionListeners()` Returns a list of session listeners.
`SessionManager`	`getSessionManager()` Returns session manager
`SessionMBean`	`getSessionMBean()` Returns the session MBean
`java.util.Set<java.lang.String>`	`getSessions()` Returns the set of sessions that exist
`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
`ValidationService`	`getValidationService()` Returns the validation service
`boolean`	`isAdmin()` returns whether this instance is running in admin mode
`boolean`	`isResourceType(java.lang.String typeId)` Returns true if the given resource type is registered
`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
`void`	`registerResourceLifecycleListenerbeforepurgers(ResourceLifecycleListener listener)`
`void`	`registerResourceTypeDef(ResourceTypeDef typedef)` Registers a given (non-extension) 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.
`boolean`	`sessionExists(java.lang.String session)` Checks for existence of config context for specified session
`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

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - TEMP_UNDO_SESSION_PREFIX
```
public static final java.lang.String TEMP_UNDO_SESSION_PREFIX
```
    Prefix for undo sessions
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - ConfigServiceImpl
```
public ConfigServiceImpl(java.lang.String name,
                         ConfigServiceConfiguration config)
                  throws java.lang.Exception
```
    Constructs a new instance of the Config Service
    
    Throws:
    
    java.lang.Exception
- Method Detail
  - getName
```
public java.lang.String getName()
```
    returns the name for this instance
    
    Specified by:
    
    getName in interface ConfigService
  - getNodeName
```
public java.lang.String getNodeName()
```
    returns the node name for this instance
    
    Specified by:
    
    getNodeName in interface ConfigService
  - getProductInfo
```
public ProductInfo getProductInfo()
```
    returns the product info for this instance
    
    Specified by:
    
    getProductInfo in interface ConfigService
  - isAdmin
```
public boolean isAdmin()
```
    returns whether this instance is running in admin mode
    
    Specified by:
    
    isAdmin in interface ConfigService
  - getPersistenceService
```
public PersistenceService getPersistenceService()
```
    returns the persistance handler factory for this instance
    
    Specified by:
    
    getPersistenceService in interface ConfigService
  - getDeploymentInitiator
```
public ConfigDeploymentInitiator getDeploymentInitiator()
```
    returns the deployment initiator for this instance
    
    Specified by:
    
    getDeploymentInitiator in interface ConfigService
  - getSecurityProvider
```
public SecurityProvider getSecurityProvider()
```
    returns the security provider for this instance
    
    Specified by:
    
    getSecurityProvider in interface ConfigService
  - getLogLogger
```
public java.util.logging.Logger getLogLogger()
```
    returns the log logger
    
    Specified by:
    
    getLogLogger in interface ConfigService
  - getDebugLogger
```
public java.util.logging.Logger getDebugLogger(java.lang.String name)
```
    returns the debug logger for the given name (as defined in LoggerFactory)
    
    Specified by:
    
    getDebugLogger in interface ConfigService
  - start
```
public void start()
           throws java.lang.Exception
```
    Starts the config service
    
    Specified by:
    
    start in interface ConfigService
    
    Throws:
    
    java.lang.Exception - if service fails to start
  - started
```
public boolean started()
```
    Check whether config service is started
    
    Specified by:
    
    started in interface ConfigService
    
    Returns:
    
    true if config service is started; false otherwise
  - startListeners
```
public void startListeners()
                    throws java.lang.Exception
```
    Starts transaction listener
    
    Specified by:
    
    startListeners in interface ConfigService
    
    Throws:
    
    java.lang.Exception - if an error occurs starting listeners
  - listenersStarted
```
public boolean listenersStarted()
```
    Check whether config service listeners are started
    
    Specified by:
    
    listenersStarted in interface ConfigService
    
    Returns:
    
    true if listeners have been started; false otherwise
  - shutdown
```
public void shutdown()
```
    Shuts down the config service instance
    
    Specified by:
    
    shutdown in interface ConfigService
  - registerConfigServiceLifecycleListener
```
public void registerConfigServiceLifecycleListener(ConfigServiceLifecycleListener listener)
```
    Registers a config service lifecycle listener
    
    Specified by:
    
    registerConfigServiceLifecycleListener in interface ConfigService
  - registerSimpleTypeDef
```
public void registerSimpleTypeDef(SimpleTypeDef typedef)
```
    Registers a given simple type def. It must be registered before the config service is started.
    
    Specified by:
    
    registerSimpleTypeDef in interface ConfigService
  - getSimpleTypeDef
```
public SimpleTypeDef getSimpleTypeDef(java.lang.String typeId)
```
    returns the simple type def for the given id
    
    Specified by:
    
    getSimpleTypeDef in interface ConfigService
  - isSimpleType
```
public boolean isSimpleType(java.lang.String typeId)
```
    returns whether the given id represents a registered simple type
    
    Specified by:
    
    isSimpleType in interface ConfigService
  - getSimpleTypes
```
public java.util.Set<java.lang.String> getSimpleTypes()
```
    returns the list of simple types
    
    Specified by:
    
    getSimpleTypes in interface ConfigService
  - registerResourceTypeDef
```
public void registerResourceTypeDef(ResourceTypeDef typedef)
```
    Registers a given (non-extension) typedef.
    
    Specified by:
    
    registerResourceTypeDef in interface ConfigService
  - getResourceTypeDef
```
public final ResourceTypeDef getResourceTypeDef(java.lang.String typeId)
```
    Returns the typedef for the given type id
    
    Specified by:
    
    getResourceTypeDef in interface ConfigService
  - isResourceType
```
public final boolean isResourceType(java.lang.String typeId)
```
    Returns true if the given resource type is registered
    
    Specified by:
    
    isResourceType in interface ConfigService
  - getResourceTypes
```
public final java.util.Set<java.lang.String> getResourceTypes()
```
    Returns a set of registered resource types
    
    Specified by:
    
    getResourceTypes in interface ConfigService
  - registerExtensionTypeDef
```
public void registerExtensionTypeDef(ExtensionTypeDef typedef)
```
    Registers an extension typedef.
    
    Specified by:
    
    registerExtensionTypeDef in interface ConfigService
  - getExtensionTypeDefs
```
public java.util.List<ExtensionTypeDef> getExtensionTypeDefs(java.lang.String typeId)
```
    returns the list of extensions for the given type
    
    Specified by:
    
    getExtensionTypeDefs in interface ConfigService
  - getEnvValueTypes
```
public final java.util.Set<java.lang.String> getEnvValueTypes()
```
    Returns a set of registered env value metadata
    
    Specified by:
    
    getEnvValueTypes in interface ConfigService
  - registerEnvValueMetadata
```
public final void registerEnvValueMetadata(EnvValueMetadata md)
```
    Registers metadata about a particular kind of env value
    
    Specified by:
    
    registerEnvValueMetadata in interface ConfigService
  - getEnvValueMetadata
```
public final EnvValueMetadata getEnvValueMetadata(java.lang.String envValueType)
```
    Returns the metadata for the given env value
    
    Specified by:
    
    getEnvValueMetadata in interface ConfigService
  - registerOOTBLocation
```
public final void registerOOTBLocation(Ref location,
                                       LocationProperties props)
```
    Registers an OOTB location (project or folder) with the given properties.
    
    Specified by:
    
    registerOOTBLocation in interface ConfigService
    
    Parameters:
    
    location - the location to register
    
    props - the location's properties
  - registerOOTBResource
```
public final void registerOOTBResource(Ref resource,
                                       java.lang.Object data)
```
    Registers an OOTB resource with the given data.
    
    Specified by:
    
    registerOOTBResource in interface ConfigService
    
    Parameters:
    
    resource - the resource to register
    
    data - the resource's data
  - registerSessionedDataProvider
```
public final void registerSessionedDataProvider(SessionedDataProvider provider)
```
    Registers a SessionedDataProvider
    
    Specified by:
    
    registerSessionedDataProvider in interface ConfigService
  - registerConfigUpgrader
```
public void registerConfigUpgrader(ConfigUpgrader upgrader)
```
    Registers a configuration upgrader/migrator
    
    Specified by:
    
    registerConfigUpgrader in interface ConfigService
    
    Parameters:
    
    upgrader - the upgrader to register
  - registerImportHook
```
public void registerImportHook(ConfigUpgrader upgrader)
```
    Registers a configuration upgrader/migrator
    
    Specified by:
    
    registerImportHook in interface ConfigService
    
    Parameters:
    
    upgrader - the upgrader to register
  - registerResourceLifecycleListener
```
public void registerResourceLifecycleListener(ResourceLifecycleListener listener,
                                              boolean beginning)
                                       throws java.lang.IllegalStateException
```
    Registers a resource life cycle listener
    
    Specified by:
    
    registerResourceLifecycleListener in interface ConfigService
    
    Throws:
    
    java.lang.IllegalStateException
  - registerResourceLifecycleListenerbeforepurgers
```
public void registerResourceLifecycleListenerbeforepurgers(ResourceLifecycleListener listener)
```
    Specified by:
    
    registerResourceLifecycleListenerbeforepurgers in interface ConfigService
  - registerResourceLifecycleListener
```
public void registerResourceLifecycleListener(ResourceLifecycleListener listener)
                                       throws java.lang.IllegalStateException
```
    Description copied from interface: ConfigService
    
    Registers a resource life cycle listener.
    
    Specified by:
    
    registerResourceLifecycleListener in interface ConfigService
    
    Throws:
    
    java.lang.IllegalStateException
  - unregisterResourceLifecycleListener
```
public void unregisterResourceLifecycleListener(ResourceLifecycleListener listener)
```
    Unregisters a resource lifecycle listener
    
    Specified by:
    
    unregisterResourceLifecycleListener in interface ConfigService
  - getResourceLifecycleListeners
```
public java.util.List<ResourceLifecycleListener> getResourceLifecycleListeners()
```
    Returns a list of resource lifecycle listeners
    
    Specified by:
    
    getResourceLifecycleListeners in interface ConfigService
  - getSessionMBean
```
public SessionMBean getSessionMBean()
```
    Returns the session MBean
    
    Specified by:
    
    getSessionMBean in interface ConfigService
  - getSessionManager
```
public SessionManager getSessionManager()
```
    Returns session manager
  - getConfigContext
```
public ConfigContext getConfigContext(java.lang.String session)
```
    Returns config context for specified session
    
    Specified by:
    
    getConfigContext in interface ConfigService
  - getConfigContext
```
public 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
    
    Specified by:
    
    getConfigContext in interface ConfigService
  - registerSessionListener
```
public void registerSessionListener(SessionListener listener)
```
    Registers a listener for session events
    
    Specified by:
    
    registerSessionListener in interface ConfigService
  - unregisterSessionListener
```
public void unregisterSessionListener(SessionListener listener)
```
    unregisters a listener for session events
    
    Specified by:
    
    unregisterSessionListener in interface ConfigService
  - getSessionListeners
```
public java.util.List<SessionListener> getSessionListeners()
```
    Returns a list of session listeners.
    
    Specified by:
    
    getSessionListeners in interface ConfigService
  - getDerivedResourceManager
```
public DerivedResourceManager getDerivedResourceManager()
```
    Returns the derived resource manager
    
    Specified by:
    
    getDerivedResourceManager in interface ConfigService
  - getTransactionManager
```
public TransactionManager getTransactionManager()
```
    Returns transaction manager
    
    Specified by:
    
    getTransactionManager in interface ConfigService
  - addUserService
```
public <T> void addUserService(java.lang.Class<T> clazz,
                               T instance)
```
    sets the service instance for the given API
    
    Specified by:
    
    addUserService in interface ConfigService
  - getUserService
```
public <T> T getUserService(java.lang.Class<T> clazz)
```
    returns the service instance for the given API
    
    Specified by:
    
    getUserService in interface ConfigService
  - getLoggerFactory
```
public LoggerFactoryImpl getLoggerFactory()
```
    internal debug logger factory
  - getPlugins
```
public Plugins getPlugins()
```
    returns plugins manager
  - getValidationService
```
public ValidationService getValidationService()
```
    Returns the validation service
  - sessionExists
```
public boolean sessionExists(java.lang.String session)
```
    Checks for existence of config context for specified session
  - getSessions
```
public java.util.Set<java.lang.String> getSessions()
```
    Returns the set of sessions that exist
  - createNewConfigContext
```
public ConfigContext createNewConfigContext(java.lang.String session,
                                            boolean isTransient)
                                     throws java.lang.Exception
```
    Creates config context for a session this call is expected to be under the SessionManager session lock, which we use as the implicit writelock for the configContextMap.
    
    Throws:
    
    java.lang.Exception
  - discardConfigContextForSession
```
public void discardConfigContextForSession(java.lang.String session)
                                    throws java.lang.Exception
```
    Discards config context for a session. this call is expected to be under the SessionManager session lock, which we use as the implicit writelock for the configContextMap.
    
    Throws:
    
    java.lang.Exception
  - getConfigContextImpl
```
public ConfigContextImpl getConfigContextImpl()
```
    provides access ot the internal config context instance for the current session
  - getConfigContextImpl
```
public ConfigContextImpl getConfigContextImpl(java.lang.String session)
```
    provides access ot the internal config context instance for the given session
  - getCoreComponentType
```
public ComponentType getCoreComponentType(java.lang.String typeId)
```
    Returns the component type for the given id that works on core state

Class ConfigServiceImpl

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

TEMP_UNDO_SESSION_PREFIX

Constructor Detail

ConfigServiceImpl

Method Detail

getName

getNodeName

getProductInfo

isAdmin

getPersistenceService

getDeploymentInitiator

getSecurityProvider

getLogLogger

getDebugLogger

start

started

startListeners

listenersStarted

shutdown

registerConfigServiceLifecycleListener

registerSimpleTypeDef

getSimpleTypeDef

isSimpleType

getSimpleTypes

registerResourceTypeDef

getResourceTypeDef

isResourceType

getResourceTypes

registerExtensionTypeDef

getExtensionTypeDefs

getEnvValueTypes

registerEnvValueMetadata

getEnvValueMetadata

registerOOTBLocation

registerOOTBResource

registerSessionedDataProvider

registerConfigUpgrader

registerImportHook

registerResourceLifecycleListener

registerResourceLifecycleListenerbeforepurgers

registerResourceLifecycleListener

unregisterResourceLifecycleListener

getResourceLifecycleListeners

getSessionMBean

getSessionManager

getConfigContext

getConfigContext

registerSessionListener

unregisterSessionListener

getSessionListeners

getDerivedResourceManager

getTransactionManager

addUserService

getUserService

getLoggerFactory

getPlugins

getValidationService

sessionExists

getSessions

createNewConfigContext

discardConfigContextForSession

getConfigContextImpl

getConfigContextImpl

getCoreComponentType