org.opends.guitools.controlpanel.ui.nodes

Interface BrowserNodeInfo

public interface BrowserNodeInfo

Interface used in the LDAP entries browser code to deal with entries.

Field Summary

Fields

Modifier and Type	Field and Description
static int	ERROR_NONE No error happened.
static int	ERROR_READING_ENTRY And error reading the entry occurred.
static int	ERROR_SEARCHING_CHILDREN An error occurred searching the children of the entry.
static int	ERROR_SOLVING_REFERRAL An error following referrals occurred.

Method Summary

Methods

Modifier and Type	Method and Description
Object	getErrorArg() Returns the argument associated to an error/exception.
Exception	getErrorException() Returns the exception associated to the error.
int	getErrorType() Returns the error detected while reading this entry.
BasicNode	getNode() Returns the basic node associated with the node info.
int	getNumSubOrdinates() Returns the value of numsubordinates for the entry.
String[]	getObjectClassValues() Returns the object class value of the entry that the nodes represents.
String[]	getReferral() Returns the referrals attached to the displayed entry.
TreePath	getTreePath() Returns the TreePath corresponding to the displayed entry.
LDAPURL	getURL() URL of the displayed entry.
boolean	hasSubOrdinates() Returns the value of hassubordinates for the entry.
boolean	isRemote() Returns true if the displayed entry is not located on the current server.
boolean	isRootNode() Returns true if the displayed entry is the root node of the server (the dn="" entry) and false otherwise.
boolean	isSuffix() Returns true if the displayed entry is the top entry of a suffix and false otherwise.
boolean	representsSameNode(BrowserNodeInfo node) Tells whether the node passed as parameter represents the same node as this one.

Field Detail

ERROR_NONE

static final int ERROR_NONE

No error happened.

See Also:

Constant Field Values

ERROR_READING_ENTRY

static final int ERROR_READING_ENTRY

And error reading the entry occurred.

See Also:

Constant Field Values

ERROR_SOLVING_REFERRAL

static final int ERROR_SOLVING_REFERRAL

An error following referrals occurred.

See Also:

Constant Field Values

ERROR_SEARCHING_CHILDREN

static final int ERROR_SEARCHING_CHILDREN

An error occurred searching the children of the entry.

See Also:

Constant Field Values

Method Detail

getURL

LDAPURL getURL()

URL of the displayed entry.

Returns:

the URL of the displayed entry.

isSuffix

boolean isSuffix()

Returns true if the displayed entry is the top entry of a suffix and false otherwise.

Returns:

true if the displayed entry is the top entry of a suffix and false otherwise.

isRootNode

boolean isRootNode()

Returns true if the displayed entry is the root node of the server (the dn="" entry) and false otherwise.

Returns:

true if the displayed entry is the root node of the server (the dn="" entry) and false otherwise.

isRemote

boolean isRemote()

Returns true if the displayed entry is not located on the current server. An entry is declared 'remote' when the host/port of getURL() is different from the host/port of the DirContext associated to the browser controller. Returns false otherwise.

Returns:

true if the displayed entry is not located on the current server. An entry is declared 'remote' when the host/port of getURL() is different from the host/port of the DirContext associated to the browser controller. Returns false otherwise.

getNumSubOrdinates

int getNumSubOrdinates()

Returns the value of numsubordinates for the entry. -1 if the numsubordinates attribute is not defined.

Returns:

the value of numsubordinates for the entry.

hasSubOrdinates

boolean hasSubOrdinates()

Returns the value of hassubordinates for the entry.

Returns:

the value of hassubordinates for the entry.

getReferral

String[] getReferral()

Returns the referrals attached to the displayed entry. This is the value of the 'ref' attribute. Returns null if the attribute is not present.

Returns:

the referrals attached to the displayed entry.

getErrorType

int getErrorType()

Returns the error detected while reading this entry.

Returns:

the error detected while reading this entry.

getErrorException

Exception getErrorException()

Returns the exception associated to the error. Returns null if getErrorType() == ERROR_NONE.

Returns:

the exception associated to the error.

getErrorArg

Object getErrorArg()

Returns the argument associated to an error/exception. Always null except when errorType == ERROR_SOLVING_REFERRAL, errorArg contains the String representing the faulty LDAP URL.

Returns:

the argument associated to an error/exception.

getNode

BasicNode getNode()

Returns the basic node associated with the node info.

Returns:

the basic node associated with the node info.

getTreePath

TreePath getTreePath()

Returns the TreePath corresponding to the displayed entry.

Returns:

the TreePath corresponding to the displayed entry.

representsSameNode

boolean representsSameNode(BrowserNodeInfo node)

Tells whether the node passed as parameter represents the same node as this one.

Parameters:

node - the node.

Returns:

true if the node passed as parameter represents the same node as this one and false otherwise.

getObjectClassValues

String[] getObjectClassValues()

Returns the object class value of the entry that the nodes represents.

Returns:

the object class value of the entry that the nodes represents.