Package io.getlime.security.powerauth.rest.api.base.authentication

Interface PowerAuthApiAuthentication

public interface PowerAuthApiAuthentication
Interface for PowerAuth API authentication object used between intermediate server application (such as mobile banking API) and core systems (such as banking core).
Author:
Petr Dvorak, petr@wultra.com

  • Method Summary

    Modifier and Type Method Description
    java.lang.String getActivationId()
    Get activation ID
    java.lang.Long getApplicationId()
    Get related application ID.
    io.getlime.security.powerauth.http.PowerAuthHttpHeader getHttpHeader()
    Get the PowerAuth HTTP header.
    io.getlime.security.powerauth.crypto.lib.enums.PowerAuthSignatureTypes getSignatureFactors()
    Return authentication factors related to the signature that was used to produce this authentication object.
    java.lang.String getUserId()
    Get user ID
    java.lang.String getVersion()
    Get PowerAuth protocol version.
    void setActivationId​(java.lang.String activationId)
    Set activation ID
    void setApplicationId​(java.lang.Long id)
    Set related application ID.
    void setHttpHeader​(io.getlime.security.powerauth.http.PowerAuthHttpHeader httpHeader)
    Set the PowerAuth HTTP header.
    void setSignatureFactors​(io.getlime.security.powerauth.crypto.lib.enums.PowerAuthSignatureTypes factors)
    Set authentication factors related to the signature that was used to produce this authentication object.
    void setUserId​(java.lang.String userId)
    Set user ID
    void setVersion​(java.lang.String version)
    Set PowerAuth protocol version.

  • Method Details

    • getUserId

      java.lang.String getUserId()
      Get user ID
      Returns:
      User ID

    • setUserId

      void setUserId​(java.lang.String userId)
      Set user ID
      Parameters:
      userId - User ID

    • getActivationId

      java.lang.String getActivationId()
      Get activation ID
      Returns:
      Activation ID

    • setActivationId

      void setActivationId​(java.lang.String activationId)
      Set activation ID
      Parameters:
      activationId - Activation ID

    • getApplicationId

      java.lang.Long getApplicationId()
      Get related application ID.
      Returns:
      Application ID.

    • setApplicationId

      void setApplicationId​(java.lang.Long id)
      Set related application ID.
      Parameters:
      id - Application ID.

    • getSignatureFactors

      io.getlime.security.powerauth.crypto.lib.enums.PowerAuthSignatureTypes getSignatureFactors()
      Return authentication factors related to the signature that was used to produce this authentication object.
      Returns:
      Signature type (signature factors).

    • setSignatureFactors

      void setSignatureFactors​(io.getlime.security.powerauth.crypto.lib.enums.PowerAuthSignatureTypes factors)
      Set authentication factors related to the signature that was used to produce this authentication object.
      Parameters:
      factors - Signature type (signature factors).

    • getVersion

      java.lang.String getVersion()
      Get PowerAuth protocol version.
      Returns:
      PowerAuth protocol version.

    • setVersion

      void setVersion​(java.lang.String version)
      Set PowerAuth protocol version.
      Parameters:
      version - PowerAuth protocol version.

    • getHttpHeader

      io.getlime.security.powerauth.http.PowerAuthHttpHeader getHttpHeader()
      Get the PowerAuth HTTP header.
      Returns:
      PowerAuth HTTP header.

    • setHttpHeader

      void setHttpHeader​(io.getlime.security.powerauth.http.PowerAuthHttpHeader httpHeader)
      Set the PowerAuth HTTP header.
      Parameters:
      httpHeader - PowerAuth HTTP header.