Skip navigation links

com.octetstring.vde.chain
Class VirtualServicesInterface

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

public class VirtualServicesInterface

extends java.lang.Object

The VirtualServicesInterface (VSI) is used to allow plugins to be able to call into OVD to perform various operations. This is the preferred way to access OVD, as it guarantees consistent data by always using a chain that begins after the current plugin. For instance, if plugin1, plugin2 and plugin3 are in a chain a call from plugin1 will go through plugin2 and plugin3, while a call from plugin2 will only go through plugin3 and a call to plugin3 will not go through the chain at all. In this way a plugin can call into OVD without worring about data consistency or recursion.

Method Summary

void	add(java.util.HashMap<java.lang.Object,java.lang.Object> request, Credentials creds, Entry entry, Int8 result) Moves Through the "add" operation's chain
void	add(java.util.HashMap<java.lang.Object,java.lang.Object> request, Credentials creds, Entry entry, Int8 result, Plugin begin) Moves Through the "add" operation's chain
void	bind(java.util.HashMap<java.lang.Object,java.lang.Object> request, Credentials creds, DirectoryString dn, BinarySyntax password, Bool result) Moves through the "bind" operation's chain
void	bind(java.util.HashMap<java.lang.Object,java.lang.Object> request, Credentials creds, DirectoryString dn, BinarySyntax password, Bool result, Plugin begin) Moves through the "bind" operation's chain
void	delete(java.util.HashMap<java.lang.Object,java.lang.Object> request, Credentials creds, DirectoryString object, Int8 results) Moves through the "delete" operation's chain
void	delete(java.util.HashMap<java.lang.Object,java.lang.Object> request, Credentials creds, DirectoryString object, Int8 results, Plugin begin) Moves through the "delete" operation's chain
void	get(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) Moves through the "get" operation's chain
void	get(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, Plugin begin) Moves through the "get" operation's chain
AdapterServiceInterface	getASI() Returns an instance of Adapter Service Interface or ASI
Entry	getByDn(java.util.HashMap<java.lang.Object,java.lang.Object> request, Credentials creds, DirectoryString base) Moves through the "get" operation's chain
Entry	getByDn(java.util.HashMap<java.lang.Object,java.lang.Object> request, Credentials creds, DirectoryString base, Plugin begin) Moves through the "get" operation's chain
GlobalServicesInterface	getGSI() Returns an instance of Global Services Interface or GSI
void	modify(java.util.HashMap<java.lang.Object,java.lang.Object> request, Credentials creds, DirectoryString name, java.util.Vector<EntryChange> changeEntries) Moves through the "modify" operation's chain
void	modify(java.util.HashMap<java.lang.Object,java.lang.Object> request, Credentials creds, DirectoryString name, java.util.Vector<EntryChange> changeEntries, Plugin begin) Moves through the "modify" operation's chain
void	rename(java.util.HashMap<java.lang.Object,java.lang.Object> request, Credentials creds, DirectoryString oldName, DirectoryString newName, DirectoryString newSuffix, Bool removeOldRdn, Int8 results) Moves through the "rename" operation's chain
void	rename(java.util.HashMap<java.lang.Object,java.lang.Object> request, Credentials creds, DirectoryString oldName, DirectoryString newName, DirectoryString newSuffix, Bool removeOldRdn, Int8 results, Plugin begin) Moves through the "rename" operation's chain

Methods inherited from class java.lang.Object

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

Method Detail

getASI

public AdapterServiceInterface getASI()

Returns an instance of Adapter Service Interface or ASI

Returns:

The global handle to AdapterServiceInterface

getGSI

public GlobalServicesInterface getGSI()

Returns an instance of Global Services Interface or GSI

Returns:

The global handle to the GlobalServicesInterface

add

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

Moves Through the "add" operation's chain

Parameters:

request - The current LDAP transaction information

creds - The currently bound user's credentials

entry - The entry being added

result - The result of the add

Throws:

DirectorySchemaViolation

DirectoryException

ChainException

add

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

Moves Through the "add" operation's chain

Parameters:

request - The current LDAP transaction information

creds - The currently bound user's credentials

entry - The entry being added

result - The result of the add

begin - The plugin in the chain which will begin the chain

Throws:

DirectoryException

DirectorySchemaViolation

ChainException

bind

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

Moves through the "bind" operation's chain

Parameters:

request - The current LDAP transaction information

creds - The currently bound user's credentials

dn - The DN for the user

password - The user's password

result - The result of the bind

Throws:

DirectoryException

ChainException

bind

public void bind(java.util.HashMap<java.lang.Object,java.lang.Object> request,
                 Credentials creds,
                 DirectoryString dn,
                 BinarySyntax password,
                 Bool result,
                 Plugin begin)
          throws DirectoryException,
                 ChainException

Moves through the "bind" operation's chain

Parameters:

request - The current LDAP transaction information

creds - The currently bound user's credentials

dn - The DN for the user

password - The user's password

result - The result of the bind

begin - The plugin in the chain which will begin the chain

Throws:

DirectoryException

ChainException

delete

public void delete(java.util.HashMap<java.lang.Object,java.lang.Object> request,
                   Credentials creds,
                   DirectoryString object,
                   Int8 results)
            throws DirectoryException,
                   ChainException

Moves through the "delete" operation's chain

Parameters:

request - The current LDAP transaction information

creds - The current user's credentials

object - The object to delete

results - The results of the operation

Throws:

DirectoryException

ChainException

delete

public void delete(java.util.HashMap<java.lang.Object,java.lang.Object> request,
                   Credentials creds,
                   DirectoryString object,
                   Int8 results,
                   Plugin begin)
            throws DirectoryException,
                   ChainException

Moves through the "delete" operation's chain

Parameters:

request - The current LDAP transaction information

creds - The current user's credentials

object - The object to delete

results - The result code of the operation

begin - The plugin in the chain which will begin the chain

Throws:

DirectoryException

ChainException

get

public void get(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

Moves through the "get" operation's chain

Parameters:

request - The current LDAP transaction information

creds - The currently bound user's credentials

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

get

public void get(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,
                Plugin begin)
         throws DirectoryException,
                ChainException

Moves through the "get" operation's chain

Parameters:

request - The current LDAP transaction information

creds - The currently bound user's credentials

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

begin - The plugin in the chain which will begin the chain

Throws:

DirectoryException

ChainException

modify

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

Moves through the "modify" operation's chain

Parameters:

request - The current LDAP transaction information

creds - The currnet user's credentials

name - The name of the object being modified

changeEntries - Group of EntryChange Objects

Throws:

DirectoryException

ChainException

modify

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

Moves through the "modify" operation's chain

Parameters:

request - The current LDAP transaction information

creds - The currnet user's credentials

name - The name of the object being modified

changeEntries - Group of EntryChange Objects

begin - The plugin in the chain which will begin the chain

Throws:

DirectoryException

ChainException

rename

public void rename(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

Moves through the "rename" operation's chain

Parameters:

request - The current LDAP transaction information

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

rename

public void rename(java.util.HashMap<java.lang.Object,java.lang.Object> request,
                   Credentials creds,
                   DirectoryString oldName,
                   DirectoryString newName,
                   DirectoryString newSuffix,
                   Bool removeOldRdn,
                   Int8 results,
                   Plugin begin)
            throws DirectoryException,
                   ChainException

Moves through the "rename" operation's chain

Parameters:

request - The current LDAP transaction information

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

begin - The plugin in the chain which will begin the chain

Throws:

DirectoryException

ChainException

getByDn

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

Moves through the "get" operation's chain

Parameters:

request - The current LDAP transaction information

creds - The currently bound user's credentials

base - The base of the search

Throws:

DirectoryException

ChainException

getByDn

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

Moves through the "get" operation's chain

Parameters:

request - The current LDAP transaction information

creds - The currently bound user's credentials

base - The base of the search

begin - The plugin in the chain which will begin the chain

Throws:

DirectoryException

ChainException

Skip navigation links