org.mbs.services.cup.data

Class CUEventSubscription

java.lang.Object

org.mbs.services.cup.data.SVEventSubscription

org.mbs.services.cup.data.CUEventSubscription

public class CUEventSubscription
extends SVEventSubscription

A structure containing the properties needed for subscribing for state variable events notification.

See Also:

ControlUnitProxy#subscribe

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	receiveCUStates Flag indicating whether this subscription requests receiving of control unit states.
protected boolean	receiveParentsInfo Flag indicating whether this subscription requests receiving of control unit parents info.

Fields inherited from class org.mbs.services.cup.data.SVEventSubscription

eventTimeout, expiredEventsFilter, listenerRegProps

Constructor Summary

Constructors

Constructor and Description
CUEventSubscription() Empty constructor.
CUEventSubscription(java.util.Dictionary listenerRegProps, java.lang.String expiredEventsFilter, long eventTimeout, boolean receiveCUStates, boolean receiveParentsInfo) Creates a CUEventSubscription object with given attributes.

Method Summary

Modifier and Type	Method and Description
void	read(java.io.DataInputStream in) Method used for serialization.
boolean	receiveCUStates() Returns the receiveCUStates flag with which the object is created.
boolean	receiveParentsInfo() Returns the receiveParentsInfo flag with which the object is created.
void	write(java.io.DataOutputStream out) Method used for serialization.

Methods inherited from class org.mbs.services.cup.data.SVEventSubscription

getExpiredEventsFilter, getListenerRegProps, getTimeout

Methods inherited from class java.lang.Object

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

Field Detail

receiveCUStates

protected boolean receiveCUStates

Flag indicating whether this subscription requests receiving of control unit states.

receiveParentsInfo

protected boolean receiveParentsInfo

Flag indicating whether this subscription requests receiving of control unit parents info.

Constructor Detail

CUEventSubscription

public CUEventSubscription()

Empty constructor.

CUEventSubscription

public CUEventSubscription(java.util.Dictionary listenerRegProps,
                           java.lang.String expiredEventsFilter,
                           long eventTimeout,
                           boolean receiveCUStates,
                           boolean receiveParentsInfo)

Creates a CUEventSubscription object with given attributes.

Parameters:

listenerRegProps - registration properties of the listener service. The ControlUnitListener on the target framework to serve this subscription shall be registered with the registration properties applied with this argument.

expiredEventsFilter - - filter in ldap form, specifying the sub set of control unit events for which all events (even the expired ones) should be delivered. Events are considered as expired if in the current event chunk of non sent events, for a particular control unit there are unregistered and registered events (in this sequence). In this case, both events are considered expired and by default will not be delivered. Applications that use a state machine logic could apply a expiredEventsFilter to specify the set of control units for which expired event notifications should not be omitted.

eventTimeout - max timeout (in milliseconds) after which a control unit event should be delivered. Zero or negative number means that every event should be delivered without any delay. If it is a negative number – then the event notification shall be sent immediately within synchronous messages.
Specifying a delay is useful for increasing the performance of notifications sending – if two or more events are raised within a short time - they shall be delivered within a single packet.

receiveCUStates - if this flag is raised, the events for registered control units shall bear the whole cu state of the registered unit(that means – the registered control unit will come together with the values if its state variables), otherwise the events shall bear the cu identification only (cuType + cuId). The control unit states delivered, depend on the stateInterfaces parameter passed to the ControlUnitProxy#subscribe method.

 
 The control unit state shall be constructed as follows:
 - If the current subscription defines control unit state interface for control units with the type of the registered control unit, then this is the control unit interface used.
 - If there are other subscriptions in the scope of this connection defining state interface for control units of type, then the interface provided in the latest subscription is used.
 - If metatype for control units with the type of the registered control unit is provided in the framework, then control unit state interface is constructed from all the state variables defined in the metatype.
 - Otherwise, only cuId is delivered.
 

receiveParentsInfo - if this flag is raised, the events for registered control units shall bear information about its parent units.

Method Detail

receiveCUStates

public boolean receiveCUStates()

Returns the receiveCUStates flag with which the object is created.

Returns:

the receiveCUStates flag for this object.

receiveParentsInfo

public boolean receiveParentsInfo()

Returns the receiveParentsInfo flag with which the object is created.

Returns:

the receiveParentsInfo flag for this object.

read

public void read(java.io.DataInputStream in)
          throws java.io.IOException

Method used for serialization.

Overrides:

read in class SVEventSubscription

Parameters:

in - input stream.

Throws:

java.io.IOException - of error occurs while reading.

write

public void write(java.io.DataOutputStream out)
           throws java.io.IOException

Method used for serialization.

Overrides:

write in class SVEventSubscription

Parameters:

out - output stream.

Throws:

java.io.IOException - if error occurs while writing.