com.washingtonpost.dw.auth

Class AllowedPeerConfiguration

java.lang.Object

com.washingtonpost.dw.auth.AllowedPeerConfiguration

public class AllowedPeerConfiguration
extends Object

Container for configuration, in the "config + factory" pattern that DropWizard likes

This configuration can behave in a couple different ways, depending on what properties are set:

1. If a "credentialFile" is specified (i.e. non-null), the usernames and passwords of the allowed peers will be read from that file
2. If instead the "users" and "passwords" strings are specified (i.e. non-null), then those strings are split up with whatever value is specified by the "delimited" property and the token (user, password)s are used as the list of allowed peers. By default, the delimiter is ";", so if users="bob;alice" and passwords="foo;bar" then the list of allowed peers would contain "user bob with password foo" and "user alice with password bar"

If a cachePolicy is set, then the Authenticator that is registered with Jersey upon calling registerAuthenticator will be a CachingAuthenticator. Otherwise, it'll be an instance of AllowedPeerAuthenticator

Constructor Summary

Constructors

Constructor and Description
AllowedPeerConfiguration()

Method Summary

Modifier and Type	Method and Description
io.dropwizard.auth.Authenticator<io.dropwizard.auth.basic.BasicCredentials,Peer>	createAuthenticator() If a credentialFile is provided, this method will use that file to populate the list of Peers the Authenticator checks during request processing.
io.dropwizard.auth.CachingAuthenticator<io.dropwizard.auth.basic.BasicCredentials,Peer>	createCachingAuthenticator(com.codahale.metrics.MetricRegistry metrics)
com.google.common.cache.CacheBuilderSpec	getCachePolicy()
String	getCredentialFile()
String	getDelimiter()
String	getPasswords()
String	getRealm()
String	getUsers()
void	registerAuthenticator(io.dropwizard.setup.Environment environment) This method registers the authenticator configured in this Configuration class with Jersey.
void	setCachePolicy(com.google.common.cache.CacheBuilderSpec cachePolicy)
void	setCredentialFile(String credentialFile)
void	setDelimiter(String delimiter)
void	setPasswords(String passwords)
void	setRealm(String realm)
void	setUsers(String users)

Methods inherited from class java.lang.Object

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

Constructor Detail

AllowedPeerConfiguration

public AllowedPeerConfiguration()

Method Detail

getRealm

public String getRealm()

Returns:

BasicAuth Realm (name not really important; just needed for response http://tools.ietf.org/html/rfc2617#section-3.2.1)

setRealm

public void setRealm(String realm)

Parameters:

realm - BasicAuth Realm (name not really important; just needed for response http://tools.ietf.org/html/rfc2617#section-3.2.1). If not set, it defaults to "peers"

getCredentialFile

public String getCredentialFile()

Returns:

The classpath-relative name of a properties file holding (user=password) pairs that will count as authorized users of your service. Example value "peers/allowed-peers.properties"

setCredentialFile

public void setCredentialFile(String credentialFile)

Parameters:

credentialFile - The classpath-relative name of a properties file holding (user=password) pairs that will count as authorized users of your service. Example value "peers/allowed-peers.properties".

getCachePolicy

public com.google.common.cache.CacheBuilderSpec getCachePolicy()

Returns:

A String conforming to Guava's CacheBuilderSpec that is used if/when returning a CachingAuthenticator.

setCachePolicy

public void setCachePolicy(com.google.common.cache.CacheBuilderSpec cachePolicy)

Parameters:

cachePolicy - A String conforming to Guava's CacheBuilderSpec that is used if/when returning a CachingAuthenticator.

getUsers

public String getUsers()

Returns:

A delimiter-separated list of users who are authorized peers of your Dropwizard service.

setUsers

public void setUsers(String users)

Parameters:

users - A delimiter-separated list of users who are authorized peers of your Dropwizard service.

getPasswords

public String getPasswords()

Returns:

A delimiter-separated list of passwords associated to the users. There must be 1 password for each user

setPasswords

public void setPasswords(String passwords)

Parameters:

passwords - A delimiter-separated list of passwords associated to the users. There must be 1 password for each user

getDelimiter

public String getDelimiter()

Returns:

The string that separates each user and each password in the users and passwords strings. This defaults to the semi-colon (";")

setDelimiter

public void setDelimiter(String delimiter)

Parameters:

delimiter - The string that separates each user and each password in the users and passwords strings. This defaults to the semi-colon (";")

createAuthenticator

public io.dropwizard.auth.Authenticator<io.dropwizard.auth.basic.BasicCredentials,Peer> createAuthenticator()

If a credentialFile is provided, this method will use that file to populate the list of Peers the Authenticator checks during request processing. If instead the "users" and "passwords" Strings are provided, this method will use those to populate the list of Peers.

Returns:

An Authenticator appropriate for registering with Jersey as described https://dropwizard.github.io/dropwizard/manual/auth.html

createCachingAuthenticator

public io.dropwizard.auth.CachingAuthenticator<io.dropwizard.auth.basic.BasicCredentials,Peer> createCachingAuthenticator(com.codahale.metrics.MetricRegistry metrics)

Parameters:

metrics - A metrics registry

Returns:

The Authenticator you'd get by calling createAuthenticator directly, but wrapped in the Dropwizard CachingAuthenticator proxy with this configuration object's cachePolicy applied to it.

registerAuthenticator

public void registerAuthenticator(io.dropwizard.setup.Environment environment)

This method registers the authenticator configured in this Configuration class with Jersey.

Parameters:

environment - A DropWizard environment