Package com.hybris.cis.service.impl

Class DefaultCisClientPaymentService

java.lang.Object

com.hybris.cis.service.impl.DefaultCisClientPaymentService

All Implemented Interfaces:

CisClientPaymentService, CisClientService

public class DefaultCisClientPaymentService
extends java.lang.Object
implements CisClientPaymentService

Default implementation of CisClientPaymentService

Constructor Summary

Constructors

Constructor	Description
DefaultCisClientPaymentService()

Method Summary

Modifier and Type	Method	Description
com.hybris.charon.RawResponse<CisPaymentProfileResult>	addCustomerProfile(java.lang.String xCisClientRef, java.lang.String tenantId, java.lang.String documentId, CisExternalPaymentRequest cisExternalPayment)	Add a customer profile
CisPaymentTransactionResult	authorizeWithProfile(java.lang.String xCisClientRef, java.lang.String tenantId, java.net.URI profileLocation, CisPaymentAuthorization cisPaymentAuthorization)	Requests an authorization of a payment
CisPaymentTransactionResult	capture(java.lang.String xCisClientRef, java.lang.String tenantId, java.net.URI authorizationLocation, java.lang.String transactionId, CisPaymentRequest paymentRequest)	Captures a payment based on the given properties
java.lang.String	deleteCustomerProfile(java.lang.String xCisClientRef, java.lang.String tenantId, java.net.URI profileLocation)	Deletes a given customer profile
protected java.lang.String	extractLastUriParam(java.net.URI uri)	Extracts the last part of the URI
protected PaymentClient	getCisPaymentClient()
CisPaymentTransactionResult	handleExternalAuthorization(java.lang.String xCisClientRef, java.lang.String tenantId, CisExternalPaymentRequest cisExternalPayment)	Requests a payment authorization
CisTokenizedPaymentTransactionResult	initPaymentSession(java.lang.String xCisClientRef, java.lang.String tenantId, CisPaymentSessionInitRequest cisPaymentSessionInitRequest)	Initialize the payment session
CisTokenizedPaymentTransactionResult	paymentOrderSetup(java.lang.String xCisClientRef, java.lang.String tenantId, java.net.URI authorizationLocation, CisTokenizedPaymentAuthorization cisTokenizedPaymentAuthorization)	Setup order payment
boolean	ping(java.lang.String xCisClientRef, java.lang.String tenantId)	Checks if service is functioning and connecting with current credentials.
com.hybris.charon.RawResponse<java.lang.String>	pspUrl(java.lang.String xCisClientRef, java.lang.String tenantId)	Retrieves the payment service url for a given client and tenant
CisPaymentTransactionResult	refund(java.lang.String xCisClientRef, java.lang.String tenantId, java.net.URI captureLocation, java.lang.String transactionId, CisPaymentRequest paymentRequest)	Refunds a payment transaction
CisPaymentTransactionResult	reverse(java.lang.String xCisClientRef, java.lang.String tenantId, java.net.URI authorizationLocation, java.lang.String transactionId, CisPaymentRequest paymentRequest)	Reverses a payment based on the given properties
void	setCisPaymentClient(PaymentClient cisPaymentClient)
CisTokenizedPaymentTransactionResult	tokenizedPaymentAuthorization(java.lang.String xCisClientRef, java.lang.String tenantId, CisTokenizedPaymentAuthorization cisTokenizedPaymentAuthorization)	Tokenized Payment Authorization
CisTokenizedPaymentTransactionResult	tokenizedPaymentCapture(java.lang.String xCisClientRef, java.lang.String tenantId, java.lang.String authGroupId, java.lang.String authId, CisTokenizedPaymentCapture cisTokenizedPaymentCapture)	Tokenized Payment Capture
CisTokenizedPaymentTransactionResult	tokenizedPaymentRefund(java.lang.String xCisClientRef, java.lang.String tenantId, java.lang.String authGroupId, java.lang.String authId, CisTokenizedPaymentRefund cisTokenizedPaymentRefund)	Tokenized Payment Refund
CisTokenizedPaymentTransactionResult	tokenizedPaymentReverse(java.lang.String xCisClientRef, java.lang.String tenantId, java.lang.String authGroupId, java.lang.String authId, CisTokenizedPaymentReverse cisTokenizedPaymentReverse)	Tokenized Payment Reverse
CisPaymentProfileResult	updateCustomerProfile(java.lang.String xCisClientRef, java.lang.String tenantId, java.net.URI profileLocation, CisPaymentProfileRequest cisPaymentProfileRequest)	Updates a customer profile

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultCisClientPaymentService

public DefaultCisClientPaymentService()

Method Detail

pspUrl

public com.hybris.charon.RawResponse<java.lang.String> pspUrl(java.lang.String xCisClientRef,
                                                              java.lang.String tenantId)

Description copied from interface: CisClientPaymentService

Retrieves the payment service url for a given client and tenant

Specified by:

pspUrl in interface CisClientPaymentService

Parameters:

xCisClientRef - the client reference

tenantId - the tenant identifier

Returns:

a raw response with the psp url in the location attribute of the header

handleExternalAuthorization

public CisPaymentTransactionResult handleExternalAuthorization(java.lang.String xCisClientRef,
                                                               java.lang.String tenantId,
                                                               CisExternalPaymentRequest cisExternalPayment)

Description copied from interface: CisClientPaymentService

Requests a payment authorization

Specified by:

handleExternalAuthorization in interface CisClientPaymentService

Parameters:

xCisClientRef - the client reference

tenantId - the tenant identifier

cisExternalPayment - the external payment request

Returns:

the result of the payment transaction

authorizeWithProfile

public CisPaymentTransactionResult authorizeWithProfile(java.lang.String xCisClientRef,
                                                        java.lang.String tenantId,
                                                        java.net.URI profileLocation,
                                                        CisPaymentAuthorization cisPaymentAuthorization)

Description copied from interface: CisClientPaymentService

Requests an authorization of a payment

Specified by:

authorizeWithProfile in interface CisClientPaymentService

Parameters:

xCisClientRef - the client reference

tenantId - the tenant identifier

profileLocation - the URI of the profile to be authorized

cisPaymentAuthorization - the payment authorization to be authorized

Returns:

capture

public CisPaymentTransactionResult capture(java.lang.String xCisClientRef,
                                           java.lang.String tenantId,
                                           java.net.URI authorizationLocation,
                                           java.lang.String transactionId,
                                           CisPaymentRequest paymentRequest)

Description copied from interface: CisClientPaymentService

Captures a payment based on the given properties

Specified by:

capture in interface CisClientPaymentService

Parameters:

xCisClientRef - the client reference

tenantId - the tenant identifier

transactionId - the transaction identifier to be captured

paymentRequest - the corresponding payment request

Returns:

the payment transaction result

reverse

public CisPaymentTransactionResult reverse(java.lang.String xCisClientRef,
                                           java.lang.String tenantId,
                                           java.net.URI authorizationLocation,
                                           java.lang.String transactionId,
                                           CisPaymentRequest paymentRequest)

Description copied from interface: CisClientPaymentService

Reverses a payment based on the given properties

Specified by:

reverse in interface CisClientPaymentService

Parameters:

xCisClientRef - the client reference

tenantId - the tenant identifier

authorizationLocation - the location of the granted authorization

transactionId - the transaction identifier to be reversed

paymentRequest - the corresponding payment request

Returns:

the reversal payment transaction result

refund

public CisPaymentTransactionResult refund(java.lang.String xCisClientRef,
                                          java.lang.String tenantId,
                                          java.net.URI captureLocation,
                                          java.lang.String transactionId,
                                          CisPaymentRequest paymentRequest)

Description copied from interface: CisClientPaymentService

Refunds a payment transaction

Specified by:

refund in interface CisClientPaymentService

Parameters:

xCisClientRef - the client reference

tenantId - the tenant identifier

captureLocation - the URI of the captured location

transactionId - the transaction identifier to be reversed

paymentRequest - the corresponding payment request

Returns:

the result of the refund payment transaction

addCustomerProfile

public com.hybris.charon.RawResponse<CisPaymentProfileResult> addCustomerProfile(java.lang.String xCisClientRef,
                                                                                 java.lang.String tenantId,
                                                                                 java.lang.String documentId,
                                                                                 CisExternalPaymentRequest cisExternalPayment)

Description copied from interface: CisClientPaymentService

Add a customer profile

Specified by:

addCustomerProfile in interface CisClientPaymentService

Parameters:

xCisClientRef - the client reference

tenantId - the tenant identifier

documentId - the document identifier

cisExternalPayment - the external payment request

Returns:

a raw response with the payment profile created

updateCustomerProfile

public CisPaymentProfileResult updateCustomerProfile(java.lang.String xCisClientRef,
                                                     java.lang.String tenantId,
                                                     java.net.URI profileLocation,
                                                     CisPaymentProfileRequest cisPaymentProfileRequest)

Description copied from interface: CisClientPaymentService

Updates a customer profile

Specified by:

updateCustomerProfile in interface CisClientPaymentService

Parameters:

xCisClientRef - the client reference

tenantId - the tenant identifier

profileLocation - the URI of the profile location

cisPaymentProfileRequest - the payment profile request

Returns:

the profile payment updated

deleteCustomerProfile

public java.lang.String deleteCustomerProfile(java.lang.String xCisClientRef,
                                              java.lang.String tenantId,
                                              java.net.URI profileLocation)

Description copied from interface: CisClientPaymentService

Deletes a given customer profile

Specified by:

deleteCustomerProfile in interface CisClientPaymentService

Parameters:

xCisClientRef - the client reference

tenantId - the tenant identifier

profileLocation - the URI of the profile to delete

Returns:

initPaymentSession

public CisTokenizedPaymentTransactionResult initPaymentSession(java.lang.String xCisClientRef,
                                                               java.lang.String tenantId,
                                                               CisPaymentSessionInitRequest cisPaymentSessionInitRequest)

Description copied from interface: CisClientPaymentService

Initialize the payment session

Specified by:

initPaymentSession in interface CisClientPaymentService

Parameters:

xCisClientRef - the client reference

tenantId - the tenant identifier

cisPaymentSessionInitRequest - the payment session request

Returns:

CisTokenizedPaymentTransactionResult

paymentOrderSetup

public CisTokenizedPaymentTransactionResult paymentOrderSetup(java.lang.String xCisClientRef,
                                                              java.lang.String tenantId,
                                                              java.net.URI authorizationLocation,
                                                              CisTokenizedPaymentAuthorization cisTokenizedPaymentAuthorization)

Description copied from interface: CisClientPaymentService

Setup order payment

Specified by:

paymentOrderSetup in interface CisClientPaymentService

Parameters:

xCisClientRef - the client reference

tenantId - the tenant identifier

authorizationLocation - the URI of the authorization

Returns:

CisTokenizedPaymentTransactionResult

tokenizedPaymentAuthorization

public CisTokenizedPaymentTransactionResult tokenizedPaymentAuthorization(java.lang.String xCisClientRef,
                                                                          java.lang.String tenantId,
                                                                          CisTokenizedPaymentAuthorization cisTokenizedPaymentAuthorization)

Description copied from interface: CisClientPaymentService

Tokenized Payment Authorization

Specified by:

tokenizedPaymentAuthorization in interface CisClientPaymentService

Parameters:

xCisClientRef - the client reference

tenantId - the tenant identifier

Returns:

CisTokenizedPaymentTransactionResult

tokenizedPaymentCapture

public CisTokenizedPaymentTransactionResult tokenizedPaymentCapture(java.lang.String xCisClientRef,
                                                                    java.lang.String tenantId,
                                                                    java.lang.String authGroupId,
                                                                    java.lang.String authId,
                                                                    CisTokenizedPaymentCapture cisTokenizedPaymentCapture)

Description copied from interface: CisClientPaymentService

Tokenized Payment Capture

Specified by:

tokenizedPaymentCapture in interface CisClientPaymentService

Parameters:

xCisClientRef - the client reference

tenantId - the tenant identifier

authGroupId - the authentication group identifier

authId - the authentication identifier

Returns:

CisTokenizedPaymentTransactionResult

tokenizedPaymentRefund

public CisTokenizedPaymentTransactionResult tokenizedPaymentRefund(java.lang.String xCisClientRef,
                                                                   java.lang.String tenantId,
                                                                   java.lang.String authGroupId,
                                                                   java.lang.String authId,
                                                                   CisTokenizedPaymentRefund cisTokenizedPaymentRefund)

Description copied from interface: CisClientPaymentService

Tokenized Payment Refund

Specified by:

tokenizedPaymentRefund in interface CisClientPaymentService

Parameters:

xCisClientRef - the client reference

tenantId - the tenant identifier

authGroupId - the authentication group identifier

authId - the authentication identifier

Returns:

CisTokenizedPaymentTransactionResult

tokenizedPaymentReverse

public CisTokenizedPaymentTransactionResult tokenizedPaymentReverse(java.lang.String xCisClientRef,
                                                                    java.lang.String tenantId,
                                                                    java.lang.String authGroupId,
                                                                    java.lang.String authId,
                                                                    CisTokenizedPaymentReverse cisTokenizedPaymentReverse)

Description copied from interface: CisClientPaymentService

Tokenized Payment Reverse

Specified by:

tokenizedPaymentReverse in interface CisClientPaymentService

Parameters:

xCisClientRef - the client reference

tenantId - the tenant identifier

authGroupId - the authentication group identifier

authId - the authentication identifier

Returns:

CisTokenizedPaymentTransactionResult

ping

public boolean ping(java.lang.String xCisClientRef,
                    java.lang.String tenantId)

Description copied from interface: CisClientService

Checks if service is functioning and connecting with current credentials.

Specified by:

ping in interface CisClientService

Parameters:

xCisClientRef - client ref to pass in the header

tenantId - tenantId to pass in the header

Returns:

flag if the service is accessible or not

extractLastUriParam

protected java.lang.String extractLastUriParam(java.net.URI uri)

Extracts the last part of the URI

Parameters:

uri - the URI for which we want to extract the last parameter

Returns:

the last parameter of the URI

getCisPaymentClient

protected PaymentClient getCisPaymentClient()

Returns:

the cisPaymentClient

setCisPaymentClient

public void setCisPaymentClient(PaymentClient cisPaymentClient)

Parameters:

cisPaymentClient - the cisPaymentClient to set