ch.postfinance.sdk.service

Class WebhookEncryptionService

java.lang.Object

ch.postfinance.sdk.service.WebhookEncryptionService

public class WebhookEncryptionService
extends Object

Constructor Summary

Constructors

Constructor and Description
WebhookEncryptionService(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
ApiClient	getApiClient()
boolean	isContentValid(String signatureHeader, String contentToVerify) Verify webhook content
boolean	isContentValid(String signatureHeader, String contentToVerify, String encryptionProviderName) Verify webhook content
WebhookEncryptionPublicKey	read(String id) Read Reads the entity with the given 'id' and returns it.
WebhookEncryptionPublicKey	read(String id, Map<String,Object> params) Read Reads the entity with the given 'id' and returns it.
com.google.api.client.http.HttpResponse	readForHttpResponse(String id)
com.google.api.client.http.HttpResponse	readForHttpResponse(String id, Map<String,Object> params)
void	setApiClient(ApiClient apiClient)

Methods inherited from class java.lang.Object

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

Constructor Detail

WebhookEncryptionService

public WebhookEncryptionService(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

read

public WebhookEncryptionPublicKey read(String id)
                                throws IOException

Read Reads the entity with the given 'id' and returns it.

200 - This status code indicates that a client request was successfully received, understood, and accepted.

442 - This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.

542 - This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

Parameters:

id - The ID of the key version.

Returns:

WebhookEncryptionPublicKey

Throws:

IOException - if an error occurs while attempting to invoke the API For more information visit this link.

See Also:

Read Documentation

read

public WebhookEncryptionPublicKey read(String id,
                                       Map<String,Object> params)
                                throws IOException

Read Reads the entity with the given 'id' and returns it.

200 - This status code indicates that a client request was successfully received, understood, and accepted.

442 - This status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error.

542 - This status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the client request.

Parameters:

id - The ID of the key version.

params - Map of query params. A collection will be interpreted as passing in multiple instances of the same query param.

Returns:

WebhookEncryptionPublicKey

Throws:

IOException - if an error occurs while attempting to invoke the API For more information visit this link.

See Also:

Read Documentation

readForHttpResponse

public com.google.api.client.http.HttpResponse readForHttpResponse(String id)
                                                            throws IOException

Throws:

IOException

readForHttpResponse

public com.google.api.client.http.HttpResponse readForHttpResponse(String id,
                                                                   Map<String,Object> params)
                                                            throws IOException

Throws:

IOException

isContentValid

public boolean isContentValid(String signatureHeader,
                              String contentToVerify,
                              String encryptionProviderName)

Verify webhook content

Parameters:

signatureHeader - Signature header 'X-Signature' value from the Http request

contentToVerify - Raw webhook content in String format

encryptionProviderName - Encryption provider name

Returns:

true if webhook content body conforms with signature header

isContentValid

public boolean isContentValid(String signatureHeader,
                              String contentToVerify)

Verify webhook content

Uses BouncyCastle as encryption provider.

Important: this method updates list of Security providers:

Security.addProvider(new BouncyCastleProvider())

Parameters:

signatureHeader - Signature header 'X-Signature' value from the Http request

contentToVerify - Raw webhook content in String format

Returns:

true if webhook content body conforms with signature header