com.cleo.lexicom.scripts

Interface IncomingFilters

public interface IncomingFilters

Standalone javascript action incoming filters management interface

Method Summary

Modifier and Type	Method and Description
void	add(LexiComIncomingFilter filter) Adds an incoming filter for all in-scope content.
java.lang.String[][]	list(boolean allInScope) List added javascript incoming filters
LexiComIncomingFilter	remove(java.lang.String[] path) Remove an added javascript incoming filter

Method Detail

add

void add(LexiComIncomingFilter filter)
  throws java.lang.Exception

Adds an incoming filter for all in-scope content.

Limitations:
- If a Custom ILexiComIncoming Class has already been set in System Options, an incoming filter cannot be set from ISessionScript.
- Only one incoming filter can be added per script. If multiple are added, only the last one added is actually active.
- If an incoming file is in-scope for multiple filters (within different scripts), all the filters will potentially be invoked one-by-one; however once any filter returns an output stream, the chain ends. The sequence of the chain is random.

Parameters:

filter - an incoming filter. The filter is invoked with every solicited or unsolicited incoming file request just before the content stream begins

Throws:

java.lang.Exception

list

java.lang.String[][] list(boolean allInScope)
                   throws java.lang.Exception

List added javascript incoming filters

Parameters:

allInScope - true if all of the in-scope entries should be listed; false if just the entries added by this javascript should be listed

Returns:

list of javascript action alias paths

Throws:

java.lang.Exception

remove

LexiComIncomingFilter remove(java.lang.String[] path)
                      throws java.lang.Exception

Remove an added javascript incoming filter

Parameters:

path - the alias path of the javascript action to be removed

Returns:

the javascript inooming filter removed

Throws:

java.lang.Exception