io.getlime.security.powerauth.rest.api.base.provider

Interface CustomActivationProvider

public interface CustomActivationProvider

Interface which enables implementation of custom activations. The interface defines a method for obtaining a user ID based on arbitrary identity attributes, processing of custom activation attributes and configuration of auto-commit mode.

Author:

Petr Dvorak, petr@wultra.com

Method Summary

Modifier and Type	Method and Description
String	lookupUserIdForAttributes(Map<String,String> identityAttributes) This method is responsible for looking user ID up based on a provided set of identity attributes.
Map<String,Object>	processCustomActivationAttributes(Map<String,Object> customAttributes, String activationId, String userId, ActivationType activationType) Process custom attributes, in any way that is suitable for the purpose of your application.
boolean	shouldAutoCommitActivation(Map<String,String> identityAttributes, Map<String,Object> customAttributes, String activationId, String userId) Variable that specifies if the activation should be automatically committed based on provided attributes.

Method Detail

lookupUserIdForAttributes

String lookupUserIdForAttributes(Map<String,String> identityAttributes)

This method is responsible for looking user ID up based on a provided set of identity attributes.

Parameters:

identityAttributes - Attributes that uniquely identify user with given ID.

Returns:

User ID value.

processCustomActivationAttributes

Map<String,Object> processCustomActivationAttributes(Map<String,Object> customAttributes,
                                                     String activationId,
                                                     String userId,
                                                     ActivationType activationType)

Process custom attributes, in any way that is suitable for the purpose of your application.

Parameters:

customAttributes - Custom attributes (not related to identity) to be processed.

activationId - Activation ID of created activation.

userId - User ID of user who created the activation.

activationType - Activation type (CODE or CUSTOM).

Returns:

Custom attributes after processing.

shouldAutoCommitActivation

boolean shouldAutoCommitActivation(Map<String,String> identityAttributes,
                                   Map<String,Object> customAttributes,
                                   String activationId,
                                   String userId)

Variable that specifies if the activation should be automatically committed based on provided attributes. Return true in case you would like to create an activation that is ready to be used for signing (ACTIVE), and false for the cases when you need activation to remain in OTP_USED state.

Parameters:

identityAttributes - Identity related attributes.

customAttributes - Custom attributes, not related to identity.

activationId - Activation ID of created activation.

userId - User ID of user who created the activation.

Returns:

True in case activation should be committed, false otherwise.