Package org.openremote.manager.security

Class LDAPComponentBuilder

java.lang.Object

org.openremote.manager.security.LDAPComponentBuilder

public class LDAPComponentBuilder
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	LDAPComponentBuilder.AuthType
static enum	LDAPComponentBuilder.EditMode
class	LDAPComponentBuilder.LDAPConstants
static enum	LDAPComponentBuilder.MapperMode
static enum	LDAPComponentBuilder.MemberShipAttributeType
static enum	LDAPComponentBuilder.ProviderId
static enum	LDAPComponentBuilder.ProviderType
static enum	LDAPComponentBuilder.UserRolesRetrieveStrategy
static enum	LDAPComponentBuilder.UseTrustStoreSpi
static enum	LDAPComponentBuilder.Vendor

Constructor Summary

Constructors

Constructor	Description
LDAPComponentBuilder()

Method Summary

Modifier and Type	Method	Description
org.keycloak.representations.idm.ComponentRepresentation	build()
LDAPComponentBuilder	setAllowKerberosAuthentication(boolean allowKerberosAuthentication)	Kerberos
LDAPComponentBuilder	setAuthType(LDAPComponentBuilder.AuthType authType)
LDAPComponentBuilder	setBatchSizeForSync(int batchSizeForSync)
LDAPComponentBuilder	setBindCredential(String bindCredential)
LDAPComponentBuilder	setBindDn(String bindDn)
LDAPComponentBuilder	setChangedSyncPeriod(int periodInSeconds)	Period to sync changed users, excluding users that didn't changed
LDAPComponentBuilder	setClientId(String clientId)
LDAPComponentBuilder	setConnectionPooling(boolean connectionPooling)
LDAPComponentBuilder	setConnectionUrl(String connectionUrl)
LDAPComponentBuilder	setCustomUserSearchFilter(String customUserSearchFilter)
LDAPComponentBuilder	setDebug(boolean debug)	Kerberos End
LDAPComponentBuilder	setDropNonExistingGroupsDuringSync(boolean dropNonExistingGroupsDuringSync)
LDAPComponentBuilder	setEditMode(LDAPComponentBuilder.EditMode editMode)
LDAPComponentBuilder	setFullSyncPeriod(int periodInSeconds)	Period to fully sync the users, including users that didn't changed
LDAPComponentBuilder	setGroupNameLDAPAttribute(String groupNameLDAPAttribute)
LDAPComponentBuilder	setGroupObjectClasses(String groupObjectClasses)
LDAPComponentBuilder	setGroupsDn(String groupsDn)
LDAPComponentBuilder	setGroupsLDAPFilter(String filter)
LDAPComponentBuilder	setKerberosKeyTabPath(String kerberosKeyTabPath)
LDAPComponentBuilder	setKerberosRealm(String kerberosRealm)
LDAPComponentBuilder	setKerberosServerPrincipal(String kerberosServerPrincipal)
LDAPComponentBuilder	setMapperMode(LDAPComponentBuilder.MapperMode mapperMode)
LDAPComponentBuilder	setMemberShipAttributeType(LDAPComponentBuilder.MemberShipAttributeType memberShipAttributeType)
LDAPComponentBuilder	setMemberShipLDAPAttribute(String ldapAttribute)
LDAPComponentBuilder	setMemberShipUserLDAPAttribute(String userLDAPAttribute)
LDAPComponentBuilder	setName(String name)
LDAPComponentBuilder	setPagination(boolean pagination)
LDAPComponentBuilder	setParentId(String parentId)
LDAPComponentBuilder	setPreserveGroupInheritance(boolean preserveGroupInheritance)
LDAPComponentBuilder	setPriority(int priority)
LDAPComponentBuilder	setProviderId(LDAPComponentBuilder.ProviderId providerId)
LDAPComponentBuilder	setProviderType(LDAPComponentBuilder.ProviderType providerType)
LDAPComponentBuilder	setRDNLDAPAttribute(String rdnLDAPAttribute)
LDAPComponentBuilder	setRoleNameLDAPAttribute(String nameLDAPAttribute)
LDAPComponentBuilder	setRoleObjectClasses(String roleObjectClasses)
LDAPComponentBuilder	setRolesDn(String rolesDn)
LDAPComponentBuilder	setRolesLDAPFilter(String filter)
LDAPComponentBuilder	setSearchScope(int searchScope)
LDAPComponentBuilder	setUseKerberosForPasswordAuthentication(boolean useKerberosForPasswordAuthentication)
LDAPComponentBuilder	setUseRealmsRoleMapping(boolean useRealmsRoleMapping)
LDAPComponentBuilder	setUserNameLDAPAttribute(String usernameLDAPAttribute)
LDAPComponentBuilder	setUserObjectClasses(String userObjectClasses)
LDAPComponentBuilder	setUserRolesRetrieveStrategy(LDAPComponentBuilder.UserRolesRetrieveStrategy userRolesRetrieveStrategy)
LDAPComponentBuilder	setUsersDn(String usersDn)
LDAPComponentBuilder	setUseTrustStoreSPI(LDAPComponentBuilder.UseTrustStoreSpi useTruststoreSpi)
LDAPComponentBuilder	setUUIDLDAPAttribute(String uuidLDAPAttribute)
LDAPComponentBuilder	setVendor(LDAPComponentBuilder.Vendor vendor)

Methods inherited from class java.lang.Object

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

Constructor Details

LDAPComponentBuilder

public LDAPComponentBuilder()

Method Details

setProviderType

public LDAPComponentBuilder setProviderType(LDAPComponentBuilder.ProviderType providerType)

setName

public LDAPComponentBuilder setName(String name)

setProviderId

public LDAPComponentBuilder setProviderId(LDAPComponentBuilder.ProviderId providerId)

setParentId

public LDAPComponentBuilder setParentId(String parentId)

setVendor

public LDAPComponentBuilder setVendor(LDAPComponentBuilder.Vendor vendor)

setEditMode

public LDAPComponentBuilder setEditMode(LDAPComponentBuilder.EditMode editMode)

setUserNameLDAPAttribute

public LDAPComponentBuilder setUserNameLDAPAttribute(String usernameLDAPAttribute)

setRDNLDAPAttribute

public LDAPComponentBuilder setRDNLDAPAttribute(String rdnLDAPAttribute)

setUUIDLDAPAttribute

public LDAPComponentBuilder setUUIDLDAPAttribute(String uuidLDAPAttribute)

setUserObjectClasses

public LDAPComponentBuilder setUserObjectClasses(String userObjectClasses)

setConnectionUrl

public LDAPComponentBuilder setConnectionUrl(String connectionUrl)

setUsersDn

public LDAPComponentBuilder setUsersDn(String usersDn)

setAuthType

public LDAPComponentBuilder setAuthType(LDAPComponentBuilder.AuthType authType)

setBindDn

public LDAPComponentBuilder setBindDn(String bindDn)

setBindCredential

public LDAPComponentBuilder setBindCredential(String bindCredential)

setCustomUserSearchFilter

public LDAPComponentBuilder setCustomUserSearchFilter(String customUserSearchFilter)

setSearchScope

public LDAPComponentBuilder setSearchScope(int searchScope)

setUseTrustStoreSPI

public LDAPComponentBuilder setUseTrustStoreSPI(LDAPComponentBuilder.UseTrustStoreSpi useTruststoreSpi)

setConnectionPooling

public LDAPComponentBuilder setConnectionPooling(boolean connectionPooling)

setPagination

public LDAPComponentBuilder setPagination(boolean pagination)

setBatchSizeForSync

public LDAPComponentBuilder setBatchSizeForSync(int batchSizeForSync)

setFullSyncPeriod

public LDAPComponentBuilder setFullSyncPeriod(int periodInSeconds)

Period to fully sync the users, including users that didn't changed

Parameters:

periodInSeconds - set to -1 to disable

Returns:

setChangedSyncPeriod

public LDAPComponentBuilder setChangedSyncPeriod(int periodInSeconds)

Period to sync changed users, excluding users that didn't changed

Parameters:

periodInSeconds - set to -1 to disable

Returns:

setAllowKerberosAuthentication

public LDAPComponentBuilder setAllowKerberosAuthentication(boolean allowKerberosAuthentication)

Kerberos

setKerberosServerPrincipal

public LDAPComponentBuilder setKerberosServerPrincipal(String kerberosServerPrincipal)

setUseKerberosForPasswordAuthentication

public LDAPComponentBuilder setUseKerberosForPasswordAuthentication(boolean useKerberosForPasswordAuthentication)

setKerberosKeyTabPath

public LDAPComponentBuilder setKerberosKeyTabPath(String kerberosKeyTabPath)

setKerberosRealm

public LDAPComponentBuilder setKerberosRealm(String kerberosRealm)

setDebug

public LDAPComponentBuilder setDebug(boolean debug)

Kerberos End

setPriority

public LDAPComponentBuilder setPriority(int priority)

setClientId

public LDAPComponentBuilder setClientId(String clientId)

setMemberShipAttributeType

public LDAPComponentBuilder setMemberShipAttributeType(LDAPComponentBuilder.MemberShipAttributeType memberShipAttributeType)

setMemberShipLDAPAttribute

public LDAPComponentBuilder setMemberShipLDAPAttribute(String ldapAttribute)

setMemberShipUserLDAPAttribute

public LDAPComponentBuilder setMemberShipUserLDAPAttribute(String userLDAPAttribute)

setRoleNameLDAPAttribute

public LDAPComponentBuilder setRoleNameLDAPAttribute(String nameLDAPAttribute)

setRoleObjectClasses

public LDAPComponentBuilder setRoleObjectClasses(String roleObjectClasses)

setRolesDn

public LDAPComponentBuilder setRolesDn(String rolesDn)

setUseRealmsRoleMapping

public LDAPComponentBuilder setUseRealmsRoleMapping(boolean useRealmsRoleMapping)

setMapperMode

public LDAPComponentBuilder setMapperMode(LDAPComponentBuilder.MapperMode mapperMode)

setUserRolesRetrieveStrategy

public LDAPComponentBuilder setUserRolesRetrieveStrategy(LDAPComponentBuilder.UserRolesRetrieveStrategy userRolesRetrieveStrategy)

setRolesLDAPFilter

public LDAPComponentBuilder setRolesLDAPFilter(String filter)

setGroupNameLDAPAttribute

public LDAPComponentBuilder setGroupNameLDAPAttribute(String groupNameLDAPAttribute)

setGroupObjectClasses

public LDAPComponentBuilder setGroupObjectClasses(String groupObjectClasses)

setGroupsDn

public LDAPComponentBuilder setGroupsDn(String groupsDn)

setPreserveGroupInheritance

public LDAPComponentBuilder setPreserveGroupInheritance(boolean preserveGroupInheritance)

setDropNonExistingGroupsDuringSync

public LDAPComponentBuilder setDropNonExistingGroupsDuringSync(boolean dropNonExistingGroupsDuringSync)

setGroupsLDAPFilter

public LDAPComponentBuilder setGroupsLDAPFilter(String filter)

build

public org.keycloak.representations.idm.ComponentRepresentation build()