|
Oracle Virtual Directory Java API Reference 11g Release 1 (11.1.1) E10688-03 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object
com.octetstring.vde.util.PluginUtil
public class PluginUtil
Utility class containing tools for building plugins
Nested Class Summary | |
---|---|
class |
PluginUtil.MappingStatus |
Field Summary | |
---|---|
static java.lang.String |
CHANGE_CANDIDATE |
static java.lang.String |
CHANGED |
static java.lang.String |
NO_CHANGE |
Method Summary | |
---|---|
void |
appendAdd(DirectoryString attrib1, DirectoryString attrib2, Entry entry) Facilitates an "append" durring an inbound ADD request or and outbound GET request by adding all instances of the appended attributes to target attribute |
void |
appendAdd(java.util.Map<DirectoryString,DirectoryString> appends, Entry entry) Facilitates a bulk "append" during an inbound ADD or an outbound GET request by adding all instances of the appended attributes to the request's entry changes |
boolean |
appendFilter(Filter currentFilter, java.util.Map<DirectoryString,DirectoryString> appends) Used to append one attribute's values to another in a filter. |
void |
appendGet(java.util.Map<DirectoryString,DirectoryString> appends, java.util.Vector<DirectoryString> attributes, Filter filter) Facilitates a bulk "append" during an inbound GET request by adding all instances of the appended attributes to the attribute request list and adjusting the filter. |
void |
appendModify(DirectoryString attrib1, DirectoryString attrib2, java.util.Vector<EntryChange> changes) Facilitates an "append" during an inbound MODIFY request by adding all instances of the appended attributes to the request's entry changes |
void |
appendModify(java.util.Map<DirectoryString,DirectoryString> appends, java.util.Vector<EntryChange> changeEntries) Facilitates a bulk "append" during an inbound MODIFY request by adding all instances of the appended attributes to the request's entry changes |
void |
converBaseEntry(Entry entry, DirectoryString attrib, DirectoryString oldBase, DirectoryString newBase) Converts the base of a DN to a new base |
void |
converBaseEntry(Entry entry, java.util.Set<DirectoryString> attribs, DirectoryString oldBase, DirectoryString newBase) Converts the base of a DN to a new base |
DirectoryString |
convertBase(DirectoryString base, DirectoryString origBase, DirectoryString newBase) Converts the base of a DN to a new base |
void |
convertBaseModify(java.util.Vector<EntryChange> changeEntries, DirectoryString attrib, DirectoryString oldBase, DirectoryString newBase) Converts the base of a DN to a new base |
void |
convertBaseModify(java.util.Vector<EntryChange> changeEntries, java.util.Set<DirectoryString> attribs, DirectoryString oldBase, DirectoryString newBase) Converts the base of a DN to a new base |
void |
convertFilterBase(Filter currentFilter, DirectoryString base, DirectoryString newBase, java.util.Set<DirectoryString> dnattrlist) Converts the base of a DN to a new base |
void |
copyAdd(DirectoryString attrib1, DirectoryString attrib2, Entry entry) Copies one attribute's values over another attributes values durring an inbound ADD operation or an outbound GET operation |
void |
copyAdd(java.util.Map<DirectoryString,DirectoryString> copies, Entry entry) Copies one attribute's values over another attributes values during an inbound ADD operation or an outbound GET operation |
boolean |
copyFilter(Filter currentFilter, java.util.Map<DirectoryString,DirectoryString> copies) Adjust the filter for copy. |
void |
copyGet(DirectoryString attrib1, DirectoryString attrib2, java.util.Vector<DirectoryString> attributes, Filter filter) Copies one attribute's values over another attributes values durring an inbound GET operation |
void |
copyGet(java.util.Map<DirectoryString,DirectoryString> copies, java.util.Vector<DirectoryString> attributes, Filter filter) Copies one attribute's values over another attributes values durring an inbound GET operation |
void |
copyModify(DirectoryString attrib1, DirectoryString attrib2, java.util.Vector<EntryChange> changeEntries) Copies one attribute's values over another attributes values during an inbound MODIFY operation |
void |
copyModify(java.util.Map<DirectoryString,DirectoryString> copies, java.util.Vector<EntryChange> changeEntries) Copies one attribute's values over another attributes values during an inbound MODIFY operation |
Filter |
createAndFilter(java.util.List<Filter> lparts) Creates an AND (&) filter from a list of filter parts |
Filter |
createFilter(java.lang.String target, java.lang.String op, java.lang.String value) Creates a new filter object |
Filter |
createOrFilter(java.util.List<Filter> lparts) Creates an OR (|) filter from a list of filter parts |
java.util.List<Filter> |
findFilters(DirectoryString target, Filter filter) Finds all instances of a given attribute in a filter |
static PluginUtil |
getInstance() Used to retrieve an instance of this singleton |
Syntax |
mapSyntax(Syntax value, java.lang.String syntax) Maps a given value to a new value of the given syntax |
boolean |
removeFilter(Filter currentFilter, java.util.Set<DirectoryString> removes) Removes an attribute from a a filter |
void |
renameAdd(DirectoryString attrib1, DirectoryString attrib2, Entry entry) Renames one attribute's values over another attributes values during an inbound ADD or outbound GET operation, overwriting the target attribute if it exists |
void |
renameAdd(java.util.Map<DirectoryString,DirectoryString> renames, Entry entry) Renames one attribute to another, overwriting the target attribute if it exists on an inbound ADD or outbound GET operation |
PluginUtil.MappingStatus |
renameFilter(Filter currentFilter, java.util.Map<DirectoryString,DirectoryString> renames) Renames one attribute's values over another attributes values. |
void |
renameGet(DirectoryString attrib1, DirectoryString attrib2, java.util.Vector<DirectoryString> attributes) Renames one attribute to another, overwriting the target attribute if it exists on an inbound GET operation |
void |
renameGet(DirectoryString attrib1, DirectoryString attrib2, java.util.Vector<DirectoryString> attributes, Filter filter) Renames one attribute's values over another attributes values durring an inbound GET operation, overwriting the target attribute if it exists |
void |
renameGet(java.util.Map<DirectoryString,DirectoryString> renames, java.util.Vector<DirectoryString> attributes, Filter filter) Renames one attribute to another, overwriting the target attribute if it exists on an inbound GET operation |
void |
renameModify(DirectoryString attrib1, DirectoryString attrib2, java.util.Vector<EntryChange> changeEntries) Renames one attribute's values over another attributes values durring an inbound MODIFY operation, overwriting the target attribute if it exists |
void |
renameModify(java.util.Map<DirectoryString,DirectoryString> renames, java.util.Vector<EntryChange> changeEntries) Renames one attribute to another, overwriting the target attribute if it exists on an inbound MODIFY operation |
void |
revalueAdd(DirectoryString attrib, Syntax currValue, Syntax newValue, Entry entry) Revaules an attribute with a given value to a new value |
void |
revalueGet(DirectoryString attrib, Syntax currValue, Syntax newValue, Filter filter) Revaules an attribute with a given value to a new value |
void |
revalueModify(DirectoryString attrib, Syntax currValue, Syntax newValue, java.util.Vector<EntryChange> changes) Revaules an attribute with a given value to a new value |
void |
setRDNEntry(Entry entry, DirectoryString oldRDNAttrType, DirectoryString newRDNAttrType) Changes the attribute of the RDN for the given dn on the given entry |
void |
setRDNGet(Chain chain, DirectoryString currentName, DirectoryString old, DirectoryString name, Credentials creds) Changes the attribute of the RDN for the given dn |
void |
setRDNModify(Chain chain, DirectoryString currentName, DirectoryString old, DirectoryString name, Credentials creds) Changes the attribute of the RDN for the given dn on an inbound MODIFY operation |
void |
setRDNRename(Chain chain, DirectoryString currentName, DirectoryString old, DirectoryString name, Credentials creds, DirectoryString newEntryName) Changes the attribute of the RDN for the given dn on an inbound RENAME operation |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final java.lang.String NO_CHANGE
public static final java.lang.String CHANGED
public static final java.lang.String CHANGE_CANDIDATE
Method Detail |
---|
public static PluginUtil getInstance()
public void appendGet(java.util.Map<DirectoryString,DirectoryString> appends, java.util.Vector<DirectoryString> attributes, Filter filter)
appends
- Name/Value pair of appended attribute/append targetattributes
- The requested attributes on an inbound get operationfilter
- The request filterpublic void appendModify(java.util.Map<DirectoryString,DirectoryString> appends, java.util.Vector<EntryChange> changeEntries)
appends
- Name/Value pair of appended attribute/append targetchangeEntries
- Entry changes effectedpublic void appendAdd(java.util.Map<DirectoryString,DirectoryString> appends, Entry entry)
appends
- Name/Value pair of appended attribute/append targetentry
- The entry to be manipulatedpublic void appendModify(DirectoryString attrib1, DirectoryString attrib2, java.util.Vector<EntryChange> changes)
attrib1
- The attribute being appendedattrib2
- The attribute being appended tochanges
- The entry change listpublic void appendAdd(DirectoryString attrib1, DirectoryString attrib2, Entry entry)
attrib1
- The attribute who's values will be appendedattrib2
- The target attribute who will recieve the source attribute's valuesentry
- The entry to perform the append onpublic boolean appendFilter(Filter currentFilter, java.util.Map<DirectoryString,DirectoryString> appends)
(&(givenName=first)(sn=last))
will become (&(|(givenName=first)(givenName=last))(sn=last))
appendGet
public void copyGet(java.util.Map<DirectoryString,DirectoryString> copies, java.util.Vector<DirectoryString> attributes, Filter filter)
copies
- Map of copy source/copy target pairsattributes
- The search attribute request listfilter
- The search filterpublic void copyModify(java.util.Map<DirectoryString,DirectoryString> copies, java.util.Vector<EntryChange> changeEntries)
copies
- Map of copy source/copy target pairschangeEntries
- List of entry changespublic void copyAdd(java.util.Map<DirectoryString,DirectoryString> copies, Entry entry)
copies
- Map of copy source/copy target pairsentry
- The entry to perform the copy onpublic void copyModify(DirectoryString attrib1, DirectoryString attrib2, java.util.Vector<EntryChange> changeEntries)
attrib1
- The source attributeattrib2
- The destination attributechangeEntries
- The entry change listpublic void copyAdd(DirectoryString attrib1, DirectoryString attrib2, Entry entry)
attrib1
- The source attributeattrib2
- The destination attributeentry
- The entry to perform the copy onpublic boolean copyFilter(Filter currentFilter, java.util.Map<DirectoryString,DirectoryString> copies)
(&(givenName=first)(sn=last))
becomes (|(sn=last)(givenName=last))
copyGet
currentFilter
- The filter to work oncopies
- Map of copy source/copy target pairspublic void copyGet(DirectoryString attrib1, DirectoryString attrib2, java.util.Vector<DirectoryString> attributes, Filter filter)
attrib1
- source attributeattrib2
- target attributeattributes
- The search attribute request listfilter
- The search filterpublic void renameGet(java.util.Map<DirectoryString,DirectoryString> renames, java.util.Vector<DirectoryString> attributes, Filter filter)
renames
- source/target pairs of attribute namesattributes
- The list of requested attributesfilter
- The search filterpublic void renameModify(java.util.Map<DirectoryString,DirectoryString> renames, java.util.Vector<EntryChange> changeEntries)
renames
- source/target pairs of attribute nameschangeEntries
- The list of entry changespublic void renameAdd(java.util.Map<DirectoryString,DirectoryString> renames, Entry entry)
renames
- source/target pairs of attribute namesentry
- The entry to perform the rename onpublic void renameGet(DirectoryString attrib1, DirectoryString attrib2, java.util.Vector<DirectoryString> attributes)
attrib1
- Attribute to be renamedattrib2
- The name of the new attributeattributes
- The list of requested attributespublic void renameModify(DirectoryString attrib1, DirectoryString attrib2, java.util.Vector<EntryChange> changeEntries)
attrib1
- The source attributeattrib2
- The destination attributechangeEntries
- The entry change listpublic void renameAdd(DirectoryString attrib1, DirectoryString attrib2, Entry entry)
attrib1
- The source attributeattrib2
- The destination attributeentry
- The entry to perform the rename onpublic PluginUtil.MappingStatus renameFilter(Filter currentFilter, java.util.Map<DirectoryString,DirectoryString> renames)
(&(givenName=first)(sn=last))
becomes (sn=first)
currentFilter
- The filterrenames
- The source/target pairs to renamepublic void renameGet(DirectoryString attrib1, DirectoryString attrib2, java.util.Vector<DirectoryString> attributes, Filter filter)
attrib1
- The source attributeattrib2
- The destination attributeattributes
- The requested search attributesfilter
- The search filterpublic boolean removeFilter(Filter currentFilter, java.util.Set<DirectoryString> removes)
currentFilter
- The filter to remove the attribute fromremoves
- The list of attributes to removepublic void setRDNGet(Chain chain, DirectoryString currentName, DirectoryString old, DirectoryString name, Credentials creds) throws DirectoryException, ChainException, InvalidDNException
chain
- The current plugin chaincurrentName
- The current nameold
- The old rdn attributename
- The new rdn attributecreds
- The current credentialsDirectoryException
ChainException
InvalidDNException
public void setRDNRename(Chain chain, DirectoryString currentName, DirectoryString old, DirectoryString name, Credentials creds, DirectoryString newEntryName) throws ChainException, InvalidDNException, DirectoryException
chain
- The current plugin chaincurrentName
- The current nameold
- The old rdn attributename
- The new rdn attributecreds
- The current credentialsnewEntryName
- The new name of the entryChainException
InvalidDNException
DirectoryException
public void setRDNModify(Chain chain, DirectoryString currentName, DirectoryString old, DirectoryString name, Credentials creds) throws DirectoryException, ChainException, InvalidDNException
chain
- The current plugin chaincurrentName
- The current nameold
- The old rdn attributename
- The new rdn attributecreds
- The current credentialsDirectoryException
ChainException
InvalidDNException
public void setRDNEntry(Entry entry, DirectoryString oldRDNAttrType, DirectoryString newRDNAttrType) throws DirectoryException, InvalidDNException
entry
- The entry to changeoldRDNAttrType
- The old rdn attributenewRDNAttrType
- The new rdn attributeDirectoryException
InvalidDNException
public Filter createFilter(java.lang.String target, java.lang.String op, java.lang.String value) throws DirectoryException
target
- The attribute begin filteredop
- The comparatorvalue
- The value being comparedDirectoryException
public Filter createAndFilter(java.util.List<Filter> lparts)
lparts
- List of filter partspublic Filter createOrFilter(java.util.List<Filter> lparts)
lparts
- List of filter partspublic java.util.List<Filter> findFilters(DirectoryString target, Filter filter)
target
- The attribute being soughtfilter
- The filter to searchpublic void revalueAdd(DirectoryString attrib, Syntax currValue, Syntax newValue, Entry entry)
attrib
- The attribute to revaluecurrValue
- The sought valuenewValue
- The new valueentry
- The entry to perform onpublic void revalueModify(DirectoryString attrib, Syntax currValue, Syntax newValue, java.util.Vector<EntryChange> changes)
attrib
- The attribute to revaluecurrValue
- The sought valuenewValue
- The new valuechanges
- List of entry changespublic void revalueGet(DirectoryString attrib, Syntax currValue, Syntax newValue, Filter filter)
attrib
- The attribute to revaluecurrValue
- The sought valuenewValue
- The new valuefilter
- The filter to perform onpublic Syntax mapSyntax(Syntax value, java.lang.String syntax) throws ChainException
value
- The value to mapsyntax
- One of the allowed syntaxs: BinarySyntax,DirectoryString,IA5String,InegerSyntaxChainException
public DirectoryString convertBase(DirectoryString base, DirectoryString origBase, DirectoryString newBase)
base
- The value to convertorigBase
- The original basenewBase
- The new basepublic void converBaseEntry(Entry entry, java.util.Set<DirectoryString> attribs, DirectoryString oldBase, DirectoryString newBase)
entry
- Entry to perform onattribs
- Attributes to convertoldBase
- The original basenewBase
- The new basepublic void converBaseEntry(Entry entry, DirectoryString attrib, DirectoryString oldBase, DirectoryString newBase)
entry
- Entry to perform onattrib
- Attribute to convertoldBase
- The original basenewBase
- The new basepublic void convertBaseModify(java.util.Vector<EntryChange> changeEntries, java.util.Set<DirectoryString> attribs, DirectoryString oldBase, DirectoryString newBase)
changeEntries
- List of entry changesattribs
- Attributes to convertoldBase
- The original basenewBase
- The new basepublic void convertBaseModify(java.util.Vector<EntryChange> changeEntries, DirectoryString attrib, DirectoryString oldBase, DirectoryString newBase)
changeEntries
- List of entry changesattrib
- Attribute to convertoldBase
- The original basenewBase
- The new basepublic void convertFilterBase(Filter currentFilter, DirectoryString base, DirectoryString newBase, java.util.Set<DirectoryString> dnattrlist)
currentFilter
- filter to convertbase
- Base to be convertednewBase
- The new basednattrlist
- Set of attributes to be converted
|
Oracle Virtual Directory Java API Reference 11g Release 1 (11.1.1) E10688-03 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |