Skip navigation links

com.octetstring.vde.router
Class RoutingHandler

java.lang.Object
com.octetstring.vde.router.RoutingHandler

All Implemented Interfaces:

com.octetstring.vde.Singleton

public class RoutingHandler

extends java.lang.Object

implements com.octetstring.vde.Singleton

This class provides basic query routing for BackendHandler. It selects backends based on LDAP search base parameters. This routine runs as a singleton and autoconfigures itself against the backend handler.

Field Summary

static java.lang.String	PARTIAL_RESULTS
static int	ROUTING_PRIORITY_DEFAULT

Method Summary

RoutingRule	createRoutingRule(java.lang.String adapterName)
Adapter	getBackendByNumber(java.lang.String adapterName)
java.util.Collection<Adapter>	getBackends()
java.util.List<Adapter>	getBackendsBySuffix(DirectoryString suffix)
static RoutingHandler	getInstance()
int	getNewBENum()
int	getNewSysBENum()
java.lang.String	getNumberByBackend(Adapter backend)
RoutingRule	getRoutingRule(java.lang.String adapterName)
RoutingRule	getRuleByBackend(Adapter backend)
java.util.Set<DistinguishedName>	getSuffixes()
java.util.Set<DistinguishedName>	getVisibleSuffixes()
static void	initConfig()
void	moveBefore(java.lang.String stomove, java.lang.String before)
void	moveRule(java.lang.String name, boolean up)
java.util.List<Adapter>	pickBackends(Credentials creds, DirectoryString entryName, int scope, Filter filter)
java.util.List<Adapter>	pickBackendsbyEntry(Credentials creds, Entry entry)
java.util.List<Adapter>	pickBackendsbyName(Credentials creds, DirectoryString normalizedDN)
java.util.List<Adapter>	pickBackendsForPlugin(Credentials creds, DirectoryString entryName, int scope, Filter filter) This new API was introduced for the use case where a plugin runs a search operation over the adapters.
java.util.List<Adapter>	pickBindBackendsbyName(Credentials creds, DirectoryString bindDN)
java.util.List<Adapter>	pickBindBackendsbyName(Credentials creds, DirectoryString normalizedDN, boolean respectVisible)
void	registerBackend(Adapter backend, boolean system)
void	registerBackend(Adapter backend, java.lang.String adapterName)
void	removeRoutingRule(java.lang.String adapterName)
void	reorder()
static void	reset()
void	unregisterBackend(java.lang.String adapterName, boolean removeSuffix) Un-register the adapter from the router

Methods inherited from class java.lang.Object

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

Field Detail

ROUTING_PRIORITY_DEFAULT

public static final int ROUTING_PRIORITY_DEFAULT

See Also:

Constant Field Values

PARTIAL_RESULTS

public static final java.lang.String PARTIAL_RESULTS

See Also:

Constant Field Values

Method Detail

getInstance

public static RoutingHandler getInstance()

initConfig

public static void initConfig()

reset

public static void reset()

createRoutingRule

public RoutingRule createRoutingRule(java.lang.String adapterName)

registerBackend

public void registerBackend(Adapter backend,
                            java.lang.String adapterName)
                     throws InvalidDNException

Throws:

InvalidDNException

registerBackend

public void registerBackend(Adapter backend,
                            boolean system)
                     throws InvalidDNException

Throws:

InvalidDNException

getNewBENum

public int getNewBENum()

getNewSysBENum

public int getNewSysBENum()

getRoutingRule

public RoutingRule getRoutingRule(java.lang.String adapterName)

getBackendByNumber

public Adapter getBackendByNumber(java.lang.String adapterName)

getBackends

public java.util.Collection<Adapter> getBackends()

getBackendsBySuffix

public java.util.List<Adapter> getBackendsBySuffix(DirectoryString suffix)

getSuffixes

public java.util.Set<DistinguishedName> getSuffixes()

getVisibleSuffixes

public java.util.Set<DistinguishedName> getVisibleSuffixes()

getNumberByBackend

public java.lang.String getNumberByBackend(Adapter backend)

getRuleByBackend

public RoutingRule getRuleByBackend(Adapter backend)

pickBackendsbyEntry

public java.util.List<Adapter> pickBackendsbyEntry(Credentials creds,
                                                   Entry entry)

pickBindBackendsbyName

public java.util.List<Adapter> pickBindBackendsbyName(Credentials creds,
                                                      DirectoryString bindDN)
                                               throws DirectoryException

Throws:

DirectoryException

pickBindBackendsbyName

public java.util.List<Adapter> pickBindBackendsbyName(Credentials creds,
                                                      DirectoryString normalizedDN,
                                                      boolean respectVisible)
                                               throws DirectoryException

Throws:

DirectoryException

pickBackendsbyName

public java.util.List<Adapter> pickBackendsbyName(Credentials creds,
                                                  DirectoryString normalizedDN)
                                           throws DirectoryException

Throws:

DirectoryException

pickBackends

public java.util.List<Adapter> pickBackends(Credentials creds,
                                            DirectoryString entryName,
                                            int scope,
                                            Filter filter)
                                     throws DirectoryException

Throws:

DirectoryException

pickBackendsForPlugin

public java.util.List<Adapter> pickBackendsForPlugin(Credentials creds,
                                                     DirectoryString entryName,
                                                     int scope,
                                                     Filter filter)
                                              throws DirectoryException

This new API was introduced for the use case where a plugin runs a search operation over the adapters. If there is any adapter with visivility = Internal, those adapters must be reachable for the operations kicked off from plugins.

Parameters:

creds -

entryName -

scope -

filter -

Returns:

Throws:

DirectoryException

unregisterBackend

public void unregisterBackend(java.lang.String adapterName,
                              boolean removeSuffix)

Un-register the adapter from the router

moveRule

public void moveRule(java.lang.String name,
                     boolean up)

moveBefore

public void moveBefore(java.lang.String stomove,
                       java.lang.String before)

removeRoutingRule

public void removeRoutingRule(java.lang.String adapterName)

reorder

public void reorder()

Skip navigation links