org.trellisldp.auth.basic

Class BasicAuthFilter

java.lang.Object

org.trellisldp.auth.basic.BasicAuthFilter

All Implemented Interfaces:

ContainerRequestFilter

@Priority(value=1000)
public class BasicAuthFilter
extends Object
implements ContainerRequestFilter

A basic authentication filter using an Authorization HTTP header.

Field Summary

Fields

Modifier and Type	Field and Description
static String	ADMIN_ROLE The admin role.
static String	CONFIG_AUTH_ADMIN_USERS The configuration key controlling the list of of admin WebID values.
static String	CONFIG_AUTH_BASIC_CREDENTIALS The configuration key controlling the location of the basic auth credentials file.
static String	CONFIG_AUTH_REALM The configuration key controlling the realm used in a WWW-Authenticate header, or 'trellis' by default.

Constructor Summary

Constructors

Constructor and Description
BasicAuthFilter() Create a basic auth filter.
BasicAuthFilter(File file) Create a basic auth filter.
BasicAuthFilter(File file, String realm, Set<String> admins) Create a basic auth filter.
BasicAuthFilter(String credentialsFile) Create a basic auth filter.

Method Summary

Modifier and Type	Method and Description
void	filter(ContainerRequestContext requestContext)

Methods inherited from class java.lang.Object

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

Field Detail

CONFIG_AUTH_BASIC_CREDENTIALS

public static final String CONFIG_AUTH_BASIC_CREDENTIALS

The configuration key controlling the location of the basic auth credentials file.

See Also:

Constant Field Values

CONFIG_AUTH_REALM

public static final String CONFIG_AUTH_REALM

The configuration key controlling the realm used in a WWW-Authenticate header, or 'trellis' by default.

See Also:

Constant Field Values

CONFIG_AUTH_ADMIN_USERS

public static final String CONFIG_AUTH_ADMIN_USERS

The configuration key controlling the list of of admin WebID values.

See Also:

Constant Field Values

ADMIN_ROLE

public static final String ADMIN_ROLE

The admin role.

See Also:

Constant Field Values

Constructor Detail

BasicAuthFilter

@Inject
public BasicAuthFilter()

Create a basic auth filter.

BasicAuthFilter

public BasicAuthFilter(String credentialsFile)

Create a basic auth filter.

Parameters:

credentialsFile - a credentials file

BasicAuthFilter

public BasicAuthFilter(File file)

Create a basic auth filter.

Parameters:

file - the credentials file

BasicAuthFilter

public BasicAuthFilter(File file,
                       String realm,
                       Set<String> admins)

Create a basic auth filter.

Parameters:

file - the credentials file

realm - the authentication realm

admins - the admin users

Method Detail

filter

public void filter(ContainerRequestContext requestContext)

Specified by:

filter in interface ContainerRequestFilter