Skip navigation links

Oracle Virtual Directory Java API Reference
11g Release 1 (11.1.1)

E10688-01


com.octetstring.vde.chain
Interface Plugin

All Known Implementing Classes:
BasePlugin, TreePlugin

public interface Plugin

Interface for all plugins


Method Summary
 void add(Chain chain, Credentials creds, Entry entry, com.asn1c.core.Int8 result)
          Moves Through the "add" operation's chain
 boolean available(Chain chain, DirectoryString base)
          Determines if a plugin is available for the current chain
 void bind(Chain chain, Credentials creds, DirectoryString dn, BinarySyntax password, com.asn1c.core.Bool result)
          Moves through the "bind" operation's chain
 void delete(Chain chain, Credentials creds, DirectoryString object, com.asn1c.core.Int8 results)
          Moves through the "delete" operation's chain
 void destroy()
          Destroys the current plugin
 void get(Chain chain, Credentials creds, DirectoryString base, com.asn1c.core.Int8 scope, Filter filter, com.asn1c.core.Bool typesonly, java.util.Vector<DirectoryString> attributes, java.util.Vector<EntrySet> result)
          Moves through the "get" operation's chain
 void init(PluginInit initParams, java.lang.String name)
          Passes initialization information to the Plugin
 void modify(Chain chain, Credentials creds, DirectoryString name, java.util.Vector<EntryChange> changeEntries)
          Moves through the "modify" operation's chain
 void postSearchComplete(Chain chain, ChainEntrySet entrySet)
          Run after all entries are returned
 void postSearchEntry(Chain chain, Credentials creds, java.util.Vector<DirectoryString> returnAttribs, Filter filter, com.asn1c.core.Int8 scope, DirectoryString base, Entry entry, ChainEntrySet entrySet)
          Run on each entry after a "get" is performed
 void rename(Chain chain, Credentials creds, DirectoryString oldName, DirectoryString newName, DirectoryString newSuffix, com.asn1c.core.Bool removeOldRdn, com.asn1c.core.Int8 results)
          Moves through the "rename" operation's chain

 

Method Detail

add

void add(Chain chain,
         Credentials creds,
         Entry entry,
         com.asn1c.core.Int8 result)
         throws DirectorySchemaViolation,
                DirectoryException,
                ChainException
Moves Through the "add" operation's chain
Parameters:
chain - The curren chain
creds - The currently bound user's credentials
entry - The entry being added
result - The result of the add
Throws:
DirectorySchemaViolation
DirectoryException
ChainException

bind

void bind(Chain chain,
          Credentials creds,
          DirectoryString dn,
          BinarySyntax password,
          com.asn1c.core.Bool result)
          throws DirectoryException,
                 ChainException
Moves through the "bind" operation's chain
Parameters:
chain - The current chain
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

delete

void delete(Chain chain,
            Credentials creds,
            DirectoryString object,
            com.asn1c.core.Int8 results)
            throws DirectoryException,
                   ChainException
Moves through the "delete" operation's chain
Parameters:
chain - The current chain
creds - The current user's credentials
object - The object to delete
results - The LDAP result code
Throws:
DirectoryException
ChainException

get

void get(Chain chain,
         Credentials creds,
         DirectoryString base,
         com.asn1c.core.Int8 scope,
         Filter filter,
         com.asn1c.core.Bool typesonly,
         java.util.Vector<DirectoryString> attributes,
         java.util.Vector<EntrySet> result)
         throws DirectoryException,
                ChainException
Moves through the "get" operation's chain
Parameters:
chain - The current chain
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

modify

void modify(Chain chain,
            Credentials creds,
            DirectoryString name,
            java.util.Vector<EntryChange> changeEntries)
            throws DirectoryException,
                   ChainException
Moves through the "modify" operation's chain
Parameters:
chain - The current chain
creds - The currnet user's credentials
name - The name of the object being modified
changeEntries - The group of EntryChange Objects
Throws:
DirectoryException
ChainException

rename

void rename(Chain chain,
            Credentials creds,
            DirectoryString oldName,
            DirectoryString newName,
            DirectoryString newSuffix,
            com.asn1c.core.Bool removeOldRdn,
            com.asn1c.core.Int8 results)
            throws DirectoryException,
                   ChainException
Moves through the "rename" operation's chain
Parameters:
chain - The current Chain
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

postSearchEntry

void postSearchEntry(Chain chain,
                     Credentials creds,
                     java.util.Vector<DirectoryString> returnAttribs,
                     Filter filter,
                     com.asn1c.core.Int8 scope,
                     DirectoryString base,
                     Entry entry,
                     ChainEntrySet entrySet)
                     throws DirectoryException,
                            ChainException
Run on each entry after a "get" is performed
Parameters:
chain - The current chain
creds - The current user's credentials
returnAttribs - The attributes being returned
filter - The filter
scope - The search scope
base - The search base
entry - The current entry
entrySet - The complete entry set
Throws:
DirectoryException
ChainException

postSearchComplete

void postSearchComplete(Chain chain,
                        ChainEntrySet entrySet)
                        throws DirectoryException,
                               ChainException
Run after all entries are returned
Parameters:
chain - The current Chain
entrySet - The complete entry set
Throws:
DirectoryException
ChainException

available

boolean available(Chain chain,
                  DirectoryString base)
Determines if a plugin is available for the current chain
Parameters:
chain - The current chain
base - The base DN
Returns:
True or False if available

init

void init(PluginInit initParams,
          java.lang.String name)
          throws ChainException
Passes initialization information to the Plugin
Parameters:
initParams - Hashmap of key/value pairs specified in initial config
name - The name specified in the config for this Plugin
Throws:
ChainException

destroy

void destroy()
Destroys the current plugin

Skip navigation links

Oracle Virtual Directory Java API Reference
11g Release 1 (11.1.1)

E10688-01


Copyright © 2009 Oracle. All Rights Reserved.