com.contentful.java.cma

Class ModuleWebhooks

java.lang.Object

com.contentful.java.cma.ModuleWebhooks

public class ModuleWebhooks
extends java.lang.Object

This module is intended to ease communication with the webhooks module from Contentful.

All methods here are available twice: Once synchronously and asynchronously through async().

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	ModuleWebhooks.Async Async module.

Constructor Summary

Constructors

Constructor and Description
ModuleWebhooks(retrofit2.Retrofit retrofit, java.util.concurrent.Executor callbackExecutor) Create this module.

Method Summary

Modifier and Type	Method and Description
ModuleWebhooks.Async	async() Use this method if you require asynchronous requests through retrofit.
CMAWebhookCallDetail	callDetails(java.lang.String spaceId, java.lang.String webhookId, java.lang.String callId) Get more information about one specific call to one specific webhook, hosted by one specific space.
CMAArray<CMAWebhookCall>	calls(java.lang.String spaceId, java.lang.String webhookId) Get more information about a specific webhook.
CMAWebhook	create(java.lang.String spaceId, CMAWebhook webhook) Create a new webhook.
CMAWebhook	create(java.lang.String spaceId, java.lang.String webhookId, CMAWebhook webhook) Create a new webhook with specified ID.
protected com.contentful.java.cma.ServiceWebhooks	createService(retrofit2.Retrofit retrofit) Internal method used for creating the service.
java.lang.Integer	delete(java.lang.String spaceId, java.lang.String webhookId) Delete a given Webhook by its ID.
CMAArray<CMAWebhook>	fetchAll(java.lang.String spaceId) Retrieve all the webhooks defined for this space.
CMAArray<CMAWebhook>	fetchAll(java.lang.String spaceId, java.util.Map<java.lang.String,java.lang.String> query) Retrieve specific webhooks matching a query for this space.
CMAWebhook	fetchOne(java.lang.String spaceId, java.lang.String webhookId) Retrieve exactly one webhook, whose id you know.
CMAWebhookHealth	health(java.lang.String spaceId, java.lang.String webhookId) Return a general understanding of the health of the webhooks.
CMAWebhook	update(CMAWebhook webhook) Change the content of a webhook.

Methods inherited from class java.lang.Object

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

Constructor Detail

ModuleWebhooks

public ModuleWebhooks(retrofit2.Retrofit retrofit,
                      java.util.concurrent.Executor callbackExecutor)

Create this module.

Parameters:

retrofit - An instance to an already setup Retrofit module

callbackExecutor - Use this executor for this module.

Method Detail

async

public ModuleWebhooks.Async async()

Use this method if you require asynchronous requests through retrofit.

Returns:

An instance of this classes Async representation.

create

public CMAWebhook create(java.lang.String spaceId,
                         CMAWebhook webhook)

Create a new webhook.

This will create a new ID and return the newly created webhook as a return value.

Parameters:

spaceId - Which space should be used?

webhook - A representation of the Webhook to be used.

Returns:

The webhook returned from the backend, containing created its ID and more.

Throws:

java.lang.IllegalArgumentException - if space's id is null.

java.lang.IllegalArgumentException - if webhook is null.

create

public CMAWebhook create(java.lang.String spaceId,
                         java.lang.String webhookId,
                         CMAWebhook webhook)

Create a new webhook with specified ID.

Similar to create(String, CMAWebhook) but uses an id for this Webhook.

Parameters:

spaceId - the space, this Webhook should be created in.

webhookId - What id should be given to the new webhook?

webhook - Contains the actual data of the webhook to be created.

Returns:

The webhook as returned from the backend, enriched by the backend.

Throws:

java.lang.IllegalArgumentException - if space's id is null.

java.lang.IllegalArgumentException - if webhookId is null.

java.lang.IllegalArgumentException - if webhook is null.

delete

public java.lang.Integer delete(java.lang.String spaceId,
                                java.lang.String webhookId)

Delete a given Webhook by its ID.

Parameters:

spaceId - The id of the space hosting the webhook to be deleted.

webhookId - The id of the actual webhook to be deleted.

Returns:

the response code of the request (aka 200 if successful)

Throws:

java.lang.IllegalArgumentException - if spaceId is null.

java.lang.IllegalArgumentException - if webhookId is null.

fetchAll

public CMAArray<CMAWebhook> fetchAll(java.lang.String spaceId)

Retrieve all the webhooks defined for this space.

Parameters:

spaceId - The id of the space to be asked for all of its spaces.

Returns:

An CMAArray containing all found webhooks for this space.

Throws:

java.lang.IllegalArgumentException - if spaceId is null.

fetchAll

public CMAArray<CMAWebhook> fetchAll(java.lang.String spaceId,
                                     java.util.Map<java.lang.String,java.lang.String> query)

Retrieve specific webhooks matching a query for this space.

Parameters:

spaceId - The id of the space to be asked for all of its spaces.

query - Specifying the criteria on which webhooks to return.

Returns:

An CMAArray containing all found webhooks for this space.

Throws:

java.lang.IllegalArgumentException - if spaceId is null.

fetchOne

public CMAWebhook fetchOne(java.lang.String spaceId,
                           java.lang.String webhookId)

Retrieve exactly one webhook, whose id you know.

Parameters:

spaceId - The id of the space to be hosting this webhook.

webhookId - The id of the webhook to be returned.

Returns:

The webhook found, or null, if no such webhook is available.

Throws:

java.lang.IllegalArgumentException - if spaceId is null.

java.lang.IllegalArgumentException - if webhookId is null.

update

public CMAWebhook update(CMAWebhook webhook)

Change the content of a webhook.

This will take the webhooks id and update it on the backend.

Parameters:

webhook - The webhook retrieved beforehand to be changed.

Returns:

The from the backend returned, changed webhook.

Throws:

java.lang.IllegalArgumentException - if webhook is null.

java.lang.IllegalArgumentException - if webhookId is null.

java.lang.IllegalArgumentException - if spaceId is null.

java.lang.IllegalArgumentException - if version is null.

calls

public CMAArray<CMAWebhookCall> calls(java.lang.String spaceId,
                                      java.lang.String webhookId)

Get more information about a specific webhook.

Parameters:

spaceId - The id of the space hosting the webhook

webhookId - The id of the webhook to be asked for more detail.

Returns:

A detailed object for the given webhook.

Throws:

java.lang.IllegalArgumentException - if spaceId is null.

java.lang.IllegalArgumentException - if webhook is null.

See Also:

CMAWebhookCall

callDetails

public CMAWebhookCallDetail callDetails(java.lang.String spaceId,
                                        java.lang.String webhookId,
                                        java.lang.String callId)

Get more information about one specific call to one specific webhook, hosted by one specific space.

Parameters:

spaceId - A space id, identifying the space containing the webhook.

webhookId - A webhook id containing the webhook containing the call.

callId - A call id identifying the call to be informed about.

Returns:

A Call Detail to be used to gather more information about this call.

Throws:

java.lang.IllegalArgumentException - if spaceId is null.

java.lang.IllegalArgumentException - if webhook is null.

java.lang.IllegalArgumentException - if callId is null.

health

public CMAWebhookHealth health(java.lang.String spaceId,
                               java.lang.String webhookId)

Return a general understanding of the health of the webhooks.

Parameters:

spaceId - Which space does host this webhook?

webhookId - Which webhook should be asked for its health?

Returns:

A health indicator summarizing healthy/total calls to the Webhook.

Throws:

java.lang.IllegalArgumentException - if spaceId is null.

java.lang.IllegalArgumentException - if webhook is null.

createService

protected com.contentful.java.cma.ServiceWebhooks createService(retrofit2.Retrofit retrofit)

Internal method used for creating the service.

Parameters:

retrofit - A Retrofit instance to create the service from.

Returns:

The service, to be used for calls to the backend.