org.keycloak.connections.mongo

Class DefaultMongoConnectionFactoryProvider

java.lang.Object

org.keycloak.connections.mongo.DefaultMongoConnectionFactoryProvider

All Implemented Interfaces:

MongoConnectionProviderFactory, ProviderFactory<MongoConnectionProvider>, ServerInfoAwareProviderFactory

public class DefaultMongoConnectionFactoryProvider
extends Object
implements MongoConnectionProviderFactory, ServerInfoAwareProviderFactory

Author:

Stian Thorgersen

Field Summary

Fields

Modifier and Type	Field and Description
protected Config.Scope	config

Constructor Summary

Constructors

Constructor and Description
DefaultMongoConnectionFactoryProvider()

Method Summary

Modifier and Type	Method and Description
protected void	checkBooleanOption(String optionName, com.mongodb.MongoClientOptions.Builder builder)
protected void	checkIntOption(String optionName, com.mongodb.MongoClientOptions.Builder builder)
void	close()
MongoConnectionProvider	create(KeycloakSession session)
protected com.mongodb.MongoClient	createMongoClient() Override this method if you want more possibility to configure Mongo client.
protected com.mongodb.MongoClientOptions	getClientOptions()
com.mongodb.DB	getDBBeforeUpdate()
String	getId()
Map<String,String>	getOperationalInfo()
void	init(Config.Scope config)
void	postInit(KeycloakSessionFactory factory)

Methods inherited from class java.lang.Object

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

Field Detail

config

protected Config.Scope config

Constructor Detail

DefaultMongoConnectionFactoryProvider

public DefaultMongoConnectionFactoryProvider()

Method Detail

init

public void init(Config.Scope config)

Specified by:

init in interface ProviderFactory<MongoConnectionProvider>

postInit

public void postInit(KeycloakSessionFactory factory)

Specified by:

postInit in interface ProviderFactory<MongoConnectionProvider>

getDBBeforeUpdate

public com.mongodb.DB getDBBeforeUpdate()

Specified by:

getDBBeforeUpdate in interface MongoConnectionProviderFactory

Returns:

DB object, which may not be yet updated to current Keycloak version. Useful just if something needs to be done even before DB update (for example acquire DB lock)

create

public MongoConnectionProvider create(KeycloakSession session)

Specified by:

create in interface ProviderFactory<MongoConnectionProvider>

close

public void close()

Specified by:

close in interface ProviderFactory<MongoConnectionProvider>

getId

public String getId()

Specified by:

getId in interface ProviderFactory<MongoConnectionProvider>

createMongoClient

protected com.mongodb.MongoClient createMongoClient()
                                             throws UnknownHostException

Override this method if you want more possibility to configure Mongo client. It can be also used to inject mongo client from different source. This method can assume that "config" is already set and can use it.

Returns:

mongoClient instance, which will be shared for whole Keycloak

Throws:

UnknownHostException

getClientOptions

protected com.mongodb.MongoClientOptions getClientOptions()

checkBooleanOption

protected void checkBooleanOption(String optionName,
                                  com.mongodb.MongoClientOptions.Builder builder)

checkIntOption

protected void checkIntOption(String optionName,
                              com.mongodb.MongoClientOptions.Builder builder)

getOperationalInfo

public Map<String,String> getOperationalInfo()

Specified by:

getOperationalInfo in interface ServerInfoAwareProviderFactory