|
OracleVirtual Directory Java API Reference 11g Release 1 (11.1.1) E10688-02 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface Plugin
Interface for all plugins
Method Summary | |
---|---|
void |
add(Chain chain, Credentials creds, Entry entry, 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, Bool result) Moves through the "bind" operation's chain |
void |
delete(Chain chain, Credentials creds, DirectoryString object, Int8 results) Moves through the "delete" operation's chain |
void |
destroy() Destroys the current plugin |
void |
get(Chain chain, Credentials creds, DirectoryString base, Int8 scope, Filter filter, 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, 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, Bool removeOldRdn, Int8 results) Moves through the "rename" operation's chain |
Method Detail |
---|
void add(Chain chain, Credentials creds, Entry entry, Int8 result) throws DirectorySchemaViolation, DirectoryException, ChainException
chain
- The curren chaincreds
- The currently bound user's credentialsentry
- The entry being addedresult
- The result of the addDirectorySchemaViolation
DirectoryException
ChainException
void bind(Chain chain, Credentials creds, DirectoryString dn, BinarySyntax password, Bool result) throws DirectoryException, ChainException
chain
- The current chaincreds
- The currently bound user's credentialsdn
- The DN for the userpassword
- The user's passwordresult
- The result of the bindDirectoryException
ChainException
void delete(Chain chain, Credentials creds, DirectoryString object, Int8 results) throws DirectoryException, ChainException
chain
- The current chaincreds
- The current user's credentialsobject
- The object to deleteresults
- The LDAP result codeDirectoryException
ChainException
void get(Chain chain, Credentials creds, DirectoryString base, Int8 scope, Filter filter, Bool typesonly, java.util.Vector<DirectoryString> attributes, java.util.Vector<EntrySet> result) throws DirectoryException, ChainException
chain
- The current chaincreds
- The currently bound user's credentialsbase
- The base of the searchscope
- The scope of the searchfilter
- The search's filtertypesonly
- Should entry contain valuesattributes
- List of attributesresult
- Final resultsDirectoryException
ChainException
void modify(Chain chain, Credentials creds, DirectoryString name, java.util.Vector<EntryChange> changeEntries) throws DirectoryException, ChainException
chain
- The current chaincreds
- The currnet user's credentialsname
- The name of the object being modifiedchangeEntries
- The group of EntryChange ObjectsDirectoryException
ChainException
void rename(Chain chain, Credentials creds, DirectoryString oldName, DirectoryString newName, DirectoryString newSuffix, Bool removeOldRdn, Int8 results) throws DirectoryException, ChainException
chain
- The current Chaincreds
- User's credentialsoldName
- The old name of the entrynewName
- The new name of the entrynewSuffix
- The new suffix of the entryremoveOldRdn
- Determine if the old RDN is to be removedresults
- The results of the renameDirectoryException
ChainException
void postSearchEntry(Chain chain, Credentials creds, java.util.Vector<DirectoryString> returnAttribs, Filter filter, Int8 scope, DirectoryString base, Entry entry, ChainEntrySet entrySet) throws DirectoryException, ChainException
chain
- The current chaincreds
- The current user's credentialsreturnAttribs
- The attributes being returnedfilter
- The filterscope
- The search scopebase
- The search baseentry
- The current entryentrySet
- The complete entry setDirectoryException
ChainException
void postSearchComplete(Chain chain, ChainEntrySet entrySet) throws DirectoryException, ChainException
chain
- The current ChainentrySet
- The complete entry setDirectoryException
ChainException
boolean available(Chain chain, DirectoryString base)
chain
- The current chainbase
- The base DNvoid init(PluginInit initParams, java.lang.String name) throws ChainException
initParams
- Hashmap of key/value pairs specified in initial configname
- The name specified in the config for this PluginChainException
void destroy()
|
OracleVirtual Directory Java API Reference 11g Release 1 (11.1.1) E10688-02 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |