com.rapid7.appspider.models

Class AuthenticationModel

java.lang.Object

com.rapid7.appspider.models.AuthenticationModel

public class AuthenticationModel
extends Object

Storage class containing all the information need to authenticate

Constructor Summary

Constructors

Constructor and Description
AuthenticationModel(String username, String password) instantiates a new instance of the AuthenticationModel class with no client Id
AuthenticationModel(String username, String password, Optional<String> clientId) instantiates a new instance of the AuthenticationModel class ensuring that username and password are both non-null and non-empty

Method Summary

Modifier and Type	Method and Description
String	getClientId() Gets the client id if present; otherwise throws a NoSuchElementException
String	getPassword() gets the password value
String	getUsername() Get the username value
boolean	hasClientId() Returns whether this object contains a clientId or not

Methods inherited from class java.lang.Object

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

Constructor Detail

AuthenticationModel

public AuthenticationModel(String username,
                           String password)

instantiates a new instance of the AuthenticationModel class with no client Id

AuthenticationModel

public AuthenticationModel(String username,
                           String password,
                           Optional<String> clientId)

instantiates a new instance of the AuthenticationModel class ensuring that username and password are both non-null and non-empty

Method Detail

getPassword

public String getPassword()

gets the password value

Returns:

password as a Secret

getUsername

public String getUsername()

Get the username value

Returns:

username as a String

hasClientId

public boolean hasClientId()

Returns whether this object contains a clientId or not

should be called prior to getClientId to ensure a value is present, otherwise an exception may occur

Returns:

getClientId

public String getClientId()
                   throws NoSuchElementException

Gets the client id if present; otherwise throws a NoSuchElementException

Returns:

the client Id if present

Throws:

NoSuchElementException - if this instance does not have a clientId