io.apimatic.coreinterfaces.authentication

Class Authentication

java.lang.Object

io.apimatic.coreinterfaces.authentication.Authentication

public abstract class Authentication
extends Object

To setup methods for authentication

Constructor Summary

Constructors

Constructor and Description
Authentication()

Method Summary

Modifier and Type	Method and Description
abstract Request	apply(Request httpRequest) Applies the authentication on the httpRequest.
String	getErrorMessage() Returns the error message if the auth credentials are not valid.
boolean	isValid() Checks if the auth credentials are valid.
void	setErrorMessage(String errorMessage) Sets the error message for invalid auth credentials.
void	setValidity(boolean isValid) Sets the validatity of the auth credentials.
abstract void	validate() Validates the credentials for authentication.

Methods inherited from class java.lang.Object

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

Constructor Detail

Authentication

public Authentication()

Method Detail

apply

public abstract Request apply(Request httpRequest)

Applies the authentication on the httpRequest.

Parameters:

httpRequest - the request on which authentication is being applied.

Returns:

the authenticated request.

validate

public abstract void validate()

Validates the credentials for authentication.

isValid

public boolean isValid()

Checks if the auth credentials are valid.

Returns:

true if the auth credentials are valid, false otherwise.

setValidity

public void setValidity(boolean isValid)

Sets the validatity of the auth credentials.

Parameters:

isValid - the flag to set for validity.

getErrorMessage

public String getErrorMessage()

Returns the error message if the auth credentials are not valid.

Returns:

the string message whenever the auth credentials are not valid.

setErrorMessage

public void setErrorMessage(String errorMessage)

Sets the error message for invalid auth credentials.

Parameters:

errorMessage - the error message to set.