|
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 |
java.lang.Object
com.octetstring.vde.chain.Chain
public final class Chain
The chain object is used to control how data moves through the plugin and adapter architecture
Field Summary | |
---|---|
static int |
ADD_OP Add Operation |
static int |
BIND_OP Bind Operation |
static int |
DEL_OP Delete Operation |
static int |
GET_OP Get Operation |
static int |
MOD_OP Modify Operation |
static int |
RENAME_OP Rename Operation |
Constructor Summary | |
---|---|
Chain(Adapter backend, com.octetstring.vde.chain.ChainLink[] plugins, int chainScope, java.util.HashMap<java.lang.Object,java.lang.Object> request, int operation, int start) Creates a new chain instance to execute a single operation |
|
Chain(Adapter backend, java.util.HashMap<java.lang.Object,java.lang.Object> request, int operation) Creates a new default chain instance to execute an operation |
Method Summary | |
---|---|
int |
getOperationType() |
java.util.HashMap<java.lang.Object,java.lang.Object> |
getRequest() |
VirtualServicesInterface |
getVSI() |
void |
nextAdd(Credentials creds, Entry entry, Int8 result) Moves Through the "add" operation's chain |
void |
nextBind(Credentials creds, DirectoryString dn, BinarySyntax password, Bool result) Moves through the "bind" operation's chain |
void |
nextDelete(Credentials creds, DirectoryString object, Int8 results) Moves through the "delete" operation's chain |
void |
nextGet(Credentials creds, DirectoryString base, Int8 scope, Filter filter, Bool typesonly, java.util.Vector<DirectoryString> attributes, java.util.Vector<EntrySet> result) Moves through the global "get" operation's chain |
void |
nextModify(Credentials creds, DirectoryString name, java.util.Vector<EntryChange> changeEntries) Moves through the "modify" operation's chain |
void |
nextPostSearchComplete(ChainEntrySet entrySet) Run after all entries are returned |
void |
nextPostSearchEntry(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 |
nextRename(Credentials creds, DirectoryString oldName, DirectoryString newName, DirectoryString newSuffix, Bool removeOldRdn, Int8 results) Moves through the "rename" operation's chain |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final int ADD_OP
public static final int MOD_OP
public static final int DEL_OP
public static final int GET_OP
public static final int BIND_OP
public static final int RENAME_OP
Constructor Detail |
---|
public Chain(Adapter backend, com.octetstring.vde.chain.ChainLink[] plugins, int chainScope, java.util.HashMap<java.lang.Object,java.lang.Object> request, int operation, int start)
backend
- A handle to the current adapter that the chain is associated with.plugins
- The list of pluginschainScope
- The scope of the chainrequest
- LDAP Request data for the current operation instanceoperation
- The LDAP operation performed (ADD_OP, BIND_OP, DEL_OP, GET_OP, MOD_OP, RENAME_OP)start
- The position to begin executing in the chainpublic Chain(Adapter backend, java.util.HashMap<java.lang.Object,java.lang.Object> request, int operation)
backend
- A handle to the adapter that the chain is associated.request
- LDAP Request data for the current operational instanceoperation
- The LDAP operation performed (ADD_OP, BIND_OP, DEL_OP, GET_OP, MOD_OP, RENAME_OP)Method Detail |
---|
public void nextAdd(Credentials creds, Entry entry, Int8 result) throws DirectoryException, ChainException, DirectorySchemaViolation
creds
- The currently bound user's credentialsentry
- The entry being addedresult
- The result of the addDirectoryException
ChainException
DirectorySchemaViolation
public void nextBind(Credentials creds, DirectoryString dn, BinarySyntax password, Bool result) throws DirectoryException, ChainException
creds
- The currently bound user credentialsdn
- The DN for the userpassword
- The user's passwordresult
- The result of the bindDirectoryException
ChainException
public void nextDelete(Credentials creds, DirectoryString object, Int8 results) throws DirectoryException, ChainException
creds
- The current user's credentialsobject
- The object to deleteresults
- The number of entries deletedDirectoryException
ChainException
public void nextGet(Credentials creds, DirectoryString base, Int8 scope, Filter filter, Bool typesonly, java.util.Vector<DirectoryString> attributes, java.util.Vector<EntrySet> result) throws DirectoryException, ChainException
creds
- 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 results. A Vector of EntrySets objects.DirectoryException
ChainException
public void nextModify(Credentials creds, DirectoryString name, java.util.Vector<EntryChange> changeEntries) throws DirectoryException, ChainException
creds
- The currnet user's credentialsname
- The name of the object being modifiedchangeEntries
- The group of EntryChange ObjectsDirectoryException
ChainException
public void nextRename(Credentials creds, DirectoryString oldName, DirectoryString newName, DirectoryString newSuffix, Bool removeOldRdn, Int8 results) throws DirectoryException, ChainException
creds
- 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 operationDirectoryException
ChainException
public void nextPostSearchEntry(Credentials creds, java.util.Vector<DirectoryString> returnAttribs, Filter filter, Int8 scope, DirectoryString base, Entry entry, ChainEntrySet entrySet) throws DirectoryException, ChainException
creds
- The current user's credentialsreturnAttribs
- A Vector of DirectoryStrings listing attributes requestedfilter
- The original search Filterscope
- The original search scopebase
- A DirectoryString containing the search baseentry
- The current entry being returnedentrySet
- The current ChainEntrySet being processedDirectoryException
ChainException
public void nextPostSearchComplete(ChainEntrySet entrySet) throws DirectoryException, ChainException
entrySet
- The current ChainEntrySet being processedDirectoryException
ChainException
public int getOperationType()
public VirtualServicesInterface getVSI()
public java.util.HashMap<java.lang.Object,java.lang.Object> getRequest()
|
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 |