ConfigService (Oracle Fusion Middleware Java API Reference for Oracle Service Bus)

```
public interface ConfigService
```
The main class for the Config Service. An instance of this class is instantiated for each application that wishes to use the service.

Method Summary

All Methods Instance Methods Abstract 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`	`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

- Method Detail
  - getName
```
java.lang.String getName()
```
    Returns the name for this instance.
  - getNodeName
```
java.lang.String getNodeName()
```
    returns the logical node name this instance is running on.
  - getProductInfo
```
com.bea.wli.config.spi.ProductInfo getProductInfo()
```
    Returns product info of app using config service
  - isAdmin
```
boolean isAdmin()
```
    returns whether this instance is running in admin mode
  - getPersistenceService
```
com.bea.wli.config.persistence.PersistenceService getPersistenceService()
```
    returns the PersistenceService for this instance
  - getDeploymentInitiator
```
com.bea.wli.config.deployment.ConfigDeploymentInitiator getDeploymentInitiator()
```
    Returns the ConfigDeploymentInitiator for this instance
  - getSecurityProvider
```
com.bea.wli.config.security.SecurityProvider getSecurityProvider()
```
    Returns SecurityProvider for this instance
  - getLogLogger
```
java.util.logging.Logger getLogLogger()
```
    returns the log logger
  - getDebugLogger
```
java.util.logging.Logger getDebugLogger(java.lang.String name)
```
    returns the debug logger for the given name (as defined in LoggerFactory)
  - start
```
void start()
    throws java.lang.Exception
```
    Starts the config service
    
    Throws:
    
    java.lang.Exception - if service fails to start
  - started
```
boolean started()
```
    Check whether config service is started
    
    Returns:
    
    true if config service is started; false otherwise
  - startListeners
```
void startListeners()
             throws java.lang.Exception
```
    Starts transaction listener
    
    Throws:
    
    java.lang.Exception - if an error occurs starting listeners
  - listenersStarted
```
boolean listenersStarted()
```
    Check whether config service listeners are started
    
    Returns:
    
    true if listeners have been started; false otherwise
  - shutdown
```
void shutdown()
```
    Shuts down the config service instance
  - registerConfigServiceLifecycleListener
```
void registerConfigServiceLifecycleListener(com.bea.wli.config.spi.ConfigServiceLifecycleListener listener)
```
    Registers a config service lifecycle listener. It must be registered before the config service is started.
  - registerSimpleTypeDef
```
void registerSimpleTypeDef(com.bea.wli.config.spi.SimpleTypeDef typedef)
```
    Registers a given simple type def. It must be registered before the config service is started.
  - getSimpleTypeDef
```
com.bea.wli.config.spi.SimpleTypeDef getSimpleTypeDef(java.lang.String typeId)
```
    returns the simple type def for the given id
  - isSimpleType
```
boolean isSimpleType(java.lang.String typeId)
```
    returns whether the given id represents a registered simple type
  - getSimpleTypes
```
java.util.Set<java.lang.String> getSimpleTypes()
```
    returns the list of simple types
  - registerResourceTypeDef
```
void registerResourceTypeDef(com.bea.wli.config.spi.ResourceTypeDef typedef)
```
    Registers a given typedef. It must be registered before the config service is started.
  - getResourceTypeDef
```
com.bea.wli.config.spi.ResourceTypeDef getResourceTypeDef(java.lang.String typeId)
```
    Returns the typedef for the given type id
  - isResourceType
```
boolean isResourceType(java.lang.String typeId)
```
    Returns whether the given id represents a registered resource type
  - getResourceTypes
```
java.util.Set<java.lang.String> getResourceTypes()
```
    Returns a set of registered resource types
  - registerExtensionTypeDef
```
void registerExtensionTypeDef(com.bea.wli.config.spi.ExtensionTypeDef typedef)
```
    Registers an extension typedef. It must be registered before the config service is started.
  - getExtensionTypeDefs
```
java.util.List<com.bea.wli.config.spi.ExtensionTypeDef> getExtensionTypeDefs(java.lang.String typeId)
```
    returns the list of extensions for the given type
  - registerEnvValueMetadata
```
void registerEnvValueMetadata(com.bea.wli.config.spi.EnvValueMetadata md)
```
    Registers metadata about a particular kind of env value. It must be registered before the config service is started.
  - getEnvValueMetadata
```
com.bea.wli.config.spi.EnvValueMetadata getEnvValueMetadata(java.lang.String envValueType)
```
    Returns the metadata for the given env value
  - getEnvValueTypes
```
java.util.Set<java.lang.String> getEnvValueTypes()
```
    Returns a set of registered env value metadata
  - registerOOTBLocation
```
void registerOOTBLocation(Ref location,
                          LocationProperties props)
```
    Registers an OOTB location (project or folder) with the given properties. It must be registered before the config service is started.
    
    Parameters:
    
    location - the location to register
    
    props - the location's properties
  - registerOOTBResource
```
void registerOOTBResource(Ref resource,
                          java.lang.Object data)
```
    Registers an OOTB resource with the given data. It must be registered before the config service is started.
    
    Parameters:
    
    resource - the resource to register
    
    data - the resource's data
  - registerSessionedDataProvider
```
void registerSessionedDataProvider(com.bea.wli.config.spi.SessionedDataProvider provider)
```
    Registers a SessionedDataProvider. It must be registered before the config service is started, and only for an admin instance.
  - registerConfigUpgrader
```
void registerConfigUpgrader(com.bea.wli.config.spi.ConfigUpgrader upgrader)
```
    Registers a configuration upgrader/migrator. It must be registered before the config service is started, and only for an admin instance.
  - registerImportHook
```
void registerImportHook(com.bea.wli.config.spi.ConfigUpgrader upgrader)
```
    Registers a configuration upgrader/migrator. It must be registered before the config service is started, and only for an admin instance.
  - registerResourceLifecycleListener
```
void registerResourceLifecycleListener(com.bea.wli.config.spi.ResourceLifecycleListener listener)
```
    Registers a resource life cycle listener.
  - unregisterResourceLifecycleListener
```
void unregisterResourceLifecycleListener(com.bea.wli.config.spi.ResourceLifecycleListener listener)
```
    Unregisters a resource lifecycle listener
  - getResourceLifecycleListeners
```
java.util.List<com.bea.wli.config.spi.ResourceLifecycleListener> getResourceLifecycleListeners()
```
    Returns a list of resource lifecycle listeners
  - getSessionMBean
```
com.bea.wli.config.mbeans.SessionMBean getSessionMBean()
```
    Returns the session MBean
  - registerSessionListener
```
void registerSessionListener(com.bea.wli.config.spi.SessionListener listener)
```
    Registers a listener for session events. Can be registered only on an admin instance.
  - unregisterSessionListener
```
void unregisterSessionListener(com.bea.wli.config.spi.SessionListener listener)
```
    unregisters a listener for session events
  - getSessionListeners
```
java.util.List<com.bea.wli.config.spi.SessionListener> getSessionListeners()
```
    Returns a list of session listeners.
  - getConfigContext
```
ConfigContext getConfigContext(java.lang.String session)
```
    Returns config context for specified session
  - getConfigContext
```
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
  - getDerivedResourceManager
```
com.bea.wli.config.derivedcache.DerivedResourceManager getDerivedResourceManager()
```
    Returns the derived resource manager
  - getTransactionManager
```
TransactionManager getTransactionManager()
```
    Returns transaction manager
  - addUserService
```
<T> void addUserService(java.lang.Class<T> clazz,
                        T instance)
```
    sets the service instance for the given API
  - getUserService
```
<T> T getUserService(java.lang.Class<T> clazz)
```
    returns the service instance for the given API

Interface ConfigService

Method Summary

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

registerEnvValueMetadata

getEnvValueMetadata

getEnvValueTypes

registerOOTBLocation

registerOOTBResource

registerSessionedDataProvider

registerConfigUpgrader

registerImportHook

registerResourceLifecycleListener

unregisterResourceLifecycleListener

getResourceLifecycleListeners

getSessionMBean

registerSessionListener

unregisterSessionListener

getSessionListeners

getConfigContext

getConfigContext

getDerivedResourceManager

getTransactionManager

addUserService

getUserService