org.opends.guitools.controlpanel.browser

Class NodeRefresher

java.lang.Object

org.opends.guitools.controlpanel.browser.AbstractNodeTask

org.opends.guitools.controlpanel.browser.NodeRefresher

All Implemented Interfaces:

Runnable

public class NodeRefresher
extends AbstractNodeTask

The class that is in charge of doing the LDAP searches required to update a node: search the local entry, detect if it has children, retrieve the attributes required to render the node, etc.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	NodeRefresher.State The enumeration containing all the states the refresher can have.

Method Summary

Modifier and Type	Method and Description
List<org.forgerock.opendj.ldap.responses.SearchResultEntry>	getChildEntries() Returns the child entries of the node.
org.forgerock.opendj.ldap.responses.SearchResultEntry	getDisplayedEntry() Returns the displayed entry in the browser.
LDAPURL	getDisplayedUrl() Returns the LDAP URL of the displayed entry in the browser.
Exception	getException() Returns the exception that occurred during the processing.
Object	getExceptionArg() Returns the argument of the exception that occurred during the processing.
org.forgerock.opendj.ldap.responses.SearchResultEntry	getLocalEntry() Returns the local entry the refresher is handling.
org.forgerock.opendj.ldap.responses.SearchResultEntry	getRemoteEntry() Returns the remote entry for the node.
LDAPURL	getRemoteUrl() Returns the URL of the remote entry.
boolean	isDifferential() Returns whether this refresher object is working on differential mode or not.
boolean	isInFinalState() Returns whether the refresh is over or not.
boolean	isLeafNode() Tells whether the node is a leaf or not.
void	run() The method that actually does the refresh.

Methods inherited from class org.opends.guitools.controlpanel.browser.AbstractNodeTask

cancel, getNode, isCanceled

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getLocalEntry

public org.forgerock.opendj.ldap.responses.SearchResultEntry getLocalEntry()

Returns the local entry the refresher is handling.

Returns:

the local entry the refresher is handling.

getRemoteEntry

public org.forgerock.opendj.ldap.responses.SearchResultEntry getRemoteEntry()

Returns the remote entry for the node. It will be null if the entry is not a referral.

Returns:

the remote entry for the node.

getRemoteUrl

public LDAPURL getRemoteUrl()

Returns the URL of the remote entry. It will be null if the entry is not a referral.

Returns:

the URL of the remote entry.

isLeafNode

public boolean isLeafNode()

Tells whether the node is a leaf or not.

Returns:

true if the node is a leaf and false otherwise.

getChildEntries

public List<org.forgerock.opendj.ldap.responses.SearchResultEntry> getChildEntries()

Returns the child entries of the node.

Returns:

the child entries of the node.

isDifferential

public boolean isDifferential()

Returns whether this refresher object is working on differential mode or not.

Returns:

true if the refresher is working on differential mode and false otherwise.

getException

public Exception getException()

Returns the exception that occurred during the processing. It returns null if no exception occurred.

Returns:

the exception that occurred during the processing.

getExceptionArg

public Object getExceptionArg()

Returns the argument of the exception that occurred during the processing. It returns null if no exception occurred or if the exception has no arguments.

Returns:

the argument exception that occurred during the processing.

getDisplayedEntry

public org.forgerock.opendj.ldap.responses.SearchResultEntry getDisplayedEntry()

Returns the displayed entry in the browser. This depends on the visualization options in the BrowserController.

Returns:

the remote entry if the entry is a referral and the BrowserController is following referrals and the local entry otherwise.

getDisplayedUrl

public LDAPURL getDisplayedUrl()

Returns the LDAP URL of the displayed entry in the browser. This depends on the visualization options in the BrowserController.

Returns:

the remote entry LDAP URL if the entry is a referral and the BrowserController is following referrals and the local entry LDAP URL otherwise.

isInFinalState

public boolean isInFinalState()

Returns whether the refresh is over or not.

Returns:

true if the refresh is over and false otherwise.

run

public void run()

The method that actually does the refresh.

Specified by:

run in interface Runnable

Specified by:

run in class AbstractNodeTask