Package com.broadleafcommerce.paymenttransaction.service.validation

Class DefaultSavedPaymentMethodAccessValidationService

java.lang.Object

com.broadleafcommerce.paymenttransaction.service.validation.DefaultSavedPaymentMethodAccessValidationService

All Implemented Interfaces:

SavedPaymentMethodAccessValidationService

public class DefaultSavedPaymentMethodAccessValidationService
extends Object
implements SavedPaymentMethodAccessValidationService

Default implementation of SavedPaymentMethodAccessValidationService.

Author:

Sunny Yu

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ACCOUNT_AUTHENTICATION_FAILURE
static final String	ANONYMOUS_AUTHENTICATION_FAILURE
static final String	CUSTOMER_AUTHENTICATION_FAILURE
static final String	OWNERSHIP_MISMATCH
static final String	UNSUPPORTED_OWNER_TYPE

Constructor Summary

Constructors

Constructor	Description
DefaultSavedPaymentMethodAccessValidationService(SavedPaymentMethodManagementService savedPaymentMethodManagementService)

Method Summary

Modifier and Type	Method	Description
protected com.broadleafcommerce.resource.security.utils.service.AuthenticationUtils	getAuthenticationUtils()
protected SavedPaymentMethodManagementService	getSavedPaymentMethodManagementService()
void	setAuthenticationUtils(com.broadleafcommerce.resource.security.utils.service.AuthenticationUtils authenticationUtils)
void	validateOwnershipMatchWithPayment(@NonNull OwnershipSummary savedPaymentOwnership, @NonNull Payment payment)	Validates the ownership of the saved payment method matches the ownership of the given Payment.
protected void	validatePaymentOwnershipForAccount(@NonNull OwnershipSummary savedPaymentOwnership, @NonNull Payment payment)	Validates that the Payment is in the same account hierarchy as the SavedPaymentMethod it was created from.
void	validateSavedPaymentMethodOwnership(@NonNull String savedPaymentId, @NonNull CustomerRef customerRef, com.broadleafcommerce.data.tracking.core.context.ContextInfo context)	Validates access to the saved payment method based on the passed in context.

Methods inherited from class java.lang.Object

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

Field Details

ANONYMOUS_AUTHENTICATION_FAILURE

public static final String ANONYMOUS_AUTHENTICATION_FAILURE

See Also:

• Constant Field Values

CUSTOMER_AUTHENTICATION_FAILURE

public static final String CUSTOMER_AUTHENTICATION_FAILURE

See Also:

• Constant Field Values

ACCOUNT_AUTHENTICATION_FAILURE

public static final String ACCOUNT_AUTHENTICATION_FAILURE

See Also:

• Constant Field Values

UNSUPPORTED_OWNER_TYPE

public static final String UNSUPPORTED_OWNER_TYPE

See Also:

• Constant Field Values

OWNERSHIP_MISMATCH

public static final String OWNERSHIP_MISMATCH

See Also:

• Constant Field Values

Constructor Details

DefaultSavedPaymentMethodAccessValidationService

public DefaultSavedPaymentMethodAccessValidationService(SavedPaymentMethodManagementService savedPaymentMethodManagementService)

Method Details

validateSavedPaymentMethodOwnership

public void validateSavedPaymentMethodOwnership(@NonNull
 @NonNull String savedPaymentId,
 @NonNull
 @NonNull CustomerRef customerRef,
 @Nullable
 com.broadleafcommerce.data.tracking.core.context.ContextInfo context)

Description copied from interface: SavedPaymentMethodAccessValidationService

Validates access to the saved payment method based on the passed in context.

This ensures that the given saved payment method being accessed by the given CustomerRef has the correct ownership.

Specified by:

validateSavedPaymentMethodOwnership in interface SavedPaymentMethodAccessValidationService

Parameters:

savedPaymentId - the id of the saved payment method requiring access

customerRef - the CustomerRef to validate against

context - context information surrounding multitenant state

See Also:

• DefaultSavedPaymentMethodOwningUserTypes

validateOwnershipMatchWithPayment

public void validateOwnershipMatchWithPayment(@NonNull
 @NonNull OwnershipSummary savedPaymentOwnership,
 @NonNull
 @NonNull Payment payment)

Description copied from interface: SavedPaymentMethodAccessValidationService

Validates the ownership of the saved payment method matches the ownership of the given Payment.

This ensures the owning user of the Payment matches with the owning user of the saved payment method.

Specified by:

validateOwnershipMatchWithPayment in interface SavedPaymentMethodAccessValidationService

Parameters:

savedPaymentOwnership - the OwnershipSummary of the saved payment method

payment - the Payment to validate the ownership against

validatePaymentOwnershipForAccount

protected void validatePaymentOwnershipForAccount(@NonNull
 @NonNull OwnershipSummary savedPaymentOwnership,
 @NonNull
 @NonNull Payment payment)

Validates that the Payment is in the same account hierarchy as the SavedPaymentMethod it was created from.

• The saved payment must be visible to sub-accounts.
• The current user's account must be the same or a descendent of the saved payment's owning account.
• The payment's owner must be the current user's account or an ancestor of it.

Parameters:

savedPaymentOwnership - Details about the ownership of the SavedPaymentMethod that produced the payment.

payment - The Payment to validate.

getSavedPaymentMethodManagementService

protected SavedPaymentMethodManagementService getSavedPaymentMethodManagementService()

setAuthenticationUtils

@Autowired
public void setAuthenticationUtils(com.broadleafcommerce.resource.security.utils.service.AuthenticationUtils authenticationUtils)

getAuthenticationUtils

protected com.broadleafcommerce.resource.security.utils.service.AuthenticationUtils getAuthenticationUtils()