Skip navigation links

com.octetstring.vde.chain
Class GlobalServicesInterface

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

All Implemented Interfaces:

com.octetstring.vde.chain.RunChain, com.octetstring.vde.Singleton

public final class GlobalServicesInterface

extends java.lang.Object

implements com.octetstring.vde.chain.RunChain, com.octetstring.vde.Singleton

Interface for plug-in writers to call in for extra operations on a global level. Calls to this interface are run through all global plugins and are run through the router and adapter systems. Obtain handle to singleton using getInstance() method.

Method Summary

void	addACLPlugin()
static void	addAcls()
static GlobalServicesInterface	getInstance()
static void	init()
static void	removeAcls()
static void	reset()
void	runAdd(java.util.HashMap<java.lang.Object,java.lang.Object> request, Credentials creds, Entry entry, 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, Bool result) Runs the "bind" operation's chain
void	runDelete(java.util.HashMap<java.lang.Object,java.lang.Object> request, Credentials creds, DirectoryString object, 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, Int8 scope, Filter filter, Bool typesonly, java.util.Vector<DirectoryString> attributes, com.octetstring.vde.chain.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, 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, Bool removeOldRdn, Int8 results) Runs the "rename" operation's chain
void	stopGSI()

Methods inherited from class java.lang.Object

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

Method Detail

init

public static void init()

getInstance

public static GlobalServicesInterface getInstance()

Returns:

a handle to the GSI singleton

runAdd

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

Description copied from interface: com.octetstring.vde.chain.RunChain

Runs the "add" operation's chain

Specified by:

runAdd in interface com.octetstring.vde.chain.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,
                    Bool result)
             throws DirectoryException,
                    ChainException

Description copied from interface: com.octetstring.vde.chain.RunChain

Runs the "bind" operation's chain

Specified by:

runBind in interface com.octetstring.vde.chain.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 object,
                      Int8 results)
               throws DirectoryException,
                      ChainException

Description copied from interface: com.octetstring.vde.chain.RunChain

Moves through the "delete" operation's chain

Specified by:

runDelete in interface com.octetstring.vde.chain.RunChain

creds - The current user's credentials

object - 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,
                   Int8 scope,
                   Filter filter,
                   Bool typesonly,
                   java.util.Vector<DirectoryString> attributes,
                   com.octetstring.vde.chain.ChainVector result)
            throws DirectoryException,
                   ChainException

Description copied from interface: com.octetstring.vde.chain.RunChain

Runs the "get" operation's chain

Specified by:

runGet in interface com.octetstring.vde.chain.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: com.octetstring.vde.chain.RunChain

Runs the "modify" operation's chain

Specified by:

runModify in interface com.octetstring.vde.chain.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,
                      Bool removeOldRdn,
                      Int8 results)
               throws DirectoryException,
                      ChainException

Description copied from interface: com.octetstring.vde.chain.RunChain

Runs the "rename" operation's chain

Specified by:

runRename in interface com.octetstring.vde.chain.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,
                               Int8 scope,
                               DirectoryString base,
                               Entry entry,
                               ChainEntrySet entrySet,
                               int start)
                        throws DirectoryException,
                               ChainException

Description copied from interface: com.octetstring.vde.chain.RunChain

Run on each entry after a "get" is performed

Specified by:

runPostSearchEntry in interface com.octetstring.vde.chain.RunChain

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

Description copied from interface: com.octetstring.vde.chain.RunChain

Run after all entries are returned

Specified by:

runPostSearchComplete in interface com.octetstring.vde.chain.RunChain

Throws:

DirectoryException

ChainException

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 com.octetstring.vde.chain.RunChain

Throws:

DirectoryException

ChainException

addACLPlugin

public void addACLPlugin()
                  throws ChainException

Throws:

ChainException

addAcls

public static void addAcls()
                    throws ChainException

Throws:

ChainException

removeAcls

public static void removeAcls()

stopGSI

public void stopGSI()

reset

public static void reset()

Skip navigation links