Constructor and Description |
---|
Branch(TemplateFile templateFile,
org.forgerock.opendj.ldap.Dn branchDN)
Creates a new branch with the provided information.
|
Modifier and Type | Method and Description |
---|---|
void |
addExtraLine(TemplateLine line)
Adds the provided template line to the set of extra lines for this branch.
|
void |
addSubordinateTemplate(String name,
int numEntries)
Adds a new subordinate template to this branch.
|
void |
completeBranchInitialization(Map<String,Template> templates)
Performs any necessary processing to ensure that the branch initialization
is completed.
|
org.forgerock.opendj.ldap.Dn |
getBranchDN()
Retrieves the DN for this branch entry.
|
TemplateLine[] |
getExtraLines()
Retrieves the set of extra lines that should be included in this branch
entry.
|
int[] |
getNumEntriesPerTemplate()
Retrieves the number of entries that should be created below this branch
for each subordinate template.
|
String[] |
getSubordinateTemplateNames()
Retrieves the names of the subordinate templates for this branch.
|
Template[] |
getSubordinateTemplates()
Retrieves the set of subordinate templates used to generate entries below
this branch.
|
boolean |
hasAttribute(org.forgerock.opendj.ldap.schema.AttributeType attributeType)
Indicates whether this branch contains a reference to the specified
attribute type, either in the RDN components of the DN or in the extra
lines.
|
TagResult |
writeEntries(EntryWriter entryWriter)
Writes the entry for this branch, as well as all appropriate subordinate
entries.
|
public Branch(TemplateFile templateFile, org.forgerock.opendj.ldap.Dn branchDN)
templateFile
- The template file in which this branch appears.branchDN
- The DN for this branch entry.public void completeBranchInitialization(Map<String,Template> templates) throws MakeLDIFException
templates
- The set of templates defined in the template file.MakeLDIFException
- If any of the subordinate templates are not
defined in the template file.public org.forgerock.opendj.ldap.Dn getBranchDN()
public String[] getSubordinateTemplateNames()
public Template[] getSubordinateTemplates()
completeBranchInitialization
method has been called.public int[] getNumEntriesPerTemplate()
public void addSubordinateTemplate(String name, int numEntries)
completeBranchInitialization
has been called.name
- The name of the template to use to generate the
entries.numEntries
- The number of entries to create based on the template.public TemplateLine[] getExtraLines()
public void addExtraLine(TemplateLine line)
line
- The line to add to the set of extra lines for this branch.public boolean hasAttribute(org.forgerock.opendj.ldap.schema.AttributeType attributeType)
attributeType
- The attribute type for which to make the
determination.true
if the branch does contain the specified
attribute type, or false
if it does not.public TagResult writeEntries(EntryWriter entryWriter) throws IOException, MakeLDIFException
entryWriter
- The entry writer to which the entries should be
written.IOException
- If a problem occurs while attempting to write to the
LDIF writer.MakeLDIFException
- If some other problem occurs.Copyright © 2010-2017 ForgeRock AS. All Rights Reserved.