org.trellisldp.webac

Class WebAcFilter

java.lang.Object

org.trellisldp.webac.WebAcFilter

All Implemented Interfaces:

ContainerRequestFilter, ContainerResponseFilter

@Provider
 @Priority(value=2000)
public class WebAcFilter
extends Object
implements ContainerRequestFilter, ContainerResponseFilter

A ContainerRequestFilter that implements WebAC-based authorization.

See Also:

SOLID WebACL Specification

Field Summary

Fields

Modifier and Type	Field and Description
static String	CONFIG_WEBAC_APPENDABLE_METHODS The configuration key controlling with HTTP methods should apply to the acl:Append.
static String	CONFIG_WEBAC_CHALLENGES The configuration key controlling which WWW-Authenticate challenges are provided on 401 errors.
static String	CONFIG_WEBAC_READABLE_METHODS The configuration key controlling with HTTP methods should apply to the acl:Read.
static String	CONFIG_WEBAC_REALM The configuration key controlling the realm used in a WWW-Authenticate header, or 'trellis' by default.
static String	CONFIG_WEBAC_SCOPE The configuration key controlling the scope(s) used in a WWW-Authenticate header.
static String	CONFIG_WEBAC_WRITABLE_METHODS The configuration key controlling with HTTP methods should apply to the acl:Write.

Constructor Summary

Constructors

Constructor and Description
WebAcFilter() For use with RESTeasy and CDI proxies.
WebAcFilter(WebAcService accessService) Create a new WebAc-based auth filter.
WebAcFilter(WebAcService accessService, List<String> challengeTypes, String realm, String scope, String baseUrl) Create a WebAc-based auth filter.

Method Summary

Modifier and Type	Method and Description
void	filter(ContainerRequestContext ctx)
void	filter(ContainerRequestContext req, ContainerResponseContext res)

Methods inherited from class java.lang.Object

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

Field Detail

CONFIG_WEBAC_CHALLENGES

public static final String CONFIG_WEBAC_CHALLENGES

The configuration key controlling which WWW-Authenticate challenges are provided on 401 errors.

Multiple challenges should be separated with commas.

See Also:

Constant Field Values

CONFIG_WEBAC_READABLE_METHODS

public static final String CONFIG_WEBAC_READABLE_METHODS

The configuration key controlling with HTTP methods should apply to the acl:Read.

Values defined here will be in addition to GET, HEAD and OPTIONS. Multiple methods should be separated with commas.

See Also:

Constant Field Values

CONFIG_WEBAC_WRITABLE_METHODS

public static final String CONFIG_WEBAC_WRITABLE_METHODS

The configuration key controlling with HTTP methods should apply to the acl:Write.

Values defined here will be in addition to GET, HEAD and OPTIONS. Multiple methods should be separated with commas.

See Also:

Constant Field Values

CONFIG_WEBAC_APPENDABLE_METHODS

public static final String CONFIG_WEBAC_APPENDABLE_METHODS

The configuration key controlling with HTTP methods should apply to the acl:Append.

Values defined here will be in addition to GET, HEAD and OPTIONS. Multiple methods should be separated with commas.

See Also:

Constant Field Values

CONFIG_WEBAC_REALM

public static final String CONFIG_WEBAC_REALM

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

See Also:

Constant Field Values

CONFIG_WEBAC_SCOPE

public static final String CONFIG_WEBAC_SCOPE

The configuration key controlling the scope(s) used in a WWW-Authenticate header.

See Also:

Constant Field Values

Constructor Detail

WebAcFilter

public WebAcFilter()

For use with RESTeasy and CDI proxies.

API Note:

This construtor is used by CDI runtimes that require a public, no-argument constructor. It should not be invoked directly in user code.

WebAcFilter

@Inject
public WebAcFilter(WebAcService accessService)

Create a new WebAc-based auth filter.

Parameters:

accessService - the access service

WebAcFilter

public WebAcFilter(WebAcService accessService,
                   List<String> challengeTypes,
                   String realm,
                   String scope,
                   String baseUrl)

Create a WebAc-based auth filter.

Parameters:

accessService - the access service

challengeTypes - the WWW-Authenticate challenge types

realm - the authentication realm

scope - the authentication scope

baseUrl - the base URL, may be null

Method Detail

filter

public void filter(ContainerRequestContext ctx)

Specified by:

filter in interface ContainerRequestFilter

filter

public void filter(ContainerRequestContext req,
                   ContainerResponseContext res)

Specified by:

filter in interface ContainerResponseFilter