Package io.inugami.api.providers

Interface Provider

All Superinterfaces:

NamedComponent

public interface Provider
extends NamedComponent

Inugami is a solution that gathers information from various sources, combines it and sends it to the front-end. To accomplish this, Inugami uses data providers, which are represented by the Provider interface. These providers have two main functions :

• first one is **callEvent**, which which retrieves data and takes in an event (simple or composite) and plugin information
• the second is the aggregate, which is used to process the data once it has been retrieved and is only activated when "callEvent" is run with a composite event.

Since:

3 janv. 2017

See Also:

ProviderWithHttpConnector

Field Summary

Fields

Modifier and Type	Field	Description
static String	CONFIG_TIMEOUT

Method Summary

Modifier and Type	Method	Description
ProviderFutureResult	aggregate(List<ProviderFutureResult> data)
<T extends SimpleEvent> FutureData<ProviderFutureResult>	callEvent(T event, Gav pluginGav)
default ConfigHandler<String,String>	getConfig()
default long	getTimeout()
String	getType()

Methods inherited from interface io.inugami.api.tools.NamedComponent

getName

Field Detail

CONFIG_TIMEOUT

static final String CONFIG_TIMEOUT

See Also:

Constant Field Values

Method Detail

callEvent

<T extends SimpleEvent> FutureData<ProviderFutureResult> callEvent(T event,
                                                                   Gav pluginGav)

aggregate

ProviderFutureResult aggregate(List<ProviderFutureResult> data)
                        throws ProviderException

Throws:

ProviderException

getType

String getType()

getTimeout

default long getTimeout()

getConfig

default ConfigHandler<String,String> getConfig()