Package com.attivio.sdk.client.trigger

Interface TriggerApi

All Superinterfaces:

ExternalizableStore

public interface TriggerApi
extends ExternalizableStore

API for defining and modifying triggers.

Nested Class Summary

Nested classes/interfaces inherited from interface com.attivio.sdk.client.ExternalizableStore

ExternalizableStore.ImportOption

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	STORE_NAME

Method Summary

Modifier and Type	Method	Description
void	compileDictionary(TriggerDictionaryName dictionaryName)	Compile the trigger dictionary identified by dictionaryName into binary format.
default void	compileDictionary(java.lang.String dictionaryName)	Deprecated. use compileDictionary(TriggerDictionaryName) instead.
void	copyDictionary(TriggerDictionaryName dictionaryName, TriggerDictionaryName newName)	Copy the trigger dictionary identified by dictionaryName to a new dictionary with newName.
default void	copyDictionary(java.lang.String dictionaryName, java.lang.String newName)	Deprecated. use copyDictionary(TriggerDictionaryName, TriggerDictionaryName) instead.
void	createDictionary(TriggerDictionaryInfo info)	Create a new trigger dictionary.
void	createTrigger(TriggerDictionaryName dictionaryName, TriggerDefinition trigger)	Add trigger to the dictionary identified by dictionaryName.
default void	createTrigger(java.lang.String dictionaryName, TriggerDefinition trigger)	Deprecated. use createTrigger(TriggerDictionaryName, TriggerDefinition) instead.
void	deleteDictionary(TriggerDictionaryName dictionaryName)	Delete a trigger dictionary identified by dictionaryName .
default void	deleteDictionary(java.lang.String dictionaryName)	Deprecated. use deleteDictionary(TriggerDictionaryName) instead.
void	deleteTrigger(TriggerDictionaryName dictionaryName, java.lang.String triggerName)	Delete trigger named triggerName for the dictionary identified by dictionaryName.
default void	deleteTrigger(java.lang.String dictionaryName, java.lang.String triggerName)	Deprecated. use deleteTrigger(TriggerDictionaryName, String) instead.
void	exportDictionary(TriggerDictionaryName dictionaryName, java.io.OutputStream output)	Export trigger dictionary by name to output.
default void	exportDictionary(java.lang.String dictionaryName, java.io.OutputStream output)	Deprecated. use exportDictionary(TriggerDictionaryName, OutputStream) instead.
java.lang.Iterable<TriggerDictionaryInfo>	getDictionaries(TriggerDictionaryName prefix, int offset, int rows)	Get all dictionaries.
default java.lang.Iterable<TriggerDictionaryInfo>	getDictionaries(java.lang.String prefix, int offset, int rows)	Deprecated. use getDictionaries(TriggerDictionaryName, int, int) instead.
TriggerDictionaryInfo	getDictionary(TriggerDictionaryName dictionaryName)	Get a TriggerDictionaryInfo by dictionaryName.
default TriggerDictionaryInfo	getDictionary(java.lang.String dictionaryName)	Deprecated. use getDictionary(TriggerDictionaryName) instead.
default java.util.List<java.lang.String>	getDictionaryNames()	Get the names of all dictionaries in the default namespace.
java.util.Map<java.util.Locale,java.lang.Long>	getLocales(TriggerDictionaryName dictionaryName, java.lang.String prefix)	Get a map of locales for dictionary specified by dictionaryName.
default java.util.Map<java.util.Locale,java.lang.Long>	getLocales(java.lang.String dictionaryName, java.lang.String prefix)	Deprecated. use getLocales(TriggerDictionaryName, String) instead.
default java.lang.String	getStoreName()	Get the name of this store.
default long	getStoreRevision()	Get the store revision for the default namespace.
long	getStoreRevision(java.lang.String namespace)	Get the store revision for the specified namespace.
TriggerDefinition	getTrigger(TriggerDictionaryName dictionaryName, java.lang.String triggerName)	Get a TriggerDefinition by triggerName for dictionaryName.
default TriggerDefinition	getTrigger(java.lang.String dictionaryName, java.lang.String triggerName)	Deprecated. use #getTrigger(String, String, String) instead.
java.lang.Iterable<TriggerDefinition>	getTriggers(TriggerDictionaryName dictionaryName, java.util.Locale locale, java.lang.String prefix, int offset, int rows)	Get triggers for dictionary identified by dictionaryName.
default java.lang.Iterable<TriggerDefinition>	getTriggers(java.lang.String dictionaryName, java.util.Locale locale, java.lang.String prefix, int offset, int rows)	Deprecated. use getTriggers(TriggerDictionaryName, Locale, String, int, int) instead.
default void	importDictionary(byte[] input, TriggerDictionaryName newName, boolean replace)	Deprecated.
default void	importDictionary(byte[] input, java.lang.String newName, boolean replace)	Deprecated.
void	importDictionary(java.io.InputStream input, TriggerDictionaryName newName, boolean replace)	Import a trigger dictionary from input.
default void	importDictionary(java.io.InputStream input, java.lang.String newName, boolean replace)	Deprecated. use importDictionary(InputStream, TriggerDictionaryName, boolean) instead.
IngestDocument	process(TriggerDictionaryName dictionaryName, IngestDocument document, boolean published)	Process document according to dictionaryName.
default IngestDocument	process(java.lang.String dictionaryName, IngestDocument document, boolean published)	Deprecated. use process(TriggerDictionaryName, IngestDocument, boolean) instead.
void	publishDictionary(TriggerDictionaryName dictionaryName)	Publish the most recently compiled binary dictionary identified by dictionaryName.
default void	publishDictionary(java.lang.String dictionaryName)	Deprecated. use publishDictionary(TriggerDictionaryName) instead.
void	updateDictionary(TriggerDictionaryInfo info)	Update the metadata for a trigger dictionary.
void	updateTrigger(TriggerDictionaryName dictionaryName, TriggerDefinition trigger)	Update trigger for the dictionary identified by dictionaryName.
default void	updateTrigger(java.lang.String dictionaryName, TriggerDefinition trigger)	Deprecated. use #updateTrigger(String, String, TriggerDefinition) instead.

Methods inherited from interface com.attivio.sdk.client.ExternalizableStore

exportStore, importStore

Field Detail

STORE_NAME

static final java.lang.String STORE_NAME

See Also:

Constant Field Values

Method Detail

getStoreName

default java.lang.String getStoreName()

Description copied from interface: ExternalizableStore

Get the name of this store.

This name will be the location that store configuration is synchronized to in the project's conf directory.

Specified by:

getStoreName in interface ExternalizableStore

getStoreRevision

default long getStoreRevision()
                       throws AttivioException

Get the store revision for the default namespace.

Specified by:

getStoreRevision in interface ExternalizableStore

Throws:

AttivioException

getStoreRevision

long getStoreRevision(java.lang.String namespace)
               throws AttivioException

Get the store revision for the specified namespace.

Throws:

AttivioException

getDictionary

@Deprecated
default TriggerDictionaryInfo getDictionary(java.lang.String dictionaryName)
                                     throws AttivioException

Deprecated.

use getDictionary(TriggerDictionaryName) instead.

Get a TriggerDictionaryInfo by dictionaryName.

Returns null if a trigger dictionary with dictionaryName does not exist.

Throws:

AttivioException

getDictionary

TriggerDictionaryInfo getDictionary(TriggerDictionaryName dictionaryName)
                             throws AttivioException

Get a TriggerDictionaryInfo by dictionaryName.

Returns null if a trigger dictionary with dictionaryName does not exist.

Throws:

AttivioException

getDictionaries

@Deprecated
default java.lang.Iterable<TriggerDictionaryInfo> getDictionaries(java.lang.String prefix,
                                                                  int offset,
                                                                  int rows)
                                                           throws AttivioException

Deprecated.

use getDictionaries(TriggerDictionaryName, int, int) instead.

Get all dictionaries.

Dictionaries will be returned ordered by name.

If prefix is specified, the result will be filtered to only include dictionaries whose name starts with prefix .

Throws:

AttivioException

getDictionaryNames

default java.util.List<java.lang.String> getDictionaryNames()
                                                     throws AttivioException

Get the names of all dictionaries in the default namespace.

Throws:

AttivioException

getDictionaries

java.lang.Iterable<TriggerDictionaryInfo> getDictionaries(TriggerDictionaryName prefix,
                                                          int offset,
                                                          int rows)
                                                   throws AttivioException

Get all dictionaries.

Dictionaries will be returned ordered by name.

If prefix is specified, the result will be filtered to only include dictionaries whose name starts with prefix .

Throws:

AttivioException

createDictionary

void createDictionary(TriggerDictionaryInfo info)
               throws AttivioException

Create a new trigger dictionary.

This dictionary will not be available to transformers/components until compileDictionary(String) and publishDictionary(String) has been called for this dictionary.

Throws:

AttivioException

updateDictionary

void updateDictionary(TriggerDictionaryInfo info)
               throws AttivioException

Update the metadata for a trigger dictionary.

The changes to this dictionary will not be available to transformers/components until compileDictionary(String) and publishDictionary(String) has been called for this dictionary.

Throws:

AttivioException

deleteDictionary

@Deprecated
default void deleteDictionary(java.lang.String dictionaryName)
                       throws AttivioException

Deprecated.

use deleteDictionary(TriggerDictionaryName) instead.

Delete a trigger dictionary identified by dictionaryName .

Throws:

AttivioException

deleteDictionary

void deleteDictionary(TriggerDictionaryName dictionaryName)
               throws AttivioException

Delete a trigger dictionary identified by dictionaryName .

Throws:

AttivioException

compileDictionary

@Deprecated
default void compileDictionary(java.lang.String dictionaryName)
                        throws AttivioException

Deprecated.

use compileDictionary(TriggerDictionaryName) instead.

Compile the trigger dictionary identified by dictionaryName into binary format.

Throws:

AttivioException

compileDictionary

void compileDictionary(TriggerDictionaryName dictionaryName)
                throws AttivioException

Compile the trigger dictionary identified by dictionaryName into binary format.

Throws:

AttivioException

publishDictionary

@Deprecated
default void publishDictionary(java.lang.String dictionaryName)
                        throws AttivioException

Deprecated.

use publishDictionary(TriggerDictionaryName) instead.

Publish the most recently compiled binary dictionary identified by dictionaryName.

Upon successful completion of this method, all transformers/components will start using the newly published version of this dictionary.

Throws:

AttivioException

publishDictionary

void publishDictionary(TriggerDictionaryName dictionaryName)
                throws AttivioException

Publish the most recently compiled binary dictionary identified by dictionaryName.

Upon successful completion of this method, all transformers/components will start using the newly published version of this dictionary.

Throws:

AttivioException

copyDictionary

@Deprecated
default void copyDictionary(java.lang.String dictionaryName,
                            java.lang.String newName)
                     throws AttivioException

Deprecated.

use copyDictionary(TriggerDictionaryName, TriggerDictionaryName) instead.

Copy the trigger dictionary identified by dictionaryName to a new dictionary with newName.

NOTE: the newly created copy will not be available to transformers/components until compileDictionary(String) and publishDictionary(String) are called for the new dictionary.

Throws:

AttivioException

copyDictionary

void copyDictionary(TriggerDictionaryName dictionaryName,
                    TriggerDictionaryName newName)
             throws AttivioException

Copy the trigger dictionary identified by dictionaryName to a new dictionary with newName.

NOTE: the newly created copy will not be available to transformers/components until compileDictionary(TriggerDictionaryName) and publishDictionary(TriggerDictionaryName) are called for the new dictionary.

Throws:

AttivioException

getTrigger

@Deprecated
default TriggerDefinition getTrigger(java.lang.String dictionaryName,
                                     java.lang.String triggerName)
                              throws AttivioException

Deprecated.

use #getTrigger(String, String, String) instead.

Get a TriggerDefinition by triggerName for dictionaryName.

Throws:

AttivioException - if dictionary does not exist, or trigger does not exist.

getTrigger

TriggerDefinition getTrigger(TriggerDictionaryName dictionaryName,
                             java.lang.String triggerName)
                      throws AttivioException

Get a TriggerDefinition by triggerName for dictionaryName.

Throws:

AttivioException - if dictionary does not exist, or trigger does not exist.

createTrigger

@Deprecated
default void createTrigger(java.lang.String dictionaryName,
                           TriggerDefinition trigger)
                    throws AttivioException

Deprecated.

use createTrigger(TriggerDictionaryName, TriggerDefinition) instead.

Add trigger to the dictionary identified by dictionaryName.

If the dictionary already contains a trigger with the same name, an exception will be thrown.

This new trigger will not be available to transformers/components until compileDictionary(String) and publishDictionary(String) has been called for dictionaryName.

Throws:

AttivioException

createTrigger

void createTrigger(TriggerDictionaryName dictionaryName,
                   TriggerDefinition trigger)
            throws AttivioException

Add trigger to the dictionary identified by dictionaryName.

If the dictionary already contains a trigger with the same name, an exception will be thrown.

This new trigger will not be available to transformers/components until compileDictionary(String) and publishDictionary(String) has been called for dictionaryName.

Throws:

AttivioException

updateTrigger

@Deprecated
default void updateTrigger(java.lang.String dictionaryName,
                           TriggerDefinition trigger)
                    throws AttivioException

Deprecated.

use #updateTrigger(String, String, TriggerDefinition) instead.

Update trigger for the dictionary identified by dictionaryName.

If the dictionary does not contain a trigger with the name specified, an exception will be thrown.

NOTE: you cannot change the name of a trigger. In order to rename a trigger, you must first call createTrigger(String, TriggerDefinition) with the new trigger, and upon success, call deleteTrigger(String, String) for the previous trigger.

Updates to this trigger will not be available to transformers/components until compileDictionary(String) and publishDictionary(String) has been called for dictionaryName.

Throws:

AttivioException

updateTrigger

void updateTrigger(TriggerDictionaryName dictionaryName,
                   TriggerDefinition trigger)
            throws AttivioException

Update trigger for the dictionary identified by dictionaryName.

If the dictionary does not contain a trigger with the name specified, an exception will be thrown.

NOTE: you cannot change the name of a trigger. In order to rename a trigger, you must first call createTrigger(String, TriggerDefinition) with the new trigger, and upon success, call deleteTrigger(String, String) for the previous trigger.

Updates to this trigger will not be available to transformers/components until compileDictionary(String) and publishDictionary(String) has been called for dictionaryName.

Throws:

AttivioException

deleteTrigger

default void deleteTrigger(java.lang.String dictionaryName,
                           java.lang.String triggerName)
                    throws AttivioException

Deprecated.

use deleteTrigger(TriggerDictionaryName, String) instead.

Delete trigger named triggerName for the dictionary identified by dictionaryName.

This trigger will continue to be available to transformers/components until compileDictionary(String) and publishDictionary(String) has been called for dictionaryName, assuming this trigger has been published previously.

Throws:

AttivioException

deleteTrigger

void deleteTrigger(TriggerDictionaryName dictionaryName,
                   java.lang.String triggerName)
            throws AttivioException

Delete trigger named triggerName for the dictionary identified by dictionaryName.

This trigger will continue to be available to transformers/components until compileDictionary(String) and publishDictionary(String) has been called for dictionaryName, assuming this trigger has been published previously.

Throws:

AttivioException

getLocales

@Deprecated
default java.util.Map<java.util.Locale,java.lang.Long> getLocales(java.lang.String dictionaryName,
                                                                        java.lang.String prefix)
                                                                 throws AttivioException

Deprecated.

use getLocales(TriggerDictionaryName, String) instead.

Get a map of locales for dictionary specified by dictionaryName.

The value for the map will contain the number of triggers in the dictionary specified for the locale.

If prefix is specified, this will be used to filter the matching triggers to only include triggers with a name that starts with prefix.

Throws:

AttivioException

getLocales

java.util.Map<java.util.Locale,java.lang.Long> getLocales(TriggerDictionaryName dictionaryName,
                                                                java.lang.String prefix)
                                                         throws AttivioException

Get a map of locales for dictionary specified by dictionaryName.

The value for the map will contain the number of triggers in the dictionary specified for the locale.

If prefix is specified, this will be used to filter the matching triggers to only include triggers with a name that starts with prefix.

Throws:

AttivioException

getTriggers

@Deprecated
default java.lang.Iterable<TriggerDefinition> getTriggers(java.lang.String dictionaryName,
                                                          java.util.Locale locale,
                                                          java.lang.String prefix,
                                                          int offset,
                                                          int rows)
                                                   throws AttivioException

Deprecated.

use getTriggers(TriggerDictionaryName, Locale, String, int, int) instead.

Get triggers for dictionary identified by dictionaryName.

Returned triggers will be ordered according to name.

If locale is specified, the result will be filtered to only include triggers for the specified locale.

If prefix is specified, the result will be filtered to only include triggers whose name starts with prefix.

Throws:

AttivioException

getTriggers

java.lang.Iterable<TriggerDefinition> getTriggers(TriggerDictionaryName dictionaryName,
                                                  java.util.Locale locale,
                                                  java.lang.String prefix,
                                                  int offset,
                                                  int rows)
                                           throws AttivioException

Get triggers for dictionary identified by dictionaryName.

Returned triggers will be ordered according to name.

If locale is specified, the result will be filtered to only include triggers for the specified locale.

If prefix is specified, the result will be filtered to only include triggers whose name starts with prefix.

Throws:

AttivioException

exportDictionary

@Deprecated
default void exportDictionary(java.lang.String dictionaryName,
                              java.io.OutputStream output)
                       throws AttivioException

Deprecated.

use exportDictionary(TriggerDictionaryName, OutputStream) instead.

Export trigger dictionary by name to output.

Dictionary will be output in XML format..

Triggers will be output in order according to name.

NOTE: this export will also include any changes not yet compiled or published.

Throws:

AttivioException

exportDictionary

void exportDictionary(TriggerDictionaryName dictionaryName,
                      java.io.OutputStream output)
               throws AttivioException

Export trigger dictionary by name to output.

Dictionary will be output in XML format..

Triggers will be output in order according to name.

NOTE: this export will also include any changes not yet compiled or published.

Throws:

AttivioException

importDictionary

@Deprecated
default void importDictionary(java.io.InputStream input,
                              java.lang.String newName,
                              boolean replace)
                       throws AttivioException

Deprecated.

use importDictionary(InputStream, TriggerDictionaryName, boolean) instead.

Import a trigger dictionary from input.

Dictionary must be in XML format as output from exportDictionary(String, OutputStream).

If newName is specified, the imported dictionary will be imported with this name instead of the name stored in the export.

If replace is true, this import will overwrite any existing dictionary.

NOTE: the imported dictionary will not be available to transformers/components until compileDictionary(String) and publishDictionary(String) are called for the new dictionary.

Throws:

AttivioException

importDictionary

void importDictionary(java.io.InputStream input,
                      TriggerDictionaryName newName,
                      boolean replace)
               throws AttivioException

Import a trigger dictionary from input.

Dictionary must be in XML format as output from exportDictionary(String, OutputStream).

If newName is specified, the imported dictionary will be imported with this name instead of the name stored in the export.

If replace is true, this import will overwrite any existing dictionary.

NOTE: the imported dictionary will not be available to transformers/components until compileDictionary(String) and publishDictionary(String) are called for the new dictionary.

Throws:

AttivioException

importDictionary

@Deprecated
default void importDictionary(byte[] input,
                              java.lang.String newName,
                              boolean replace)
                       throws AttivioException

Deprecated.

Import a trigger dictionary from input bytes.

Dictionary must be in XML format as output from exportDictionary(String, OutputStream).

If newName is specified, the imported dictionary will be imported with this name instead of the name stored in the export.

If replace is true, this import will overwrite any existing dictionary.

NOTE: the imported dictionary will not be available to transformers/components until compileDictionary(String) and publishDictionary(String) are called for the new dictionary.

Throws:

AttivioException

importDictionary

@Deprecated
default void importDictionary(byte[] input,
                              TriggerDictionaryName newName,
                              boolean replace)
                       throws AttivioException

Deprecated.

Import a trigger dictionary from input bytes.

Dictionary must be in XML format as output from exportDictionary(String, OutputStream).

If newName is specified, the imported dictionary will be imported with this name instead of the name stored in the export.

If replace is true, this import will overwrite any existing dictionary.

NOTE: the imported dictionary will not be available to transformers/components until compileDictionary(String) and publishDictionary(String) are called for the new dictionary.

Throws:

AttivioException

process

@Deprecated
default IngestDocument process(java.lang.String dictionaryName,
                               IngestDocument document,
                               boolean published)
                        throws AttivioException

Deprecated.

use process(TriggerDictionaryName, IngestDocument, boolean) instead.

Process document according to dictionaryName.

Parameters:

dictionaryName - the name of the dictionary to use for processing

document - the document to process.

published - if true the most recently published dictionary will be used for processing, if false the most recently compiled dictionary will be used for processing.

Returns:

The processed document.

Throws:

AttivioException

process

IngestDocument process(TriggerDictionaryName dictionaryName,
                       IngestDocument document,
                       boolean published)
                throws AttivioException

Process document according to dictionaryName.

Parameters:

dictionaryName - the name of the dictionary to use for processing

document - the document to process.

published - if true the most recently published dictionary will be used for processing, if false the most recently compiled dictionary will be used for processing.

Returns:

The processed document.

Throws:

AttivioException