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() Create a webhoook, setting up the system attribute for it.

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()
String	getPassword()
List<CMAWebhookTopic>	getTopics()
CMAWebhookTransformation	getTransformation()
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	setId(String id) Convenience: Update the id of this entry without going through CMAResource.getSystem().
CMAWebhook	setName(String name) Set the name of this webhook.
CMAWebhook	setSpaceId(String spaceId) Convenience: Update the space id of this entry without going through CMAResource.getSystem().
CMAWebhook	setSystem(CMASystem system) Sets the system field.
CMAWebhook	setTransformation(CMAWebhookTransformation transformation) Set the transformation of this webhook
CMAWebhook	setUrl(String url) Sets the url to be called when this webhook is triggered.
CMAWebhook	setVersion(Integer version) Convenience: Update the version of this entry without going through CMAResource.getSystem().
String	toString()

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

getEnvironmentId, getId, getSpaceId, getSystem, getVersion, getVisibility, isArchived, isPublished, setEnvironmentId, setVisibility

Methods inherited from class java.lang.Object

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

Constructor Detail

CMAWebhook

public CMAWebhook()

Create a webhoook, setting up the system attribute for it.

Method Detail

setSystem

public CMAWebhook setSystem(CMASystem system)

Sets the system field.

Overrides:

setSystem in class CMAResource

Parameters:

system - sets the system property.

Returns:

this, as casted to a resource, for the ease of chaining.

setId

public CMAWebhook setId(String id)

Convenience: Update the id of this entry without going through CMAResource.getSystem().

Overrides:

setId in class CMAResource

Parameters:

id - to be set.

Returns:

the calling instance for chaining.

setVersion

public CMAWebhook setVersion(Integer version)

Convenience: Update the version of this entry without going through CMAResource.getSystem().

Overrides:

setVersion in class CMAResource

Parameters:

version - to be set.

Returns:

the calling instance for chaining.

setSpaceId

public CMAWebhook setSpaceId(String spaceId)

Convenience: Update the space id of this entry without going through CMAResource.getSystem().

Overrides:

setSpaceId in class CMAResource

Parameters:

spaceId - to be set.

Returns:

the calling instance 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

setName

public CMAWebhook setName(String name)

Set the name of this webhook.

Parameters:

name - to identify this webhook

Returns:

this webhook for chaining

getUrl

public String getUrl()

Returns:

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

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

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.

getTransformation

public CMAWebhookTransformation getTransformation()

Returns:

the transformation.

setTransformation

public CMAWebhook setTransformation(CMAWebhookTransformation transformation)

Set the transformation of this webhook

Parameters:

transformation - transformation property.

Returns:

this webhook for chaining.

getUser

public String getUser()

Returns:

the http basic auth user set.

See Also:

setBasicAuthorization(String, String)

getPassword

public String getPassword()

Returns:

the http basic auth password set (only valid while creating the hook on Contentful).

See Also:

setBasicAuthorization(String, String)

toString

public String toString()

Overrides:

toString in class CMAResource

Returns:

a human readable string, representing the object.