|
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.Entry
public class Entry
The Entry class represents an LDAP entry in Java.
Constructor Summary | |
---|---|
Entry() Creates a new Entry instance. |
|
Entry(byte[] entryBytes) Creates a new Entry instance. |
|
Entry(DirectoryString name) Creates a new Entry instance with the specified DN |
|
Entry(Entry entry) Creates a new Entry instance. |
|
Entry(Entry entry, boolean recreateName) Creates a new Entry instance., re-creating the dn from scratch |
Method Summary | |
---|---|
void |
clear() Cleans up the reference resources not being used anymore |
java.lang.Object |
clone() Creates an exact copy of this entry that can be changed without affecting the original entry. |
boolean |
containsKey(DirectoryString attributeType) Checks to see whether this entry contains a particular attribute type. |
java.util.Vector<Syntax> |
get(DirectoryString attributeType) Retrieves the value(s) associated with a particular attribute type. |
java.util.Collection<Attribute> |
getAllAttributes() |
byte[] |
getAsByteArray() Retrieves the contents of this entry as a byte array. |
java.util.Vector<Attribute> |
getAttributes() Deprecated. |
DirectoryString |
getBase() Retrieve the entry immediately above this entry in the directory tree. |
int |
getID() Retrieve the id of this entry. |
DirectoryString |
getName() Retrieve the distinguished name of this entry |
boolean |
isReturnEntry() Determines if the entry should be returned to the client |
java.util.Enumeration<DirectoryString> |
keys() Returns an enumeration of all attribute types available in this entry |
void |
put(DirectoryString attributeType, java.util.Vector<? extends Syntax> values) Replaces/Adds one or more values to this entry |
void |
put(DirectoryString attributeType, java.util.Vector<? extends Syntax> values, boolean checkExist) A version of the put method that allows a bypass of checking for the previous existence of the specified attribute type. |
void |
readFrom(Entry entry) Required for the new chain system to allow Entry objects to take the value of another Entry without creating a new reference |
void |
remove(DirectoryString attributeType) Removes the specified attribute type from this entry |
static DirectoryString |
removeLangTag(DirectoryString attribute) |
void |
setAttributes(java.util.Collection<Attribute> attributeList) |
void |
setBase(DirectoryString base) Set the entry immediately above this entry in the directory tree |
void |
setID(int id) Set the id number of this entry |
void |
setName(DirectoryString name) Set the distinguished name of this entry |
void |
setName(DirectoryString name, boolean bypassConstruct) Set the distinguished name of the entry with an option for bypassing the normalization step. |
void |
setReturnAttrs(java.util.List<DirectoryString> returnAttrs) |
void |
setReturnEntry(boolean returnEntry) Set to determine if the entry should be returned to the client |
int |
size() |
org.w3c.dom.Element |
toDOM(org.w3c.dom.Document doc) |
java.lang.String |
toLDIF() Retrieve a string containing an LDIF representation of this entry |
java.lang.String |
toLDIF(boolean toMaskPassword) |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public Entry()
Entry
instance.public Entry(byte[] entryBytes)
Entry
instance.
entryBytes
- a byte array representation of an Entry object. Can be generated by getAsByteArray
.public Entry(Entry entry)
Entry
instance.
entry
- another object of the Entry
classpublic Entry(Entry entry, boolean recreateName)
Entry
instance., re-creating the dn from scratch
entry
- another object of the Entry
classpublic Entry(DirectoryString name) throws InvalidDNException
Entry
instance with the specified DN
name
- a DirectoryString
value representing the entry's distinguished nameInvalidDNException
- if the entry name provided is invalidMethod Detail |
---|
@Deprecated
public java.util.Vector<Attribute> getAttributes()
Vector
of all attributes available in this entrypublic java.util.Collection<Attribute> getAllAttributes()
public void setAttributes(java.util.Collection<Attribute> attributeList)
public DirectoryString getBase()
DirectoryString
public void setBase(DirectoryString base) throws InvalidDNException
base
- a DirectoryString
value containing the distinguished name of the entry's baseInvalidDNException
public DirectoryString getName()
DirectoryString
value containing the DNpublic void setName(DirectoryString name) throws InvalidDNException
name
- a DirectoryString
value containing a DNInvalidDNException
- if the entry name is invalidpublic void setName(DirectoryString name, boolean bypassConstruct) throws InvalidDNException
name
- a DirectoryString
value containing the DNbypassConstruct
- true if the construction/normalization process should be bypassedInvalidDNException
- should never be thrown by this version of the methodpublic java.lang.Object clone()
clone
in class java.lang.Object
public boolean containsKey(DirectoryString attributeType)
attributeType
- a DirectoryString
value containing an attribute type to checkpublic java.util.Vector<Syntax> get(DirectoryString attributeType)
attributeType
- a DirectoryString
value representing the attribute we want to retrieveVector
of values, with each element encoded as an object of a class that implements the Syntax interfacepublic byte[] getAsByteArray()
public int getID()
public java.util.Enumeration<DirectoryString> keys()
Enumeration
of the attribute types this entry contains.public void put(DirectoryString attributeType, java.util.Vector<? extends Syntax> values)
attributeType
- a DirectoryString
containing the name of the attribute type whose values will be replaced.values
- a List
of all the values this attribute contains. Each element in the vector is an instance of a class implementing the Syntax interface.public void put(DirectoryString attributeType, java.util.Vector<? extends Syntax> values, boolean checkExist)
attributeType
- a DirectoryString
value containing the attribute type to be changed.values
- a List
containing the values of this attribute.checkExist
- true if we should check for the previous existence of this attribute type within the entrypublic void remove(DirectoryString attributeType)
attributeType
- the attribute type to be removedpublic void setID(int id)
id
- an id number to associate with this entry. Can be arbitrarily assigned by an adapter for internal use.public org.w3c.dom.Element toDOM(org.w3c.dom.Document doc)
public java.lang.String toLDIF()
public java.lang.String toLDIF(boolean toMaskPassword)
public void readFrom(Entry entry)
entry
- The entry to be clonedpublic int size()
public boolean isReturnEntry()
public void setReturnEntry(boolean returnEntry)
returnEntry
- The returnEntry to set.public void setReturnAttrs(java.util.List<DirectoryString> returnAttrs)
returnAttrs
- a list of DirectoryString attribute names that are to be returned. Attributes in the current entry that are not in the returnAttrNames list are removed.public void clear()
public static DirectoryString removeLangTag(DirectoryString attribute)
|
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 |