com.atlassian.crowd.plugin.rest.filter

Class BasicAuthenticationHelper

java.lang.Object

com.atlassian.crowd.plugin.rest.filter.BasicAuthenticationHelper

public final class BasicAuthenticationHelper
extends Object

A collection of methods that help implementing HTTP basic auth for end users and applications.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	BasicAuthenticationHelper.Credentials

Method Summary

Modifier and Type	Method and Description
static BasicAuthenticationHelper.Credentials	getBasicAuthCredentials(javax.servlet.http.HttpServletRequest request) Returns the Basic Auth credentials.
static void	respondWithChallenge(javax.servlet.http.HttpServletResponse response, String message, String basicAuthRealm) Responds to request with a message and a Basic Authentication challenge.

Methods inherited from class java.lang.Object

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

Method Detail

getBasicAuthCredentials

public static BasicAuthenticationHelper.Credentials getBasicAuthCredentials(javax.servlet.http.HttpServletRequest request)

Returns the Basic Auth credentials.

Parameters:

request - the request

Returns:

basic authentication credentials

respondWithChallenge

public static void respondWithChallenge(javax.servlet.http.HttpServletResponse response,
                                        String message,
                                        String basicAuthRealm)
                                 throws IOException

Responds to request with a message and a Basic Authentication challenge.

Parameters:

response - the HTTP response

message - plain text message to send

basicAuthRealm - used as the realm for the WWWW-Authenticate header

Throws:

IOException