com.apama.dashboard.security
Interface IMacroPreprocessor

public interface IMacroPreprocessor

IMacroPreprocessor class provides a hook for user to resolve macros inside any attachment strings in the Instance Table Query attachment.

Nested Class Summary

static class

IMacroPreprocessor.ATTACHMENT_TYPE Enum type to indicate the type of attachment when the process() method is called.

Field Summary

static java.lang.String

USERNAME

Method Summary

java.lang.String

process(IMacroPreprocessor.ATTACHMENT_TYPE attachmentType, java.lang.String input, java.util.Map<java.lang.String,java.lang.String> extraParams) This method is called right before we process the attachment strings so customer's implementation will have a chance to resolve any macros according to the extraParam entries.

Field Detail

USERNAME

static final java.lang.String USERNAME

See Also:

Constant Field Values

Method Detail

process

java.lang.String process(IMacroPreprocessor.ATTACHMENT_TYPE attachmentType,
                         java.lang.String input,
                         java.util.Map<java.lang.String,java.lang.String> extraParams)

This method is called right before we process the attachment strings so customer's implementation will have a chance to resolve any macros according to the extraParam entries.

Parameters:

input - - the attachment string

attachmentType - - the type of attachment

extraParams - - a map of string value pairs. As of today, only "user" key is available in the map and value of which is the authenticated user

Returns:

The resolved attachment. The original input should be returned if no patching is done.