Skip navigation links

com.octetstring.vde.chain
Class PluginManager

java.lang.Object
com.octetstring.vde.chain.PluginManager

All Implemented Interfaces:

RunChain

public final class PluginManager

extends java.lang.Object

implements RunChain

Constructor Summary

PluginManager(int scope, com.octetstring.vde.ClassLoaderProvider provider)

Method Summary

void	addPlugin(java.lang.String className, java.lang.String name, PluginInit initparams) Adds a plugin to the manager
void	addRef() Adds a reference to the current adapter
void	configurePlugins(com.octetstring.vde.config.PluginsConfig pluginsConfig)
com.octetstring.vde.chain.PluginChain	createPluginChain() Used to create a PluginChain that can then be added to the current PluginManager
void	destroyPlugins()
com.octetstring.vde.chain.PluginChain	getAdd()
Adapter	getBackend()
com.octetstring.vde.chain.PluginChain	getBind()
int	getChainStartingPoint(int operation, Plugin plugin)
com.octetstring.vde.chain.PluginChain	getDef()
com.octetstring.vde.chain.PluginChain	getDelete()
com.octetstring.vde.chain.PluginChain	getGet()
com.octetstring.vde.chain.plugins.mapper.Mapper	getMapper(java.lang.String name) Retrieves a Mapper based on the Mapper File Name
com.octetstring.vde.chain.PluginChain	getModify()
Plugin	getPlugin(java.lang.String name) Retrieves a plugin based on the name
int	getRefs()
void	remRef() Removes a reference to the current adapter
void	runAdd(java.util.HashMap<java.lang.Object,java.lang.Object> request, Credentials creds, Entry entry, com.asn1c.core.Int8 result) Runs the "add" operation's chain
void	runBind(java.util.HashMap<java.lang.Object,java.lang.Object> request, Credentials creds, DirectoryString dn, BinarySyntax password, com.asn1c.core.Bool result) Runs the "bind" operation's chain
void	runDelete(java.util.HashMap<java.lang.Object,java.lang.Object> request, Credentials creds, DirectoryString dn, com.asn1c.core.Int8 results) Moves through the "delete" operation's chain
void	runGet(java.util.HashMap<java.lang.Object,java.lang.Object> request, Credentials creds, DirectoryString base, com.asn1c.core.Int8 scope, Filter filter, com.asn1c.core.Bool typesonly, java.util.Vector<DirectoryString> attributes, ChainVector result) Runs the "get" operation's chain
Entry	runGetByDn(java.util.HashMap<java.lang.Object,java.lang.Object> request, Credentials creds, DirectoryString base)
void	runModify(java.util.HashMap<java.lang.Object,java.lang.Object> request, Credentials creds, DirectoryString name, java.util.Vector<EntryChange> changeEntries) Runs the "modify" operation's chain
void	runPostSearchComplete(java.util.HashMap<java.lang.Object,java.lang.Object> request, ChainEntrySet entrySet, int start) Run after all entries are returned
void	runPostSearchEntry(java.util.HashMap<java.lang.Object,java.lang.Object> request, Credentials creds, java.util.Vector<DirectoryString> returnAttribs, Filter filter, com.asn1c.core.Int8 scope, DirectoryString base, Entry entry, ChainEntrySet entrySet, int start) Run on each entry after a "get" is performed
void	runRename(java.util.HashMap<java.lang.Object,java.lang.Object> request, Credentials creds, DirectoryString oldName, DirectoryString newName, DirectoryString newSuffix, com.asn1c.core.Bool removeOldRdn, com.asn1c.core.Int8 results) Runs the "rename" operation's chain
void	setAdd(com.octetstring.vde.chain.PluginChain chain)
void	setBackend(Adapter backend)
void	setBind(com.octetstring.vde.chain.PluginChain chain)
void	setDef(com.octetstring.vde.chain.PluginChain chain)
void	setDelete(com.octetstring.vde.chain.PluginChain chain)
void	setGet(com.octetstring.vde.chain.PluginChain chain)
void	setModify(com.octetstring.vde.chain.PluginChain chain)

Methods inherited from class java.lang.Object

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

Constructor Detail

PluginManager

public PluginManager(int scope,
                     com.octetstring.vde.ClassLoaderProvider provider)

Method Detail

addRef

public final void addRef()

Adds a reference to the current adapter

remRef

public final void remRef()

Removes a reference to the current adapter

getRefs

public final int getRefs()

addPlugin

public void addPlugin(java.lang.String className,
                      java.lang.String name,
                      PluginInit initparams)

Adds a plugin to the manager

Parameters:

className - The class name of the plugin

name - The label for the plugin

initparams - The plugin's initialization parameters

getPlugin

public Plugin getPlugin(java.lang.String name)

Retrieves a plugin based on the name

Parameters:

name - The name of the plugin

getMapper

public com.octetstring.vde.chain.plugins.mapper.Mapper getMapper(java.lang.String name)

Retrieves a Mapper based on the Mapper File Name

Parameters:

name - The name of the mapper file

getAdd

public com.octetstring.vde.chain.PluginChain getAdd()

getBind

public com.octetstring.vde.chain.PluginChain getBind()

getDef

public com.octetstring.vde.chain.PluginChain getDef()

getDelete

public com.octetstring.vde.chain.PluginChain getDelete()

getGet

public com.octetstring.vde.chain.PluginChain getGet()

getModify

public com.octetstring.vde.chain.PluginChain getModify()

setAdd

public void setAdd(com.octetstring.vde.chain.PluginChain chain)

setBind

public void setBind(com.octetstring.vde.chain.PluginChain chain)

setDef

public void setDef(com.octetstring.vde.chain.PluginChain chain)

setDelete

public void setDelete(com.octetstring.vde.chain.PluginChain chain)

setGet

public void setGet(com.octetstring.vde.chain.PluginChain chain)

setModify

public void setModify(com.octetstring.vde.chain.PluginChain chain)

runAdd

public void runAdd(java.util.HashMap<java.lang.Object,java.lang.Object> request,
                   Credentials creds,
                   Entry entry,
                   com.asn1c.core.Int8 result)
            throws DirectoryException,
                   ChainException

Description copied from interface: RunChain

Runs the "add" operation's chain

Specified by:

runAdd in interface RunChain

creds - The currently bound user's credentials

entry - The entry being added

result - The result of the add

Throws:

DirectoryException

ChainException

runBind

public void runBind(java.util.HashMap<java.lang.Object,java.lang.Object> request,
                    Credentials creds,
                    DirectoryString dn,
                    BinarySyntax password,
                    com.asn1c.core.Bool result)
             throws DirectoryException,
                    ChainException

Description copied from interface: RunChain

Runs the "bind" operation's chain

Specified by:

runBind in interface RunChain

dn - The DN for the user

password - The user's password

result - The result of the bind

Throws:

DirectoryException

ChainException

runDelete

public void runDelete(java.util.HashMap<java.lang.Object,java.lang.Object> request,
                      Credentials creds,
                      DirectoryString dn,
                      com.asn1c.core.Int8 results)
               throws DirectoryException,
                      ChainException

Description copied from interface: RunChain

Moves through the "delete" operation's chain

Specified by:

runDelete in interface RunChain

creds - The current user's credentials

dn - The object to delete

Throws:

DirectoryException

ChainException

runGet

public void runGet(java.util.HashMap<java.lang.Object,java.lang.Object> request,
                   Credentials creds,
                   DirectoryString base,
                   com.asn1c.core.Int8 scope,
                   Filter filter,
                   com.asn1c.core.Bool typesonly,
                   java.util.Vector<DirectoryString> attributes,
                   ChainVector result)
            throws DirectoryException,
                   ChainException

Description copied from interface: RunChain

Runs the "get" operation's chain

Specified by:

runGet in interface RunChain

base - The base of the search

scope - The scope of the search

filter - The search's filter

typesonly - Should entry contain values

attributes - List of attributes

result - Final results

Throws:

DirectoryException

ChainException

runModify

public void runModify(java.util.HashMap<java.lang.Object,java.lang.Object> request,
                      Credentials creds,
                      DirectoryString name,
                      java.util.Vector<EntryChange> changeEntries)
               throws DirectoryException,
                      ChainException

Description copied from interface: RunChain

Runs the "modify" operation's chain

Specified by:

runModify in interface RunChain

creds - The currnet user's credentials

name - The name of the object being modified

changeEntries - Group of EntryChange Objects

Throws:

DirectoryException

ChainException

runRename

public void runRename(java.util.HashMap<java.lang.Object,java.lang.Object> request,
                      Credentials creds,
                      DirectoryString oldName,
                      DirectoryString newName,
                      DirectoryString newSuffix,
                      com.asn1c.core.Bool removeOldRdn,
                      com.asn1c.core.Int8 results)
               throws DirectoryException,
                      ChainException

Description copied from interface: RunChain

Runs the "rename" operation's chain

Specified by:

runRename in interface RunChain

creds - User's credentials

oldName - The old name of the entry

newName - The new name of the entry

newSuffix - The new suffix of the entry

removeOldRdn - Determine if the old RDN is to be removed

results - The results of the rename

Throws:

DirectoryException

ChainException

runPostSearchEntry

public void runPostSearchEntry(java.util.HashMap<java.lang.Object,java.lang.Object> request,
                               Credentials creds,
                               java.util.Vector<DirectoryString> returnAttribs,
                               Filter filter,
                               com.asn1c.core.Int8 scope,
                               DirectoryString base,
                               Entry entry,
                               ChainEntrySet entrySet,
                               int start)
                        throws DirectoryException,
                               ChainException

Run on each entry after a "get" is performed

Specified by:

runPostSearchEntry in interface RunChain

Parameters:

creds - The current user's credentials

entry - The current entry

Throws:

DirectoryException

ChainException

runPostSearchComplete

public void runPostSearchComplete(java.util.HashMap<java.lang.Object,java.lang.Object> request,
                                  ChainEntrySet entrySet,
                                  int start)
                           throws DirectoryException,
                                  ChainException

Run after all entries are returned

Specified by:

runPostSearchComplete in interface RunChain

Throws:

DirectoryException

ChainException

createPluginChain

public com.octetstring.vde.chain.PluginChain createPluginChain()

Used to create a PluginChain that can then be added to the current PluginManager

getBackend

public Adapter getBackend()

setBackend

public void setBackend(Adapter backend)

runGetByDn

public Entry runGetByDn(java.util.HashMap<java.lang.Object,java.lang.Object> request,
                        Credentials creds,
                        DirectoryString base)
                 throws DirectoryException,
                        ChainException

Specified by:

runGetByDn in interface RunChain

Throws:

DirectoryException

ChainException

configurePlugins

public void configurePlugins(com.octetstring.vde.config.PluginsConfig pluginsConfig)
                      throws ChainException

Throws:

ChainException

getChainStartingPoint

public int getChainStartingPoint(int operation,
                                 Plugin plugin)
                          throws ChainException

Throws:

ChainException

destroyPlugins

public void destroyPlugins()

Skip navigation links