public static final class DITContentRule.Builder extends Object
Modifier and Type | Method and Description |
---|---|
SchemaBuilder |
addToSchema()
Adds this DIT content rule to the schema, throwing a
ConflictingSchemaElementException if there is an existing DIT
content rule with the same structural object class OID. |
SchemaBuilder |
addToSchemaOverwrite()
Adds this DIT content rule to the schema overwriting any existing
content rule with the same structural class OID.
|
DITContentRule.Builder |
auxiliaryObjectClasses(Collection<String> objectClassNamesOrOIDs)
Adds the provided auxiliary classes to the list of auxiliary object
classes that entries subject to this DIT content rule may belong to.
|
DITContentRule.Builder |
auxiliaryObjectClasses(String... objectClassNamesOrOIDs)
Adds the provided auxiliary classes to the list of auxiliary object
classes that entries subject to this DIT content rule may belong to.
|
DITContentRule.Builder |
description(String description)
Sets the description.
|
DITContentRule.Builder |
extraProperties(Map<String,List<String>> extraProperties)
Adds the provided collection of extended properties.
|
T |
extraProperties(String extensionName,
List<String> extensionValues)
Adds the provided extended property.
|
DITContentRule.Builder |
extraProperties(String extensionName,
String... extensionValues)
Adds the provided extended property.
|
DITContentRule.Builder |
names(Collection<String> names)
Adds the provided user friendly names.
|
DITContentRule.Builder |
names(String... names)
Adds the provided user friendly names.
|
DITContentRule.Builder |
obsolete(boolean isObsolete)
Specifies whether this schema element is obsolete.
|
DITContentRule.Builder |
optionalAttributes(Collection<String> attributeNamesOrOIDs)
Adds the provided optional attributes to the list of attribute types
that entries subject to this DIT content rule may contain.
|
DITContentRule.Builder |
optionalAttributes(String... attributeNamesOrOIDs)
Adds the provided optional attributes to the list of attribute types
that entries subject to this DIT content rule may contain.
|
DITContentRule.Builder |
prohibitedAttributes(Collection<String> attributeNamesOrOIDs)
Adds the provided prohibited attributes to the list of attribute types
that entries subject to this DIT content rule must not contain.
|
DITContentRule.Builder |
prohibitedAttributes(String... attributeNamesOrOIDs)
Adds the provided prohibited attributes to the list of attribute types
that entries subject to this DIT content rule must not contain.
|
DITContentRule.Builder |
removeAllAuxiliaryObjectClasses()
Clears the list of auxiliary object classes that entries subject to
this DIT content rule may belong to.
|
DITContentRule.Builder |
removeAllExtraProperties()
Removes all extra properties.
|
DITContentRule.Builder |
removeAllNames()
Removes all user defined names.
|
DITContentRule.Builder |
removeAllOptionalAttributes()
Clears the list of attribute types that entries subject to this DIT
content rule may contain.
|
DITContentRule.Builder |
removeAllProhibitedAttributes()
Clears the list of attribute types that entries subject to this DIT
content rule must not contain.
|
DITContentRule.Builder |
removeAllRequiredAttributes()
Clears the list of attribute types that entries subject to this DIT
content rule must contain.
|
DITContentRule.Builder |
removeAuxiliaryObjectClass(String objectClassNameOrOID)
Removes the provided object class in the list of auxiliary object classes that entries subject to
this DIT content rule may belong to.
|
DITContentRule.Builder |
removeExtraProperty(String extensionName,
String... extensionValues)
Removes the specified extended property.
|
DITContentRule.Builder |
removeName(String name)
Removes the provided user defined name.
|
DITContentRule.Builder |
removeOptionalAttribute(String attributeNameOrOID)
Removes the provided optional attribute in the list of attribute
types that entries subject to this DIT content rule may contain.
|
DITContentRule.Builder |
removeProhibitedAttribute(String attributeNameOrOID)
Removes the provided prohibited attribute in the list of attribute
types that entries subject to this DIT content rule must not contain.
|
DITContentRule.Builder |
removeRequiredAttribute(String attributeNameOrOID)
Removes the provided required attribute in the list of attribute
types that entries subject to this DIT content rule must contain.
|
DITContentRule.Builder |
requiredAttributes(Collection<String> attributeNamesOrOIDs)
Adds the provided attribute to the list of attribute types that
entries subject to this DIT content rule must contain.
|
DITContentRule.Builder |
requiredAttributes(String... attributeNamesOrOIDs)
Adds the provided attribute to the list of attribute types that
entries subject to this DIT content rule must contain.
|
DITContentRule.Builder |
structuralClassOID(String strucuralClassOID)
Sets the structural class OID which uniquely identifies this DIT
content rule.
|
public SchemaBuilder addToSchema()
ConflictingSchemaElementException
if there is an existing DIT
content rule with the same structural object class OID.ConflictingSchemaElementException
- If there is an existing DIT content rule with the same
structural object class OID.public SchemaBuilder addToSchemaOverwrite()
public DITContentRule.Builder auxiliaryObjectClasses(Collection<String> objectClassNamesOrOIDs)
objectClassNamesOrOIDs
- The list of auxiliary class names or OIDs.public DITContentRule.Builder auxiliaryObjectClasses(String... objectClassNamesOrOIDs)
objectClassNamesOrOIDs
- The list of auxiliary class names or OIDs.public DITContentRule.Builder description(String description)
description
- The description, which may be null
in which case
the empty string will be used.public DITContentRule.Builder extraProperties(Map<String,List<String>> extraProperties)
extraProperties
- The collection of extended properties.public DITContentRule.Builder extraProperties(String extensionName, String... extensionValues)
extensionName
- The name of the extended property.extensionValues
- The optional list of values for the extended property.public DITContentRule.Builder names(Collection<String> names)
names
- The user friendly names.public DITContentRule.Builder names(String... names)
names
- The user friendly names.public DITContentRule.Builder obsolete(boolean isObsolete)
isObsolete
- true
if this schema element is obsolete (default
is false
).public DITContentRule.Builder optionalAttributes(Collection<String> attributeNamesOrOIDs)
attributeNamesOrOIDs
- The list of optional attribute names or OIDs.public DITContentRule.Builder optionalAttributes(String... attributeNamesOrOIDs)
attributeNamesOrOIDs
- The list of optional attribute names or OIDs.public DITContentRule.Builder prohibitedAttributes(Collection<String> attributeNamesOrOIDs)
attributeNamesOrOIDs
- The list of prohibited attribute names or OIDs.public DITContentRule.Builder prohibitedAttributes(String... attributeNamesOrOIDs)
attributeNamesOrOIDs
- The list of prohibited attribute names or OIDs.public DITContentRule.Builder removeAllAuxiliaryObjectClasses()
public DITContentRule.Builder removeAllExtraProperties()
public DITContentRule.Builder removeAllNames()
public DITContentRule.Builder removeAllOptionalAttributes()
public DITContentRule.Builder removeAllProhibitedAttributes()
public DITContentRule.Builder removeAllRequiredAttributes()
public DITContentRule.Builder removeAuxiliaryObjectClass(String objectClassNameOrOID)
objectClassNameOrOID
- The auxiliary object class name or OID to be removed.public DITContentRule.Builder removeExtraProperty(String extensionName, String... extensionValues)
extensionName
- The name of the extended property.extensionValues
- The optional list of values for the extended property,
which may be empty indicating that the entire property
should be removed.public DITContentRule.Builder removeName(String name)
name
- The user defined name to be removed.public DITContentRule.Builder removeOptionalAttribute(String attributeNameOrOID)
attributeNameOrOID
- The optional attribute name or OID to be removed.public DITContentRule.Builder removeProhibitedAttribute(String attributeNameOrOID)
attributeNameOrOID
- The prohibited attribute name or OID to be removed.public DITContentRule.Builder removeRequiredAttribute(String attributeNameOrOID)
attributeNameOrOID
- The provided required attribute name or OID to be removed.public DITContentRule.Builder requiredAttributes(Collection<String> attributeNamesOrOIDs)
attributeNamesOrOIDs
- The list of required attribute names or OIDs.public DITContentRule.Builder requiredAttributes(String... attributeNamesOrOIDs)
attributeNamesOrOIDs
- The list of required attribute names or OIDs.public DITContentRule.Builder structuralClassOID(String strucuralClassOID)
strucuralClassOID
- The numeric OID.public T extraProperties(String extensionName, List<String> extensionValues)
extensionName
- The name of the extended property.extensionValues
- The optional list of values for the extended property.Copyright 2010-2017 ForgeRock AS.