org.forgerock.opendj.config

Class AdministratorAction

java.lang.Object

org.forgerock.opendj.config.AdministratorAction

public final class AdministratorAction
extends Object

Defines an optional action which administators must perform after they have modified a property. By default modifications to properties are assumed to take effect immediately and require no additional administrative action. Developers should be aware that, where feasible, they should implement components such that property modifications require no additional administrative action. This is required in order to minimize server downtime during administration and provide a more user-friendly experience.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AdministratorAction.Type Specifies the type of administrator action which must be performed in order for pending changes to take effect.

Constructor Summary

Constructors

Constructor and Description
AdministratorAction(AdministratorAction.Type type, AbstractManagedObjectDefinition<?,?> d, String propertyName) Create a new administrator action.

Method Summary

Modifier and Type	Method and Description
LocalizableMessage	getSynopsis() Gets the synopsis of this administrator action in the default locale.
LocalizableMessage	getSynopsis(Locale locale) Gets the synopsis of this administrator action in the specified locale.
AdministratorAction.Type	getType() Gets the type of this administrator action.

Methods inherited from class java.lang.Object

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

Constructor Detail

AdministratorAction

public AdministratorAction(AdministratorAction.Type type,
                           AbstractManagedObjectDefinition<?,?> d,
                           String propertyName)

Create a new administrator action.

Parameters:

type - The type of this administration action.

d - The managed object definition associated with this administrator action.

propertyName - The name of the property definition associated with this administrator action.

Method Detail

getSynopsis

public final LocalizableMessage getSynopsis()

Gets the synopsis of this administrator action in the default locale.

Returns:

Returns the synopsis of this administrator action in the default locale, or null if there is no synopsis defined.

getSynopsis

public final LocalizableMessage getSynopsis(Locale locale)

Gets the synopsis of this administrator action in the specified locale.

Parameters:

locale - The locale.

Returns:

Returns the synopsis of this administrator action in the specified locale, or null if there is no synopsis defined.

getType

public final AdministratorAction.Type getType()

Gets the type of this administrator action.

Returns:

Returns the type of this administrator action.