Skip navigation links

com.octetstring.vde.chain
Class Chain

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

public final class Chain

extends java.lang.Object

The chain object is used to control how data moves through the plugin and adapter architecture

Since:

3.0

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

ADD_OP

public static final int ADD_OP

Add Operation

See Also:

Constant Field Values

MOD_OP

public static final int MOD_OP

Modify Operation

See Also:

Constant Field Values

DEL_OP

public static final int DEL_OP

Delete Operation

See Also:

Constant Field Values

GET_OP

public static final int GET_OP

Get Operation

See Also:

Constant Field Values

BIND_OP

public static final int BIND_OP

Bind Operation

See Also:

Constant Field Values

RENAME_OP

public static final int RENAME_OP

Rename Operation

See Also:

Constant Field Values

Constructor Detail

Chain

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)

Creates a new chain instance to execute a single operation

Parameters:

backend - A handle to the current adapter that the chain is associated with.

plugins - The list of plugins

chainScope - The scope of the chain

request - LDAP Request data for the current operation instance

operation - The LDAP operation performed (ADD_OP, BIND_OP, DEL_OP, GET_OP, MOD_OP, RENAME_OP)

start - The position to begin executing in the chain

Chain

public 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

Parameters:

backend - A handle to the adapter that the chain is associated.

request - LDAP Request data for the current operational instance

operation - The LDAP operation performed (ADD_OP, BIND_OP, DEL_OP, GET_OP, MOD_OP, RENAME_OP)

Method Detail

nextAdd

public void nextAdd(Credentials creds,
                    Entry entry,
                    Int8 result)
             throws DirectoryException,
                    ChainException,
                    DirectorySchemaViolation

Moves Through the "add" operation's chain

Parameters:

creds - The currently bound user's credentials

entry - The entry being added

result - The result of the add

Throws:

DirectoryException

ChainException

DirectorySchemaViolation

nextBind

public void nextBind(Credentials creds,
                     DirectoryString dn,
                     BinarySyntax password,
                     Bool result)
              throws DirectoryException,
                     ChainException

Moves through the "bind" operation's chain

Parameters:

creds - The currently bound user credentials

dn - The DN for the user

password - The user's password

result - The result of the bind

Throws:

DirectoryException

ChainException

nextDelete

public void nextDelete(Credentials creds,
                       DirectoryString object,
                       Int8 results)
                throws DirectoryException,
                       ChainException

Moves through the "delete" operation's chain

Parameters:

creds - The current user's credentials

object - The object to delete

results - The number of entries deleted

Throws:

DirectoryException

ChainException

nextGet

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

Moves through the global "get" operation's chain

Parameters:

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. A Vector of EntrySets objects.

Throws:

DirectoryException

ChainException

nextModify

public void nextModify(Credentials creds,
                       DirectoryString name,
                       java.util.Vector<EntryChange> changeEntries)
                throws DirectoryException,
                       ChainException

Moves through the "modify" operation's chain

Parameters:

creds - The currnet user's credentials

name - The name of the object being modified

changeEntries - The group of EntryChange Objects

Throws:

DirectoryException

ChainException

nextRename

public void nextRename(Credentials creds,
                       DirectoryString oldName,
                       DirectoryString newName,
                       DirectoryString newSuffix,
                       Bool removeOldRdn,
                       Int8 results)
                throws DirectoryException,
                       ChainException

Moves through the "rename" operation's chain

Parameters:

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 operation

Throws:

DirectoryException

ChainException

nextPostSearchEntry

public void nextPostSearchEntry(Credentials creds,
                                java.util.Vector<DirectoryString> returnAttribs,
                                Filter filter,
                                Int8 scope,
                                DirectoryString base,
                                Entry entry,
                                ChainEntrySet entrySet)
                         throws DirectoryException,
                                ChainException

Run on each entry after a "get" is performed. Called once for each entry returned.

Parameters:

creds - The current user's credentials

returnAttribs - A Vector of DirectoryStrings listing attributes requested

filter - The original search Filter

scope - The original search scope

base - A DirectoryString containing the search base

entry - The current entry being returned

entrySet - The current ChainEntrySet being processed

Throws:

DirectoryException

ChainException

nextPostSearchComplete

public void nextPostSearchComplete(ChainEntrySet entrySet)
                            throws DirectoryException,
                                   ChainException

Run after all entries are returned

Parameters:

entrySet - The current ChainEntrySet being processed

Throws:

DirectoryException

ChainException

getOperationType

public int getOperationType()

Returns:

Returns the operation type id

getVSI

public VirtualServicesInterface getVSI()

Returns:

A handle to the VirtualServicesInterface

getRequest

public java.util.HashMap<java.lang.Object,java.lang.Object> getRequest()

Skip navigation links