|
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.join.Joiner
public abstract class Joiner
This abstract class defines the basic operations and methods required for any Joiner object. It defines pre-action operations to allow manipulation of data prior to any ldap operation. A Joiner always works in the context of the primary adapter and a designated target adapter.
Field Summary | |
---|---|
static DirectoryString |
ATTR_ANY |
static DirectoryString |
ATTR_DN |
static DirectoryString |
ATTR_JOINDN |
static DirectoryString |
ATTR_OBJECTCLASS |
static DirectoryString |
EMPTY_DS |
Constructor Summary | |
---|---|
Joiner(java.lang.String targetAdapterNum, java.lang.String configSpecification) This constructor forms a new Joiner object. |
|
Joiner(java.lang.String targetAdapterNum, java.lang.String configSpecification, com.octetstring.vde.join.JoinViewAdapter joinAdapter, java.lang.String parentLogger) |
Method Summary | |
---|---|
Filter |
createJoinFilter(Chain chain, Credentials creds, Entry entry) Creates a join search filter based on the entry provided. |
java.lang.String |
getAdapterStr() This method returns the String adapter number for the target adapter. |
DirectoryString |
getBindTarget(Chain chain, Credentials creds, Entry entry) This method returns the target binddn based on the Entry provided. |
java.lang.String |
getConfigSpec() Method getConfigSpec , returns the configuration specification used to instantiate this joiner. |
ChainEntrySet |
getJoinCandidatesByFilter(Chain chain, Credentials creds, DirectoryString binddn, Filter filter) This method returns all the possible DNs (as Entry's) found in the target adapter for a particular search filter. |
ChainEntrySet |
getJoinCandidatesBySearch(Chain chain, Credentials creds, DirectoryString binddn, DirectoryString base, int scope, Filter filter) This method returns all the possible DNs (as Entry's) found in the target adapter for a particular search filter and base/scope specification. |
java.util.Vector<DirectoryString> |
getPrimaryJoinAttrs() This method returns a Vector of DirectoryStrings representing the primary adapter attributes to join with the target adapter. |
java.util.Vector<DirectoryString> |
getRetrieveAttrs() This method returns a Vector of attributes ( DirectoryString ) that the target adapter is capable of returning. |
com.octetstring.vde.router.RoutingRule |
getRoutingRule() |
java.util.Vector<DirectoryString> |
getStoreAttrs() This method returns a Vector of attributes( DirectoryString ) that the target adapter will allow modification to. |
java.lang.String |
getTargetAdapterNumber() |
java.util.Vector<DirectoryString> |
getTargetJoinAttrs() This method returns a Vector of DirectoryStrings representing the target adapter attributes to join with the primary adapter. |
DirectoryString |
getTargetSuffix() This method returns the base suffix of the target adapter. |
abstract boolean |
isOneToMany() Marks a join rule for one-to-many treatment. |
boolean |
isPreFetchEntryRequired() Method isPreFetchEntryRequired (NOT IMPLEMENTED), returns whether the joiner will need the entry to be fetched (as a join entry) before processing modifies. |
Entry |
joinByEntry(Chain chain, Credentials creds, DirectoryString binddn, Entry entry, java.util.Vector<DirectoryString> srchattrs) This method takes the Entry of primary adapter and maps it to a target Entry in a joined adapter for a get operation. |
DirectoryString |
mapAddTargetDNByEntry(Chain chain, Credentials creds, DirectoryString binddn, Entry entry) This method takes the Entry of primary adapter and maps it to a target DN in a joined adapter for an add operation. |
DirectoryString |
mapDeleteTargetDNByEntry(Chain chain, Credentials creds, DirectoryString binddn, Entry entry) This method takes the Entry of primary adapter and maps it to a target DN in a joined adapter for an delete operation. |
DirectoryString |
mapModifyTargetDNByEntry(Chain chain, Credentials creds, DirectoryString binddn, Entry entry) This method takes the Entry of primary adapter and maps it to a target DN in a joined adapter for an modify operation. |
java.util.List<DirectoryString> |
mapModifyTargetDNsByEntry(Chain chain, Credentials creds, DirectoryString binddn, Entry entry, java.util.Vector<DirectoryString> attribs) This method takes the Entry of primary adapter and maps it to a target DN in a joined adapter for an modify operation. |
DirectoryString |
mapRenameTargetDNByEntry(Chain chain, Credentials creds, DirectoryString binddn, Entry entry) This method takes the Entry of primary adapter and maps it to a target DN in a joined adapter for a rename operation. |
DirectoryString |
mapRenameTargetDNByEntry(Chain chain, Credentials creds, DirectoryString binddn, Entry entry, Entry oldentry) This method takes the Entry of primary adapter and maps it to a target DN in a * joined adapter for a rename operation. |
Entry |
preAddOperation(Chain chain, Credentials creds, DirectoryString binddn, Entry entry) This method takes an inbound entry and maps for insertion into joined adapter. |
Entry |
preDeleteOperation(Chain chain, Credentials creds, DirectoryString binddn, Entry entry) This method takes an inbound entry and performs any secondary manipulations. |
java.util.Vector<EntryChange> |
preModifyOperation(Chain chain, Credentials creds, DirectoryString binddn, Entry entry, java.util.Vector<EntryChange> changeEntries) This method takes an inbound entry and change request and performs all necessary manipulations in the context of the joined adapter. |
Entry |
preRenameOperation(Chain chain, Credentials creds, DirectoryString binddn, Entry entry) This method takes an inbound entry and performs any secondary manipulations. |
static java.lang.String |
swapJoinRules(java.lang.String strJoinRules) |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final DirectoryString EMPTY_DS
public static final DirectoryString ATTR_DN
public static final DirectoryString ATTR_ANY
public static final DirectoryString ATTR_OBJECTCLASS
public static final DirectoryString ATTR_JOINDN
Constructor Detail |
---|
public Joiner(java.lang.String targetAdapterNum, java.lang.String configSpecification)
targetAdapterNum
- A String
specifying the adapter which is the target of this joinconfigSpec
- A String
providing join configuration parameters from the adapter configuration file.public Joiner(java.lang.String targetAdapterNum, java.lang.String configSpecification, com.octetstring.vde.join.JoinViewAdapter joinAdapter, java.lang.String parentLogger)
Method Detail |
---|
public boolean isPreFetchEntryRequired()
isPreFetchEntryRequired
(NOT IMPLEMENTED), returns whether the joiner will need the entry to be fetched (as a join entry) before processing modifies. (true by default)public java.lang.String getConfigSpec()
getConfigSpec
, returns the configuration specification used to instantiate this joiner.public java.lang.String getTargetAdapterNumber()
public com.octetstring.vde.router.RoutingRule getRoutingRule()
public java.util.Vector<DirectoryString> getRetrieveAttrs()
DirectoryString
) that the target adapter is capable of returning. Null implies no restrictions.public java.util.Vector<DirectoryString> getStoreAttrs()
DirectoryString
) that the target adapter will allow modification to. Null implies no restrictions.public java.lang.String getAdapterStr()
public DirectoryString getTargetSuffix()
public java.util.Vector<DirectoryString> getPrimaryJoinAttrs()
public java.util.Vector<DirectoryString> getTargetJoinAttrs()
public Entry preAddOperation(Chain chain, Credentials creds, DirectoryString binddn, Entry entry)
binddn
- a DirectoryString
value containing the bind DN of the ldap client performing the operation.entry
- a com.octetstring.vde.Entry
object containing the entry to be added from the ldap client.public DirectoryString mapAddTargetDNByEntry(Chain chain, Credentials creds, DirectoryString binddn, Entry entry) throws DirectoryException, ChainException
binddn
- a DirectoryString
value containing the bind DN of the ldap client performing the operationentry
- a com.octetstring.vde.Entry
object containing the main entry to be joined with.DirectoryException
ChainException
public Entry preDeleteOperation(Chain chain, Credentials creds, DirectoryString binddn, Entry entry)
binddn
- a DirectoryString
value containing the bind dn of the ldap client performing the operationentry
- a com.octetstring.vde.Entry
object containing the entry to be added from the ldap client.public DirectoryString mapDeleteTargetDNByEntry(Chain chain, Credentials creds, DirectoryString binddn, Entry entry) throws DirectoryException, ChainException
binddn
- a DirectoryString
value containing the bind DN of the ldap client performing the operationentry
- a com.octetstring.vde.Entry
object containing the main entry to be joined with.DirectoryException
ChainException
public java.util.Vector<EntryChange> preModifyOperation(Chain chain, Credentials creds, DirectoryString binddn, Entry entry, java.util.Vector<EntryChange> changeEntries)
binddn
- a DirectoryString
value containing the bind DN of the ldap client performing the operationentry
- a com.octetstring.vde.Entry
object containing the entry from the primary adapter.changeEntries
- a Vector
containing the modify operations requested by the clientpublic DirectoryString mapModifyTargetDNByEntry(Chain chain, Credentials creds, DirectoryString binddn, Entry entry) throws DirectoryException, ChainException
binddn
- a DirectoryString
value containing the bind DN of the ldap client performing the operationentry
- a com.octetstring.vde.Entry
object containing the main entry to be joined with.DirectoryException
ChainException
public java.util.List<DirectoryString> mapModifyTargetDNsByEntry(Chain chain, Credentials creds, DirectoryString binddn, Entry entry, java.util.Vector<DirectoryString> attribs) throws DirectoryException, ChainException
binddn
- a DirectoryString
value containing the bind DN of the ldap client performing the operationentry
- a com.octetstring.vde.Entry
object containing the main entry to be joined with.DirectoryException
ChainException
public Entry preRenameOperation(Chain chain, Credentials creds, DirectoryString binddn, Entry entry)
binddn
- a DirectoryString
value containing the bind DN of the ldap client performing the operationentry
- a com.octetstring.vde.Entry
object containing the entry to be added from the ldap client.public DirectoryString mapRenameTargetDNByEntry(Chain chain, Credentials creds, DirectoryString binddn, Entry entry) throws DirectoryException, ChainException
binddn
- a DirectoryString
value containing the bind DN of the ldap client performing the operationentry
- a com.octetstring.vde.Entry
object containing the main entry to be joined with.DirectoryException
ChainException
public DirectoryString mapRenameTargetDNByEntry(Chain chain, Credentials creds, DirectoryString binddn, Entry entry, Entry oldentry) throws DirectoryException, ChainException
binddn
- a DirectoryString
value containing the bind DN of the ldap client performing the operationentry
- a com.octetstring.vde.Entry
object containing the main entry to be joined with.oldentry
- a com.octetstring.vde.Entry
object containing the old entry to be renamedDirectoryException
ChainException
public Entry joinByEntry(Chain chain, Credentials creds, DirectoryString binddn, Entry entry, java.util.Vector<DirectoryString> srchattrs) throws DirectoryException, ChainException
binddn
- a DirectoryString
value containing the bind DN of the ldap client performing the operationentry
- a com.octetstring.vde.Entry
object containing the main entry to be joined with.DirectoryException
ChainException
public DirectoryString getBindTarget(Chain chain, Credentials creds, Entry entry) throws DirectoryException, ChainException
entry
- an Entry
typically from the primary adapter that is used by the joiner to locate the joined entry target.DirectoryException
ChainException
public Filter createJoinFilter(Chain chain, Credentials creds, Entry entry)
public static java.lang.String swapJoinRules(java.lang.String strJoinRules)
public ChainEntrySet getJoinCandidatesByFilter(Chain chain, Credentials creds, DirectoryString binddn, Filter filter) throws DirectoryException
binddn
- a DirectoryString
containing the dn of the ldap client executing the query (or null)filter
- a Filter
specifying the search criteria supplied by the ldap clientDirectoryException
public ChainEntrySet getJoinCandidatesBySearch(Chain chain, Credentials creds, DirectoryString binddn, DirectoryString base, int scope, Filter filter) throws DirectoryException
binddn
- a DirectoryString
containing the dn of the ldap client executing the query (or null)base
- a DirectoryString
specifying the base of the target adapterscope
- a int
specifying the scope of the search.filter
- a Filter
specifying the search criteria supplied by the ldap clientDirectoryException
public abstract boolean isOneToMany()
|
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 |