Package net.shibboleth.idp.plugin.authn.totp.impl

Class TOTPAuthenticatorArguments

java.lang.Object

net.shibboleth.shared.cli.AbstractCommandLineArguments

net.shibboleth.idp.cli.AbstractIdPHomeAwareCommandLineArguments

net.shibboleth.idp.plugin.authn.totp.impl.TOTPAuthenticatorArguments

All Implemented Interfaces:

CommandLineArguments

public class TOTPAuthenticatorArguments
extends net.shibboleth.idp.cli.AbstractIdPHomeAwareCommandLineArguments

Arguments for TOTPAuthenticatorCLI.

Field Summary

Fields

Modifier and Type	Field	Description
private String	account	Credential account name.
private String	authenticatorName	Name of a specific TOTPAuthenticator, if one has been requested.
private String	issuer	Credential issuer.
private org.slf4j.Logger	log	The Log.
private byte[]	seed	Raw token seed when verifying codes.
private Integer	tokenCode	Token code to verify.

Constructor Summary

Constructors

Constructor	Description
TOTPAuthenticatorArguments()

Method Summary

Modifier and Type	Method	Description
String	getAccountName()	Get the token account name.
String	getAuthenticatorName()	Get name of TOTPAuthenticator bean to access.
String	getIssuer()	Get the token issuer.
org.slf4j.Logger	getLog()
byte[]	getSeed()	Get token seed when verifying codes.
Integer	getTokenCode()	Get token code to verify.
void	printHelp(PrintStream out)
void	validate()

Methods inherited from class net.shibboleth.idp.cli.AbstractIdPHomeAwareCommandLineArguments

getHttpClientName, getHttpClientSecurityParameterstName, getIdPHome, setHttpClientName

Methods inherited from class net.shibboleth.shared.cli.AbstractCommandLineArguments

getLanguageRanges, getLoggingConfiguration, getOtherArgs, getPropertyFiles, isANSI, isHelp, isQuietOutput, isVerboseOutput, isVersion

Methods inherited from class java.lang.Object

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

Field Details

authenticatorName

@Nullable
private String authenticatorName

Name of a specific TOTPAuthenticator, if one has been requested.

issuer

@Nullable
private String issuer

Credential issuer.

account

@Nullable
private String account

Credential account name.

seed

@Nullable
private byte[] seed

Raw token seed when verifying codes.

tokenCode

@Nullable
private Integer tokenCode

Token code to verify.

log

@Nullable
private org.slf4j.Logger log

The Log.

Constructor Details

TOTPAuthenticatorArguments

public TOTPAuthenticatorArguments()

Method Details

getLog

@Nonnull
public org.slf4j.Logger getLog()

Specified by:

getLog in class AbstractCommandLineArguments

getAuthenticatorName

@Nullable
@NotEmpty
public String getAuthenticatorName()

Get name of TOTPAuthenticator bean to access.

Returns:

bean name

getSeed

@Nullable
@NotEmpty
public byte[] getSeed()

Get token seed when verifying codes.

Returns:

raw seed

getIssuer

@Nullable
@NotEmpty
public String getIssuer()

Get the token issuer.

Returns:

token issuer

getAccountName

@Nullable
@NotEmpty
public String getAccountName()

Get the token account name.

Returns:

token account name

getTokenCode

@Nullable
public Integer getTokenCode()

Get token code to verify.

Returns:

token code

validate

public void validate()
              throws IllegalArgumentException

Specified by:

validate in interface CommandLineArguments

Overrides:

validate in class AbstractCommandLineArguments

Throws:

IllegalArgumentException

printHelp

public void printHelp(PrintStream out)

Specified by:

printHelp in interface CommandLineArguments

Overrides:

printHelp in class net.shibboleth.idp.cli.AbstractIdPHomeAwareCommandLineArguments