Interface LocalMdibAccess
-
- All Superinterfaces:
MdibAccess,MdibAccessObservable,ReadTransactionProvider
- All Known Implementing Classes:
LocalMdibAccessImpl
public interface LocalMdibAccess extends MdibAccess, ReadTransactionProvider, MdibAccessObservable
MDIB read and write access for the BICEPS provider side.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description WriteDescriptionResultwriteDescription(MdibDescriptionModifications mdibDescriptionModifications)Processes the description modifications object, stores the data internally and trigger an event.WriteStateResultwriteStates(MdibStateModifications mdibStateModifications)Processes the state modifications object, stores the data internally and triggers an event.-
Methods inherited from interface org.somda.sdc.biceps.common.access.MdibAccess
findContextStatesByType, findEntitiesByType, getChildrenByType, getContextStates, getContextStates, getContextStates, getDescriptor, getDescriptor, getEntity, getMdDescriptionVersion, getMdibVersion, getMdStateVersion, getRootEntities, getState, getState
-
Methods inherited from interface org.somda.sdc.biceps.common.access.MdibAccessObservable
registerObserver, unregisterObserver
-
Methods inherited from interface org.somda.sdc.biceps.common.access.ReadTransactionProvider
startTransaction
-
-
-
-
Method Detail
-
writeDescription
WriteDescriptionResult writeDescription(MdibDescriptionModifications mdibDescriptionModifications) throws PreprocessingException
Processes the description modifications object, stores the data internally and trigger an event.Data is passed through if the elements of the modification change set do not violate the MDIB storage.
Attention: description modifications are expensive. Even if this operation allows to change states, it should only be used for changes that affect descriptors.
- Parameters:
mdibDescriptionModifications- a set of insertions, updates and deletes.- Returns:
- a write result including inserted, updates and deleted entities.
- Throws:
PreprocessingException- if something goes wrong during preprocessing, i.e., the consistency of the MDIB would be violated.
-
writeStates
WriteStateResult writeStates(MdibStateModifications mdibStateModifications) throws PreprocessingException
Processes the state modifications object, stores the data internally and triggers an event.Data is passed through if the elements of the modification change set do not violate the MDIB storage.
Hint: this function cheap in terms of runtime and should be used for state changes.
- Parameters:
mdibStateModifications- a set of state updates.- Returns:
- a write result including the updated entities.
- Throws:
PreprocessingException- if something goes wrong during preprocessing, i.e., the consistency of the MDIB would be violated.
-
-