ConfigContextImpl (Java API Reference for Oracle Service Bus)

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

All Implemented Interfaces:

ConfigContext
```
public final class ConfigContextImpl
extends java.lang.Object
implements ConfigContext
```
Class that represents the config of a session or of core note: every access to resources via this API must be in a transaction. note: internal simple types are often called without transaction for read, but the fact they use transactional maps make them somewhat concurrent

Constructor Summary

Constructors
Constructor and Description
`ConfigContextImpl(ConfigServiceImpl configService, java.lang.String session, boolean isTransient, boolean isLoad)` Creates config context but does not initialize it yet.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`create(Ref ref, java.lang.Object data)` Creates a new simple type instance with the given id and value.
`void`	`delete(Ref ref)` Deletes the simple type instance with the given reference.
`void`	`delete(java.util.Set<Ref> refs)` Deletes the simple type instances with the given references.
`void`	`destroy()` Nukes all the persisted data associated with a session, essentially erasing the session
`<T> T`	`execute(java.util.concurrent.Callable<T> callable, java.lang.String description, boolean readOnly)` executes the given callable in this context
`<T> T`	`executeTask(SessionedTask<T> task)` Executes the given task in this context.
`boolean`	`exists(Ref ref)` Check if the given reference exists.
`boolean`	`exists(ResourceAccess.VersionedRef vref)`
`BaseType`	`getBaseTypeHere(java.lang.String typeId)`
`ReferenceMap`	`getCombinedDependencyGraph()`
`ComponentTypeImpl`	`getComponentTypeHere(java.lang.String typeId)`
`ConfigMBean`	`getConfigMBean()` Returns the ConfigMBean
`ConfigService`	`getConfigService()` Returns the ConfigService that owns this context
`ConfigServiceImpl`	`getConfigServiceImpl()`
`<T> T`	`getData(Ref ref)` Returns the data value for the given reference (applies to simple and resource types).
`Diagnostics`	`getDiagnostics(Ref ref)` Returns the Diagnostics object for the given resource.
`SimpleType`	`getExecHistory()`
`ProjectHierarchy`	`getHierarchy()`
`ComponentType`	`getLocationDataType()`
`LocationType`	`getLocationType()`
`Metadata`	`getMetadata(Ref ref)` Returns the internal Metadata object for the given reference (applies to simple and resource types).
`ReferenceMap`	`getParentChildMap()`
`PersistenceHandler`	`getPersistenceHandler(java.lang.String typeId)`
`ProjectView`	`getProjectView()` returns a view into the project hierarchy
`ReferenceMap`	`getReferenceMap()`
`ReferenceView`	`getReferenceView()` returns a view into the reference graphs
`java.util.Set<Ref>`	`getRefs(ResourceQuery query)` Returns the set of references for resource instances that satisfy the given filter criteria.
`java.util.Set<Ref>`	`getRefs(java.lang.String typeId)` Returns references to all instances of the given (simple or resource) type
`java.util.Set<Ref>`	`getRefs(java.lang.String typeId, java.lang.String keyName, java.lang.Object keyValue)` returns a set of references for instances that have the given keyValue for the given key (applies to simple and resource types).
`<T> T`	`getResourceData(Ref ref, boolean returnCopy)` Returns the resource data for the given reference.
`java.lang.String`	`getSession()` Returns the name of the session this context is associated with
`InternalSessionData`	`getSessionData()`
`java.util.List<SessionedData>`	`getSessionedData()`
`SimpleTypeImpl`	`getSimpleTypeHere(java.lang.String typeId)`
`SimpleType`	`getSystemData()`
`SimpleType`	`getUndoInfo()`
`SimpleType`	`getUploadStore()`
`<T> T`	`getUserProperty(java.lang.String name)` Returns the user property associated with the session.
`java.util.Set<ResourceAccess.VersionedRef>`	`getVersionedRefs()`
`void`	`init(boolean isLoad)` This one really initializes the things transactionally
`boolean`	`isCommitting()`
`boolean`	`isTransient()` returns whether this context is transient
`void`	`setCommitting(boolean b)`
`void`	`setUserProperty(java.lang.String name, java.lang.Object value)` Sets a property associated with the session.
`void`	`shutdown()` Shutdown the context
`void`	`update(Ref ref, java.lang.Object newData)` Updates an existing simple type instance with a new value.
`void`	`updateSessionData(InternalSessionData newdata)`

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

- Constructor Detail
  - ConfigContextImpl
```
public ConfigContextImpl(ConfigServiceImpl configService,
                         java.lang.String session,
                         boolean isTransient,
                         boolean isLoad)
                  throws java.lang.Exception
```
    Creates config context but does not initialize it yet.
    
    Throws:
    
    java.lang.Exception
- Method Detail
  - init
```
public void init(boolean isLoad)
          throws java.lang.Exception
```
    This one really initializes the things transactionally
    
    Throws:
    
    java.lang.Exception
  - shutdown
```
public void shutdown()
```
    Shutdown the context
  - destroy
```
public void destroy()
```
    Nukes all the persisted data associated with a session, essentially erasing the session
  - getSession
```
public java.lang.String getSession()
```
    Description copied from interface: ConfigContext
    
    Returns the name of the session this context is associated with
    
    Specified by:
    
    getSession in interface ConfigContext
  - isTransient
```
public boolean isTransient()
```
    Description copied from interface: ConfigContext
    
    returns whether this context is transient
    
    Specified by:
    
    isTransient in interface ConfigContext
  - getConfigService
```
public ConfigService getConfigService()
```
    Description copied from interface: ConfigContext
    
    Returns the ConfigService that owns this context
    
    Specified by:
    
    getConfigService in interface ConfigContext
  - setUserProperty
```
public void setUserProperty(java.lang.String name,
                            java.lang.Object value)
```
    Description copied from interface: ConfigContext
    
    Sets a property associated with the session. The properties are volatile, not persisted.
    
    Specified by:
    
    setUserProperty in interface ConfigContext
  - getUserProperty
```
public <T> T getUserProperty(java.lang.String name)
```
    Description copied from interface: ConfigContext
    
    Returns the user property associated with the session.
    
    Specified by:
    
    getUserProperty in interface ConfigContext
  - getConfigMBean
```
public ConfigMBean getConfigMBean()
```
    Description copied from interface: ConfigContext
    
    Returns the ConfigMBean
    
    Specified by:
    
    getConfigMBean in interface ConfigContext
  - exists
```
public boolean exists(Ref ref)
```
    Description copied from interface: ConfigContext
    
    Check if the given reference exists. In case of resources, the reference can be a project, location or resource instance.
    
    Specified by:
    
    exists in interface ConfigContext
  - getRefs
```
public java.util.Set<Ref> getRefs(java.lang.String typeId)
```
    Description copied from interface: ConfigContext
    
    Returns references to all instances of the given (simple or resource) type
    
    Specified by:
    
    getRefs in interface ConfigContext
  - getRefs
```
public java.util.Set<Ref> getRefs(java.lang.String typeId,
                                  java.lang.String keyName,
                                  java.lang.Object keyValue)
```
    Description copied from interface: ConfigContext
    
    returns a set of references for instances that have the given keyValue for the given key (applies to simple and resource types). Returns empty set if none found.
    
    Specified by:
    
    getRefs in interface ConfigContext
    
    Parameters:
    
    typeId - the simple or resource type
    
    keyName - the name of the key defined on this type
    
    keyValue - the key value to be searched
  - getRefs
```
public java.util.Set<Ref> getRefs(ResourceQuery query)
```
    Description copied from interface: ConfigContext
    
    Returns the set of references for resource instances that satisfy the given filter criteria.
    
    Specified by:
    
    getRefs in interface ConfigContext
    
    Parameters:
    
    query - the resource query
    
    Returns:
    
    the set of references of components that satisfy the criteria
  - getData
```
public <T> T getData(Ref ref)
              throws NotFoundException
```
    Description copied from interface: ConfigContext
    
    Returns the data value for the given reference (applies to simple and resource types). For resources, this is the actual value (i.e. not a copy).
    
    Specified by:
    
    getData in interface ConfigContext
    
    Throws:
    
    NotFoundException
  - getResourceData
```
public <T> T getResourceData(Ref ref,
                             boolean returnCopy)
                      throws NotFoundException
```
    Description copied from interface: ConfigContext
    
    Returns the resource data for the given reference.
    
    Specified by:
    
    getResourceData in interface ConfigContext
    
    Parameters:
    
    ref - reference to the resource
    
    returnCopy - whether to return a copy of the data
    
    Returns:
    
    the resource data
    
    Throws:
    
    NotFoundException
  - getMetadata
```
public Metadata getMetadata(Ref ref)
                     throws NotFoundException
```
    Description copied from interface: ConfigContext
    
    Returns the internal Metadata object for the given reference (applies to simple and resource types).
    
    Specified by:
    
    getMetadata in interface ConfigContext
    
    Parameters:
    
    ref - reference to the instance
    
    Returns:
    
    the metadata associated with this reference
    
    Throws:
    
    NotFoundException
  - getDiagnostics
```
public Diagnostics getDiagnostics(Ref ref)
                           throws NotFoundException
```
    Description copied from interface: ConfigContext
    
    Returns the Diagnostics object for the given resource.
    
    Specified by:
    
    getDiagnostics in interface ConfigContext
    
    Throws:
    
    NotFoundException
  - create
```
public void create(Ref ref,
                   java.lang.Object data)
            throws ValidationException,
                   CreateException
```
    Description copied from interface: ConfigContext
    
    Creates a new simple type instance with the given id and value.
    
    Specified by:
    
    create in interface ConfigContext
    
    Parameters:
    
    ref - reference of the new instance.
    
    data - the data used to initialize the instance.
    
    Throws:
    
    ValidationException - if the validation of the data, or reference fails, or if the instance already exists
    
    CreateException - if there are any other errors during the operation (serialization, etc)
  - delete
```
public void delete(Ref ref)
            throws DeleteException,
                   NotFoundException
```
    Description copied from interface: ConfigContext
    
    Deletes the simple type instance with the given reference.
    
    Specified by:
    
    delete in interface ConfigContext
    
    Parameters:
    
    ref - reference of the instance to be deleted.
    
    Throws:
    
    DeleteException - if there are any other errors during the operation
    
    NotFoundException - if the instance does not exist.
  - delete
```
public void delete(java.util.Set<Ref> refs)
            throws DeleteException,
                   NotFoundException
```
    Description copied from interface: ConfigContext
    
    Deletes the simple type instances with the given references.
    
    Specified by:
    
    delete in interface ConfigContext
    
    Parameters:
    
    refs - references of the instances to be deleted.
    
    Throws:
    
    DeleteException - if there are any other errors during the operation
    
    NotFoundException - if the instance does not exist.
  - update
```
public void update(Ref ref,
                   java.lang.Object newData)
            throws ValidationException,
                   UpdateException
```
    Description copied from interface: ConfigContext
    
    Updates an existing simple type instance with a new value.
    
    Specified by:
    
    update in interface ConfigContext
    
    Parameters:
    
    ref - reference of the instance to be updated.
    
    newData - the new value
    
    Throws:
    
    ValidationException - if the validation of the data, or reference fails, or if the instance does not exist
    
    UpdateException - if there are any other errors during the operation (serialization, etc)
  - executeTask
```
public <T> T executeTask(SessionedTask<T> task)
                  throws java.lang.Exception
```
    Description copied from interface: ConfigContext
    
    Executes the given task in this context.
    
    Specified by:
    
    executeTask in interface ConfigContext
    
    Throws:
    
    java.lang.Exception
  - execute
```
public <T> T execute(java.util.concurrent.Callable<T> callable,
                     java.lang.String description,
                     boolean readOnly)
              throws java.lang.Exception
```
    Description copied from interface: ConfigContext
    
    executes the given callable in this context
    
    Specified by:
    
    execute in interface ConfigContext
    
    Throws:
    
    java.lang.Exception
  - getProjectView
```
public ProjectView getProjectView()
```
    Description copied from interface: ConfigContext
    
    returns a view into the project hierarchy
    
    Specified by:
    
    getProjectView in interface ConfigContext
  - getReferenceView
```
public ReferenceView getReferenceView()
```
    Description copied from interface: ConfigContext
    
    returns a view into the reference graphs
    
    Specified by:
    
    getReferenceView in interface ConfigContext
  - getConfigServiceImpl
```
public ConfigServiceImpl getConfigServiceImpl()
```
  - getReferenceMap
```
public ReferenceMap getReferenceMap()
```
  - getParentChildMap
```
public ReferenceMap getParentChildMap()
```
  - getCombinedDependencyGraph
```
public ReferenceMap getCombinedDependencyGraph()
```
  - getHierarchy
```
public ProjectHierarchy getHierarchy()
```
  - getSystemData
```
public SimpleType getSystemData()
```
  - getExecHistory
```
public SimpleType getExecHistory()
```
  - getUndoInfo
```
public SimpleType getUndoInfo()
```
  - getUploadStore
```
public SimpleType getUploadStore()
```
  - getLocationDataType
```
public ComponentType getLocationDataType()
```
  - getLocationType
```
public LocationType getLocationType()
```
  - getBaseTypeHere
```
public BaseType getBaseTypeHere(java.lang.String typeId)
```
  - getComponentTypeHere
```
public ComponentTypeImpl getComponentTypeHere(java.lang.String typeId)
```
  - getSimpleTypeHere
```
public SimpleTypeImpl getSimpleTypeHere(java.lang.String typeId)
```
  - getSessionData
```
public InternalSessionData getSessionData()
```
  - updateSessionData
```
public void updateSessionData(InternalSessionData newdata)
                       throws java.lang.Exception
```
    Throws:
    
    java.lang.Exception
  - getSessionedData
```
public java.util.List<SessionedData> getSessionedData()
```
  - getPersistenceHandler
```
public PersistenceHandler getPersistenceHandler(java.lang.String typeId)
                                         throws java.lang.Exception
```
    Throws:
    
    java.lang.Exception
  - exists
```
public boolean exists(ResourceAccess.VersionedRef vref)
```
  - getVersionedRefs
```
public java.util.Set<ResourceAccess.VersionedRef> getVersionedRefs()
```
  - isCommitting
```
public boolean isCommitting()
```
  - setCommitting
```
public void setCommitting(boolean b)
```

Class ConfigContextImpl

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ConfigContextImpl

Method Detail

init

shutdown

destroy

getSession

isTransient

getConfigService

setUserProperty

getUserProperty

getConfigMBean

exists

getRefs

getRefs

getRefs

getData

getResourceData

getMetadata

getDiagnostics

create

delete

delete

update

executeTask

execute

getProjectView

getReferenceView

getConfigServiceImpl

getReferenceMap

getParentChildMap

getCombinedDependencyGraph

getHierarchy

getSystemData

getExecHistory

getUndoInfo

getUploadStore

getLocationDataType

getLocationType

getBaseTypeHere

getComponentTypeHere

getSimpleTypeHere

getSessionData

updateSessionData

getSessionedData

getPersistenceHandler

exists

getVersionedRefs

isCommitting

setCommitting