com.contentful.java.cma.model

Class CMAWebhook

java.lang.Object

com.contentful.java.cma.model.CMAResource

com.contentful.java.cma.model.CMAWebhook

public class CMAWebhook
extends CMAResource

Represents one webhook definition. A valid webhook needs to at least have called setName(String), setUrl(String), addTopic(CMAWebhookTopic).

Constructor Summary

Constructors

Constructor and Description
CMAWebhook()

Method Summary

Modifier and Type	Method and Description
CMAWebhook	addHeader(String key, String value) Adds a custom http header to the call done by this webhook.
CMAWebhook	addTopic(CMAWebhookTopic topic) Add a topic this webhook should be triggered on.
List<CMAWebhookHeader>	getHeaders()
String	getName()
List<CMAWebhookTopic>	getTopics()
String	getUrl()
String	getUser()
CMAWebhook	setBasicAuthorization(String user, String password) Set authorization parameter for basic HTTP authorization on the url to be called by this webhook.
CMAWebhook	setName(String name) Set the name of this webhook.
CMAWebhook	setUrl(String url) Sets the url to be called when this webhook is triggered.

Methods inherited from class com.contentful.java.cma.model.CMAResource

getResourceId, getSpaceId, getSys, getVersion, setId, setSys

Methods inherited from class java.lang.Object

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

Constructor Detail

CMAWebhook

public CMAWebhook()

Method Detail

setName

public CMAWebhook setName(String name)

Set the name of this webhook.

Parameters:

name - to identify this webhook

Returns:

this webhook for chaining

setUrl

public CMAWebhook setUrl(String url)

Sets the url to be called when this webhook is triggered.

Parameters:

url - complete, existing url to be used

Returns:

this webhook for chaining

addTopic

public CMAWebhook addTopic(CMAWebhookTopic topic)

Add a topic this webhook should be triggered on.

Parameters:

topic - a valid enum value for the trigger reason.

Returns:

this webhook for chaining

addHeader

public CMAWebhook addHeader(String key,
                            String value)

Adds a custom http header to the call done by this webhook.

Parameters:

key - HTTP header key to be used (aka 'X-My-Header-Name')

value - HTTP header value to be used (aka 'this-is-my-name')

Returns:

this webhook for chaining.

setBasicAuthorization

public CMAWebhook setBasicAuthorization(String user,
                                        String password)

Set authorization parameter for basic HTTP authorization on the url to be called by this webhook.

Parameters:

user - username to be used

password - password to be used (cannot be retrieved, only updated!)

Returns:

this webhook for chaining.

getName

public String getName()

Returns:

the name of this webhook

getUrl

public String getUrl()

Returns:

Url to the server to be called, if this webhook is to be triggered

getTopics

public List<CMAWebhookTopic> getTopics()

Returns:

A copy of the topics this webhook is interested in.

getHeaders

public List<CMAWebhookHeader> getHeaders()

Returns:

A copy of the custom headers this webhook uses when triggered.

getUser

public String getUser()

Returns:

the http basic auth user set.