Package org.opends.server.types

Class SubEntry

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	Description
static class	SubEntry.CollectiveConflictBehavior	Defines the set of permissible values for the conflict behavior.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	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.
DN	getDN()	Retrieves the distinguished name for this subentry.
Entry	getEntry()	Getter to retrieve the actual entry object for this subentry.
DN	getInheritFromBaseDN()	Getter to retrieve inheritFromBaseRDN DN for inherited collective attribute subentry.
ByteString	getInheritFromDNAttrValue()	Getter to retrieve inheritFromDNAttribute value for inherited collective attribute subentry.
AttributeType	getInheritFromDNType()	Getter to retrieve inheritFromDNAttribute type for inherited collective attribute subentry.
AttributeType	getInheritFromRDNAttrType()	Getter to retrieve inheritFromRDNAttribute type for inherited collective attribute subentry.
ByteString	getInheritFromRDNAttrValue()	Getter to retrieve inheritFromRDNAttribute value for inherited collective attribute subentry.
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

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 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 AttributeType getInheritFromDNType()

Getter to retrieve inheritFromDNAttribute type for inherited collective attribute subentry.

Returns:

Type of inheritFromDNAttribute, or null if there is none.

getInheritFromRDNAttrType

public AttributeType getInheritFromRDNAttrType()

Getter to retrieve inheritFromRDNAttribute type for inherited collective attribute subentry.

Returns:

Type of inheritFromRDNAttribute, or null if there is none.

getInheritFromRDNAttrValue

public ByteString getInheritFromRDNAttrValue()

Getter to retrieve inheritFromRDNAttribute value for inherited collective attribute subentry.

Returns:

ByteString of inheritFromRDNAttribute, or null if there is none.

getInheritFromRDNType

public 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 ByteString getInheritFromDNAttrValue()

Getter to retrieve inheritFromDNAttribute value for inherited collective attribute subentry.

Returns:

ByteString of inheritFromDNAttribute, or null if there is none.

getInheritFromBaseDN

public 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