org.zaproxy.zap.authentication

Class UsernamePasswordAuthenticationCredentials

java.lang.Object

org.zaproxy.zap.authentication.UsernamePasswordAuthenticationCredentials

All Implemented Interfaces:

AuthenticationCredentials

public class UsernamePasswordAuthenticationCredentials
extends Object
implements AuthenticationCredentials

The credentials implementation for use in systems that require a username and password combination for authentication.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	UsernamePasswordAuthenticationCredentials.UsernamePasswordAuthenticationCredentialsOptionsPanel The Options Panel used for configuring a UsernamePasswordAuthenticationCredentials.

Constructor Summary

Constructors

Constructor and Description
UsernamePasswordAuthenticationCredentials()
UsernamePasswordAuthenticationCredentials(String username, String password)

Method Summary

Modifier and Type	Method and Description
void	decode(String encodedCredentials) Decodes the internal values of the Authentication Credentials from an encoded string and fills in the current object.
String	encode(String parentStringSeparator) Encodes the Credentials in a String.
ApiResponse	getApiResponseRepresentation() Gets an api response that represents the Credentials.
String	getPassword() Gets the password.
static ApiDynamicActionImplementor	getSetCredentialsForUserApiAction(AuthenticationMethodType methodType) Gets the api action for setting a UsernamePasswordAuthenticationCredentials for an User.
String	getUsername() Gets the username.
boolean	isConfigured() Checks if the credentials object is fully configured.

Methods inherited from class java.lang.Object

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

Constructor Detail

UsernamePasswordAuthenticationCredentials

public UsernamePasswordAuthenticationCredentials()

UsernamePasswordAuthenticationCredentials

public UsernamePasswordAuthenticationCredentials(String username,
                                                 String password)

Method Detail

getUsername

public String getUsername()

Gets the username.

Returns:

the username

getPassword

public String getPassword()

Gets the password.

Returns:

the password

isConfigured

public boolean isConfigured()

Description copied from interface: AuthenticationCredentials

Checks if the credentials object is fully configured.

Specified by:

isConfigured in interface AuthenticationCredentials

Returns:

true, if is configured

encode

public String encode(String parentStringSeparator)

Description copied from interface: AuthenticationCredentials

Encodes the Credentials in a String. Fields that contain strings should not contain the parentFieldSeparator. Should be consistent with AuthenticationCredentials.decode(String).

Specified by:

encode in interface AuthenticationCredentials

Parameters:

parentStringSeparator - the parent field separator

Returns:

the string

decode

public void decode(String encodedCredentials)

Description copied from interface: AuthenticationCredentials

Decodes the internal values of the Authentication Credentials from an encoded string and fills in the current object. The string provided as input should have been obtained through calls to AuthenticationCredentials.encode(String).

Specified by:

decode in interface AuthenticationCredentials

Parameters:

encodedCredentials - the encoded credentials

getApiResponseRepresentation

public ApiResponse getApiResponseRepresentation()

Description copied from interface: AuthenticationCredentials

Gets an api response that represents the Credentials.

Specified by:

getApiResponseRepresentation in interface AuthenticationCredentials

Returns:

the api response representation

getSetCredentialsForUserApiAction

public static ApiDynamicActionImplementor getSetCredentialsForUserApiAction(AuthenticationMethodType methodType)

Gets the api action for setting a UsernamePasswordAuthenticationCredentials for an User.

Parameters:

methodType - the method type for which this is called

Returns:

the sets the credentials for user api action