org.apache.nifi.web.security.otp

Class OtpService

java.lang.Object

org.apache.nifi.web.security.otp.OtpService

public class OtpService
extends java.lang.Object

OtpService is a service for generating and verifying one time password tokens.

Field Summary

Fields

Modifier and Type	Field and Description
protected static int	MAX_CACHE_SOFT_LIMIT

Constructor Summary

Constructors

Constructor and Description
OtpService() Creates a new OtpService with an expiration of 5 minutes.
OtpService(int duration, java.util.concurrent.TimeUnit units) Creates a new OtpService.

Method Summary

Modifier and Type	Method and Description
java.lang.String	generateDownloadToken(OtpAuthenticationToken authenticationToken) Generates a download token for the specified authentication.
java.lang.String	generateUiExtensionToken(OtpAuthenticationToken authenticationToken) Generates a UI extension token for the specified authentication.
java.lang.String	getAuthenticationFromDownloadToken(java.lang.String token) Gets the authenticated identity from the specified one time use download token.
java.lang.String	getAuthenticationFromUiExtensionToken(java.lang.String token) Gets the authenticated identity from the specified one time use UI extension token.

Methods inherited from class java.lang.Object

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

Field Detail

MAX_CACHE_SOFT_LIMIT

protected static final int MAX_CACHE_SOFT_LIMIT

See Also:

Constant Field Values

Constructor Detail

OtpService

public OtpService()

Creates a new OtpService with an expiration of 5 minutes.

OtpService

public OtpService(int duration,
                  java.util.concurrent.TimeUnit units)

Creates a new OtpService.

Parameters:

duration - The expiration duration

units - The expiration units

Throws:

java.lang.NullPointerException - If units is null

java.lang.IllegalArgumentException - If duration is negative

Method Detail

generateDownloadToken

public java.lang.String generateDownloadToken(OtpAuthenticationToken authenticationToken)

Generates a download token for the specified authentication.

Parameters:

authenticationToken - The authentication

Returns:

The one time use download token

getAuthenticationFromDownloadToken

public java.lang.String getAuthenticationFromDownloadToken(java.lang.String token)
                                                    throws OtpAuthenticationException

Gets the authenticated identity from the specified one time use download token. This method will not return null.

Parameters:

token - The one time use download token

Returns:

The authenticated identity

Throws:

OtpAuthenticationException - When the specified token does not correspond to an authenticated identity

generateUiExtensionToken

public java.lang.String generateUiExtensionToken(OtpAuthenticationToken authenticationToken)

Generates a UI extension token for the specified authentication.

Parameters:

authenticationToken - The authentication

Returns:

The one time use UI extension token

getAuthenticationFromUiExtensionToken

public java.lang.String getAuthenticationFromUiExtensionToken(java.lang.String token)
                                                       throws OtpAuthenticationException

Gets the authenticated identity from the specified one time use UI extension token. This method will not return null.

Parameters:

token - The one time use UI extension token

Returns:

The authenticated identity

Throws:

OtpAuthenticationException - When the specified token does not correspond to an authenticated identity