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

Class TOTPContext

java.lang.Object

org.opensaml.messaging.context.BaseContext

net.shibboleth.idp.plugin.authn.totp.context.TOTPContext

All Implemented Interfaces:

Iterable<BaseContext>

public class TOTPContext
extends BaseContext

Context class for state of a TOTP validation.

Nested Class Summary

Nested classes/interfaces inherited from class org.opensaml.messaging.context.BaseContext

BaseContext.ContextSetNoRemoveIteratorDecorator, BaseContext.DeprecatedContextClassNameLookAside

Field Summary

Fields

Modifier and Type	Field	Description
private Integer	tokenCode	The token code supplied.
private Collection<byte[]>	tokenSeeds	The raw token seeds associated with the subject.
private String	username	The subject identifier with respect to the token "back-end".

Constructor Summary

Constructors

Constructor	Description
TOTPContext()	Constructor.

Method Summary

Modifier and Type	Method	Description
Integer	getTokenCode()	Get the token code.
Collection<byte[]>	getTokenSeeds()	Get the raw token seeds for the subject.
String	getUsername()	Get the username.
TOTPContext	setTokenCode(Integer code)	Set the token code.
TOTPContext	setUsername(String name)	Set the username.

Methods inherited from class org.opensaml.messaging.context.BaseContext

addSubcontext, addSubcontext, clearSubcontexts, containsSubcontext, createSubcontext, ensureSubcontext, ensureSubcontext, getParent, getSubcontext, getSubcontext, getSubcontext, getSubcontext, iterator, removeFromParent, removeSubcontext, removeSubcontext, setParent

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Field Details

username

@Nullable
@NotEmpty
private String username

The subject identifier with respect to the token "back-end".

tokenCode

@Nullable
private Integer tokenCode

The token code supplied.

tokenSeeds

@Nonnull
private Collection<byte[]> tokenSeeds

The raw token seeds associated with the subject.

Constructor Details

TOTPContext

public TOTPContext()

Constructor.

Method Details

getUsername

@Nullable
@NotEmpty
public String getUsername()

Get the username.

Returns:

the username

setUsername

@Nonnull
public TOTPContext setUsername(@Nullable @NotEmpty
 String name)

Set the username.

Parameters:

name - the username

Returns:

this context

getTokenCode

@Nullable
public Integer getTokenCode()

Get the token code.

Returns:

the token code

setTokenCode

@Nonnull
public TOTPContext setTokenCode(@Nullable
 Integer code)

Set the token code.

Parameters:

code - the token code

Returns:

this context

getTokenSeeds

@Nonnull
@Live
public Collection<byte[]> getTokenSeeds()

Get the raw token seeds for the subject.

Returns:

the token seeds