com.allanbank.mongodb

Class Credential.Builder

java.lang.Object

com.allanbank.mongodb.Credential.Builder

Enclosing class:

Credential

public static class Credential.Builder
extends Object

Builder provides a helper for creating a Credential.

Copyright ©:

2013, Allanbank Consulting, Inc., All Rights Reserved

Field Summary

Fields

Modifier and Type	Field and Description
protected String	myAuthenticationType The authentication type or mode that the credential should be used with.
protected Authenticator	myAuthenticator The template authenticator for the credential.
protected String	myDatabase The database the credential are valid for.
protected File	myFile The file containing the full credentials.
protected Map<String,String>	myOptions Other options for the credentials.
protected char[]	myPassword The password for the credential set.
protected String	myUserName The user name for the credential set.

Constructor Summary

Constructors

Constructor and Description
Credential.Builder() Creates a new Builder.

Method Summary

Methods

Modifier and Type	Method and Description
Credential.Builder	addOption(String optionName, boolean optionValue) Adds an option to the built credentials.
Credential.Builder	addOption(String optionName, int optionValue) Adds an option to the built credentials.
Credential.Builder	addOption(String optionName, String optionValue) Adds an option to the built credentials.
Credential.Builder	authenticationType(String authenticationType) Sets the value of the authentication type or mode that the credential should be used with.
Credential.Builder	authenticator(Authenticator authenticator) Sets the value of the template authenticator for the credential.
Credential	build() Creates the credential from this builder.
Credential.Builder	database(String database) Sets the value of the database the credential are valid for.
Credential.Builder	file(File file) Sets the value of the file containing the full credentials.
Credential.Builder	kerberos() Sets the value of the authentication type or mode that the credential should be used with to Kerberos.
Credential.Builder	ldap() Sets the value of the authentication type or mode that the credential should be used with LDAP via PLAIN SASL.
Credential.Builder	mongodbCR() Sets the value of the authentication type or mode that the credential should be used with to MongoDB Challenge/Response.
Credential.Builder	pam() Sets the value of the authentication type or mode that the credential should be used with PAM via PLAIN SASL.
Credential.Builder	password(char[] password) Sets the value of the password for the credential set.
Credential.Builder	plainSasl() Sets the value of the authentication type or mode that the credential should be used with to PLAIN SASL.
Credential.Builder	reset() Resets the builder to a known state.
Credential.Builder	setAuthenticationType(String authenticationType) Sets the value of the authentication type or mode that the credential should be used with.
Credential.Builder	setAuthenticator(Authenticator authenticator) Sets the value of the template authenticator for the credential.
Credential.Builder	setDatabase(String database) Sets the value of the database the credential are valid for.
Credential.Builder	setFile(File file) Sets the value of the file containing the full credentials.
Credential.Builder	setPassword(char[] password) Sets the value of the password for the credential set.
Credential.Builder	setUserName(String userName) Sets the value of the user name for the credential set.
Credential.Builder	userName(String userName) Sets the value of the user name for the credential set.
Credential.Builder	x509() Sets the value of the authentication type or mode that the credential should be used with to x.509 client certificates exchanged via the TLS connection.
Credential.Builder	x509(X509Certificate cert) Sets the user name to that of the x.509 certificate subject name and then sets the value of the authentication type or mode that the credential should be used with to x.509 client certificates exchanged via the TLS connection.

Methods inherited from class java.lang.Object

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

Field Detail

myAuthenticationType

protected String myAuthenticationType

The authentication type or mode that the credential should be used with.

myAuthenticator

protected Authenticator myAuthenticator

The template authenticator for the credential.

myDatabase

protected String myDatabase

The database the credential are valid for.

myFile

protected File myFile

The file containing the full credentials.

myOptions

protected final Map<String,String> myOptions

Other options for the credentials.

myPassword

protected char[] myPassword

The password for the credential set.

myUserName

protected String myUserName

The user name for the credential set.

Constructor Detail

Credential.Builder

public Credential.Builder()

Creates a new Builder.

Method Detail

addOption

public Credential.Builder addOption(String optionName,
                           boolean optionValue)

Adds an option to the built credentials.

Parameters:

optionName - The name of the option to set.

optionValue - The value of the option to set.

Returns:

This Credential.Builder for method chaining.

addOption

public Credential.Builder addOption(String optionName,
                           int optionValue)

Adds an option to the built credentials.

Parameters:

optionName - The name of the option to set.

optionValue - The value of the option to set.

Returns:

This Credential.Builder for method chaining.

addOption

public Credential.Builder addOption(String optionName,
                           String optionValue)

Adds an option to the built credentials.

Parameters:

optionName - The name of the option to set.

optionValue - The value of the option to set.

Returns:

This Credential.Builder for method chaining.

authenticationType

public Credential.Builder authenticationType(String authenticationType)

Sets the value of the authentication type or mode that the credential should be used with.

This method delegates to setAuthenticationType(String).

Parameters:

authenticationType - The new value for the authentication type or mode that the credential should be used with.

Returns:

This Credential.Builder for method chaining.

authenticator

public Credential.Builder authenticator(Authenticator authenticator)

Sets the value of the template authenticator for the credential.

This method delegates to setAuthenticator(Authenticator).

Parameters:

authenticator - The new value for the template authenticator for the credential.

Returns:

This Credential.Builder for method chaining.

build

public Credential build()

Creates the credential from this builder.

Returns:

The Credential populated with the state of this builder.

database

public Credential.Builder database(String database)

Sets the value of the database the credential are valid for.

This method delegates to setDatabase(String).

Parameters:

database - The new value for the database the credential are valid for.

Returns:

This Credential.Builder for method chaining.

file

public Credential.Builder file(File file)

Sets the value of the file containing the full credentials.

This method delegates to setFile(File).

Parameters:

file - The new value for the file containing the full credentials.

Returns:

This Credential.Builder for method chaining.

kerberos

public Credential.Builder kerberos()

Sets the value of the authentication type or mode that the credential should be used with to Kerberos.

This method delegates to setAuthenticationType(KERBEROS).

Note: Use of Kerberos for authentication requires the driver's extensions. See the Kerberos Usage Guide for details.

Returns:

This Credential.Builder for method chaining.

See Also:

Kerberos Usage Guide

ldap

public Credential.Builder ldap()

Sets the value of the authentication type or mode that the credential should be used with LDAP via PLAIN SASL.

This method delegates to setAuthenticationType(PLAIN_SASL).

Note: Use of Plain SASL for authentication requires the driver's extensions. See the Plain SASL Usage Guide for details.

Returns:

This Credential.Builder for method chaining.

See Also:

Plain SASL Usage Guide

mongodbCR

public Credential.Builder mongodbCR()

Sets the value of the authentication type or mode that the credential should be used with to MongoDB Challenge/Response.

This method delegates to setAuthenticationType(MONGODB_CR).

Returns:

This Credential.Builder for method chaining.

pam

public Credential.Builder pam()

Sets the value of the authentication type or mode that the credential should be used with PAM via PLAIN SASL.

This method delegates to setAuthenticationType(PLAIN_SASL).

Note: Use of Plain SASL for authentication requires the driver's extensions. See the Plain SASL Usage Guide for details.

Returns:

This Credential.Builder for method chaining.

See Also:

Plain SASL Usage Guide

password

public Credential.Builder password(char[] password)

Sets the value of the password for the credential set.

This method delegates to setPassword(char[]).

Parameters:

password - The new value for the password for the credential set.

Returns:

This Credential.Builder for method chaining.

plainSasl

public Credential.Builder plainSasl()

Sets the value of the authentication type or mode that the credential should be used with to PLAIN SASL.

This method delegates to setAuthenticationType(PLAIN_SASL).

Note: Use of Plain SASL for authentication requires the driver's extensions. See the Plain SASL Usage Guide for details.

Returns:

This Credential.Builder for method chaining.

See Also:

Plain SASL Usage Guide

reset

public Credential.Builder reset()

Resets the builder to a known state.

Returns:

This Credential.Builder for method chaining.

setAuthenticationType

public Credential.Builder setAuthenticationType(String authenticationType)

Sets the value of the authentication type or mode that the credential should be used with.

Parameters:

authenticationType - The new value for the authentication type or mode that the credential should be used with.

Returns:

This Credential.Builder for method chaining.

setAuthenticator

public Credential.Builder setAuthenticator(Authenticator authenticator)

Sets the value of the template authenticator for the credential.

Parameters:

authenticator - The new value for the template authenticator for the credential.

Returns:

This Credential.Builder for method chaining.

setDatabase

public Credential.Builder setDatabase(String database)

Sets the value of the database the credential are valid for.

Parameters:

database - The new value for the database the credential are valid for.

Returns:

This Credential.Builder for method chaining.

setFile

public Credential.Builder setFile(File file)

Sets the value of the file containing the full credentials.

Parameters:

file - The new value for the file containing the full credentials.

Returns:

This Credential.Builder for method chaining.

setPassword

public Credential.Builder setPassword(char[] password)

Sets the value of the password for the credential set.

Parameters:

password - The new value for the password for the credential set.

Returns:

This Credential.Builder for method chaining.

setUserName

public Credential.Builder setUserName(String userName)

Sets the value of the user name for the credential set.

Parameters:

userName - The new value for the user name for the credential set.

Returns:

This Credential.Builder for method chaining.

userName

public Credential.Builder userName(String userName)

Sets the value of the user name for the credential set.

This method delegates to setUserName(String).

Parameters:

userName - The new value for the user name for the credential set.

Returns:

This Credential.Builder for method chaining.

x509

public Credential.Builder x509()

Sets the value of the authentication type or mode that the credential should be used with to x.509 client certificates exchanged via the TLS connection.

This method delegates to setAuthenticationType(X509).

Note: Use of x.509 for authentication requires the driver's extensions. See the TLS Usage Guide for details.

Returns:

This Credential.Builder for method chaining.

See Also:

TLS/SSL Usage Guide, x.509 Authentication Usage Guide

x509

public Credential.Builder x509(X509Certificate cert)

Sets the user name to that of the x.509 certificate subject name and then sets the value of the authentication type or mode that the credential should be used with to x.509 client certificates exchanged via the TLS connection.

This method delegates to userName(cert.getSubjectX500Principal().toString()).x509().

Note: Use of x.509 for authentication requires the driver's extensions. See the TLS Usage Guide for details.

Parameters:

cert - The client's certificate containing the client subject name.

Returns:

This Credential.Builder for method chaining.

See Also:

TLS/SSL Usage Guide, x.509 Authentication Usage Guide