org.hawkular.inventory.api

Interface ResultFilter

public interface ResultFilter

An SPI interface to be used by the implementations to filter the results before they're returned to the API caller.

Since:

0.0.1

Author:

Lukas Krejci

Method Summary

Modifier and Type	Method and Description
boolean	isApplicable(AbstractElement<?,?> element) Given a context (that is passed to this instance outside of the responsibility of this interface), this method is called by the inventory implementations to check whether given element belongs to the result set of a call.

Method Detail

isApplicable

boolean isApplicable(AbstractElement<?,?> element)

Given a context (that is passed to this instance outside of the responsibility of this interface), this method is called by the inventory implementations to check whether given element belongs to the result set of a call.

This is primarily geared towards applying security checks to the results before they are passed to the API caller.

Parameters:

element - the element potentially returned from a inventory call (like ResolvableToSingle.entity() or ResolvableToMany.entities(Pager)).

Returns:

true if the element is allowed to be (part of) the result