com.exalead.cloudview.alerting.v10

Class AlertGroup

java.lang.Object

com.exalead.cloudview.alerting.v10.AlertGroup

All Implemented Interfaces:

com.exalead.util.Checkable, java.io.Serializable

public class AlertGroup
extends java.lang.Object
implements com.exalead.util.Checkable, java.io.Serializable

Defines the scheduling and publication rules that apply to a set of scheduled alerts

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
java.util.List<AlertPublisher>	alertPublisher
java.lang.String	application
boolean	autoBuild
static boolean	DEFAULT_AUTO_BUILD
static boolean	DEFAULT_GROUP_ALERTS_BY_USER
static boolean	DEFAULT_INCREMENTAL
static boolean	DEFAULT_PUBLISH_DOCUMENT_METAS
static boolean	DEFAULT_REAL_TIME
static boolean	DEFAULT_STORE_ALERT_OCCURENCES
static boolean	DEFAULT_STORE_RESULTS
static boolean	DEFAULT_USE_AS_DEFAULT
java.lang.String	description
boolean	groupAlertsByUser
boolean	incremental
IncrementalModeConfig	incrementalModeConfig
java.lang.String	name
boolean	publishDocumentMetas
boolean	realTime
Scheduling	scheduling
java.lang.String	securitySource
boolean	storeAlertOccurences
boolean	storeResults
boolean	useAsDefault

Constructor Summary

Constructors

Constructor and Description
AlertGroup()
AlertGroup(AlertGroup o) Copy constructor

Method Summary

Modifier and Type	Method and Description
void	check(boolean deep, java.lang.String errorContext) Checks this AlertGroup.
static AlertGroup	fromString(java.lang.String s) String representation of this AlertGroup.
java.util.List<AlertPublisher>	getAlertPublisher() List of alert publisher configurations.
java.lang.String	getApplication() Mashup application for this alert group
java.lang.String	getDescription()
IncrementalModeConfig	getIncrementalModeConfig() Advanced configuration for the incrementality of scheduled alerting groups.
java.lang.String	getName()
Scheduling	getScheduling() Defines the trigger rule for scheduled queries. Only applies to scheduled alerting groups.
java.lang.String	getSecuritySource() Name of the security source to check tokens against when executing user alerts
boolean	isAutoBuild() Automatically rebuilds the real-time alerting matchers each time an alert is added, deleted, or updated. Autobuild should be disabled for large alerting groups (thousands of alerts).
boolean	isGroupAlertsByUser() Groups all alerts for a user in a single publication.
boolean	isIncremental() Includes a timestamp criteria with each alert request so the alert only returns documents modified or added since the last alert trigger. Only applies to scheduled alerting groups, since real-time alerting groups are always incremental.
boolean	isPublishDocumentMetas() When enabled, document metas are also published on match.
boolean	isRealTime() Matches alerts in this alert group as soon as the document is pushed (real-time alerting).
boolean	isStoreAlertOccurences() If set, each matching alert will be stored in the underlying alert_occurence table.
boolean	isStoreResults() Stores the results of each alert.
boolean	isUseAsDefault() Automatically selects this alert group in the "Save as alert" Mashup Widget.
AlertGroup	makeCopy() Creates and returns a deep copy of this AlertGroup.
static AlertGroup	readFrom(java.io.InputStream is) Read this AlertGroup from an XML fragment.
void	setApplication(java.lang.String application) Mashup application for this alert group
void	setAutoBuild(boolean autoBuild) Automatically rebuilds the real-time alerting matchers each time an alert is added, deleted, or updated. Autobuild should be disabled for large alerting groups (thousands of alerts).
void	setDescription(java.lang.String description)
void	setGroupAlertsByUser(boolean groupAlertsByUser) Groups all alerts for a user in a single publication.
void	setIncremental(boolean incremental) Includes a timestamp criteria with each alert request so the alert only returns documents modified or added since the last alert trigger. Only applies to scheduled alerting groups, since real-time alerting groups are always incremental.
void	setIncrementalModeConfig(IncrementalModeConfig incrementalModeConfig) Advanced configuration for the incrementality of scheduled alerting groups.
void	setName(java.lang.String name)
void	setPublishDocumentMetas(boolean publishDocumentMetas) When enabled, document metas are also published on match.
void	setRealTime(boolean realTime) Matches alerts in this alert group as soon as the document is pushed (real-time alerting).
void	setScheduling(Scheduling scheduling) Defines the trigger rule for scheduled queries. Only applies to scheduled alerting groups.
void	setSecuritySource(java.lang.String securitySource) Name of the security source to check tokens against when executing user alerts
void	setStoreAlertOccurences(boolean storeAlertOccurences) If set, each matching alert will be stored in the underlying alert_occurence table.
void	setStoreResults(boolean storeResults) Stores the results of each alert.
void	setUseAsDefault(boolean useAsDefault) Automatically selects this alert group in the "Save as alert" Mashup Widget.
java.lang.String	toString() String representation of this AlertGroup.
AlertGroup	withAlertPublisher(AlertPublisher... __values) List of alert publisher configurations.
AlertGroup	withAlertPublisher(java.util.Collection<AlertPublisher> __values)
AlertGroup	withApplication(java.lang.String application)
AlertGroup	withAutoBuild(boolean autoBuild)
AlertGroup	withAutoBuild(java.lang.Boolean autoBuild)
AlertGroup	withDescription(java.lang.String description)
AlertGroup	withGroupAlertsByUser(boolean groupAlertsByUser)
AlertGroup	withGroupAlertsByUser(java.lang.Boolean groupAlertsByUser)
AlertGroup	withIncremental(boolean incremental)
AlertGroup	withIncremental(java.lang.Boolean incremental)
AlertGroup	withIncrementalModeConfig(IncrementalModeConfig incrementalModeConfig)
AlertGroup	withName(java.lang.String name)
AlertGroup	withPublishDocumentMetas(boolean publishDocumentMetas)
AlertGroup	withPublishDocumentMetas(java.lang.Boolean publishDocumentMetas)
AlertGroup	withRealTime(boolean realTime)
AlertGroup	withRealTime(java.lang.Boolean realTime)
AlertGroup	withScheduling(Scheduling scheduling)
AlertGroup	withSecuritySource(java.lang.String securitySource)
AlertGroup	withStoreAlertOccurences(boolean storeAlertOccurences)
AlertGroup	withStoreAlertOccurences(java.lang.Boolean storeAlertOccurences)
AlertGroup	withStoreResults(boolean storeResults)
AlertGroup	withStoreResults(java.lang.Boolean storeResults)
AlertGroup	withUseAsDefault(boolean useAsDefault)
AlertGroup	withUseAsDefault(java.lang.Boolean useAsDefault)
void	writeTo(java.io.OutputStream os) Write this AlertGroup as an XML fragment

Methods inherited from class java.lang.Object

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

Field Detail

name

public java.lang.String name

description

public java.lang.String description

securitySource

public java.lang.String securitySource

application

public java.lang.String application

useAsDefault

public boolean useAsDefault

DEFAULT_USE_AS_DEFAULT

public static final boolean DEFAULT_USE_AS_DEFAULT

See Also:

Constant Field Values

publishDocumentMetas

public boolean publishDocumentMetas

DEFAULT_PUBLISH_DOCUMENT_METAS

public static final boolean DEFAULT_PUBLISH_DOCUMENT_METAS

See Also:

Constant Field Values

storeAlertOccurences

public boolean storeAlertOccurences

DEFAULT_STORE_ALERT_OCCURENCES

public static final boolean DEFAULT_STORE_ALERT_OCCURENCES

See Also:

Constant Field Values

realTime

public boolean realTime

DEFAULT_REAL_TIME

public static final boolean DEFAULT_REAL_TIME

See Also:

Constant Field Values

autoBuild

public boolean autoBuild

DEFAULT_AUTO_BUILD

public static final boolean DEFAULT_AUTO_BUILD

See Also:

Constant Field Values

scheduling

public Scheduling scheduling

alertPublisher

public java.util.List<AlertPublisher> alertPublisher

storeResults

public boolean storeResults

DEFAULT_STORE_RESULTS

public static final boolean DEFAULT_STORE_RESULTS

See Also:

Constant Field Values

incremental

public boolean incremental

DEFAULT_INCREMENTAL

public static final boolean DEFAULT_INCREMENTAL

See Also:

Constant Field Values

groupAlertsByUser

public boolean groupAlertsByUser

DEFAULT_GROUP_ALERTS_BY_USER

public static final boolean DEFAULT_GROUP_ALERTS_BY_USER

See Also:

Constant Field Values

incrementalModeConfig

public IncrementalModeConfig incrementalModeConfig

Constructor Detail

AlertGroup

public AlertGroup()

AlertGroup

public AlertGroup(AlertGroup o)

Copy constructor

Method Detail

setName

public void setName(java.lang.String name)

getName

public java.lang.String getName()

withName

public AlertGroup withName(java.lang.String name)

setDescription

public void setDescription(java.lang.String description)

getDescription

public java.lang.String getDescription()

withDescription

public AlertGroup withDescription(java.lang.String description)

setSecuritySource

public void setSecuritySource(java.lang.String securitySource)

Name of the security source to check tokens against when executing user alerts

getSecuritySource

public java.lang.String getSecuritySource()

Name of the security source to check tokens against when executing user alerts

withSecuritySource

public AlertGroup withSecuritySource(java.lang.String securitySource)

setApplication

public void setApplication(java.lang.String application)

Mashup application for this alert group

getApplication

public java.lang.String getApplication()

Mashup application for this alert group

withApplication

public AlertGroup withApplication(java.lang.String application)

setUseAsDefault

public void setUseAsDefault(boolean useAsDefault)

Automatically selects this alert group in the "Save as alert" Mashup Widget.

isUseAsDefault

public boolean isUseAsDefault()

Automatically selects this alert group in the "Save as alert" Mashup Widget.

withUseAsDefault

public AlertGroup withUseAsDefault(boolean useAsDefault)

withUseAsDefault

public AlertGroup withUseAsDefault(java.lang.Boolean useAsDefault)

setPublishDocumentMetas

public void setPublishDocumentMetas(boolean publishDocumentMetas)

When enabled, document metas are also published on match. It may be useful to disable this option to reduce gateway heap usage.

isPublishDocumentMetas

public boolean isPublishDocumentMetas()

When enabled, document metas are also published on match. It may be useful to disable this option to reduce gateway heap usage.

withPublishDocumentMetas

public AlertGroup withPublishDocumentMetas(boolean publishDocumentMetas)

withPublishDocumentMetas

public AlertGroup withPublishDocumentMetas(java.lang.Boolean publishDocumentMetas)

setStoreAlertOccurences

public void setStoreAlertOccurences(boolean storeAlertOccurences)

If set, each matching alert will be stored in the underlying alert_occurence table.

isStoreAlertOccurences

public boolean isStoreAlertOccurences()

If set, each matching alert will be stored in the underlying alert_occurence table.

withStoreAlertOccurences

public AlertGroup withStoreAlertOccurences(boolean storeAlertOccurences)

withStoreAlertOccurences

public AlertGroup withStoreAlertOccurences(java.lang.Boolean storeAlertOccurences)

setRealTime

public void setRealTime(boolean realTime)

Matches alerts in this alert group as soon as the document is pushed
(real-time alerting). If false, matches alerts by executing scheduled queries (scheduled alerting).

Real-time alerting offers very low latency alerting, but with fewer features.
For details, see the CloudView Administration Guide.

isRealTime

public boolean isRealTime()

Matches alerts in this alert group as soon as the document is pushed
(real-time alerting). If false, matches alerts by executing scheduled queries (scheduled alerting).

Real-time alerting offers very low latency alerting, but with fewer features.
For details, see the CloudView Administration Guide.

withRealTime

public AlertGroup withRealTime(boolean realTime)

withRealTime

public AlertGroup withRealTime(java.lang.Boolean realTime)

setAutoBuild

public void setAutoBuild(boolean autoBuild)

Automatically rebuilds the real-time alerting matchers each time an alert is added, deleted, or
updated.
Autobuild should be disabled for large alerting groups (thousands of alerts).

isAutoBuild

public boolean isAutoBuild()

Automatically rebuilds the real-time alerting matchers each time an alert is added, deleted, or
updated.
Autobuild should be disabled for large alerting groups (thousands of alerts).

withAutoBuild

public AlertGroup withAutoBuild(boolean autoBuild)

withAutoBuild

public AlertGroup withAutoBuild(java.lang.Boolean autoBuild)

setScheduling

public void setScheduling(Scheduling scheduling)

Defines the trigger rule for scheduled queries.
Only applies to scheduled alerting groups.

getScheduling

public Scheduling getScheduling()

Defines the trigger rule for scheduled queries.
Only applies to scheduled alerting groups.

withScheduling

public AlertGroup withScheduling(Scheduling scheduling)

getAlertPublisher

public java.util.List<AlertPublisher> getAlertPublisher()

List of alert publisher configurations.

withAlertPublisher

public AlertGroup withAlertPublisher(AlertPublisher... __values)

List of alert publisher configurations.

withAlertPublisher

public AlertGroup withAlertPublisher(java.util.Collection<AlertPublisher> __values)

setStoreResults

public void setStoreResults(boolean storeResults)

Stores the results of each alert. Required for using the real-time alerts displayer; calculating the difference since the last alert trigger; and ensuring transaction consistency if a publication fails.

isStoreResults

public boolean isStoreResults()

Stores the results of each alert. Required for using the real-time alerts displayer; calculating the difference since the last alert trigger; and ensuring transaction consistency if a publication fails.

withStoreResults

public AlertGroup withStoreResults(boolean storeResults)

withStoreResults

public AlertGroup withStoreResults(java.lang.Boolean storeResults)

setIncremental

public void setIncremental(boolean incremental)

Includes a timestamp criteria with each alert request so the alert only returns documents modified or added since the
last alert trigger.
Only applies to scheduled alerting groups, since real-time alerting groups are always incremental.

isIncremental

public boolean isIncremental()

Includes a timestamp criteria with each alert request so the alert only returns documents modified or added since the
last alert trigger.
Only applies to scheduled alerting groups, since real-time alerting groups are always incremental.

withIncremental

public AlertGroup withIncremental(boolean incremental)

withIncremental

public AlertGroup withIncremental(java.lang.Boolean incremental)

setGroupAlertsByUser

public void setGroupAlertsByUser(boolean groupAlertsByUser)

Groups all alerts for a user in a single publication. Only applies to scheduled alerting
groups, since real-time alerting publications are never grouped.

isGroupAlertsByUser

public boolean isGroupAlertsByUser()

Groups all alerts for a user in a single publication. Only applies to scheduled alerting
groups, since real-time alerting publications are never grouped.

withGroupAlertsByUser

public AlertGroup withGroupAlertsByUser(boolean groupAlertsByUser)

withGroupAlertsByUser

public AlertGroup withGroupAlertsByUser(java.lang.Boolean groupAlertsByUser)

setIncrementalModeConfig

public void setIncrementalModeConfig(IncrementalModeConfig incrementalModeConfig)

Advanced configuration for the incrementality of scheduled alerting groups.

getIncrementalModeConfig

public IncrementalModeConfig getIncrementalModeConfig()

Advanced configuration for the incrementality of scheduled alerting groups.

withIncrementalModeConfig

public AlertGroup withIncrementalModeConfig(IncrementalModeConfig incrementalModeConfig)

makeCopy

public AlertGroup makeCopy()

Creates and returns a deep copy of this AlertGroup.

readFrom

public static AlertGroup readFrom(java.io.InputStream is)
                           throws javax.xml.bind.JAXBException

Read this AlertGroup from an XML fragment.

Throws:

javax.xml.bind.JAXBException

writeTo

public void writeTo(java.io.OutputStream os)
             throws javax.xml.bind.JAXBException,
                    java.io.IOException

Write this AlertGroup as an XML fragment

Throws:

javax.xml.bind.JAXBException

java.io.IOException

fromString

public static AlertGroup fromString(java.lang.String s)
                             throws javax.xml.bind.JAXBException,
                                    java.io.UnsupportedEncodingException

String representation of this AlertGroup.

Throws:

javax.xml.bind.JAXBException

java.io.UnsupportedEncodingException

toString

public java.lang.String toString()

String representation of this AlertGroup.

Overrides:

toString in class java.lang.Object

check

public void check(boolean deep,
                  java.lang.String errorContext)
           throws com.exalead.util.TypedException

Checks this AlertGroup.

Specified by:

check in interface com.exalead.util.Checkable

Throws:

com.exalead.util.TypedException