org.eclipse.scada.da.core.server

Interface Hive

All Superinterfaces:

LifecycleAware, Service<Session>

All Known Implementing Classes:

Hive, HiveCommon

public interface Hive
extends Service<Session>

Method Summary

Methods

Modifier and Type	Method and Description
HiveBrowser	getBrowser()
NotifyFuture<WriteResult>	startWrite(Session session, String itemId, Variant value, OperationParameters operationParameters, CallbackHandler callbackHandler) Start a write operation The operation is not started unless #thawOperation(Session, long) is called.
NotifyFuture<WriteAttributeResults>	startWriteAttributes(Session session, String itemId, Map<String,Variant> attribute, OperationParameters operationParameters, CallbackHandler callbackHandler) Start a write attributes operation The operation is not started unless #thawOperation(Session, long) is called.
void	subscribeItem(Session session, String item) Register to an item for event notification
void	unsubscribeItem(Session session, String item) Unregister from an an item for event notification

Methods inherited from interface org.eclipse.scada.core.server.Service

closeSession, createSession

Methods inherited from interface org.eclipse.scada.utils.lifecycle.LifecycleAware

start, stop

Method Detail

subscribeItem

void subscribeItem(Session session,
                 String item)
                   throws InvalidSessionException,
                          InvalidItemException

Register to an item for event notification

Parameters:

session - the session to use

item - the item to register for

initial - trigger an initial cache read with the registration

Throws:

InvalidSessionException - In the case the session is not a valid session

InvalidItemException - In the case the item is not valid

unsubscribeItem

void unsubscribeItem(Session session,
                   String item)
                     throws InvalidSessionException,
                            InvalidItemException

Unregister from an an item for event notification

Parameters:

session - the session to use

item -

Throws:

InvalidSessionException - In the case the session is not a valid session

InvalidItemException - In the case the item is not valid

startWrite

NotifyFuture<WriteResult> startWrite(Session session,
                                   String itemId,
                                   Variant value,
                                   OperationParameters operationParameters,
                                   CallbackHandler callbackHandler)
                                     throws InvalidSessionException,
                                            InvalidItemException,
                                            PermissionDeniedException

Start a write operation The operation is not started unless #thawOperation(Session, long) is called.

Parameters:

session - the session to use

itemId - The item to write to

value - The value to write

operationParameters - additional parameters to the write request, can be null

callbackHandler - can be null

Returns:

An operation ID which can be used to cancel or run the operation

Throws:

InvalidSessionException - In the case the session is not a valid session

InvalidItemException - In the case the item is not valid

PermissionDeniedException - if the user has no permission to perform this operation

startWriteAttributes

NotifyFuture<WriteAttributeResults> startWriteAttributes(Session session,
                                                       String itemId,
                                                       Map<String,Variant> attribute,
                                                       OperationParameters operationParameters,
                                                       CallbackHandler callbackHandler)
                                                         throws InvalidSessionException,
                                                                InvalidItemException,
                                                                PermissionDeniedException

Start a write attributes operation The operation is not started unless #thawOperation(Session, long) is called.

Parameters:

session - the session to use

itemId - The item to write to

attribute - The attributes to write

operationParameters - additional parameters to the write request, can be null

Returns:

An operation ID which can be used to cancel or run the operation

Throws:

InvalidSessionException - In the case the session is not a valid session

InvalidItemException - In the case the item is not valid

PermissionDeniedException - if the user has no permission to perform this operation

getBrowser

HiveBrowser getBrowser()