Package com.floragunn.searchguard.auditlog.sink

Class WebhookSink

java.lang.Object

com.floragunn.searchguard.auditlog.sink.AuditLogSink

com.floragunn.searchguard.auditlog.sink.WebhookSink

public class WebhookSink
extends AuditLogSink

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	WebhookSink.WebhookFormat

Field Summary

Fields inherited from class com.floragunn.searchguard.auditlog.sink.AuditLogSink

fallbackSink, log, settings, settingsPrefix

Constructor Summary

Constructors

Constructor	Description
WebhookSink(String name, org.elasticsearch.common.settings.Settings settings, String settingsPrefix, Path configPath, AuditLogSink fallbackSink)

Method Summary

Modifier and Type	Method	Description
void	close()
protected boolean	doGet(String url)
protected boolean	doPost(String url, String payload)
boolean	doStore(AuditMessage msg)
protected String	formatJson(AuditMessage msg)	Transforms an AuditMessage to JSON.
protected String	formatSlack(AuditMessage msg)	Transforms an AuditMessage to Slack format.
protected String	formatText(AuditMessage msg)	Transforms an AuditMessage to plain text.
protected String	formatUrlParameters(AuditMessage msg)	Transforms an AuditMessage to a query parameter String.

Methods inherited from class com.floragunn.searchguard.auditlog.sink.AuditLogSink

equals, getExpandedIndexName, getFallbackSink, getName, getSinkSettings, hashCode, isHandlingBackpressure, store, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

WebhookSink

public WebhookSink(String name,
                   org.elasticsearch.common.settings.Settings settings,
                   String settingsPrefix,
                   Path configPath,
                   AuditLogSink fallbackSink)
            throws Exception

Throws:

Exception

Method Detail

doStore

public boolean doStore(AuditMessage msg)

Specified by:

doStore in class AuditLogSink

close

public void close()
           throws IOException

Overrides:

close in class AuditLogSink

Throws:

IOException

formatJson

protected String formatJson(AuditMessage msg)

Transforms an AuditMessage to JSON. By default, all fields are included in the JSON string. This method can be overridden by subclasses if a specific JSON format is needed.

Parameters:

msg - the AuditMessage to transform

Returns:

the JSON string

formatText

protected String formatText(AuditMessage msg)

Transforms an AuditMessage to plain text. This method can be overridden by subclasses if a specific text format is needed.

Parameters:

msg - the AuditMessage to transform

Returns:

the text string

formatSlack

protected String formatSlack(AuditMessage msg)

Transforms an AuditMessage to Slack format. The default implementation returns

 {
   "text": ""
 }    
 

Can be overridden by subclasses if a more specific format is needed.

Parameters:

msg - the AuditMessage to transform

Returns:

the Slack formatted JSON string

formatUrlParameters

protected String formatUrlParameters(AuditMessage msg)

Transforms an AuditMessage to a query parameter String. Used by WebhookSink.WebhookFormat.URL_PARAMETER_GET and Used by WebhookSink.WebhookFormat.URL_PARAMETER_POST. Can be overridden by subclasses if a specific format is needed.

Parameters:

msg - the AuditMessage to transform

Returns:

the query parameter string

doGet

protected boolean doGet(String url)

doPost

protected boolean doPost(String url,
                         String payload)