Class NotificationConfigurationDetails
- java.lang.Object
-
- com.adyen.model.marketpayconfiguration.NotificationConfigurationDetails
-
public class NotificationConfigurationDetails extends Object
NotificationConfigurationDetails
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classNotificationConfigurationDetails.SslProtocolEnumThe SSL protocol employed by the endpoint.
-
Field Summary
Fields Modifier and Type Field Description static StringJSON_PROPERTY_ACTIVEstatic StringJSON_PROPERTY_API_VERSIONstatic StringJSON_PROPERTY_DESCRIPTIONstatic StringJSON_PROPERTY_EVENT_CONFIGSstatic StringJSON_PROPERTY_HMAC_SIGNATURE_KEYstatic StringJSON_PROPERTY_NOTIFICATION_IDstatic StringJSON_PROPERTY_NOTIFY_PASSWORDstatic StringJSON_PROPERTY_NOTIFY_U_R_Lstatic StringJSON_PROPERTY_NOTIFY_USERNAMEstatic StringJSON_PROPERTY_SSL_PROTOCOL
-
Constructor Summary
Constructors Constructor Description NotificationConfigurationDetails()
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description NotificationConfigurationDetailsactive(Boolean active)NotificationConfigurationDetailsaddEventConfigsItem(NotificationEventConfiguration eventConfigsItem)NotificationConfigurationDetailsapiVersion(Integer apiVersion)NotificationConfigurationDetailsdescription(String description)booleanequals(Object o)Return true if this NotificationConfigurationDetails object is equal to o.NotificationConfigurationDetailseventConfigs(List<NotificationEventConfiguration> eventConfigs)static NotificationConfigurationDetailsfromJson(String jsonString)Create an instance of NotificationConfigurationDetails given an JSON stringBooleangetActive()Indicates whether the notification subscription is active.IntegergetApiVersion()The version of the notification to which you are subscribing.StringgetDescription()A description of the notification subscription configuration.List<NotificationEventConfiguration>getEventConfigs()Contains objects that define event types and their subscription settings.StringgetHmacSignatureKey()A string with which to salt the notification(s) before hashing.LonggetNotificationId()Adyen-generated ID for the entry, returned in the response when you create a notification configuration.StringgetNotifyPassword()The password to use when accessing the notifyURL with the specified username.StringgetNotifyURL()The URL to which the notifications are to be sent.StringgetNotifyUsername()The username to use when accessing the notifyURL.NotificationConfigurationDetails.SslProtocolEnumgetSslProtocol()The SSL protocol employed by the endpoint.inthashCode()NotificationConfigurationDetailshmacSignatureKey(String hmacSignatureKey)NotificationConfigurationDetailsnotificationId(Long notificationId)NotificationConfigurationDetailsnotifyPassword(String notifyPassword)NotificationConfigurationDetailsnotifyURL(String notifyURL)NotificationConfigurationDetailsnotifyUsername(String notifyUsername)voidsetActive(Boolean active)voidsetApiVersion(Integer apiVersion)voidsetDescription(String description)voidsetEventConfigs(List<NotificationEventConfiguration> eventConfigs)voidsetHmacSignatureKey(String hmacSignatureKey)voidsetNotificationId(Long notificationId)voidsetNotifyPassword(String notifyPassword)voidsetNotifyURL(String notifyURL)voidsetNotifyUsername(String notifyUsername)voidsetSslProtocol(NotificationConfigurationDetails.SslProtocolEnum sslProtocol)NotificationConfigurationDetailssslProtocol(NotificationConfigurationDetails.SslProtocolEnum sslProtocol)StringtoJson()Convert an instance of NotificationConfigurationDetails to an JSON stringStringtoString()
-
-
-
Field Detail
-
JSON_PROPERTY_ACTIVE
public static final String JSON_PROPERTY_ACTIVE
- See Also:
- Constant Field Values
-
JSON_PROPERTY_API_VERSION
public static final String JSON_PROPERTY_API_VERSION
- See Also:
- Constant Field Values
-
JSON_PROPERTY_DESCRIPTION
public static final String JSON_PROPERTY_DESCRIPTION
- See Also:
- Constant Field Values
-
JSON_PROPERTY_EVENT_CONFIGS
public static final String JSON_PROPERTY_EVENT_CONFIGS
- See Also:
- Constant Field Values
-
JSON_PROPERTY_HMAC_SIGNATURE_KEY
public static final String JSON_PROPERTY_HMAC_SIGNATURE_KEY
- See Also:
- Constant Field Values
-
JSON_PROPERTY_NOTIFICATION_ID
public static final String JSON_PROPERTY_NOTIFICATION_ID
- See Also:
- Constant Field Values
-
JSON_PROPERTY_NOTIFY_PASSWORD
public static final String JSON_PROPERTY_NOTIFY_PASSWORD
- See Also:
- Constant Field Values
-
JSON_PROPERTY_NOTIFY_U_R_L
public static final String JSON_PROPERTY_NOTIFY_U_R_L
- See Also:
- Constant Field Values
-
JSON_PROPERTY_NOTIFY_USERNAME
public static final String JSON_PROPERTY_NOTIFY_USERNAME
- See Also:
- Constant Field Values
-
JSON_PROPERTY_SSL_PROTOCOL
public static final String JSON_PROPERTY_SSL_PROTOCOL
- See Also:
- Constant Field Values
-
-
Method Detail
-
active
public NotificationConfigurationDetails active(Boolean active)
-
getActive
public Boolean getActive()
Indicates whether the notification subscription is active.- Returns:
- active
-
setActive
public void setActive(Boolean active)
-
apiVersion
public NotificationConfigurationDetails apiVersion(Integer apiVersion)
-
getApiVersion
public Integer getApiVersion()
The version of the notification to which you are subscribing. To make sure that your integration can properly process the notification, subscribe to the same version as the API that you're using.- Returns:
- apiVersion
-
setApiVersion
public void setApiVersion(Integer apiVersion)
-
description
public NotificationConfigurationDetails description(String description)
-
getDescription
public String getDescription()
A description of the notification subscription configuration.- Returns:
- description
-
setDescription
public void setDescription(String description)
-
eventConfigs
public NotificationConfigurationDetails eventConfigs(List<NotificationEventConfiguration> eventConfigs)
-
addEventConfigsItem
public NotificationConfigurationDetails addEventConfigsItem(NotificationEventConfiguration eventConfigsItem)
-
getEventConfigs
public List<NotificationEventConfiguration> getEventConfigs()
Contains objects that define event types and their subscription settings.- Returns:
- eventConfigs
-
setEventConfigs
public void setEventConfigs(List<NotificationEventConfiguration> eventConfigs)
-
hmacSignatureKey
public NotificationConfigurationDetails hmacSignatureKey(String hmacSignatureKey)
-
getHmacSignatureKey
public String getHmacSignatureKey()
A string with which to salt the notification(s) before hashing. If this field is provided, a hash value will be included under the notification header `HmacSignature` and the hash protocol will be included under the notification header `Protocol`. A notification body along with its `hmacSignatureKey` and `Protocol` can be used to calculate a hash value; matching this hash value with the `HmacSignature` will ensure that the notification body has not been tampered with or corrupted. >Must be a 32-byte hex-encoded string (i.e. a string containing 64 hexadecimal characters; e.g. \"b0ea55c2fe60d4d1d605e9c385e0e7f7e6cafbb939ce07010f31a327a0871f27\"). The omission of this field will preclude the provision of the `HmacSignature` and `Protocol` headers in notification(s).- Returns:
- hmacSignatureKey
-
setHmacSignatureKey
public void setHmacSignatureKey(String hmacSignatureKey)
-
notificationId
public NotificationConfigurationDetails notificationId(Long notificationId)
-
getNotificationId
public Long getNotificationId()
Adyen-generated ID for the entry, returned in the response when you create a notification configuration. Required when updating an existing configuration using [`/updateNotificationConfiguration`](https://docs.adyen.com/api-explorer/#/NotificationConfigurationService/latest/post/updateNotificationConfiguration).- Returns:
- notificationId
-
setNotificationId
public void setNotificationId(Long notificationId)
-
notifyPassword
public NotificationConfigurationDetails notifyPassword(String notifyPassword)
-
getNotifyPassword
public String getNotifyPassword()
The password to use when accessing the notifyURL with the specified username.- Returns:
- notifyPassword
-
setNotifyPassword
public void setNotifyPassword(String notifyPassword)
-
notifyURL
public NotificationConfigurationDetails notifyURL(String notifyURL)
-
getNotifyURL
public String getNotifyURL()
The URL to which the notifications are to be sent.- Returns:
- notifyURL
-
setNotifyURL
public void setNotifyURL(String notifyURL)
-
notifyUsername
public NotificationConfigurationDetails notifyUsername(String notifyUsername)
-
getNotifyUsername
public String getNotifyUsername()
The username to use when accessing the notifyURL.- Returns:
- notifyUsername
-
setNotifyUsername
public void setNotifyUsername(String notifyUsername)
-
sslProtocol
public NotificationConfigurationDetails sslProtocol(NotificationConfigurationDetails.SslProtocolEnum sslProtocol)
-
getSslProtocol
public NotificationConfigurationDetails.SslProtocolEnum getSslProtocol()
The SSL protocol employed by the endpoint. >Permitted values: `TLSv12`, `TLSv13`.- Returns:
- sslProtocol
-
setSslProtocol
public void setSslProtocol(NotificationConfigurationDetails.SslProtocolEnum sslProtocol)
-
equals
public boolean equals(Object o)
Return true if this NotificationConfigurationDetails object is equal to o.
-
fromJson
public static NotificationConfigurationDetails fromJson(String jsonString) throws com.fasterxml.jackson.core.JsonProcessingException
Create an instance of NotificationConfigurationDetails given an JSON string- Parameters:
jsonString- JSON string- Returns:
- An instance of NotificationConfigurationDetails
- Throws:
com.fasterxml.jackson.core.JsonProcessingException- if the JSON string is invalid with respect to NotificationConfigurationDetails
-
toJson
public String toJson() throws com.fasterxml.jackson.core.JsonProcessingException
Convert an instance of NotificationConfigurationDetails to an JSON string- Returns:
- JSON string
- Throws:
com.fasterxml.jackson.core.JsonProcessingException
-
-