org.fcrepo.auth.common

Class HttpHeaderPrincipalProvider

java.lang.Object

org.fcrepo.auth.common.HttpHeaderPrincipalProvider

All Implemented Interfaces:

PrincipalProvider

public class HttpHeaderPrincipalProvider
extends Object
implements PrincipalProvider

An example principal provider that extracts principals from request headers.

Author:

Gregory Jansen, Mike Daines

See Also:

PrincipalProvider

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	HttpHeaderPrincipalProvider.HttpHeaderPrincipal

Constructor Summary

Constructors

Constructor and Description
HttpHeaderPrincipalProvider()

Method Summary

Methods

Modifier and Type	Method and Description
Set<Principal>	getPrincipals(javax.jcr.Credentials credentials) Extract principals from the provided credentials.
void	setHeaderName(String headerName)
void	setSeparator(String separator)

Methods inherited from class java.lang.Object

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

Constructor Detail

HttpHeaderPrincipalProvider

public HttpHeaderPrincipalProvider()

Method Detail

setHeaderName

public void setHeaderName(String headerName)

Parameters:

headerName - The name of the header from which to extract principals

setSeparator

public void setSeparator(String separator)

Parameters:

separator - The string by which to split header values

getPrincipals

public Set<Principal> getPrincipals(javax.jcr.Credentials credentials)

Description copied from interface: PrincipalProvider

Extract principals from the provided credentials.

If no principals can be extracted, for example because the credentials are of a different type than expected, implementations of this method should return the empty set rather than null.

Specified by:

getPrincipals in interface PrincipalProvider

Parameters:

credentials - the credentials

Returns:

a set of security principals