Package com.atlassian.bamboo.webhook

Class WebhookResponseDetailsEntity

java.lang.Object

com.atlassian.core.bean.EntityObject

com.atlassian.bamboo.hibernate.HibernateEntityObject

com.atlassian.bamboo.webhook.WebhookResponseDetailsEntity

All Implemented Interfaces:

BambooIdProvider, BambooObject, WebhookResponse, WebhookResponseDetails, Cloneable

@Entity
public class WebhookResponseDetailsEntity
extends HibernateEntityObject
implements WebhookResponseDetails

Constructor Summary

Constructors

Constructor	Description
WebhookResponseDetailsEntity()
WebhookResponseDetailsEntity(DefaultWebhookResponseService.WebhookToSave webhook, WebhookResponseStatus webhookResponseStatus)

Method Summary

Modifier and Type	Method	Description
@Nullable Long	getDeploymentResultId()
@NotNull String	getEventName()
@NotNull HttpMethod	getHttpMethod()
String	getMessage()
@Nullable String	getPlanResultKey()
@Nullable Date	getReceiveTime()
String	getRequestBody()
String	getRequestHeaders()
String	getResponseBody()
String	getResponseHeaders()
@NotNull WebhookResponseStatus	getResponseStatus()
int	getRetriesCount()
@NotNull Date	getSendTime()
Integer	getStatusCode()
@NotNull String	getTemplateName()
@NotNull String	getUrl()
@NotNull UUID	getUuid()
void	setMessage(String message)	Set a informative message about why webhook response was "TIMEOUT" or "ERROR"
void	setReceiveTime(Date receiveTime)	Set time of receiving webhook response.
void	setResponseBody(String responseBody)	Set response body of webhook response.
void	setResponseHeaders(String responseHeaders)	Set response headers of webhook response.
void	setResponseStatus(WebhookResponseStatus responseStatus)	Set status of webhook response.
void	setStatusCode(Integer statusCode)	Set status code of received webhook response.

Methods inherited from class com.atlassian.bamboo.hibernate.HibernateEntityObject

getId, setId

Methods inherited from class com.atlassian.core.bean.EntityObject

clone, equals, getCreationDate, getCurrentDate, getLastModificationDate, hashCode, setClock, setCreationDate, setLastModificationDate

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.atlassian.bamboo.core.BambooIdProvider

getId

Methods inherited from interface com.atlassian.bamboo.core.BambooObject

setId

Constructor Details

WebhookResponseDetailsEntity

public WebhookResponseDetailsEntity()

WebhookResponseDetailsEntity

public WebhookResponseDetailsEntity(DefaultWebhookResponseService.WebhookToSave webhook,
 WebhookResponseStatus webhookResponseStatus)

Method Details

getRequestBody

public String getRequestBody()

Specified by:

getRequestBody in interface WebhookResponseDetails

Returns:

body of sent webhook.

getRequestHeaders

public String getRequestHeaders()

Specified by:

getRequestHeaders in interface WebhookResponseDetails

Returns:

headers of sent webhook.

getResponseBody

public String getResponseBody()

Specified by:

getResponseBody in interface WebhookResponseDetails

Returns:

body of received response.

getResponseHeaders

public String getResponseHeaders()

Specified by:

getResponseHeaders in interface WebhookResponseDetails

Returns:

headers of received response.

getStatusCode

public Integer getStatusCode()

Specified by:

getStatusCode in interface WebhookResponse

Returns:

current status code of webhook response. Null if there are no status code

getResponseStatus

@NotNull
public @NotNull WebhookResponseStatus getResponseStatus()

Specified by:

getResponseStatus in interface WebhookResponse

Returns:

current status of webhook response.

getHttpMethod

@NotNull
public @NotNull HttpMethod getHttpMethod()

Specified by:

getHttpMethod in interface WebhookResponse

Returns:

HTTP method of sent webhook

getUrl

@NotNull
public @NotNull String getUrl()

Specified by:

getUrl in interface WebhookResponse

Returns:

destination URL on which webhook was sent.

getEventName

@NotNull
public @NotNull String getEventName()

Specified by:

getEventName in interface WebhookResponse

Returns:

name of the event which triggered sending webhook.

getPlanResultKey

@Nullable
public @Nullable String getPlanResultKey()

Specified by:

getPlanResultKey in interface WebhookResponse

Returns:

plan result key associated with webhook. Null if webhook is not associated with any plan result.

getDeploymentResultId

@Nullable
public @Nullable Long getDeploymentResultId()

Specified by:

getDeploymentResultId in interface WebhookResponse

Returns:

deployment result id associated with webhook. Null if webhook is not associated with any deployment result.

getUuid

@NotNull
public @NotNull UUID getUuid()

Specified by:

getUuid in interface WebhookResponse

Returns:

uuid of sent webhook.

getRetriesCount

public int getRetriesCount()

Specified by:

getRetriesCount in interface WebhookResponse

Returns:

number of retries of sending webhook.

getSendTime

@NotNull
public @NotNull Date getSendTime()

Specified by:

getSendTime in interface WebhookResponse

Returns:

time of sending webhook.

getReceiveTime

@Nullable
public @Nullable Date getReceiveTime()

Specified by:

getReceiveTime in interface WebhookResponse

Returns:

time of receiving webhook response.

getTemplateName

@NotNull
public @NotNull String getTemplateName()

Specified by:

getTemplateName in interface WebhookResponse

Returns:

name of template of sent webhook.

getMessage

public String getMessage()

Specified by:

getMessage in interface WebhookResponseDetails

Returns:

message about errors during sending webhook.

setResponseBody

public void setResponseBody(String responseBody)

Description copied from interface: WebhookResponseDetails

Set response body of webhook response.

Specified by:

setResponseBody in interface WebhookResponseDetails

Parameters:

responseBody - body of received response.

setResponseHeaders

public void setResponseHeaders(String responseHeaders)

Description copied from interface: WebhookResponseDetails

Set response headers of webhook response.

Specified by:

setResponseHeaders in interface WebhookResponseDetails

Parameters:

responseHeaders - headers of received response.

setStatusCode

public void setStatusCode(Integer statusCode)

Description copied from interface: WebhookResponseDetails

Set status code of received webhook response.

Specified by:

setStatusCode in interface WebhookResponseDetails

Parameters:

statusCode - status code of received response

setResponseStatus

public void setResponseStatus(WebhookResponseStatus responseStatus)

Description copied from interface: WebhookResponseDetails

Set status of webhook response.

Specified by:

setResponseStatus in interface WebhookResponseDetails

Parameters:

responseStatus - status of webhook response. Possible values: "PENDING", "ERROR", "TIMEOUT", "FINISHED".

setReceiveTime

public void setReceiveTime(Date receiveTime)

Description copied from interface: WebhookResponseDetails

Set time of receiving webhook response.

Specified by:

setReceiveTime in interface WebhookResponseDetails

Parameters:

receiveTime - time in the moment when response status is changed from "PENDING" to any other state.

setMessage

public void setMessage(String message)

Description copied from interface: WebhookResponseDetails

Set a informative message about why webhook response was "TIMEOUT" or "ERROR"

Specified by:

setMessage in interface WebhookResponseDetails

Parameters:

message - information about failure of webhook response