com.mirth.connect.plugins.httpauth.userutil

Class AuthenticationResult

java.lang.Object

com.mirth.connect.plugins.httpauth.userutil.AuthenticationResult

public class AuthenticationResult
extends java.lang.Object

This class represents the result of an HTTP authentication attempt, used to accept or reject requests coming into HTTP-based source connectors.

Constructor Summary

Constructors

Constructor and Description
AuthenticationResult(AuthStatus status) Instantiates a new AuthenticationResult object.

Method Summary

Methods

Modifier and Type	Method and Description
void	addResponseHeader(java.lang.String key, java.lang.String value) Adds a new response header to be sent along with the authentication response.
static AuthenticationResult	Challenged(java.lang.String authenticateHeader) Convenience method to create a new AuthenticationResult with the CHALLENGED status.
static AuthenticationResult	Failure() Convenience method to create a new AuthenticationResult with the FAILURE status.
java.lang.String	getRealm() Returns the realm that the request has been authenticated with.
java.util.Map<java.lang.String,java.util.List<java.lang.String>>	getResponseHeaders() Returns the map of HTTP headers to be sent along with the authentication response.
AuthStatus	getStatus() Returns the accept/reject status of the authentication attempt.
java.lang.String	getUsername() Returns the username that the request has been authenticated with.
void	setRealm(java.lang.String realm) Sets the realm that the request has been authenticated with.
void	setResponseHeaders(java.util.Map<java.lang.String,java.util.List<java.lang.String>> responseHeaders) Sets the map of HTTP headers to be sent along with the authentication response.
void	setStatus(AuthStatus status) Sets the accept/reject status of the authentication attempt.
void	setUsername(java.lang.String username) Sets the username that the request has been authenticated with.
static AuthenticationResult	Success() Convenience method to create a new AuthenticationResult with the SUCCESS status.
static AuthenticationResult	Success(java.lang.String username, java.lang.String realm) Convenience method to create a new AuthenticationResult with the SUCCESS status.

Methods inherited from class java.lang.Object

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

Constructor Detail

AuthenticationResult

public AuthenticationResult(AuthStatus status)

Instantiates a new AuthenticationResult object.

Parameters:

status - The accept/reject status to use.

Method Detail

getStatus

public AuthStatus getStatus()

Returns the accept/reject status of the authentication attempt.

setStatus

public void setStatus(AuthStatus status)

Sets the accept/reject status of the authentication attempt.

Parameters:

status - The accept/reject status to use.

getUsername

public java.lang.String getUsername()

Returns the username that the request has been authenticated with.

setUsername

public void setUsername(java.lang.String username)

Sets the username that the request has been authenticated with.

Parameters:

username - The username that the request has been authenticated with.

getRealm

public java.lang.String getRealm()

Returns the realm that the request has been authenticated with.

setRealm

public void setRealm(java.lang.String realm)

Sets the realm that the request has been authenticated with.

Parameters:

realm - The realm that the request has been authenticated with.

getResponseHeaders

public java.util.Map<java.lang.String,java.util.List<java.lang.String>> getResponseHeaders()

Returns the map of HTTP headers to be sent along with the authentication response.

setResponseHeaders

public void setResponseHeaders(java.util.Map<java.lang.String,java.util.List<java.lang.String>> responseHeaders)

Sets the map of HTTP headers to be sent along with the authentication response.

Parameters:

responseHeaders - The map of HTTP headers to be sent along with the authentication response.

addResponseHeader

public void addResponseHeader(java.lang.String key,
                     java.lang.String value)

Adds a new response header to be sent along with the authentication response.

Parameters:

key - The name of the header.

value - The value of the header.

Challenged

public static AuthenticationResult Challenged(java.lang.String authenticateHeader)

Convenience method to create a new AuthenticationResult with the CHALLENGED status.

Parameters:

authenticateHeader - The value to include in the WWW-Authenticate response header.

Success

public static AuthenticationResult Success()

Convenience method to create a new AuthenticationResult with the SUCCESS status.

Success

public static AuthenticationResult Success(java.lang.String username,
                           java.lang.String realm)

Convenience method to create a new AuthenticationResult with the SUCCESS status.

Parameters:

username - The username that the request has been authenticated with.

realm - The realm that the request has been authenticated with.

Failure

public static AuthenticationResult Failure()

Convenience method to create a new AuthenticationResult with the FAILURE status.