A B C D E F G H I M N O P R S T U V W X
All Classes All Packages

A

addAddressMapping(String, String) - Method in interface org.openmuc.eebus.spine.api.ConnectionHandler

Associates the SPINE device address with the address used in the communication protocol.

addDevice(String) - Method in class org.openmuc.eebus.spine.spi.Communication

Notifies device listeners of this device and starts the detailed discovery process if enabled

addDeviceListener(DeviceListener) - Method in interface org.openmuc.eebus.spine.api.NodeManagement

Adds a listener which will get notified when the communication protocol detects a new device.

addDeviceListener(DeviceListener) - Method in class org.openmuc.eebus.spine.impl.DeviceBuilder

addEntity() - Method in class org.openmuc.eebus.spine.impl.DeviceBuilder

Creates a new EntityBuilder instance.

addEntity() - Method in class org.openmuc.eebus.spine.impl.EntityBuilder

Creates a new EntityBuilder instance.

addEntity(Entity) - Method in interface org.openmuc.eebus.spine.api.EntityParent

Adds an entity with all its sub-entities and features to this device/entity at runtime.

addFeature() - Method in class org.openmuc.eebus.spine.impl.EntityBuilder

Creates a new FeatureBuilder instance.

addFeature(Feature) - Method in interface org.openmuc.eebus.spine.api.Entity

Adds a feature to this entity at runtime.

addFunction(FeatureFunction) - Method in interface org.openmuc.eebus.spine.api.Feature

Adds the passed SPINE function to the feature.

addFunction(FeatureFunction) - Method in class org.openmuc.eebus.spine.impl.FeatureBuilder

addUseCase(UseCase) - Method in class org.openmuc.eebus.spine.impl.DeviceBuilder

Adds the passed SPINE use case to this device.

addUseCase(UseCase) - Method in class org.openmuc.eebus.spine.impl.EntityBuilder

apply() - Method in class org.openmuc.eebus.spine.impl.FeatureBuilder

Builds this feature and adds it to the parent entity.

applyToDevice() - Method in class org.openmuc.eebus.spine.impl.EntityBuilder

Builds this entity and adds it to the parent device.

applyToEntity() - Method in class org.openmuc.eebus.spine.impl.EntityBuilder

Builds this entity and adds it to the parent entity.

B

BINDING_NECESSARY - org.openmuc.eebus.spine.api.Error

bindingAllowed(NodeManagementBindingRequestCallType.BindingRequest) - Method in interface org.openmuc.eebus.spine.spi.FeaturePermission

bindingRequired() - Method in class org.openmuc.eebus.spine.spi.FeatureFunction

build() - Method in class org.openmuc.eebus.spine.impl.DeviceBuilder

Builds the SPINE device and connects it to the communication network.

build() - Method in class org.openmuc.eebus.spine.impl.EntityBuilder

Builds the SPINE entity.

build() - Method in class org.openmuc.eebus.spine.impl.FeatureBuilder

Builds the SPINE feature.

C

call(FeatureAddressType) - Method in class org.openmuc.eebus.spine.spi.FeatureFunction

close() - Method in interface org.openmuc.eebus.spine.spi.SpineConnection

closeConnection(String) - Method in interface org.openmuc.eebus.spine.api.ConnectionHandler

COMMAND_NOT_SUPPORTED - org.openmuc.eebus.spine.api.Error

COMMAND_REJECTED - org.openmuc.eebus.spine.api.Error

Communication - Class in org.openmuc.eebus.spine.spi

Communication() - Constructor for class org.openmuc.eebus.spine.spi.Communication

connect() - Method in class org.openmuc.eebus.spine.spi.Communication

Connects to the network, i.e. makes the communication layer available

ConnectionHandler - Interface in org.openmuc.eebus.spine.api

createInterfaceGroup() - Method in interface org.openmuc.eebus.spine.api.NodeManagement

Creates a new interface group which communication addresses can be assigned to.

D

deleteEntity(int) - Method in interface org.openmuc.eebus.spine.api.EntityParent

deleteFeature(int) - Method in interface org.openmuc.eebus.spine.api.Entity

DESTINATION_UNKNOWN - org.openmuc.eebus.spine.api.Error

DESTINATION_UNREACHABLE - org.openmuc.eebus.spine.api.Error

device - Variable in class org.openmuc.eebus.spine.spi.Communication

Device - Interface in org.openmuc.eebus.spine.api

DeviceBuilder - Class in org.openmuc.eebus.spine.impl

DeviceBuilder() - Constructor for class org.openmuc.eebus.spine.impl.DeviceBuilder

deviceDetected(String) - Method in interface org.openmuc.eebus.spine.api.Device

Starts the detailed discovery process if enabled

deviceDetected(String) - Method in interface org.openmuc.eebus.spine.spi.DeviceListener

deviceDiscovered(NodeManagementDetailedDiscoveryDataType) - Method in interface org.openmuc.eebus.spine.spi.DeviceListener

DeviceListener - Interface in org.openmuc.eebus.spine.spi

disconnect() - Method in class org.openmuc.eebus.spine.spi.Communication

Disconnects from the network, i.e. terminates the communication layer

E

Entity - Interface in org.openmuc.eebus.spine.api

EntityBuilder - Class in org.openmuc.eebus.spine.impl

EntityBuilder() - Constructor for class org.openmuc.eebus.spine.impl.EntityBuilder

EntityParent - Interface in org.openmuc.eebus.spine.api

Error - Enum in org.openmuc.eebus.spine.api

F

feature - Variable in class org.openmuc.eebus.spine.spi.FeatureFunction

Feature - Interface in org.openmuc.eebus.spine.api

FeatureBuilder - Class in org.openmuc.eebus.spine.impl

FeatureBuilder() - Constructor for class org.openmuc.eebus.spine.impl.FeatureBuilder

FeatureFunction - Class in org.openmuc.eebus.spine.spi

FeatureFunction(String) - Constructor for class org.openmuc.eebus.spine.spi.FeatureFunction

FeaturePermission - Interface in org.openmuc.eebus.spine.spi

fromXML(byte[]) - Static method in class org.openmuc.eebus.spine.impl.XMLParser

G

GENERAL_ERROR - org.openmuc.eebus.spine.api.Error

getAcknowledgment(HeaderType) - Method in exception org.openmuc.eebus.spine.api.SpineException

getActor() - Method in interface org.openmuc.eebus.spine.spi.UseCase

getAddress() - Method in interface org.openmuc.eebus.spine.api.Device

getAddress() - Method in interface org.openmuc.eebus.spine.api.Entity

Returns the address of this entity relative to the parent device.

getAddress() - Method in interface org.openmuc.eebus.spine.api.Feature

Returns the address of this feature relative to the parent device.

getAddress() - Method in interface org.openmuc.eebus.spine.spi.UseCase

getBuilder() - Static method in interface org.openmuc.eebus.spine.api.Device

getBuilder() - Static method in interface org.openmuc.eebus.spine.api.Entity

The returned builder builds a SPINE entity which can be added to an existing SPINE device at runtime with EntityParent.addEntity(Entity).

getBuilder() - Static method in interface org.openmuc.eebus.spine.api.Feature

The returned builder builds a SPINE feature which can be added to an existing SPINE entity at runtime with Entity.addFeature(Feature).

getCmd() - Method in interface org.openmuc.eebus.spine.api.RequestResult

Returns the cmd part of the datagram the request was answered with.

getCommunicationAddress() - Method in interface org.openmuc.eebus.spine.spi.SpineConnection

getCommunicationAddress(String) - Method in interface org.openmuc.eebus.spine.api.ConnectionHandler

Returns the mapped communication address for the given SPINE device address.

getCommunicationMode() - Method in interface org.openmuc.eebus.spine.api.Device

getConnectionHandler() - Method in interface org.openmuc.eebus.spine.api.Device

getDatagram() - Method in interface org.openmuc.eebus.spine.api.RequestResult

Returns the complete datagram the request was answered with.

getDatagram(HeaderType) - Method in class org.openmuc.eebus.spine.api.SpineAcknowledgment

getDescription() - Method in interface org.openmuc.eebus.spine.api.Device

getDescription() - Method in interface org.openmuc.eebus.spine.api.Entity

getDescription() - Method in interface org.openmuc.eebus.spine.api.Feature

getDetailedDiscoveryUpdates(String, DeviceListener, boolean) - Method in interface org.openmuc.eebus.spine.api.NodeManagement

getDevice() - Method in interface org.openmuc.eebus.spine.api.EntityParent

getDevice() - Method in interface org.openmuc.eebus.spine.api.Feature

getEntities() - Method in interface org.openmuc.eebus.spine.api.EntityParent

getEntity(int) - Method in interface org.openmuc.eebus.spine.api.EntityParent

getError() - Method in exception org.openmuc.eebus.spine.api.SpineException

getFeature(int) - Method in interface org.openmuc.eebus.spine.api.Entity

getFeature(FeatureAddressType) - Method in interface org.openmuc.eebus.spine.api.Device

Returns the feature with the address given or throws a SpineException if the requested feature does not exist.

getFeatures() - Method in interface org.openmuc.eebus.spine.api.Entity

getFullDeviceInformationRequest(String) - Method in interface org.openmuc.eebus.spine.api.NodeManagement

Executes a detailed discovery on the remote device.

getFullUseCaseInformationRequest(String) - Method in interface org.openmuc.eebus.spine.api.NodeManagement

Reads supported UseCases of a remote device

getFunctionName() - Method in class org.openmuc.eebus.spine.spi.FeatureFunction

getFunctionProperty() - Method in class org.openmuc.eebus.spine.spi.FeatureFunction

getLabel() - Method in interface org.openmuc.eebus.spine.api.Device

getLabel() - Method in interface org.openmuc.eebus.spine.api.Entity

getLabel() - Method in interface org.openmuc.eebus.spine.api.Feature

getLastAddedEntityAddress() - Method in class org.openmuc.eebus.spine.impl.DeviceBuilder

getName() - Method in interface org.openmuc.eebus.spine.spi.UseCase

getNodeManagement() - Method in interface org.openmuc.eebus.spine.api.Device

Returns the node management feature instance associated to this device.

getParent() - Method in interface org.openmuc.eebus.spine.api.EntityParent

getRole() - Method in interface org.openmuc.eebus.spine.api.Feature

getScenarioSupport() - Method in interface org.openmuc.eebus.spine.spi.UseCase

getSenderAddress() - Method in interface org.openmuc.eebus.spine.api.RequestResult

Returns the address of the sender who answered the request.

getSpecificationVersion() - Method in interface org.openmuc.eebus.spine.api.Device

getThrowable() - Method in class org.openmuc.eebus.spine.api.SpineAcknowledgment

getType() - Method in interface org.openmuc.eebus.spine.api.Device

getType() - Method in interface org.openmuc.eebus.spine.api.Entity

getType() - Method in interface org.openmuc.eebus.spine.api.Feature

getUseCaseDiscoveryUpdates(String, UseCaseDiscoveryListener, boolean) - Method in interface org.openmuc.eebus.spine.api.NodeManagement

getVersion() - Method in interface org.openmuc.eebus.spine.spi.UseCase

H

hasDescription() - Method in interface org.openmuc.eebus.spine.api.Device

hasDescription() - Method in interface org.openmuc.eebus.spine.api.Entity

hasDescription() - Method in interface org.openmuc.eebus.spine.api.Feature

hasLabel() - Method in interface org.openmuc.eebus.spine.api.Device

hasLabel() - Method in interface org.openmuc.eebus.spine.api.Entity

hasLabel() - Method in interface org.openmuc.eebus.spine.api.Feature

I

IncompleteBuildException - Exception in org.openmuc.eebus.spine.api

IncompleteBuildException(String) - Constructor for exception org.openmuc.eebus.spine.api.IncompleteBuildException

isCallable() - Method in class org.openmuc.eebus.spine.spi.FeatureFunction

isDevice() - Method in interface org.openmuc.eebus.spine.api.EntityParent

isPositive() - Method in class org.openmuc.eebus.spine.api.SpineAcknowledgment

isReadable() - Method in class org.openmuc.eebus.spine.spi.FeatureFunction

isTrusted(FeatureAddressType, String) - Method in interface org.openmuc.eebus.spine.spi.FeaturePermission

isWritable() - Method in class org.openmuc.eebus.spine.spi.FeatureFunction

M

mapAddressToCommunication(String, Integer) - Method in interface org.openmuc.eebus.spine.api.NodeManagement

Assigns the given address to the given communication interface.

matchAddress(FeatureAddressType, FeatureAddressType) - Method in class org.openmuc.eebus.spine.spi.FeatureFunction

messageReceived(RequestResult) - Method in interface org.openmuc.eebus.spine.spi.SpineSubscription

N

newConnection(String) - Method in interface org.openmuc.eebus.spine.api.ConnectionHandler

Returns an open connection to the requested communication partner.

NO_ERROR - org.openmuc.eebus.spine.api.Error

NodeManagement - Interface in org.openmuc.eebus.spine.api

notifySubscribers(CmdType) - Method in interface org.openmuc.eebus.spine.api.Feature

Notifies subscribers of this SPINE feature that data contained in the given command has changed.

notifySubscribers(FunctionEnumType, FilterType) - Method in interface org.openmuc.eebus.spine.api.Feature

Notifies subscribers of this SPINE feature that data contained in the given SPINE function has changed.

O

onMessageReceived(SpineConnection, byte[]) - Method in class org.openmuc.eebus.spine.spi.Communication

open(String) - Method in class org.openmuc.eebus.spine.spi.Communication

org.openmuc.eebus.spine.api - package org.openmuc.eebus.spine.api

org.openmuc.eebus.spine.impl - package org.openmuc.eebus.spine.impl

org.openmuc.eebus.spine.spi - package org.openmuc.eebus.spine.spi

OVERLOAD - org.openmuc.eebus.spine.api.Error

P

parseDatagram(DatagramType) - Method in interface org.openmuc.eebus.spine.api.Device

Forwards the given datagram to the receiving feature for processing

R

read(FilterType, FeatureAddressType) - Method in class org.openmuc.eebus.spine.spi.FeatureFunction

registerConnection(SpineConnection) - Method in interface org.openmuc.eebus.spine.api.ConnectionHandler

Register an open connection

releaseBoundClient(FeatureAddressType) - Method in interface org.openmuc.eebus.spine.api.Feature

Releases the binding of the client feature located at the given address to this feature.

releaseBoundServer(FeatureAddressType) - Method in interface org.openmuc.eebus.spine.api.Feature

Releases the binding of this feature to the server feature located at the given address.

releaseSubscriber(FeatureAddressType) - Method in interface org.openmuc.eebus.spine.api.Feature

Releases the subscription of the client feature located at the given address to this feature.

releaseSubscription(FeatureAddressType) - Method in interface org.openmuc.eebus.spine.api.Feature

Releases the subscription of this feature to the server feature located at the given address.

removeAddressMapping(String) - Method in interface org.openmuc.eebus.spine.api.ConnectionHandler

removeAddressMapping(String) - Method in interface org.openmuc.eebus.spine.api.NodeManagement

Unmap the current communication interface from the given communication address.

removeDevice(String) - Method in class org.openmuc.eebus.spine.spi.Communication

requestBind(FeatureAddressType, FeatureTypeEnumType) - Method in interface org.openmuc.eebus.spine.api.Feature

Sends a binding request to the remote feature located at the given address.

requestBindingData(String) - Method in interface org.openmuc.eebus.spine.api.NodeManagement

Reads the binding data the remote device registered with this device.

requestDestinationListData(String) - Method in interface org.openmuc.eebus.spine.api.NodeManagement

Returns the destination list data of the remote device.

requestRead(FeatureAddressType, CmdType) - Method in interface org.openmuc.eebus.spine.api.Feature

Sends a read request to the remote feature located at the given address.

RequestResult - Interface in org.openmuc.eebus.spine.api

requestSubscription(FeatureAddressType, FeatureTypeEnumType, SpineSubscription) - Method in interface org.openmuc.eebus.spine.api.Feature

Sends a subscription request to the remote feature located at the given address.

requestSubscriptionData(String) - Method in interface org.openmuc.eebus.spine.api.NodeManagement

Reads the subscription data the remote device registered with this device.

requestWrite(FeatureAddressType, CmdType) - Method in interface org.openmuc.eebus.spine.api.Feature

Sends a write request to the remote feature located at the given address.

requireBinding() - Method in class org.openmuc.eebus.spine.spi.FeatureFunction

Call this if the function requires binding before write requests are accepted

RESTRICTED_FUNCTION_COMBINATION_UNSUPPORTED - org.openmuc.eebus.spine.api.Error

S

sendMessage(byte[]) - Method in interface org.openmuc.eebus.spine.spi.SpineConnection

Sends a message to the connected device

setAcknowledgmentEnabled(boolean) - Method in class org.openmuc.eebus.spine.impl.DeviceBuilder

setAutomaticDestinationListDetection(boolean) - Method in class org.openmuc.eebus.spine.impl.DeviceBuilder

setCallable(boolean) - Method in class org.openmuc.eebus.spine.spi.FeatureFunction

Makes this function callable from other features.

setCommunication(Communication) - Method in class org.openmuc.eebus.spine.impl.DeviceBuilder

This method must be called before calling DeviceBuilder.build()!

setCommunicationMode(NetworkManagementFeatureSetType) - Method in class org.openmuc.eebus.spine.impl.DeviceBuilder

Controls if the device should support the enhanced communication mode, i.e. can forward messages.NetworkManagementFeatureSetType.SIMPLE means no forwarding is possible and is the default.

setDescription(String) - Method in class org.openmuc.eebus.spine.impl.DeviceBuilder

setDescription(String) - Method in class org.openmuc.eebus.spine.impl.EntityBuilder

setDescription(String) - Method in class org.openmuc.eebus.spine.impl.FeatureBuilder

setDevice(Device) - Method in class org.openmuc.eebus.spine.spi.Communication

setDevice(Device) - Method in interface org.openmuc.eebus.spine.spi.UseCase

After building the Device (DeviceBuilder.build()) this method is invoked on all added UseCases.

setDeviceType(DeviceTypeEnumType) - Method in class org.openmuc.eebus.spine.impl.DeviceBuilder

This method must be called before calling DeviceBuilder.build()!

setDiscoverDevices(boolean) - Method in class org.openmuc.eebus.spine.impl.DeviceBuilder

Enables the automatic DetailedDiscovery of newly discovered SPINE devices.

setFeature(Feature) - Method in class org.openmuc.eebus.spine.spi.FeatureFunction

This method is automatically called by Feature.addFunction(FeatureFunction).

setFeatureGroup(String) - Method in class org.openmuc.eebus.spine.impl.FeatureBuilder

setFeaturePermission(FeaturePermission) - Method in class org.openmuc.eebus.spine.impl.FeatureBuilder

Sets the permissions required to access, bind to and subscribe to the new SPINE feature.

setId(String) - Method in class org.openmuc.eebus.spine.impl.DeviceBuilder

Sets the device address of the new SPINE device.

setLabel(String) - Method in class org.openmuc.eebus.spine.impl.DeviceBuilder

setLabel(String) - Method in class org.openmuc.eebus.spine.impl.EntityBuilder

setLabel(String) - Method in class org.openmuc.eebus.spine.impl.FeatureBuilder

setMinimumTrustLevel(String) - Method in class org.openmuc.eebus.spine.impl.FeatureBuilder

setPrettyPrint(boolean) - Static method in class org.openmuc.eebus.spine.impl.XMLParser

setReadable(boolean, boolean) - Method in class org.openmuc.eebus.spine.spi.FeatureFunction

Makes this function readable for other features.

setRole(RoleType) - Method in class org.openmuc.eebus.spine.impl.FeatureBuilder

This method must be called before calling FeatureBuilder.apply() or FeatureBuilder.build()!

setType(EntityTypeEnumType) - Method in class org.openmuc.eebus.spine.impl.EntityBuilder

This method must be called before calling EntityBuilder.applyToDevice(), EntityBuilder.applyToEntity() or EntityBuilder.build()!

setType(FeatureTypeEnumType) - Method in class org.openmuc.eebus.spine.impl.FeatureBuilder

This method must be called before calling FeatureBuilder.apply() or FeatureBuilder.build()!

setup(DeviceBuilder) - Method in interface org.openmuc.eebus.spine.spi.UseCase

After adding this UseCase to a Device (DeviceBuilder.addUseCase(UseCase)) this method is invoked.

setup(EntityBuilder) - Method in interface org.openmuc.eebus.spine.spi.UseCase

After adding this UseCase to an Entity (EntityBuilder.addUseCase(UseCase)) this method is invoked.

setWritable(boolean, boolean) - Method in class org.openmuc.eebus.spine.spi.FeatureFunction

Makes this function writable for other features.

SpineAcknowledgment - Class in org.openmuc.eebus.spine.api

SpineAcknowledgment(Error) - Constructor for class org.openmuc.eebus.spine.api.SpineAcknowledgment

SpineAcknowledgment(Error, String) - Constructor for class org.openmuc.eebus.spine.api.SpineAcknowledgment

SpineConnection - Interface in org.openmuc.eebus.spine.spi

SpineException - Exception in org.openmuc.eebus.spine.api

SpineException(Error, String) - Constructor for exception org.openmuc.eebus.spine.api.SpineException

SpineSubscription - Interface in org.openmuc.eebus.spine.spi

subscribeDestinationListData(String, SpineSubscription, boolean) - Method in interface org.openmuc.eebus.spine.api.NodeManagement

Subscribes to the destination list data function of the remote device.

subscriptionAllowed(NodeManagementSubscriptionRequestCallType.SubscriptionRequest) - Method in interface org.openmuc.eebus.spine.spi.FeaturePermission

T

TIMEOUT - org.openmuc.eebus.spine.api.Error

toDOM(DatagramType) - Static method in class org.openmuc.eebus.spine.impl.XMLParser

toXML(DatagramType) - Static method in class org.openmuc.eebus.spine.impl.XMLParser

U

updateUseCaseData(NodeManagementUseCaseDataType) - Method in interface org.openmuc.eebus.spine.spi.UseCaseDiscoveryListener

UseCase - Interface in org.openmuc.eebus.spine.spi

UseCaseDiscoveryListener - Interface in org.openmuc.eebus.spine.spi

V

valueOf(String) - Static method in enum org.openmuc.eebus.spine.api.Error

Returns the enum constant of this type with the specified name.

values() - Static method in enum org.openmuc.eebus.spine.api.Error

Returns an array containing the constants of this enum type, in the order they are declared.

W

write(CmdType, FeatureAddressType) - Method in class org.openmuc.eebus.spine.spi.FeatureFunction

X

XMLParser - Class in org.openmuc.eebus.spine.impl

A B C D E F G H I M N O P R S T U V W X
All Classes All Packages