SubEntry (Gluu-OpenDJ 3.0.0.1.gluu-SNAPSHOT Documentation)

java.lang.Object
- org.opends.server.types.SubEntry

```
public class SubEntry
extends Object
```
This class represents RFC 3672 subentries and RFC 3671 collective attribute subentries objects.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class SubEntry.CollectiveConflictBehavior
Defines the set of permissible values for the conflict behavior.

Nested Classes
Modifier and Type	Class and Description
`static class`	`SubEntry.CollectiveConflictBehavior` Defines the set of permissible values for the conflict behavior.

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`ATTR_COLLECTIVE_CONFLICT_BEHAVIOR_LC` The lowercased name of the "collectiveConflictBehavior" attribute type.
`static String`	`ATTR_INHERIT_COLLECTIVE_ATTR_LC` The lowercased name of the "inheritAttribute" attribute type.
`static String`	`ATTR_INHERIT_COLLECTIVE_FROM_BASE_LC` The lowercased name of the "inheritFromBaseRDN" attribute type.
`static String`	`ATTR_INHERIT_COLLECTIVE_FROM_DN_LC` The lowercased name of the "inheritFromDNAttribute" attribute type.
`static String`	`ATTR_INHERIT_COLLECTIVE_FROM_RDN_LC` The lowercased name of the "inheritFromRDNAttribute" attribute type.
`static String`	`ATTR_INHERIT_COLLECTIVE_FROM_RDN_TYPE_LC` The lowercased name of the "inheritFromRDNType" attribute type.

Constructor Summary

Constructors
Constructor and Description

SubEntry(Entry entry)
Constructs a subentry object from a given entry object.

Constructors
Constructor and Description
`SubEntry(Entry entry)` Constructs a subentry object from a given entry object.

Method Summary

Methods
Modifier and Type	Method and Description
`List<Attribute>`	`getCollectiveAttributes()` Getter for collective attributes contained within this subentry.
`SubEntry.CollectiveConflictBehavior`	`getConflictBehavior()` Getter for collective conflict behavior defined for this collective attributes subentry.
`org.forgerock.opendj.ldap.DN`	`getDN()` Retrieves the distinguished name for this subentry.
`Entry`	`getEntry()` Getter to retrieve the actual entry object for this subentry.
`org.forgerock.opendj.ldap.DN`	`getInheritFromBaseDN()` Getter to retrieve inheritFromBaseRDN DN for inherited collective attribute subentry.
`org.forgerock.opendj.ldap.ByteString`	`getInheritFromDNAttrValue()` Getter to retrieve inheritFromDNAttribute value for inherited collective attribute subentry.
`org.forgerock.opendj.ldap.schema.AttributeType`	`getInheritFromDNType()` Getter to retrieve inheritFromDNAttribute type for inherited collective attribute subentry.
`org.forgerock.opendj.ldap.schema.AttributeType`	`getInheritFromRDNAttrType()` Getter to retrieve inheritFromRDNAttribute type for inherited collective attribute subentry.
`org.forgerock.opendj.ldap.ByteString`	`getInheritFromRDNAttrValue()` Getter to retrieve inheritFromRDNAttribute value for inherited collective attribute subentry.
`org.forgerock.opendj.ldap.schema.AttributeType`	`getInheritFromRDNType()` Getter to retrieve RDN type of inheritFromRDNType for inherited collective attribute subentry.
`SubtreeSpecification`	`getSubTreeSpecification()` Getter for subentry subtree specification.
`boolean`	`isCollective()` Indicates whether this subentry is a collective attribute subentry.
`boolean`	`isInheritedCollective()` Indicates whether this subentry is inherited collective attribute subentry.
`boolean`	`isInheritedFromDNCollective()` Indicates whether this subentry is inherited from DN collective attribute subentry.
`boolean`	`isInheritedFromRDNCollective()` Indicates whether this subentry is inherited from RDN collective attribute subentry.
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - ATTR_COLLECTIVE_CONFLICT_BEHAVIOR_LC
```
public static final String ATTR_COLLECTIVE_CONFLICT_BEHAVIOR_LC
```
    The lowercased name of the "collectiveConflictBehavior" attribute type.
    
    See Also:
    Constant Field Values
  - ATTR_INHERIT_COLLECTIVE_FROM_DN_LC
```
public static final String ATTR_INHERIT_COLLECTIVE_FROM_DN_LC
```
    The lowercased name of the "inheritFromDNAttribute" attribute type.
    
    See Also:
    Constant Field Values
  - ATTR_INHERIT_COLLECTIVE_FROM_RDN_LC
```
public static final String ATTR_INHERIT_COLLECTIVE_FROM_RDN_LC
```
    The lowercased name of the "inheritFromRDNAttribute" attribute type.
    
    See Also:
    Constant Field Values
  - ATTR_INHERIT_COLLECTIVE_FROM_RDN_TYPE_LC
```
public static final String ATTR_INHERIT_COLLECTIVE_FROM_RDN_TYPE_LC
```
    The lowercased name of the "inheritFromRDNType" attribute type.
    
    See Also:
    Constant Field Values
  - ATTR_INHERIT_COLLECTIVE_FROM_BASE_LC
```
public static final String ATTR_INHERIT_COLLECTIVE_FROM_BASE_LC
```
    The lowercased name of the "inheritFromBaseRDN" attribute type.
    
    See Also:
    Constant Field Values
  - ATTR_INHERIT_COLLECTIVE_ATTR_LC
```
public static final String ATTR_INHERIT_COLLECTIVE_ATTR_LC
```
    The lowercased name of the "inheritAttribute" attribute type.
    
    See Also:
    Constant Field Values
- Constructor Detail
  - SubEntry
```
public SubEntry(Entry entry)
         throws DirectoryException
```
    Constructs a subentry object from a given entry object.
    
    Parameters:
    entry - LDAP subentry to construct from.
    
    Throws:
    
    DirectoryException - if there is a problem with constructing a subentry from a given entry.
- Method Detail
  - getDN
```
public final org.forgerock.opendj.ldap.DN getDN()
```
    Retrieves the distinguished name for this subentry.
    
    Returns:
    The distinguished name for this subentry.
  - getEntry
```
public final Entry getEntry()
```
    Getter to retrieve the actual entry object for this subentry.
    
    Returns:
    entry object for this subentry.
  - isCollective
```
public boolean isCollective()
```
    Indicates whether this subentry is a collective attribute subentry.
    
    Returns:
    true if collective, false otherwise.
  - isInheritedCollective
```
public boolean isInheritedCollective()
```
    Indicates whether this subentry is inherited collective attribute subentry.
    
    Returns:
    true if inherited collective, false otherwise.
  - isInheritedFromDNCollective
```
public boolean isInheritedFromDNCollective()
```
    Indicates whether this subentry is inherited from DN collective attribute subentry.
    
    Returns:
    true if inherited from DN collective, false otherwise.
  - isInheritedFromRDNCollective
```
public boolean isInheritedFromRDNCollective()
```
    Indicates whether this subentry is inherited from RDN collective attribute subentry.
    
    Returns:
    true if inherited from RDN collective, false otherwise.
  - getInheritFromDNType
```
public org.forgerock.opendj.ldap.schema.AttributeType getInheritFromDNType()
```
    Getter to retrieve inheritFromDNAttribute type for inherited collective attribute subentry.
    
    Returns:
    Type of inheritFromDNAttribute, or null if there is none.
  - getInheritFromRDNAttrType
```
public org.forgerock.opendj.ldap.schema.AttributeType getInheritFromRDNAttrType()
```
    Getter to retrieve inheritFromRDNAttribute type for inherited collective attribute subentry.
    
    Returns:
    Type of inheritFromRDNAttribute, or null if there is none.
  - getInheritFromRDNAttrValue
```
public org.forgerock.opendj.ldap.ByteString getInheritFromRDNAttrValue()
```
    Getter to retrieve inheritFromRDNAttribute value for inherited collective attribute subentry.
    
    Returns:
    ByteString of inheritFromRDNAttribute, or null if there is none.
  - getInheritFromRDNType
```
public org.forgerock.opendj.ldap.schema.AttributeType getInheritFromRDNType()
```
    Getter to retrieve RDN type of inheritFromRDNType for inherited collective attribute subentry.
    
    Returns:
    RDN Type of inheritFromRDNAttribute, or null if there is none.
  - getInheritFromDNAttrValue
```
public org.forgerock.opendj.ldap.ByteString getInheritFromDNAttrValue()
```
    Getter to retrieve inheritFromDNAttribute value for inherited collective attribute subentry.
    
    Returns:
    ByteString of inheritFromDNAttribute, or null if there is none.
  - getInheritFromBaseDN
```
public org.forgerock.opendj.ldap.DN getInheritFromBaseDN()
```
    Getter to retrieve inheritFromBaseRDN DN for inherited collective attribute subentry.
    
    Returns:
    DN of inheritFromBaseRDN, or null if there is none.
  - getSubTreeSpecification
```
public SubtreeSpecification getSubTreeSpecification()
```
    Getter for subentry subtree specification.
    
    Returns:
    subtree specification for this subentry.
  - getCollectiveAttributes
```
public List<Attribute> getCollectiveAttributes()
```
    Getter for collective attributes contained within this subentry.
    
    Returns:
    collective attributes contained within this subentry.
  - getConflictBehavior
```
public SubEntry.CollectiveConflictBehavior getConflictBehavior()
```
    Getter for collective conflict behavior defined for this collective attributes subentry.
    
    Returns:
    conflict behavior for this collective attributes subentry.
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class SubEntry

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

ATTR_COLLECTIVE_CONFLICT_BEHAVIOR_LC

ATTR_INHERIT_COLLECTIVE_FROM_DN_LC

ATTR_INHERIT_COLLECTIVE_FROM_RDN_LC

ATTR_INHERIT_COLLECTIVE_FROM_RDN_TYPE_LC

ATTR_INHERIT_COLLECTIVE_FROM_BASE_LC

ATTR_INHERIT_COLLECTIVE_ATTR_LC

Constructor Detail

SubEntry

Method Detail

getDN

getEntry

isCollective

isInheritedCollective

isInheritedFromDNCollective

isInheritedFromRDNCollective

getInheritFromDNType

getInheritFromRDNAttrType

getInheritFromRDNAttrValue

getInheritFromRDNType

getInheritFromDNAttrValue

getInheritFromBaseDN

getSubTreeSpecification

getCollectiveAttributes

getConflictBehavior

toString