A B C D E F G H I L M N O P R S T U V W
All Classes All Packages
All Classes All Packages
All Classes All Packages
A
- AbstractMdibAccessMessage - Class in org.somda.sdc.biceps.common.event
-
Abstract message definition that provides MDIB access.
- AbstractMdibAccessMessage(MdibAccess) - Constructor for class org.somda.sdc.biceps.common.event.AbstractMdibAccessMessage
-
Constructor that accepts the MDIB access to be provided by
AbstractMdibAccessMessage.getMdibAccess(). - add(MdibDescriptionModification.Type, MdibDescriptionModifications.Entry) - Method in class org.somda.sdc.biceps.common.MdibDescriptionModifications
-
Adds a change.
- add(MdibDescriptionModification.Type, MdibDescriptionModifications.MultiStateEntry) - Method in class org.somda.sdc.biceps.common.MdibDescriptionModifications
-
Adds a change.
- add(MdibDescriptionModification.Type, AbstractDescriptor) - Method in class org.somda.sdc.biceps.common.MdibDescriptionModifications
-
Add single or multi state descriptor to change set without state information.
- add(MdibDescriptionModification.Type, AbstractDescriptor, String) - Method in class org.somda.sdc.biceps.common.MdibDescriptionModifications
-
Adds single or multi state descriptor to change set without state information.
- add(MdibDescriptionModification.Type, AbstractDescriptor, List<? extends AbstractMultiState>) - Method in class org.somda.sdc.biceps.common.MdibDescriptionModifications
-
Add multi state descriptor to change set with state information.
- add(MdibDescriptionModification.Type, AbstractDescriptor, List<? extends AbstractMultiState>, String) - Method in class org.somda.sdc.biceps.common.MdibDescriptionModifications
-
Add multi state descriptor to change set with state information.
- add(MdibDescriptionModification.Type, AbstractDescriptor, AbstractState) - Method in class org.somda.sdc.biceps.common.MdibDescriptionModifications
-
Add single state descriptor to change set with state information.
- add(MdibDescriptionModification.Type, AbstractDescriptor, AbstractState, String) - Method in class org.somda.sdc.biceps.common.MdibDescriptionModifications
-
Add single state descriptor to change set with state information.
- add(AbstractState) - Method in class org.somda.sdc.biceps.common.MdibStateModifications
-
Add a single element to the change set.
- addAll(Collection<T>) - Method in class org.somda.sdc.biceps.common.MdibStateModifications
-
Add multiple elements to the change set.
- afterLastModification(MdibDescriptionModifications, MdibStorage) - Method in interface org.somda.sdc.biceps.common.storage.DescriptionPreprocessingSegment
-
Function that is invoked after the last modification in the processing chain has been applied.
- afterLastModification(MdibDescriptionModifications, MdibStorage) - Method in class org.somda.sdc.biceps.provider.preprocessing.VersionHandler
- afterLastModification(MdibStateModifications, MdibStorage) - Method in interface org.somda.sdc.biceps.common.storage.StatePreprocessingSegment
-
Function that is invoked after the last modification in the processing chain has been applied.
- afterLastModification(MdibStateModifications, MdibStorage) - Method in class org.somda.sdc.biceps.consumer.preprocessing.VersionDuplicateHandler
- afterLastModification(MdibStateModifications, MdibStorage) - Method in class org.somda.sdc.biceps.provider.preprocessing.VersionHandler
- ALERT - org.somda.sdc.biceps.common.MdibStateModifications.Type
- AlertStateModificationMessage - Class in org.somda.sdc.biceps.common.event
-
Subscribe to this message in order to receive alert state changes.
- AlertStateModificationMessage(MdibAccess, List<AbstractAlertState>) - Constructor for class org.somda.sdc.biceps.common.event.AlertStateModificationMessage
-
Constructor.
- allowedParents(AbstractDescriptor) - Method in class org.somda.sdc.biceps.common.MdibTreeValidator
-
Resolves allowed parents descriptor type for a given child descriptor type.
- apply(MdibVersion, BigInteger, BigInteger, MdibDescriptionModifications) - Method in interface org.somda.sdc.biceps.common.storage.MdibStorage
-
Applies description modifications on this object regardless of any consistency checks.
- apply(MdibVersion, BigInteger, BigInteger, MdibDescriptionModifications) - Method in class org.somda.sdc.biceps.common.storage.MdibStorageImpl
- apply(MdibVersion, BigInteger, MdibStateModifications) - Method in interface org.somda.sdc.biceps.common.storage.MdibStorage
-
Applies state modifications on this object regardless of any consistency checks.
- apply(MdibVersion, BigInteger, MdibStateModifications) - Method in class org.somda.sdc.biceps.common.storage.MdibStorageImpl
B
- beforeFirstModification(MdibDescriptionModifications, MdibStorage) - Method in interface org.somda.sdc.biceps.common.storage.DescriptionPreprocessingSegment
-
Function that is invoked before the first modification in the processing chain is applied.
- beforeFirstModification(MdibDescriptionModifications, MdibStorage) - Method in class org.somda.sdc.biceps.provider.preprocessing.DuplicateChecker
- beforeFirstModification(MdibDescriptionModifications, MdibStorage) - Method in class org.somda.sdc.biceps.provider.preprocessing.VersionHandler
- beforeFirstModification(MdibStateModifications, MdibStorage) - Method in interface org.somda.sdc.biceps.common.storage.StatePreprocessingSegment
-
Function that is invoked before the first modification in the processing chain is applied.
- beforeFirstModification(MdibStateModifications, MdibStorage) - Method in class org.somda.sdc.biceps.consumer.preprocessing.VersionDuplicateHandler
- beforeFirstModification(MdibStateModifications, MdibStorage) - Method in class org.somda.sdc.biceps.provider.preprocessing.VersionHandler
C
- CardinalityChecker - Class in org.somda.sdc.biceps.provider.preprocessing
-
Preprocessing segment that verifies correctness of child cardinality.
- CardinalityException - Exception in org.somda.sdc.biceps.provider.preprocessing
-
Exception that is thrown if the cardinality rules of BICEPS are violated during preprocessing.
- CardinalityException() - Constructor for exception org.somda.sdc.biceps.provider.preprocessing.CardinalityException
- CardinalityException(String) - Constructor for exception org.somda.sdc.biceps.provider.preprocessing.CardinalityException
- CardinalityException(String, Throwable) - Constructor for exception org.somda.sdc.biceps.provider.preprocessing.CardinalityException
- CardinalityException(String, Throwable, boolean, boolean) - Constructor for exception org.somda.sdc.biceps.provider.preprocessing.CardinalityException
- CardinalityException(Throwable) - Constructor for exception org.somda.sdc.biceps.provider.preprocessing.CardinalityException
- clear() - Method in class org.somda.sdc.biceps.common.MdibDescriptionModifications
-
Empties all modifications.
- clear() - Method in class org.somda.sdc.biceps.common.MdibStateModifications
-
Flushes added states.
- close() - Method in interface org.somda.sdc.biceps.common.access.ReadTransaction
-
Creates an empty default to override AutoCloseable.close().
- close() - Method in class org.somda.sdc.biceps.common.access.ReadTransactionImpl
- CodedValueFactory - Class in org.somda.sdc.biceps.model.participant.factory
-
Convenience factory to create coded values.
- CodedValueFactory() - Constructor for class org.somda.sdc.biceps.model.participant.factory.CodedValueFactory
- CommonConfig - Class in org.somda.sdc.biceps.common
-
General configuration of the BICEPS common package.
- CommonConfig() - Constructor for class org.somda.sdc.biceps.common.CommonConfig
- CommonConstants - Class in org.somda.sdc.biceps.common
-
Common BICEPS constants.
- CommonConstants() - Constructor for class org.somda.sdc.biceps.common.CommonConstants
- compareToMdibVersion(MdibVersion) - Method in class org.somda.sdc.biceps.model.participant.MdibVersion
-
Compares two MDIB versions.
- COMPONENT - org.somda.sdc.biceps.common.MdibStateModifications.Type
- ComponentStateModificationMessage - Class in org.somda.sdc.biceps.common.event
-
Subscribe to this message in order to receive component state changes.
- ComponentStateModificationMessage(MdibAccess, List<AbstractDeviceComponentState>) - Constructor for class org.somda.sdc.biceps.common.event.ComponentStateModificationMessage
-
Constructor.
- configure() - Method in class org.somda.sdc.biceps.guice.DefaultBicepsModule
- CONTEXT - org.somda.sdc.biceps.common.MdibStateModifications.Type
- ContextStateModificationMessage - Class in org.somda.sdc.biceps.common.event
-
Subscribe to this message in order to receive context state changes.
- ContextStateModificationMessage(MdibAccess, List<AbstractContextState>) - Constructor for class org.somda.sdc.biceps.common.event.ContextStateModificationMessage
-
Constructor.
- COPY_MDIB_INPUT - Static variable in class org.somda.sdc.biceps.common.CommonConfig
-
If true any input to an MDIB is copied before stored in the
MdibStorage. - COPY_MDIB_OUTPUT - Static variable in class org.somda.sdc.biceps.common.CommonConfig
-
If true any output from an MDIB is copied before exposed to the user.
- CopyManager - Class in org.somda.sdc.biceps.common.access
-
A utility class to deep copy any input and output if configured.
- create() - Static method in class org.somda.sdc.biceps.common.MdibDescriptionModifications
-
Creates a set.
- create() - Static method in class org.somda.sdc.biceps.model.participant.MdibVersion
-
Creates a new instance with a random sequence id.
- create(String) - Static method in class org.somda.sdc.biceps.provider.HandleGenerator
-
Creates instance that generates handles with a fixed prefix.
- create(MdibStateModifications.Type) - Static method in class org.somda.sdc.biceps.common.MdibStateModifications
-
Creates a set.
- create(MdibStateModifications.Type, int) - Static method in class org.somda.sdc.biceps.common.MdibStateModifications
-
Creates a set with initial capacity.
- createCodedValue(String, String, String) - Static method in class org.somda.sdc.biceps.model.participant.factory.CodedValueFactory
-
Creates a coded value.
- createCodedValue(String, String, String, String) - Static method in class org.somda.sdc.biceps.model.participant.factory.CodedValueFactory
-
Creates a coded value.
- createGloballyUnique() - Static method in class org.somda.sdc.biceps.provider.HandleGenerator
-
Creates a handle that is globally unique.
- createIeeeCodedValue(String) - Static method in class org.somda.sdc.biceps.model.participant.factory.CodedValueFactory
-
Creates a coded value from the IEEE nomenclature.
- createIeeeCodedValue(String, String) - Static method in class org.somda.sdc.biceps.model.participant.factory.CodedValueFactory
-
Creates a coded value from the IEEE nomenclature.
- createInstanceIdentifier(String) - Static method in class org.somda.sdc.biceps.model.participant.factory.InstanceIdentifierFactory
-
Creates an instance identifier solely based on the root.
- createInstanceIdentifier(String, String) - Static method in class org.somda.sdc.biceps.model.participant.factory.InstanceIdentifierFactory
-
Creates an instance identifier.
- createInstanceIdentifierWithoutRoot(String) - Static method in class org.somda.sdc.biceps.model.participant.factory.InstanceIdentifierFactory
-
Creates an instance identifier solely based on the extension.
- createLocalMdibAccess() - Method in interface org.somda.sdc.biceps.provider.access.factory.LocalMdibAccessFactory
-
Creates a local mdib access with an MDIB version that has a random sequence id.
- createMdibEntity(String, List<String>, AbstractDescriptor, List<AbstractState>, MdibVersion) - Method in class org.somda.sdc.biceps.common.factory.MdibEntityFactory
-
Creates an MDIB entity based on all possible fields.
- createMdibEntity(String, List<String>, AbstractDescriptor, List<AbstractState>, MdibVersion) - Method in interface org.somda.sdc.biceps.common.factory.MdibEntityGuiceAssistedFactory
-
Creates an MDIB entity based on all possible fields.
- createMdibStorage() - Method in interface org.somda.sdc.biceps.common.storage.factory.MdibStorageFactory
-
Creates a storage initialized with a random MDIB version.
- createMdibStorage(MdibVersion) - Method in interface org.somda.sdc.biceps.common.storage.factory.MdibStorageFactory
-
Creates a storage initialized with the given MDIB version.
- createMdibStorage(MdibVersion, BigInteger, BigInteger) - Method in interface org.somda.sdc.biceps.common.storage.factory.MdibStorageFactory
-
Creates a storage initialized with the given MDIB version, MD description and MD state version.
- createMdibStoragePreprocessingChain(MdibStorage, List<DescriptionPreprocessingSegment>, List<StatePreprocessingSegment>) - Method in interface org.somda.sdc.biceps.common.storage.factory.MdibStoragePreprocessingChainFactory
-
Creates a new MdibStoragePreprocessingChain instance.
- createOne(String) - Static method in class org.somda.sdc.biceps.provider.HandleGenerator
-
Static function to create one handle with a given prefix.
- createReadTransaction(MdibStorage, Lock) - Method in interface org.somda.sdc.biceps.common.access.factory.ReadTransactionFactory
-
Creates a read transaction intended for multiple read requests on an MDIB access object.
- createRemoteMdibAccess() - Method in interface org.somda.sdc.biceps.consumer.access.factory.RemoteMdibAccessFactory
-
Creates a local mdib access with an MDIB version that has a random sequence id.
D
- DefaultBicepsConfigModule - Class in org.somda.sdc.biceps.guice
-
Guice module that determines default values for the BICEPS package configuration.
- DefaultBicepsConfigModule() - Constructor for class org.somda.sdc.biceps.guice.DefaultBicepsConfigModule
- DefaultBicepsModule - Class in org.somda.sdc.biceps.guice
-
Default BICEPS module.
- DefaultBicepsModule() - Constructor for class org.somda.sdc.biceps.guice.DefaultBicepsModule
- defaultConfigure() - Method in class org.somda.sdc.biceps.guice.DefaultBicepsConfigModule
- delete(String) - Method in class org.somda.sdc.biceps.common.MdibDescriptionModifications
-
Convenient function to delete a descriptor.
- delete(MdibDescriptionModifications.Entry) - Method in class org.somda.sdc.biceps.common.MdibDescriptionModifications
-
Convenient function to update a descriptor.
- delete(AbstractDescriptor) - Method in class org.somda.sdc.biceps.common.MdibDescriptionModifications
-
Convenient function to delete a descriptor.
- DELETE - org.somda.sdc.biceps.common.MdibDescriptionModification.Type
- DescriptionModificationMessage - Class in org.somda.sdc.biceps.common.event
-
Subscribe to this message in order to receive description changes.
- DescriptionModificationMessage(MdibAccess, List<MdibEntity>, List<MdibEntity>, List<MdibEntity>) - Constructor for class org.somda.sdc.biceps.common.event.DescriptionModificationMessage
-
Constructor.
- DescriptionPreprocessingSegment - Interface in org.somda.sdc.biceps.common.storage
-
A segment that is applied during description modifications.
- DescriptorChildRemover - Class in org.somda.sdc.biceps.common.preprocessing
-
Removes children from descriptors in order to avoid redundant information in the MDIB storage.
- DescriptorChildRemover() - Constructor for class org.somda.sdc.biceps.common.preprocessing.DescriptorChildRemover
- Distributor - Class in org.somda.sdc.biceps.common.event
-
Utility class to distribute any BICEPS MDIB events.
- doIfMultiState(Consumer<List<AbstractMultiState>>) - Method in interface org.somda.sdc.biceps.common.MdibEntity
-
Convenience method to execute code if en entity hosts a multi-state.
- doIfMultiState(Consumer<List<AbstractMultiState>>) - Method in class org.somda.sdc.biceps.common.MdibEntityImpl
- doIfSingleState(Consumer<AbstractState>) - Method in interface org.somda.sdc.biceps.common.MdibEntity
-
Convenience method to execute code if en entity hosts a single-state.
- doIfSingleState(Consumer<AbstractState>) - Method in class org.somda.sdc.biceps.common.MdibEntityImpl
- DuplicateChecker - Class in org.somda.sdc.biceps.provider.preprocessing
-
Preprocessing segment that checks for handle duplicates on inserted entities during description modifications.
E
- Entry(AbstractDescriptor, AbstractState) - Constructor for class org.somda.sdc.biceps.common.MdibDescriptionModifications.Entry
-
Constructor that accepts a descriptor and state (no parent).
- Entry(AbstractDescriptor, AbstractState, String) - Constructor for class org.somda.sdc.biceps.common.MdibDescriptionModifications.Entry
-
Constructor that accepts a descriptor, state and parent handle.
- equals(Object) - Method in class org.somda.sdc.biceps.model.participant.MdibVersion
-
Compares two MdibVersion objects on equality.
- exposeEntityList(Map<String, MdibEntity>, Collection<String>) - Method in class org.somda.sdc.biceps.common.storage.helper.MdibStorageUtil
-
Takes a map of entities and a collection of handles and converts it to a list of entities.
- exposeInstance(Object, Class<T>) - Method in class org.somda.sdc.biceps.common.storage.helper.MdibStorageUtil
-
Accepts an object of a certain instance and cast it to a given type.
- exposeListOfType(Collection<V>, Class<T>) - Method in class org.somda.sdc.biceps.common.storage.helper.MdibStorageUtil
-
Accepts a collection of objects and cast it to a list of the given type.
F
- findContextStatesByType(Class<T>) - Method in interface org.somda.sdc.biceps.common.access.MdibAccess
-
Gets all context states of a specific type.
- findContextStatesByType(Class<T>) - Method in class org.somda.sdc.biceps.common.access.ReadTransactionImpl
- findContextStatesByType(Class<T>) - Method in interface org.somda.sdc.biceps.common.storage.MdibStorage
-
Gets all context states of a specific type.
- findContextStatesByType(Class<T>) - Method in class org.somda.sdc.biceps.common.storage.MdibStorageImpl
- findContextStatesByType(Class<T>) - Method in class org.somda.sdc.biceps.consumer.access.RemoteMdibAccessImpl
- findContextStatesByType(Class<T>) - Method in class org.somda.sdc.biceps.provider.access.LocalMdibAccessImpl
- findEntitiesByType(Class<T>) - Method in interface org.somda.sdc.biceps.common.access.MdibAccess
-
Searches all entities that match a specific type.
- findEntitiesByType(Class<T>) - Method in class org.somda.sdc.biceps.common.access.ReadTransactionImpl
- findEntitiesByType(Class<T>) - Method in interface org.somda.sdc.biceps.common.storage.MdibStorage
-
Searches all entities that match a specific type.
- findEntitiesByType(Class<T>) - Method in class org.somda.sdc.biceps.common.storage.MdibStorageImpl
- findEntitiesByType(Class<T>) - Method in class org.somda.sdc.biceps.consumer.access.RemoteMdibAccessImpl
- findEntitiesByType(Class<T>) - Method in class org.somda.sdc.biceps.provider.access.LocalMdibAccessImpl
G
- getChangeType() - Method in class org.somda.sdc.biceps.common.MdibStateModifications
- getChildren() - Method in interface org.somda.sdc.biceps.common.MdibEntity
-
Obtain a read-only list of the MDIB entity's child handles.
- getChildren() - Method in class org.somda.sdc.biceps.common.MdibEntityImpl
- getChildrenByType(String, Class<T>) - Method in interface org.somda.sdc.biceps.common.access.MdibAccess
-
Resolves the children of a specific type given a parent handle.
- getChildrenByType(String, Class<T>) - Method in class org.somda.sdc.biceps.common.access.ReadTransactionImpl
- getChildrenByType(String, Class<T>) - Method in interface org.somda.sdc.biceps.common.storage.MdibStorage
-
Resolves the children of a specific type given a parent handle.
- getChildrenByType(String, Class<T>) - Method in class org.somda.sdc.biceps.common.storage.MdibStorageImpl
- getChildrenByType(String, Class<T>) - Method in class org.somda.sdc.biceps.consumer.access.RemoteMdibAccessImpl
- getChildrenByType(String, Class<T>) - Method in class org.somda.sdc.biceps.provider.access.LocalMdibAccessImpl
- getContextStates() - Method in interface org.somda.sdc.biceps.common.access.MdibAccess
-
Gets all context states.
- getContextStates() - Method in class org.somda.sdc.biceps.common.access.ReadTransactionImpl
- getContextStates() - Method in interface org.somda.sdc.biceps.common.storage.MdibStorage
-
Gets all context states.
- getContextStates() - Method in class org.somda.sdc.biceps.common.storage.MdibStorageImpl
- getContextStates() - Method in class org.somda.sdc.biceps.consumer.access.RemoteMdibAccessImpl
- getContextStates() - Method in class org.somda.sdc.biceps.provider.access.LocalMdibAccessImpl
- getContextStates(String) - Method in interface org.somda.sdc.biceps.common.access.MdibAccess
-
Finds all context states of a certain descriptor.
- getContextStates(String) - Method in class org.somda.sdc.biceps.common.access.ReadTransactionImpl
- getContextStates(String) - Method in interface org.somda.sdc.biceps.common.storage.MdibStorage
-
Finds all context states of a certain descriptor.
- getContextStates(String) - Method in class org.somda.sdc.biceps.common.storage.MdibStorageImpl
- getContextStates(String) - Method in class org.somda.sdc.biceps.consumer.access.RemoteMdibAccessImpl
- getContextStates(String) - Method in class org.somda.sdc.biceps.provider.access.LocalMdibAccessImpl
- getContextStates(String, Class<T>) - Method in interface org.somda.sdc.biceps.common.access.MdibAccess
-
Finds all context states of a certain descriptor given a state class.
- getContextStates(String, Class<T>) - Method in class org.somda.sdc.biceps.common.access.ReadTransactionImpl
- getContextStates(String, Class<T>) - Method in interface org.somda.sdc.biceps.common.storage.MdibStorage
-
Finds all context states of a certain descriptor given a state class.
- getContextStates(String, Class<T>) - Method in class org.somda.sdc.biceps.common.storage.MdibStorageImpl
- getContextStates(String, Class<T>) - Method in class org.somda.sdc.biceps.consumer.access.RemoteMdibAccessImpl
- getContextStates(String, Class<T>) - Method in class org.somda.sdc.biceps.provider.access.LocalMdibAccessImpl
- getDeletedEntities() - Method in class org.somda.sdc.biceps.common.access.WriteDescriptionResult
-
Gets all deleted entities.
- getDeletedEntities() - Method in class org.somda.sdc.biceps.common.event.DescriptionModificationMessage
- getDescriptor() - Method in class org.somda.sdc.biceps.common.MdibDescriptionModification
- getDescriptor() - Method in class org.somda.sdc.biceps.common.MdibDescriptionModifications.Entry
- getDescriptor() - Method in class org.somda.sdc.biceps.common.MdibDescriptionModifications.MultiStateEntry
- getDescriptor() - Method in interface org.somda.sdc.biceps.common.MdibEntity
-
Obtain the entity's descriptor.
- getDescriptor() - Method in class org.somda.sdc.biceps.common.MdibEntityImpl
- getDescriptor(Class<T>) - Method in interface org.somda.sdc.biceps.common.MdibEntity
-
Obtains the entity's descriptor as a given type.
- getDescriptor(Class<T>) - Method in class org.somda.sdc.biceps.common.MdibEntityImpl
- getDescriptor(String) - Method in interface org.somda.sdc.biceps.common.access.MdibAccess
-
Retrieves a specific abstract descriptor of the hosted
Mdib. - getDescriptor(String) - Method in class org.somda.sdc.biceps.common.access.ReadTransactionImpl
- getDescriptor(String) - Method in interface org.somda.sdc.biceps.common.storage.MdibStorage
-
Retrieves a specific abstract descriptor of the hosted
Mdib. - getDescriptor(String) - Method in class org.somda.sdc.biceps.common.storage.MdibStorageImpl
- getDescriptor(String) - Method in class org.somda.sdc.biceps.consumer.access.RemoteMdibAccessImpl
- getDescriptor(String) - Method in class org.somda.sdc.biceps.provider.access.LocalMdibAccessImpl
- getDescriptor(String, Class<T>) - Method in interface org.somda.sdc.biceps.common.access.MdibAccess
-
Retrieves a specific descriptor of the hosted
Mdib. - getDescriptor(String, Class<T>) - Method in class org.somda.sdc.biceps.common.access.ReadTransactionImpl
- getDescriptor(String, Class<T>) - Method in interface org.somda.sdc.biceps.common.storage.MdibStorage
-
Retrieves a specific descriptor of the hosted
Mdib. - getDescriptor(String, Class<T>) - Method in class org.somda.sdc.biceps.common.storage.MdibStorageImpl
- getDescriptor(String, Class<T>) - Method in class org.somda.sdc.biceps.consumer.access.RemoteMdibAccessImpl
- getDescriptor(String, Class<T>) - Method in class org.somda.sdc.biceps.provider.access.LocalMdibAccessImpl
- getDescriptorClass() - Method in interface org.somda.sdc.biceps.common.MdibEntity
-
Gets the descriptor class.
- getDescriptorClass() - Method in class org.somda.sdc.biceps.common.MdibEntityImpl
- getDescriptorVersion() - Method in class org.somda.sdc.biceps.provider.preprocessing.helper.VersionPair
- getEntity(String) - Method in interface org.somda.sdc.biceps.common.access.MdibAccess
-
Gets an
MdibEntityobject with a specific handle. - getEntity(String) - Method in class org.somda.sdc.biceps.common.access.ReadTransactionImpl
- getEntity(String) - Method in interface org.somda.sdc.biceps.common.storage.MdibStorage
-
Gets an
MdibEntityobject with a specific handle. - getEntity(String) - Method in class org.somda.sdc.biceps.common.storage.MdibStorageImpl
- getEntity(String) - Method in class org.somda.sdc.biceps.consumer.access.RemoteMdibAccessImpl
- getEntity(String) - Method in class org.somda.sdc.biceps.provider.access.LocalMdibAccessImpl
- getEventMessageClass() - Method in enum org.somda.sdc.biceps.common.MdibStateModifications.Type
- getFirstState(Class<T>) - Method in interface org.somda.sdc.biceps.common.MdibEntity
-
Obtains the first state if available.
- getFirstState(Class<T>) - Method in class org.somda.sdc.biceps.common.MdibEntityImpl
- getHandle() - Method in class org.somda.sdc.biceps.common.MdibDescriptionModification
- getHandle() - Method in interface org.somda.sdc.biceps.common.MdibEntity
-
Unique name to identify the entity.
- getHandle() - Method in class org.somda.sdc.biceps.common.MdibEntityImpl
- getHandle() - Method in exception org.somda.sdc.biceps.common.storage.PreprocessingException
- getInsertedEntities() - Method in class org.somda.sdc.biceps.common.access.WriteDescriptionResult
-
Gets all inserted entities.
- getInsertedEntities() - Method in class org.somda.sdc.biceps.common.event.DescriptionModificationMessage
- getInstanceId() - Method in class org.somda.sdc.biceps.model.participant.MdibVersion
- getLastChanged() - Method in interface org.somda.sdc.biceps.common.MdibEntity
-
Gets the MDIB version of the entity where it has been changed the last time.
- getLastChanged() - Method in class org.somda.sdc.biceps.common.MdibEntityImpl
- getMdDescriptionVersion() - Method in interface org.somda.sdc.biceps.common.access.MdibAccess
-
The latest known MD description version.
- getMdDescriptionVersion() - Method in class org.somda.sdc.biceps.common.access.ReadTransactionImpl
- getMdDescriptionVersion() - Method in interface org.somda.sdc.biceps.common.storage.MdibStorage
-
The latest known MD description version.
- getMdDescriptionVersion() - Method in class org.somda.sdc.biceps.common.storage.MdibStorageImpl
- getMdDescriptionVersion() - Method in class org.somda.sdc.biceps.consumer.access.RemoteMdibAccessImpl
- getMdDescriptionVersion() - Method in class org.somda.sdc.biceps.provider.access.LocalMdibAccessImpl
- getMdibAccess() - Method in class org.somda.sdc.biceps.common.event.AbstractMdibAccessMessage
- getMdibVersion() - Method in interface org.somda.sdc.biceps.common.access.MdibAccess
-
The latest known MDIB version.
- getMdibVersion() - Method in class org.somda.sdc.biceps.common.access.ReadTransactionImpl
- getMdibVersion() - Method in class org.somda.sdc.biceps.common.access.WriteDescriptionResult
-
Gets the MDIB version that ensued during the preceding write operation.
- getMdibVersion() - Method in class org.somda.sdc.biceps.common.access.WriteStateResult
-
Gets the MDIB version that ensued during the preceding write operation.
- getMdibVersion() - Method in interface org.somda.sdc.biceps.common.storage.MdibStorage
-
The latest known MDIB version.
- getMdibVersion() - Method in class org.somda.sdc.biceps.common.storage.MdibStorageImpl
- getMdibVersion() - Method in class org.somda.sdc.biceps.consumer.access.RemoteMdibAccessImpl
- getMdibVersion() - Method in class org.somda.sdc.biceps.provider.access.LocalMdibAccessImpl
- getMdStateVersion() - Method in interface org.somda.sdc.biceps.common.access.MdibAccess
-
The latest known MD description version.
- getMdStateVersion() - Method in class org.somda.sdc.biceps.common.access.ReadTransactionImpl
- getMdStateVersion() - Method in interface org.somda.sdc.biceps.common.storage.MdibStorage
-
The latest known MD state version.
- getMdStateVersion() - Method in class org.somda.sdc.biceps.common.storage.MdibStorageImpl
- getMdStateVersion() - Method in class org.somda.sdc.biceps.consumer.access.RemoteMdibAccessImpl
- getMdStateVersion() - Method in class org.somda.sdc.biceps.provider.access.LocalMdibAccessImpl
- getModifications() - Method in class org.somda.sdc.biceps.common.MdibDescriptionModifications
-
Function to get all changes as unmodifiable list.
- getModificationType() - Method in class org.somda.sdc.biceps.common.MdibDescriptionModification
- getMultiStates(String) - Method in interface org.somda.sdc.biceps.common.storage.MdibStorage
-
Finds all multi states of a certain handle.
- getMultiStates(String) - Method in class org.somda.sdc.biceps.common.storage.MdibStorageImpl
- getParent() - Method in interface org.somda.sdc.biceps.common.MdibEntity
-
Obtains the entity's parent handle.
- getParent() - Method in class org.somda.sdc.biceps.common.MdibEntityImpl
- getParentHandle() - Method in class org.somda.sdc.biceps.common.MdibDescriptionModification
- getParentHandle() - Method in class org.somda.sdc.biceps.common.MdibDescriptionModifications.Entry
- getRootEntities() - Method in interface org.somda.sdc.biceps.common.access.MdibAccess
-
Gets all
MdibEntityobjects that are root elements. - getRootEntities() - Method in class org.somda.sdc.biceps.common.access.ReadTransactionImpl
- getRootEntities() - Method in interface org.somda.sdc.biceps.common.storage.MdibStorage
-
Gets all
MdibEntityobjects that are root elements. - getRootEntities() - Method in class org.somda.sdc.biceps.common.storage.MdibStorageImpl
- getRootEntities() - Method in class org.somda.sdc.biceps.consumer.access.RemoteMdibAccessImpl
- getRootEntities() - Method in class org.somda.sdc.biceps.provider.access.LocalMdibAccessImpl
- getSegment() - Method in exception org.somda.sdc.biceps.common.storage.PreprocessingException
- getSequenceId() - Method in class org.somda.sdc.biceps.model.participant.MdibVersion
- getState() - Method in class org.somda.sdc.biceps.common.MdibDescriptionModifications.Entry
- getState(String) - Method in interface org.somda.sdc.biceps.common.access.MdibAccess
-
Retrieves a specific abstract state of the hosted
Mdib. - getState(String) - Method in class org.somda.sdc.biceps.common.access.ReadTransactionImpl
- getState(String) - Method in interface org.somda.sdc.biceps.common.storage.MdibStorage
-
Retrieves a specific abstract state of the hosted
Mdib. - getState(String) - Method in class org.somda.sdc.biceps.common.storage.MdibStorageImpl
- getState(String) - Method in class org.somda.sdc.biceps.consumer.access.RemoteMdibAccessImpl
- getState(String) - Method in class org.somda.sdc.biceps.provider.access.LocalMdibAccessImpl
- getState(String, Class<T>) - Method in interface org.somda.sdc.biceps.common.access.MdibAccess
-
Retrieves a specific state of the hosted
Mdib. - getState(String, Class<T>) - Method in class org.somda.sdc.biceps.common.access.ReadTransactionImpl
- getState(String, Class<T>) - Method in interface org.somda.sdc.biceps.common.storage.MdibStorage
-
Retrieves a specific state of the hosted
Mdib. - getState(String, Class<T>) - Method in class org.somda.sdc.biceps.common.storage.MdibStorageImpl
- getState(String, Class<T>) - Method in class org.somda.sdc.biceps.consumer.access.RemoteMdibAccessImpl
- getState(String, Class<T>) - Method in class org.somda.sdc.biceps.provider.access.LocalMdibAccessImpl
- getStateClass() - Method in interface org.somda.sdc.biceps.common.MdibEntity
-
Gets the state class.
- getStateClass() - Method in class org.somda.sdc.biceps.common.MdibEntityImpl
- getStates() - Method in class org.somda.sdc.biceps.common.access.WriteStateResult
-
Gets all updated states.
- getStates() - Method in class org.somda.sdc.biceps.common.event.StateModificationMessage
- getStates() - Method in class org.somda.sdc.biceps.common.MdibDescriptionModification
- getStates() - Method in class org.somda.sdc.biceps.common.MdibDescriptionModifications.MultiStateEntry
- getStates() - Method in interface org.somda.sdc.biceps.common.MdibEntity
-
Obtains a copy of the MDIB entity's state list.
- getStates() - Method in class org.somda.sdc.biceps.common.MdibEntityImpl
- getStates() - Method in class org.somda.sdc.biceps.common.MdibStateModifications
- getStates(Class<T>) - Method in interface org.somda.sdc.biceps.common.MdibEntity
-
Obtains the list of states cast to a specific type.
- getStates(Class<T>) - Method in class org.somda.sdc.biceps.common.MdibEntityImpl
- getStateVersion() - Method in class org.somda.sdc.biceps.provider.preprocessing.helper.VersionPair
- getUpdatedEntities() - Method in class org.somda.sdc.biceps.common.access.WriteDescriptionResult
-
Gets all updated entities.
- getUpdatedEntities() - Method in class org.somda.sdc.biceps.common.event.DescriptionModificationMessage
- getVersion() - Method in class org.somda.sdc.biceps.model.participant.MdibVersion
H
- HandleDuplicatedException - Exception in org.somda.sdc.biceps.provider.preprocessing
-
Exception that can be thrown if a handle is duplicated during preprocessing.
- HandleDuplicatedException() - Constructor for exception org.somda.sdc.biceps.provider.preprocessing.HandleDuplicatedException
- HandleDuplicatedException(String) - Constructor for exception org.somda.sdc.biceps.provider.preprocessing.HandleDuplicatedException
- HandleDuplicatedException(String, Throwable) - Constructor for exception org.somda.sdc.biceps.provider.preprocessing.HandleDuplicatedException
- HandleDuplicatedException(String, Throwable, boolean, boolean) - Constructor for exception org.somda.sdc.biceps.provider.preprocessing.HandleDuplicatedException
- HandleDuplicatedException(Throwable) - Constructor for exception org.somda.sdc.biceps.provider.preprocessing.HandleDuplicatedException
- HandleGenerator - Class in org.somda.sdc.biceps.provider
-
Utility to create handles.
- HandleReferenceHandler - Class in org.somda.sdc.biceps.provider.preprocessing
-
Preprocessing segment that appends descriptor references to states.
- HandleReferenceHandler() - Constructor for class org.somda.sdc.biceps.provider.preprocessing.HandleReferenceHandler
- hashCode() - Method in class org.somda.sdc.biceps.model.participant.MdibVersion
I
- increment(MdibVersion) - Static method in class org.somda.sdc.biceps.model.participant.MdibVersion
-
Accepts an existing instance and increments the version counter.
- insert(MdibDescriptionModifications.Entry) - Method in class org.somda.sdc.biceps.common.MdibDescriptionModifications
-
Convenient function to insert a descriptor.
- insert(MdibDescriptionModifications.MultiStateEntry) - Method in class org.somda.sdc.biceps.common.MdibDescriptionModifications
-
Convenient function to insert a descriptor.
- insert(AbstractDescriptor) - Method in class org.somda.sdc.biceps.common.MdibDescriptionModifications
-
Convenient function to insert a descriptor.
- insert(AbstractDescriptor, String) - Method in class org.somda.sdc.biceps.common.MdibDescriptionModifications
-
Convenient function to insert a descriptor.
- insert(AbstractDescriptor, List<? extends AbstractMultiState>) - Method in class org.somda.sdc.biceps.common.MdibDescriptionModifications
-
Convenient function to insert a multi state descriptor with state information.
- insert(AbstractDescriptor, List<? extends AbstractMultiState>, String) - Method in class org.somda.sdc.biceps.common.MdibDescriptionModifications
-
Convenient function to insert a multi state descriptor with state information.
- insert(AbstractDescriptor, AbstractState) - Method in class org.somda.sdc.biceps.common.MdibDescriptionModifications
-
Convenient function to insert a single state descriptor with state information.
- insert(AbstractDescriptor, AbstractState, String) - Method in class org.somda.sdc.biceps.common.MdibDescriptionModifications
-
Convenient function to insert a single state descriptor with state information.
- INSERT - org.somda.sdc.biceps.common.MdibDescriptionModification.Type
- InstanceIdentifierFactory - Class in org.somda.sdc.biceps.model.participant.factory
-
Convenience factory to create instance identifiers.
- InstanceIdentifierFactory() - Constructor for class org.somda.sdc.biceps.model.participant.factory.InstanceIdentifierFactory
- isAddedAsDeleted(String) - Method in class org.somda.sdc.biceps.common.MdibDescriptionModifications
-
Checks if a handle was added as deleted.
- isAddedAsInserted(String) - Method in class org.somda.sdc.biceps.common.MdibDescriptionModifications
-
Checks if a handle was added as inserted.
- isAddedAsUpdated(String) - Method in class org.somda.sdc.biceps.common.MdibDescriptionModifications
-
Checks if a handle was added as updated.
- isContextState(T) - Method in class org.somda.sdc.biceps.common.MdibTypeValidator
-
Checks if a state is a context state (true) or not (false).
- isManyAllowed(T) - Method in class org.somda.sdc.biceps.common.MdibTreeValidator
-
Checks if a descriptor is allowed to appear many times as a child.
- isMultiState(T) - Method in class org.somda.sdc.biceps.common.MdibTypeValidator
-
Checks if a state is a multi-state (true) or not (false).
- isMultiStateDescriptor(T) - Method in class org.somda.sdc.biceps.common.MdibTypeValidator
-
Checks if a descriptor is a multi-state descriptor (true) or not (false).
- isSingleState(T) - Method in class org.somda.sdc.biceps.common.MdibTypeValidator
-
Checks if a state is a single state (true) or not (false).
- isSingleStateDescriptor(T) - Method in class org.somda.sdc.biceps.common.MdibTypeValidator
-
Checks if a descriptor is a single state descriptor (true) or not (false).
- isValidParent(AbstractDescriptor, AbstractDescriptor) - Method in class org.somda.sdc.biceps.common.MdibTreeValidator
-
Checks if the parent child descriptor relation is eligible.
L
- LocalMdibAccess - Interface in org.somda.sdc.biceps.provider.access
-
MDIB read and write access for the BICEPS provider side.
- LocalMdibAccessFactory - Interface in org.somda.sdc.biceps.provider.access.factory
-
Factory to create LocalMdibAccess instances.
- LocalMdibAccessImpl - Class in org.somda.sdc.biceps.provider.access
-
Default implementation of LocalMdibAccessImpl.
M
- match(D, List<S>) - Method in class org.somda.sdc.biceps.common.MdibTypeValidator
-
Checks if the given descriptor states pairing is valid.
- match(D, S) - Method in class org.somda.sdc.biceps.common.MdibTypeValidator
-
Tries to match a descriptor with exactly one state.
- match(Class<? extends AbstractDescriptor>, Class<? extends AbstractState>) - Method in class org.somda.sdc.biceps.common.MdibTypeValidator
-
Checks if descriptor and state classes match.
- MdibAccess - Interface in org.somda.sdc.biceps.common.access
-
Read access to an MDIB storage.
- MdibAccessObservable - Interface in org.somda.sdc.biceps.common.access
-
Interface to allow registration and unregistration of MdibAccessObserver instances.
- MdibAccessObserver - Interface in org.somda.sdc.biceps.common.access
-
Marks a class to be an MDIB changes observer.
- MdibDescriptionModification - Class in org.somda.sdc.biceps.common
-
Single change item.
- MdibDescriptionModification(MdibDescriptionModification.Type, AbstractDescriptor, List<AbstractState>) - Constructor for class org.somda.sdc.biceps.common.MdibDescriptionModification
- MdibDescriptionModification(MdibDescriptionModification.Type, AbstractDescriptor, List<AbstractState>, String) - Constructor for class org.somda.sdc.biceps.common.MdibDescriptionModification
- MdibDescriptionModification.Type - Enum in org.somda.sdc.biceps.common
-
Designates the MDIB description modification type, i.e., insert, update, or delete.
- MdibDescriptionModifications - Class in org.somda.sdc.biceps.common
-
Container to collect changes supposed to be applied on an MDIB.
- MdibDescriptionModifications.Entry - Class in org.somda.sdc.biceps.common
-
An entry that allows to bundle all single-state modification information in a single element.
- MdibDescriptionModifications.MultiStateEntry - Class in org.somda.sdc.biceps.common
-
An entry that allows to bundle all multi-state modification information in a single element.
- MdibEntity - Interface in org.somda.sdc.biceps.common
-
Representation of any MDIB object within a containment tree.
- MdibEntity.StateAlternative<T> - Interface in org.somda.sdc.biceps.common
-
An alternative lambda to be executed.
- MdibEntityFactory - Class in org.somda.sdc.biceps.common.factory
-
Factory to create MdibEntity instances.
- MdibEntityGuiceAssistedFactory - Interface in org.somda.sdc.biceps.common.factory
-
Guice-based factory internally used by MdibEntityFactory.
- MdibEntityImpl - Class in org.somda.sdc.biceps.common
-
Default implementation of
MdibEntity. - MdibStateModifications - Class in org.somda.sdc.biceps.common
-
Container to collect state updates supposed to be applied on an MDIB.
- MdibStateModifications.Type - Enum in org.somda.sdc.biceps.common
-
Change type designation.
- MdibStorage - Interface in org.somda.sdc.biceps.common.storage
-
Registry-based access to MdibEntity instances derived from an Mdib.
- MdibStorageFactory - Interface in org.somda.sdc.biceps.common.storage.factory
-
Factory to create MdibStorage instances.
- MdibStorageImpl - Class in org.somda.sdc.biceps.common.storage
-
Default implementation of MdibStorage.
- MdibStoragePreprocessingChain - Class in org.somda.sdc.biceps.common.storage
-
Provides a processing chain that is supposed to be run before any interaction with an MdibStorage instance.
- MdibStoragePreprocessingChainFactory - Interface in org.somda.sdc.biceps.common.storage.factory
-
Factory to create MdibStoragePreprocessingChain instances.
- MdibStorageUtil - Class in org.somda.sdc.biceps.common.storage.helper
-
Helper class to expose information hosted by MdibStorage.
- MdibTreeValidator - Class in org.somda.sdc.biceps.common
-
Utility class to verify cardinality and parent-child type correctness.
- MdibTypeValidator - Class in org.somda.sdc.biceps.common
-
Utility class to validate MDIB instances.
- MdibVersion - Class in org.somda.sdc.biceps.model.participant
-
Container for MDIB version attributes.
- MdibVersion(String) - Constructor for class org.somda.sdc.biceps.model.participant.MdibVersion
-
Constructor that sets a given sequence id.
- MdibVersion(String, BigInteger) - Constructor for class org.somda.sdc.biceps.model.participant.MdibVersion
-
Constructor that sets a given sequence id and version counter.
- MdibVersion(String, BigInteger, BigInteger) - Constructor for class org.somda.sdc.biceps.model.participant.MdibVersion
-
Constructor that sets all version attributes.
- METRIC - org.somda.sdc.biceps.common.MdibStateModifications.Type
- MetricStateModificationMessage - Class in org.somda.sdc.biceps.common.event
-
Subscribe to this message in order to receive metric state changes.
- MetricStateModificationMessage(MdibAccess, List<AbstractMetricState>) - Constructor for class org.somda.sdc.biceps.common.event.MetricStateModificationMessage
-
Constructor.
- MultiStateEntry(AbstractDescriptor, List<? extends AbstractMultiState>, String) - Constructor for class org.somda.sdc.biceps.common.MdibDescriptionModifications.MultiStateEntry
-
Constructor that accepts a descriptor, states and parent handle.
N
- NAMESPACE_EXTENSION - Static variable in class org.somda.sdc.biceps.common.CommonConstants
-
Namespace string of the BICEPS Extension Model.
- NAMESPACE_EXTENSION_PREFIX - Static variable in class org.somda.sdc.biceps.common.CommonConstants
-
Prefix used for the namespace of the BICEPS Extension Model.
- NAMESPACE_MESSAGE - Static variable in class org.somda.sdc.biceps.common.CommonConstants
-
Namespace string of the BICEPS Message Model.
- NAMESPACE_MESSAGE_PREFIX - Static variable in class org.somda.sdc.biceps.common.CommonConstants
-
Prefix used for the namespace of the BICEPS Message Model.
- NAMESPACE_PARTICIPANT - Static variable in class org.somda.sdc.biceps.common.CommonConstants
-
Namespace string of the BICEPS Participant Model.
- NAMESPACE_PARTICIPANT_PREFIX - Static variable in class org.somda.sdc.biceps.common.CommonConstants
-
Prefix used for the namespace of the BICEPS Participant Model.
- next() - Method in class org.somda.sdc.biceps.provider.HandleGenerator
-
Creates the next handle with the prefix given during construction.
O
- OPERATION - org.somda.sdc.biceps.common.MdibStateModifications.Type
- OperationStateModificationMessage - Class in org.somda.sdc.biceps.common.event
-
Subscribe to this message in order to receive operation state changes.
- OperationStateModificationMessage(MdibAccess, List<AbstractOperationState>) - Constructor for class org.somda.sdc.biceps.common.event.OperationStateModificationMessage
-
Constructor.
- orElse(Consumer<T>) - Method in interface org.somda.sdc.biceps.common.MdibEntity.StateAlternative
- org.somda.sdc.biceps - package org.somda.sdc.biceps
-
Domain layer implementation that comprises local and remote MDIB access with consistency checks and versioning.
- org.somda.sdc.biceps.common - package org.somda.sdc.biceps.common
-
Any classes that are shared between BICEPS provider and consumer.
- org.somda.sdc.biceps.common.access - package org.somda.sdc.biceps.common.access
-
MDIB read access functionality that is shared between the MDIB provider and consumer sides.
- org.somda.sdc.biceps.common.access.factory - package org.somda.sdc.biceps.common.access.factory
-
Factories for common access classes.
- org.somda.sdc.biceps.common.access.helper - package org.somda.sdc.biceps.common.access.helper
-
Helpers for access classes.
- org.somda.sdc.biceps.common.event - package org.somda.sdc.biceps.common.event
-
Common event-related objects of the BICEPS package.
- org.somda.sdc.biceps.common.factory - package org.somda.sdc.biceps.common.factory
-
Factories for common BICEPS classes.
- org.somda.sdc.biceps.common.preprocessing - package org.somda.sdc.biceps.common.preprocessing
-
Preprocessing actions shared between the MDIB provider and consumer sides.
- org.somda.sdc.biceps.common.storage - package org.somda.sdc.biceps.common.storage
-
MDIB storage implementation for BICEPS.
- org.somda.sdc.biceps.common.storage.factory - package org.somda.sdc.biceps.common.storage.factory
-
Factories for storage classes.
- org.somda.sdc.biceps.common.storage.helper - package org.somda.sdc.biceps.common.storage.helper
-
Helpers for storage classes.
- org.somda.sdc.biceps.consumer.access - package org.somda.sdc.biceps.consumer.access
-
MDIB access implementation for the MDIB consumer side.
- org.somda.sdc.biceps.consumer.access.factory - package org.somda.sdc.biceps.consumer.access.factory
-
Factories for consumer access classes.
- org.somda.sdc.biceps.consumer.preprocessing - package org.somda.sdc.biceps.consumer.preprocessing
-
Preprocessing actions for RemoteMdibAccess.
- org.somda.sdc.biceps.guice - package org.somda.sdc.biceps.guice
-
Guice-related information (i.e., annotations and modules relevant for the BICEPS implementation).
- org.somda.sdc.biceps.model.participant - package org.somda.sdc.biceps.model.participant
-
Model information that is not part of the pre-compiled XML schema.
- org.somda.sdc.biceps.model.participant.factory - package org.somda.sdc.biceps.model.participant.factory
-
Participant model factories.
- org.somda.sdc.biceps.provider - package org.somda.sdc.biceps.provider
-
Encloses classes relevant for the BICEPS provider side.
- org.somda.sdc.biceps.provider.access - package org.somda.sdc.biceps.provider.access
-
MDIB access implementation for the MDIB provider side.
- org.somda.sdc.biceps.provider.access.factory - package org.somda.sdc.biceps.provider.access.factory
-
Factories for provider access classes.
- org.somda.sdc.biceps.provider.preprocessing - package org.somda.sdc.biceps.provider.preprocessing
-
Preprocessing actions for LocalMdibAccess.
- org.somda.sdc.biceps.provider.preprocessing.helper - package org.somda.sdc.biceps.provider.preprocessing.helper
-
Encloses classes relevant for the BICEPS provider side.
P
- PreprocessingException - Exception in org.somda.sdc.biceps.common.storage
-
An exception that is thrown if a preprocessing error occurs.
- PreprocessingException(String, String, String) - Constructor for exception org.somda.sdc.biceps.common.storage.PreprocessingException
- PreprocessingException(String, Throwable, String, String) - Constructor for exception org.somda.sdc.biceps.common.storage.PreprocessingException
- process(MdibDescriptionModifications, MdibDescriptionModification, MdibStorage) - Method in class org.somda.sdc.biceps.common.preprocessing.DescriptorChildRemover
- process(MdibDescriptionModifications, MdibDescriptionModification, MdibStorage) - Method in interface org.somda.sdc.biceps.common.storage.DescriptionPreprocessingSegment
-
In a sequence of modifications this function processes one modification.
- process(MdibDescriptionModifications, MdibDescriptionModification, MdibStorage) - Method in class org.somda.sdc.biceps.provider.preprocessing.CardinalityChecker
- process(MdibDescriptionModifications, MdibDescriptionModification, MdibStorage) - Method in class org.somda.sdc.biceps.provider.preprocessing.DuplicateChecker
- process(MdibDescriptionModifications, MdibDescriptionModification, MdibStorage) - Method in class org.somda.sdc.biceps.provider.preprocessing.HandleReferenceHandler
- process(MdibDescriptionModifications, MdibDescriptionModification, MdibStorage) - Method in class org.somda.sdc.biceps.provider.preprocessing.TypeConsistencyChecker
- process(MdibDescriptionModifications, MdibDescriptionModification, MdibStorage) - Method in class org.somda.sdc.biceps.provider.preprocessing.VersionHandler
- process(MdibStateModifications, AbstractState, MdibStorage) - Method in interface org.somda.sdc.biceps.common.storage.StatePreprocessingSegment
-
In a sequence of modifications this function processes one modification.
- process(MdibStateModifications, AbstractState, MdibStorage) - Method in class org.somda.sdc.biceps.consumer.preprocessing.VersionDuplicateHandler
- process(MdibStateModifications, AbstractState, MdibStorage) - Method in class org.somda.sdc.biceps.provider.preprocessing.VersionHandler
- processDescriptionModifications(MdibDescriptionModifications) - Method in class org.somda.sdc.biceps.common.storage.MdibStoragePreprocessingChain
-
Accepts a set of description modifications and applies them on every available description chain segment.
- processInput(T) - Method in class org.somda.sdc.biceps.common.access.CopyManager
-
Copies input data if configured.
- processOutput(T) - Method in class org.somda.sdc.biceps.common.access.CopyManager
-
Copies output data if configured.
- processStateModifications(MdibStateModifications) - Method in class org.somda.sdc.biceps.common.storage.MdibStoragePreprocessingChain
-
Accepts a set of state modifications and applies them on every available state chain segment.
R
- ReadTransaction - Interface in org.somda.sdc.biceps.common.access
-
Definition of an auto-closeable interface that allows to invoke read functions without getting distracted by write calls.
- ReadTransactionFactory - Interface in org.somda.sdc.biceps.common.access.factory
-
Factory to create ReadTransaction objects.
- ReadTransactionImpl - Class in org.somda.sdc.biceps.common.access
-
Default implementation of ReadTransaction.
- ReadTransactionImpl(MdibStorage, Lock) - Constructor for class org.somda.sdc.biceps.common.access.ReadTransactionImpl
- ReadTransactionProvider - Interface in org.somda.sdc.biceps.common.access
-
Defines an interface to declare a class capable of starting read transactions.
- registerObserver(Object) - Method in class org.somda.sdc.biceps.common.event.Distributor
-
Registers an observer to MDIB modification events.
- registerObserver(MdibAccessObserver) - Method in interface org.somda.sdc.biceps.common.access.MdibAccessObservable
-
Register for MDIB modification reports.
- registerObserver(MdibAccessObserver) - Method in class org.somda.sdc.biceps.consumer.access.RemoteMdibAccessImpl
- registerObserver(MdibAccessObserver) - Method in class org.somda.sdc.biceps.provider.access.LocalMdibAccessImpl
- RemoteMdibAccess - Interface in org.somda.sdc.biceps.consumer.access
-
MDIB read and write access for the BICEPS consumer side.
- RemoteMdibAccessFactory - Interface in org.somda.sdc.biceps.consumer.access.factory
-
Factory to create RemoteMdibAccess instances.
- RemoteMdibAccessImpl - Class in org.somda.sdc.biceps.consumer.access
-
Default implementation of RemoteMdibAccessImpl.
- removeChildren(MdsDescriptor) - Method in class org.somda.sdc.biceps.common.preprocessing.DescriptorChildRemover
-
Deprecated.will be made private in 2.0.0
- replaceChildren(MdibEntity, List<String>) - Method in class org.somda.sdc.biceps.common.factory.MdibEntityFactory
-
Takes an entity and replaces the children.
- replaceDescriptorAndStates(MdibEntity, AbstractDescriptor, List<AbstractState>) - Method in class org.somda.sdc.biceps.common.factory.MdibEntityFactory
-
Takes an entity and replaces descriptor and states.
- replaceStates(MdibEntity, List<AbstractState>) - Method in class org.somda.sdc.biceps.common.factory.MdibEntityFactory
-
Takes an entity and replaces the states.
- resolveDescriptorBaseName(Class<? extends AbstractDescriptor>) - Method in class org.somda.sdc.biceps.common.MdibTypeValidator
-
Gets the base name of a descriptor class.
- resolveDescriptorType(Class<T>) - Method in class org.somda.sdc.biceps.common.MdibTypeValidator
-
Resolves the descriptor type belonging to a state type.
- resolveStateBaseName(Class<? extends AbstractState>) - Method in class org.somda.sdc.biceps.common.MdibTypeValidator
-
Gets the base name of a state class.
- resolveStateType(Class<T>) - Method in class org.somda.sdc.biceps.common.MdibTypeValidator
-
Resolves the state type belonging to a descriptor type.
S
- sendDescriptionModificationEvent(MdibAccess, List<MdibEntity>, List<MdibEntity>, List<MdibEntity>) - Method in class org.somda.sdc.biceps.common.event.Distributor
-
Creates a DescriptionModificationMessage and sends it to all subscribers.
- sendStateModificationEvent(MdibAccess, MdibStateModifications.Type, List<?>) - Method in class org.somda.sdc.biceps.common.event.Distributor
-
Creates a specific StateModificationMessage based on the change type and sends it to all subscribers.
- setVersionCounter(MdibVersion, BigInteger) - Static method in class org.somda.sdc.biceps.model.participant.MdibVersion
-
Accepts an existing instance and resets the version counter to the given number.
- startTransaction() - Method in interface org.somda.sdc.biceps.common.access.ReadTransactionProvider
-
Starts a read transaction.
- startTransaction() - Method in class org.somda.sdc.biceps.consumer.access.RemoteMdibAccessImpl
- startTransaction() - Method in class org.somda.sdc.biceps.provider.access.LocalMdibAccessImpl
- StateModificationMessage<T extends AbstractState> - Class in org.somda.sdc.biceps.common.event
-
Base class for any state modification messages.
- StateModificationMessage(MdibAccess, List<T>) - Constructor for class org.somda.sdc.biceps.common.event.StateModificationMessage
-
Constructor.
- StatePreprocessingSegment - Interface in org.somda.sdc.biceps.common.storage
-
A segment that is applied during state modifications.
T
- toContextState(T) - Method in class org.somda.sdc.biceps.common.MdibTypeValidator
-
Tries to cast to a context state.
- toMultiState(T) - Method in class org.somda.sdc.biceps.common.MdibTypeValidator
-
Tries to cast to a multi-state.
- toString() - Method in class org.somda.sdc.biceps.common.access.WriteDescriptionResult
- toString() - Method in class org.somda.sdc.biceps.common.access.WriteStateResult
- toString() - Method in class org.somda.sdc.biceps.consumer.preprocessing.VersionDuplicateHandler
- toString() - Method in class org.somda.sdc.biceps.model.participant.MdibVersion
- toString() - Method in class org.somda.sdc.biceps.provider.preprocessing.CardinalityChecker
- toString() - Method in class org.somda.sdc.biceps.provider.preprocessing.DuplicateChecker
- toString() - Method in class org.somda.sdc.biceps.provider.preprocessing.TypeConsistencyChecker
- toString() - Method in class org.somda.sdc.biceps.provider.preprocessing.VersionHandler
- TypeConsistencyChecker - Class in org.somda.sdc.biceps.provider.preprocessing
-
Preprocessing segment that ensures correctness of child-parent type relationships.
- TypeConsistencyException - Exception in org.somda.sdc.biceps.provider.preprocessing
-
Exception that is thrown during preprocessing of TypeConsistencyChecker.
- TypeConsistencyException() - Constructor for exception org.somda.sdc.biceps.provider.preprocessing.TypeConsistencyException
- TypeConsistencyException(String) - Constructor for exception org.somda.sdc.biceps.provider.preprocessing.TypeConsistencyException
- TypeConsistencyException(String, Throwable) - Constructor for exception org.somda.sdc.biceps.provider.preprocessing.TypeConsistencyException
- TypeConsistencyException(String, Throwable, boolean, boolean) - Constructor for exception org.somda.sdc.biceps.provider.preprocessing.TypeConsistencyException
- TypeConsistencyException(Throwable) - Constructor for exception org.somda.sdc.biceps.provider.preprocessing.TypeConsistencyException
U
- unregisterObserver(Object) - Method in class org.somda.sdc.biceps.common.event.Distributor
-
Unregisters an observer from MDIB modification events.
- unregisterObserver(MdibAccessObserver) - Method in interface org.somda.sdc.biceps.common.access.MdibAccessObservable
-
Unregister from MDIB modification reports.
- unregisterObserver(MdibAccessObserver) - Method in class org.somda.sdc.biceps.consumer.access.RemoteMdibAccessImpl
- unregisterObserver(MdibAccessObserver) - Method in class org.somda.sdc.biceps.provider.access.LocalMdibAccessImpl
- update(MdibDescriptionModifications.Entry) - Method in class org.somda.sdc.biceps.common.MdibDescriptionModifications
-
Convenient function to update a descriptor.
- update(MdibDescriptionModifications.MultiStateEntry) - Method in class org.somda.sdc.biceps.common.MdibDescriptionModifications
-
Convenient function to update a descriptor.
- update(AbstractDescriptor) - Method in class org.somda.sdc.biceps.common.MdibDescriptionModifications
-
Convenient function to update a descriptor.
- update(AbstractDescriptor, List<? extends AbstractMultiState>) - Method in class org.somda.sdc.biceps.common.MdibDescriptionModifications
-
Convenient function to update a multi state descriptor with state information.
- update(AbstractDescriptor, AbstractState) - Method in class org.somda.sdc.biceps.common.MdibDescriptionModifications
-
Convenient function to update a single state descriptor with state information.
- UPDATE - org.somda.sdc.biceps.common.MdibDescriptionModification.Type
V
- valueOf(String) - Static method in enum org.somda.sdc.biceps.common.MdibDescriptionModification.Type
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum org.somda.sdc.biceps.common.MdibStateModifications.Type
-
Returns the enum constant of this type with the specified name.
- values() - Static method in enum org.somda.sdc.biceps.common.MdibDescriptionModification.Type
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum org.somda.sdc.biceps.common.MdibStateModifications.Type
-
Returns an array containing the constants of this enum type, in the order they are declared.
- VersionDuplicateHandler - Class in org.somda.sdc.biceps.consumer.preprocessing
-
Preprocessing segment that removes changes from modification sets that have already been applied on the MDIB storage before.
- VersionHandler - Class in org.somda.sdc.biceps.provider.preprocessing
-
Preprocessing segment that manages BICEPS versioning.
- VersioningException - Exception in org.somda.sdc.biceps.provider.preprocessing
-
Exception that is thrown if the versioning rules of BICEPS could not be applied during preprocessing.
- VersioningException() - Constructor for exception org.somda.sdc.biceps.provider.preprocessing.VersioningException
- VersioningException(String) - Constructor for exception org.somda.sdc.biceps.provider.preprocessing.VersioningException
- VersioningException(String, Throwable) - Constructor for exception org.somda.sdc.biceps.provider.preprocessing.VersioningException
- VersioningException(String, Throwable, boolean, boolean) - Constructor for exception org.somda.sdc.biceps.provider.preprocessing.VersioningException
- VersioningException(Throwable) - Constructor for exception org.somda.sdc.biceps.provider.preprocessing.VersioningException
- VersionPair - Class in org.somda.sdc.biceps.provider.preprocessing.helper
-
Version information used by
VersionHandler. - VersionPair() - Constructor for class org.somda.sdc.biceps.provider.preprocessing.helper.VersionPair
- VersionPair(BigInteger) - Constructor for class org.somda.sdc.biceps.provider.preprocessing.helper.VersionPair
- VersionPair(BigInteger, BigInteger) - Constructor for class org.somda.sdc.biceps.provider.preprocessing.helper.VersionPair
W
- WAVEFORM - org.somda.sdc.biceps.common.MdibStateModifications.Type
- WaveformStateModificationMessage - Class in org.somda.sdc.biceps.common.event
-
Subscribe to this message in order to receive waveform changes.
- WaveformStateModificationMessage(MdibAccess, List<RealTimeSampleArrayMetricState>) - Constructor for class org.somda.sdc.biceps.common.event.WaveformStateModificationMessage
-
Constructor.
- writeDescription(Function<MdibDescriptionModifications, WriteDescriptionResult>, MdibDescriptionModifications) - Method in class org.somda.sdc.biceps.common.access.helper.WriteUtil
-
Performs preprocessing, write operation and event distribution of description modifications.
- writeDescription(MdibDescriptionModifications) - Method in interface org.somda.sdc.biceps.provider.access.LocalMdibAccess
-
Processes the description modifications object, stores the data internally and trigger an event.
- writeDescription(MdibDescriptionModifications) - Method in class org.somda.sdc.biceps.provider.access.LocalMdibAccessImpl
- writeDescription(MdibVersion, BigInteger, BigInteger, MdibDescriptionModifications) - Method in interface org.somda.sdc.biceps.consumer.access.RemoteMdibAccess
-
Processes the description modifications object, stores the data internally and trigger an event.
- writeDescription(MdibVersion, BigInteger, BigInteger, MdibDescriptionModifications) - Method in class org.somda.sdc.biceps.consumer.access.RemoteMdibAccessImpl
- WriteDescriptionResult - Class in org.somda.sdc.biceps.common.access
-
Read-only result set of a write description call.
- WriteDescriptionResult(MdibVersion, List<MdibEntity>, List<MdibEntity>, List<MdibEntity>) - Constructor for class org.somda.sdc.biceps.common.access.WriteDescriptionResult
-
Constructor to initialize all values of the result set.
- WriteStateResult - Class in org.somda.sdc.biceps.common.access
-
Read-only result set of a write states call.
- WriteStateResult(MdibVersion, List<AbstractState>) - Constructor for class org.somda.sdc.biceps.common.access.WriteStateResult
-
Constructor to initialize all values of the result set.
- writeStates(Function<MdibStateModifications, WriteStateResult>, MdibStateModifications) - Method in class org.somda.sdc.biceps.common.access.helper.WriteUtil
-
Performs preprocessing, write operation and event distribution of state modifications.
- writeStates(MdibStateModifications) - Method in interface org.somda.sdc.biceps.provider.access.LocalMdibAccess
-
Processes the state modifications object, stores the data internally and triggers an event.
- writeStates(MdibStateModifications) - Method in class org.somda.sdc.biceps.provider.access.LocalMdibAccessImpl
- writeStates(MdibVersion, MdibStateModifications) - Method in interface org.somda.sdc.biceps.consumer.access.RemoteMdibAccess
-
Processes the state modifications object, stores the data internally and triggers an event.
- writeStates(MdibVersion, MdibStateModifications) - Method in class org.somda.sdc.biceps.consumer.access.RemoteMdibAccessImpl
- WriteUtil - Class in org.somda.sdc.biceps.common.access.helper
-
Common code for write description and states that can be used by BICEPS providers and consumers.
- WriteUtil(Logger, Distributor, MdibStoragePreprocessingChain, ReentrantReadWriteLock, MdibAccess) - Constructor for class org.somda.sdc.biceps.common.access.helper.WriteUtil
-
Constructor that accepts the dependencies in order to properly process write operations.
All Classes All Packages