com.mulesoft.mule.runtime.gw.api.events.collector.service

Interface EventsCollectorService

All Superinterfaces:

org.mule.runtime.api.meta.NamedObject, org.mule.runtime.api.service.Service, org.mule.runtime.api.artifact.SplashMessageProvider

All Known Subinterfaces:

EventsCollectorService

All Known Implementing Classes:

CompatibilityEventsCollectorService

public interface EventsCollectorService
extends org.mule.runtime.api.service.Service

Service used to keep PolicyViolation related to particular events. The violation is kept in this service as long as the event is alive

Method Summary

Modifier and Type	Method and Description
void	addExtraViolationData(String eventId, Map<String,Object> data) Adds additional data to the policy violation for an event
void	addPolicyViolation(String eventId, com.mulesoft.mule.runtime.gw.api.analytics.PolicyViolation violation) Adds a violation for an event
Optional<Map<String,Object>>	getExtraViolationData(String eventId) Retrieves additional data associated to a violation of an event
Optional<com.mulesoft.mule.runtime.gw.api.analytics.PolicyViolation>	getPolicyViolation(String eventId) Retrieves a violation of an event
Optional<Map<String,Object>>	removeExtraViolationData(String eventId) Removes the additional data associated to a violation of an event
Optional<com.mulesoft.mule.runtime.gw.api.analytics.PolicyViolation>	removePolicyViolation(String eventId) Removes the violation of an event

Methods inherited from interface org.mule.runtime.api.service.Service

getContractName, getSplashMessage

Methods inherited from interface org.mule.runtime.api.meta.NamedObject

getName

Method Detail

addPolicyViolation

void addPolicyViolation(String eventId,
                        com.mulesoft.mule.runtime.gw.api.analytics.PolicyViolation violation)

Adds a violation for an event

Parameters:

eventId - id of the event related to the policy violation

violation - PolicyViolation that occurred during event execution

addExtraViolationData

void addExtraViolationData(String eventId,
                           Map<String,Object> data)

Adds additional data to the policy violation for an event

Parameters:

eventId - id of the event related to the policy violation

data - set of key-value data related to the policy violation occurrence

getPolicyViolation

Optional<com.mulesoft.mule.runtime.gw.api.analytics.PolicyViolation> getPolicyViolation(String eventId)

Retrieves a violation of an event

Parameters:

eventId - id of the event related to the policy violation

Returns:

PolicyViolation that occurred during event execution or empty if no violation is present

getExtraViolationData

Optional<Map<String,Object>> getExtraViolationData(String eventId)

Retrieves additional data associated to a violation of an event

Parameters:

eventId - id of the event related to the policy violation

removePolicyViolation

Optional<com.mulesoft.mule.runtime.gw.api.analytics.PolicyViolation> removePolicyViolation(String eventId)

Removes the violation of an event

Parameters:

eventId - id of the event related to the policy violation

Returns:

PolicyViolation that occurred during event execution or empty if no violation is present

removeExtraViolationData

Optional<Map<String,Object>> removeExtraViolationData(String eventId)

Removes the additional data associated to a violation of an event

Parameters:

eventId - id of the event related to the policy violation