Package io.getlime.security.powerauth.rest.api.spring.controller.v3

Class ActivationController

  • @RestController("activationControllerV3")
@RequestMapping("/pa/v3/activation")
public class ActivationController
extends java.lang.Object
    Controller implementing activation related end-points from the PowerAuth Standard API.

    PowerAuth protocol versions:

    • 3.0
    Author:
    Roman Strobl, roman.strobl@wultra.com

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      io.getlime.security.powerauth.rest.api.model.response.v3.ActivationLayer1Response createActivation​(io.getlime.security.powerauth.rest.api.model.request.v3.ActivationLayer1Request request, io.getlime.security.powerauth.rest.api.base.encryption.EciesEncryptionContext eciesContext)
      Create activation.
      io.getlime.core.rest.model.base.response.ObjectResponse<io.getlime.security.powerauth.rest.api.model.response.v3.ActivationStatusResponse> getActivationStatus​(io.getlime.core.rest.model.base.request.ObjectRequest<io.getlime.security.powerauth.rest.api.model.request.v3.ActivationStatusRequest> request)
      Get activation status.
      io.getlime.core.rest.model.base.response.ObjectResponse<io.getlime.security.powerauth.rest.api.model.response.v3.ActivationRemoveResponse> removeActivation​(java.lang.String signatureHeader, javax.servlet.http.HttpServletRequest httpServletRequest)
      Remove activation.
      void setActivationServiceV3​(ActivationService activationServiceV3)  
      void setAuthenticationProvider​(PowerAuthAuthenticationProvider authenticationProvider)  

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

      • ActivationController

        public ActivationController()

    • Method Detail

      • setActivationServiceV3

        @Autowired
public void setActivationServiceV3​(ActivationService activationServiceV3)

      • createActivation

        @RequestMapping(value="create",
                method=POST)
public io.getlime.security.powerauth.rest.api.model.response.v3.ActivationLayer1Response createActivation​(io.getlime.security.powerauth.rest.api.model.request.v3.ActivationLayer1Request request,
                                                                                                          io.getlime.security.powerauth.rest.api.base.encryption.EciesEncryptionContext eciesContext)
                                                                                                   throws io.getlime.security.powerauth.rest.api.base.exception.PowerAuthActivationException,
                                                                                                          io.getlime.security.powerauth.rest.api.base.exception.PowerAuthRecoveryException
        Create activation.
        Parameters:
        request - Encrypted activation layer 1 request.
        eciesContext - ECIES encryption context.
        Returns:
        Activation layer 1 response.
        Throws:
        io.getlime.security.powerauth.rest.api.base.exception.PowerAuthActivationException - In case activation fails.
        io.getlime.security.powerauth.rest.api.base.exception.PowerAuthRecoveryException - In case recovery PUK is invalid.

      • getActivationStatus

        @RequestMapping(value="status",
                method=POST)
public io.getlime.core.rest.model.base.response.ObjectResponse<io.getlime.security.powerauth.rest.api.model.response.v3.ActivationStatusResponse> getActivationStatus​(@RequestBody
                                                                                                                                                                      io.getlime.core.rest.model.base.request.ObjectRequest<io.getlime.security.powerauth.rest.api.model.request.v3.ActivationStatusRequest> request)
                                                                                                                                                               throws io.getlime.security.powerauth.rest.api.base.exception.PowerAuthActivationException
        Get activation status.
        Parameters:
        request - PowerAuth RESTful request with ActivationStatusRequest payload.
        Returns:
        PowerAuth RESTful response with ActivationStatusResponse payload.
        Throws:
        io.getlime.security.powerauth.rest.api.base.exception.PowerAuthActivationException - In case request fails.

      • removeActivation

        @RequestMapping(value="remove",
                method=POST)
public io.getlime.core.rest.model.base.response.ObjectResponse<io.getlime.security.powerauth.rest.api.model.response.v3.ActivationRemoveResponse> removeActivation​(@RequestHeader("X-PowerAuth-Authorization")
                                                                                                                                                                   java.lang.String signatureHeader,
                                                                                                                                                                   javax.servlet.http.HttpServletRequest httpServletRequest)
                                                                                                                                                            throws io.getlime.security.powerauth.rest.api.base.exception.PowerAuthActivationException,
                                                                                                                                                                   io.getlime.security.powerauth.rest.api.base.exception.PowerAuthAuthenticationException
        Remove activation.
        Parameters:
        signatureHeader - PowerAuth signature HTTP header.
        httpServletRequest - HTTP servlet request.
        Returns:
        PowerAuth RESTful response with ActivationRemoveResponse payload.
        Throws:
        io.getlime.security.powerauth.rest.api.base.exception.PowerAuthActivationException - In case activation access fails.
        io.getlime.security.powerauth.rest.api.base.exception.PowerAuthAuthenticationException - In case the signature validation fails.