com.xatkit.core.platform.io

Class WebhookEventProvider<T extends RuntimePlatform,H extends RestHandler>

java.lang.Object

com.xatkit.core.platform.io.RuntimeEventProvider<T>

com.xatkit.core.platform.io.WebhookEventProvider<T,H>

Type Parameters:

T - the concrete RuntimePlatform subclass type containing the provider

H - the RestHandler type processing incoming Rest requests

All Implemented Interfaces:

Runnable

public abstract class WebhookEventProvider<T extends RuntimePlatform,H extends RestHandler>
extends RuntimeEventProvider<T>

A specialised RuntimeEventProvider that handles Rest requests sent by the XatkitServer.

Concrete subclasses must implement the getEndpointURI() that sets the URI to register the provider to, and createRestHandler() that creates the concrete RestHandler instance handling incoming Rest requests.

See Also:

RestHandler, RestHandlerFactory

Field Summary

Fields inherited from class com.xatkit.core.platform.io.RuntimeEventProvider

runtimePlatform, xatkitCore

Constructor Summary

Constructors

Constructor and Description
WebhookEventProvider(T runtimePlatform) Constructs a new WebhookEventProvider with the provided runtimePlatform.
WebhookEventProvider(T runtimePlatform, Configuration configuration) Constructs a new WebhookEventProvider from the provided runtimePlatform and configuration.

Method Summary

Modifier and Type	Method and Description
protected abstract H	createRestHandler() Returns the concrete RestHandler instance that handles incoming Rest requests.
HttpMethod	getEndpointMethod() Returns the HttpMethod of the REST endpoint to register the provided to.
abstract String	getEndpointURI() Returns the URI of the REST endpoint to register the provider to.
H	getRestHandler() Returns the RestHandler embedded in this provider.
void	run() Runs the provider.

Methods inherited from class com.xatkit.core.platform.io.RuntimeEventProvider

broadcastEventInstance, close, getRuntimePlatform, sendEventInstance

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

WebhookEventProvider

public WebhookEventProvider(T runtimePlatform)

Constructs a new WebhookEventProvider with the provided runtimePlatform.

Note: this constructor should be used by WebhookEventProviders that do not require additional parameters to be initialized. In that case see WebhookEventProvider(RuntimePlatform, Configuration).

Parameters:

runtimePlatform - the RuntimePlatform containing this WebhookEventProvider

Throws:

NullPointerException - if the provided runtimePlatform is null

WebhookEventProvider

public WebhookEventProvider(T runtimePlatform,
                            Configuration configuration)

Constructs a new WebhookEventProvider from the provided runtimePlatform and configuration.

Note: this constructor will be called by xatkit internal engine when initializing the XatkitCore component. Subclasses implementing this constructor typically need additional parameters to be initialized, that can be provided in the configuration.

Parameters:

runtimePlatform - the RuntimePlatform containing this WebhookEventProvider

configuration - the Configuration used to initialize the WebhookEventProvider

Throws:

NullPointerException - if the provided runtimePlatform is null

Method Detail

getEndpointURI

public abstract String getEndpointURI()

Returns the URI of the REST endpoint to register the provider to.

The returned String must be prefixed by a '/'.

Returns:

the URI of the Rest endpoint to register the provider to

See Also:

XatkitServer.registerWebhookEventProvider(WebhookEventProvider)

getEndpointMethod

public HttpMethod getEndpointMethod()

Returns the HttpMethod of the REST endpoint to register the provided to.

This method returns HttpMethod.POST by default, subclasses can override this method to return custom HttpMethod.

Returns:

the HttpMethod of the REST endpoint to register the provider to

createRestHandler

protected abstract H createRestHandler()

Returns the concrete RestHandler instance that handles incoming Rest requests.

This handler can be defined with the utility methods provided in RestHandlerFactory.

Returns:

the concrete RestHandler instance that handles incoming Rest requests

See Also:

RestHandlerFactory

getRestHandler

public final H getRestHandler()

Returns the RestHandler embedded in this provider.

Returns:

the RestHandler embedded in this provider

run

public void run()

Runs the provider.