Skip navigation links

com.bea.wlevs.management.configuration
Interface EventChannelMBean

public interface EventChannelMBean

extends StageMBean, EventQueueMBean

Field Summary

static java.lang.String

MBEAN_TYPE

Method Summary
void	addSelectorQuery(java.lang.String queryID) Adds the specified query ID to the selector configuration for this channel.
java.lang.String	getEventType() Returns the event type name for this channel
java.lang.Long	getHeartbeatTimeout() Gets the heart-beat timeout for the channel if it is specified.
java.util.List	getPrimaryKey() Returns primary key of relation, or an empty list for streams.
java.util.List	getSelectorQueries() Returns a list containing the IDs of the queries that route to this channel in its selector configuration.
java.lang.String	getTimestampExpression() Returns expression that defines application time-stamp for event channel.
boolean	isApplicationTimestamped() Returns if channel is application timestamped, that is, application is responsible for assigning a timestamp to each event.
boolean	isRelation() Returns if event channel is carrying relations, instead of streams.
boolean	isSystemTimestamped() Returns if channel is system timestamped, that is, the system is responsible for assigning a timestamp to each event.
boolean	isTotalOrder() Returns if application time published is always strictly greater than the last value used.
void	removeSelectorQuery(java.lang.String queryID) Removes the specified query ID from the selector configuration for this channel.
void	setHeartbeatTimeout(java.lang.Long heartbeatTimeout) Sets the heart-beat timeout for a channel.
void	setSelectorQueries(java.util.List queryIDs) Configures selector for this channel with the given query IDs.

Methods inherited from interface com.bea.wlevs.management.configuration.StageMBean

configurePlayback, configurePlaybackWithDuration, configureRecord, configureRecordWithDuration, getPlaybackConfiguration, getRecordConfiguration, getRecordPlayback, isPlayingBack, isRecording, startPlayback, startRecording, stopPlayback, stopRecording

Methods inherited from interface com.bea.wlevs.management.configuration.EventQueueMBean

configureQueueing, getCurrentSize, getMaxSize, getMaxThreads, setMaxSize, setMaxThreads

Methods inherited from interface com.bea.wlevs.management.WebLogicMBean

getName, getObjectName, getType

Methods inherited from interface javax.management.NotificationEmitter

removeNotificationListener

Methods inherited from interface javax.management.NotificationBroadcaster

addNotificationListener, getNotificationInfo, removeNotificationListener

Field Detail

MBEAN_TYPE

public static final java.lang.String MBEAN_TYPE

Method Detail

getEventType

public java.lang.String getEventType()

Returns the event type name for this channel

Returns:

String, or null if not set

getTimestampExpression

public java.lang.String getTimestampExpression()

Returns expression that defines application time-stamp for event channel.

Returns:

String, or null if channel uses system time-stamp

isRelation

public boolean isRelation()

Returns if event channel is carrying relations, instead of streams.

Returns:

boolean

isTotalOrder

public boolean isTotalOrder()

Returns if application time published is always strictly greater than the last value used.

Returns:

boolean

getPrimaryKey

public java.util.List getPrimaryKey()

Returns primary key of relation, or an empty list for streams.

Returns:

list of property names used as primary key for relation

getSelectorQueries

public java.util.List getSelectorQueries()
                                  throws javax.management.JMException

Returns a list containing the IDs of the queries that route to this channel in its selector configuration. An empty list will be returned if the selector configuration contains no query IDs. If no query IDs are specified in the selector, events from all queries will be sent to the channel.

Returns:

list of query IDs in the selector configuration of this channel. Empty list will be returned if no query IDs are specified.

Throws:

javax.management.JMException - if an unexpected error occurs

setSelectorQueries

public void setSelectorQueries(java.util.List queryIDs)
                        throws javax.management.JMException

Configures selector for this channel with the given query IDs. If an empty or null list is given, the channel will be configured for no query IDs. Queries do NOT need to exist in source processor. In other words, it is valid to use a queryID for a query that will be added to the processor at a future time.

Parameters:

queryIDs - List of IDs of the queries that should route to this channel

Throws:

javax.management.JMException - if an unexpected error occurs

addSelectorQuery

public void addSelectorQuery(java.lang.String queryID)
                      throws javax.management.JMException

Adds the specified query ID to the selector configuration for this channel. Queries do NOT need to exist in source processor. In other words, it is valid to use a queryID for a query that will be added to the processor at a future time.

Parameters:

queryID - the ID of the query that is to be added to the channel's selector configuration

Throws:

javax.management.JMException - if an unexpected error occurs

removeSelectorQuery

public void removeSelectorQuery(java.lang.String queryID)
                         throws javax.management.JMException

Removes the specified query ID from the selector configuration for this channel.

Parameters:

queryID - the ID of the query that is to be removed from the channel's selector configuration

Throws:

javax.management.OperationsException - if queryID has not been previously registered in selector.

javax.management.JMException - if an unexpected error occurs

getHeartbeatTimeout

public java.lang.Long getHeartbeatTimeout()
                                   throws javax.management.JMException

Gets the heart-beat timeout for the channel if it is specified.

Returns:

heart-beat the value of the heart-beat timeout for this channel. null if not specified.

setHeartbeatTimeout

public void setHeartbeatTimeout(java.lang.Long heartbeatTimeout)
                         throws javax.management.JMException

Sets the heart-beat timeout for a channel. By default there is no heart-beat timeout. Heart-beat events are used by the processors to advance time.

Heat-beat timeouts only applies to system-timestamped channels.

Heart-beat timeouts are needed when no events arrive in the event channels that are feeding the processors and the processor has been configured with a statement that includes some temporal operator, such it is the case of a time-based window, or a pattern matching with duration.

Parameters:

timeout - interval in nanoseconds after which a heart-beat event is automatically generated.

isSystemTimestamped

public boolean isSystemTimestamped()

Returns if channel is system timestamped, that is, the system is responsible for assigning a timestamp to each event. This is done using System.nanoTime().

Returns:

boolean

isApplicationTimestamped

public boolean isApplicationTimestamped()

Returns if channel is application timestamped, that is, application is responsible for assigning a timestamp to each event. Application may use any time domain.

Returns:

boolean