org.eclipse.scada.da.server.common.impl

Class HiveCommon

java.lang.Object

org.eclipse.scada.core.server.common.ServiceCommon<Session,SessionCommon>

org.eclipse.scada.da.server.common.impl.HiveCommon

All Implemented Interfaces:

Service<Session>, Hive, LifecycleAware

Direct Known Subclasses:

AbstractOsgiHiveCommon, Hive, Hive, Hive, Hive, Hive, Hive, Hive, HiveImpl

public abstract class HiveCommon
extends ServiceCommon<Session,SessionCommon>
implements Hive

A common base for implementing Hive instances

Lifecycle

Hives are created using the constructor. There is no defined destructor. However there are start and stop methods that may create and free resources. All resources allocated in the start method should be destroyed in the stop method.

The item subscription manager will also be created in the performStart() method. So registering items is only possible after the hive has been started.

protected void performStart () { super.performStart (); registerItem ( "abc", … ); }

Field Summary

Fields inherited from class org.eclipse.scada.core.server.common.ServiceCommon

DEFAULT_RESULT

Constructor Summary

Constructors

Constructor and Description
HiveCommon()

Method Summary

Modifier and Type	Method and Description
void	addDataItemValidator(DataItemValidator dataItemValidator)
void	addItemFactory(DataItemFactory factory)
protected void	addItemSubscriptionListener(SubscriptionManagerListener<String> listener)
void	addSessionListener(SessionListener listener)
void	closeSession(Session session) Close a session.
protected Session	createSession(Future<UserInformation> loginFuture, Properties properties, CallbackHandler callbackHandler)
NotifyFuture<Session>	createSession(Properties properties, Map<String,Object> contextInformation, CallbackHandler callbackHandler) Create a new session for further accessing the hive
HiveBrowser	getBrowser()
Set<String>	getGrantedItems() Gets a set of all items in granted state.
abstract String	getHiveId() Get a unique ID for you hive type
Executor	getOperationService()
protected ValidationStrategy	getValidationStrategy()
protected void	handleSessionCreated(AbstractSessionImpl session, Properties properties, UserInformation userInformation)
boolean	isAutoEnableStats()
DataItem	lookupItem(String id)
protected void	performStart() Called then the hive should perform its startup procedure
protected void	performStop() Called then the hive should perform its shutdown procedure
protected NotifyFuture<WriteResult>	processWrite(SessionCommon session, String itemId, Variant value, OperationParameters effectiveOperationParameters)
protected NotifyFuture<WriteAttributeResults>	processWriteAttributes(SessionCommon session, String itemId, Map<String,Variant> attributes, OperationParameters operationParameters)
void	registerItem(DataItem item) Register a new item with the hive
void	removeItemFactory(DataItemFactory factory)
protected void	removeItemSubscriptionListener(SubscriptionManagerListener<String> listener)
void	removeItemValidator(DataItemValidator dataItemValidator)
void	removeSessionListener(SessionListener listener)
protected DataItem	retrieveItem(String id)
void	setAutoEnableStats(boolean autoEnableStats) This will disable the automatic generation of the stats module when setting the root folder.
protected void	setRootFolder(Folder rootFolder) Set the root folder.
protected void	setValidatonStrategy(ValidationStrategy validatonStrategy) Set the validation strategy Note: The validation strategy has to be set before the hive is started (e.g.
void	start()
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> attributes, OperationParameters operationParameters, CallbackHandler callbackHandler) Start a write attributes operation The operation is not started unless #thawOperation(Session, long) is called.
void	stop()
void	subscribeItem(Session session, String itemId) Register to an item for event notification
void	unregisterItem(DataItem item) Remove an item from the hive.
void	unsubscribeItem(Session session, String itemId) Unsubscribe a session from an item
protected boolean	validateItem(String id) Validate a data item id if it can be provided by the hive.
SessionCommon	validateSession(Session session) Validate a session and return the session common instance if the session is valid

Methods inherited from class org.eclipse.scada.core.server.common.ServiceCommon

authorize, authorize, extractPrivileges, fillSessionProperties, loginUser, makeEffectiveUserInformation, setAuditLogService, setAuthenticationImplementation, setAuthorizationImplementation

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

HiveCommon

public HiveCommon()

Method Detail

addItemSubscriptionListener

protected void addItemSubscriptionListener(SubscriptionManagerListener<String> listener)

removeItemSubscriptionListener

protected void removeItemSubscriptionListener(SubscriptionManagerListener<String> listener)

start

public void start()
           throws Exception

Specified by:

start in interface LifecycleAware

Throws:

Exception

stop

public void stop()
          throws Exception

Specified by:

stop in interface LifecycleAware

Throws:

Exception

performStart

protected void performStart()
                     throws Exception

Called then the hive should perform its startup procedure

This is internally dispatched when the start() method was called and the hive was not already started.

Throws:

Exception

performStop

protected void performStop()
                    throws Exception

Called then the hive should perform its shutdown procedure

This is internally dispatched when the stop() method was called and the hive was already started.

Throws:

Exception

getHiveId

public abstract String getHiveId()

Get a unique ID for you hive type

Returns:

a unique id of you hive type

addSessionListener

public void addSessionListener(SessionListener listener)

removeSessionListener

public void removeSessionListener(SessionListener listener)

setRootFolder

protected void setRootFolder(Folder rootFolder)

Set the root folder.

Note:The root folder can only be set once. All further set requests are ignored.

Note:The root folder must be set before the start method is called (e.g. in the constructor)

validateSession

public SessionCommon validateSession(Session session)
                              throws InvalidSessionException

Validate a session and return the session common instance if the session is valid

Parameters:

session - the session to validate

Returns:

the session common instance

Throws:

InvalidSessionException - in the case of an invalid session

createSession

public NotifyFuture<Session> createSession(Properties properties,
                                           Map<String,Object> contextInformation,
                                           CallbackHandler callbackHandler)

Description copied from interface: Service

Create a new session for further accessing the hive

Specified by:

createSession in interface Service<Session>

Parameters:

properties - properties used to create the session

contextInformation - additional context information

Returns:

a new session

createSession

protected Session createSession(Future<UserInformation> loginFuture,
                                Properties properties,
                                CallbackHandler callbackHandler)
                         throws InterruptedException,
                                ExecutionException

Throws:

InterruptedException

ExecutionException

handleSessionCreated

protected void handleSessionCreated(AbstractSessionImpl session,
                                    Properties properties,
                                    UserInformation userInformation)

closeSession

public void closeSession(Session session)
                  throws InvalidSessionException

Close a session. The session will be invalid after it has been closed. All subscriptions will become invalid. All pending operation will get canceled.

Specified by:

closeSession in interface Service<Session>

Parameters:

session - the session to close

Throws:

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

subscribeItem

public void subscribeItem(Session session,
                          String itemId)
                   throws InvalidSessionException,
                          InvalidItemException

Description copied from interface: Hive

Register to an item for event notification

Specified by:

subscribeItem in interface Hive

Parameters:

session - the session to use

itemId - the item to register for

Throws:

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

InvalidItemException - In the case the item is not valid

unsubscribeItem

public void unsubscribeItem(Session session,
                            String itemId)
                     throws InvalidSessionException,
                            InvalidItemException

Unsubscribe a session from an item

Specified by:

unsubscribeItem in interface Hive

Parameters:

session - the session to use

Throws:

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

InvalidItemException - In the case the item is not valid

registerItem

public void registerItem(DataItem item)

Register a new item with the hive

Note that registering an item is only possible after the Hive has been started.

Parameters:

item - the item to register

getOperationService

public Executor getOperationService()

unregisterItem

public void unregisterItem(DataItem item)

Remove an item from the hive.

Parameters:

item - the item to remove

validateItem

protected boolean validateItem(String id)

Validate a data item id if it can be provided by the hive.

The hive will perform several methods to check if the item id is valid.

Implementations must not create items based an a validation check!

Returns:

true if the item id is valid false otherwise

lookupItem

public DataItem lookupItem(String id)

retrieveItem

protected DataItem retrieveItem(String id)

startWriteAttributes

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

Description copied from interface: Hive

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

Specified by:

startWriteAttributes in interface Hive

Parameters:

session - the session to use

itemId - The item to write to

attributes - 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

processWriteAttributes

protected NotifyFuture<WriteAttributeResults> processWriteAttributes(SessionCommon session,
                                                                     String itemId,
                                                                     Map<String,Variant> attributes,
                                                                     OperationParameters operationParameters)

startWrite

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

Description copied from interface: Hive

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

Specified by:

startWrite in interface Hive

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

processWrite

protected NotifyFuture<WriteResult> processWrite(SessionCommon session,
                                                 String itemId,
                                                 Variant value,
                                                 OperationParameters effectiveOperationParameters)

getBrowser

public HiveBrowser getBrowser()

Specified by:

getBrowser in interface Hive

addItemFactory

public void addItemFactory(DataItemFactory factory)

removeItemFactory

public void removeItemFactory(DataItemFactory factory)

getGrantedItems

public Set<String> getGrantedItems()

Gets a set of all items in granted state.

Returns:

The list of granted items.

addDataItemValidator

public void addDataItemValidator(DataItemValidator dataItemValidator)

removeItemValidator

public void removeItemValidator(DataItemValidator dataItemValidator)

getValidationStrategy

protected ValidationStrategy getValidationStrategy()

setValidatonStrategy

protected void setValidatonStrategy(ValidationStrategy validatonStrategy)

Set the validation strategy
Note: The validation strategy has to be set before the hive is started (e.g. in the constructor of the hive).

Parameters:

validatonStrategy -

isAutoEnableStats

public boolean isAutoEnableStats()

setAutoEnableStats

public void setAutoEnableStats(boolean autoEnableStats)

This will disable the automatic generation of the stats module when setting the root folder. Must be called before setRootFolder(Folder)

Parameters:

autoEnableStats -