org.nuxeo.ecm.core.management.api
Interface AdministrativeStatusManager

All Known Implementing Classes:

AdministrativeStatusManagerImpl

public interface AdministrativeStatusManager

Service interface used to manage AdministrativeStatus of Nuxeo's services on a given Nuxeo Instance (node)

Author:

tiry

Field Summary

static String	ACTIVATED_EVENT
static String	ADMINISTRATIVE_EVENT_CATEGORY
static String	ADMINISTRATIVE_EVENT_INSTANCE
static String	ADMINISTRATIVE_EVENT_SERVICE
static String	ADMINISTRATIVE_INSTANCE_ID
static String	GLOBAL_INSTANCE_AVAILABILITY
static String	PASSIVATED_EVENT

Method Summary

AdministrativeStatus	activate(String serviceIdentifier, String message, String login) Mark a given resource as active.
AdministrativeStatus	activateNuxeoInstance(String message, String login) Mark local Nuxeo instance as active.
AdministrativeStatus	deactivate(String serviceIdentifier, String message, String login) Mark a given resource as non active.
AdministrativeStatus	deactivateNuxeoInstance(String message, String login) Mark local Nuxeo instance as non active.
List<AdministrativeStatus>	getAllStatuses() List AdministrativeStatus for all tracked resources (Servers or Services).
AdministrativeStatus	getNuxeoInstanceStatus() Get the AdministrativeStatus of a the local Nuxeo Instance.
AdministrativeStatus	getStatus(String serviceIdentifier) Get the AdministrativeStatus of a given resource.
AdministrativeStatus	setNuxeoInstanceStatus(String state, String message, String login) Sets the AdministrativeStatus of the Local Nuxeo Instance.
AdministrativeStatus	setStatus(String serviceIdentifier, String state, String message, String login) Sets the AdministrativeStatus of a given resource.

Field Detail

ADMINISTRATIVE_INSTANCE_ID

static final String ADMINISTRATIVE_INSTANCE_ID

See Also:

Constant Field Values

GLOBAL_INSTANCE_AVAILABILITY

static final String GLOBAL_INSTANCE_AVAILABILITY

See Also:

Constant Field Values

ADMINISTRATIVE_EVENT_CATEGORY

static final String ADMINISTRATIVE_EVENT_CATEGORY

See Also:

Constant Field Values

ADMINISTRATIVE_EVENT_INSTANCE

static final String ADMINISTRATIVE_EVENT_INSTANCE

See Also:

Constant Field Values

ADMINISTRATIVE_EVENT_SERVICE

static final String ADMINISTRATIVE_EVENT_SERVICE

See Also:

Constant Field Values

ACTIVATED_EVENT

static final String ACTIVATED_EVENT

See Also:

Constant Field Values

PASSIVATED_EVENT

static final String PASSIVATED_EVENT

See Also:

Constant Field Values

Method Detail

getAllStatuses

List<AdministrativeStatus> getAllStatuses()

List AdministrativeStatus for all tracked resources (Servers or Services).

getStatus

AdministrativeStatus getStatus(String serviceIdentifier)

Get the AdministrativeStatus of a given resource.

getNuxeoInstanceStatus

AdministrativeStatus getNuxeoInstanceStatus()

Get the AdministrativeStatus of a the local Nuxeo Instance.

setStatus

AdministrativeStatus setStatus(String serviceIdentifier,
                               String state,
                               String message,
                               String login)

Sets the AdministrativeStatus of a given resource.

setNuxeoInstanceStatus

AdministrativeStatus setNuxeoInstanceStatus(String state,
                                            String message,
                                            String login)

Sets the AdministrativeStatus of the Local Nuxeo Instance.

activate

AdministrativeStatus activate(String serviceIdentifier,
                              String message,
                              String login)

Mark a given resource as active.

activateNuxeoInstance

AdministrativeStatus activateNuxeoInstance(String message,
                                           String login)

Mark local Nuxeo instance as active.

deactivate

AdministrativeStatus deactivate(String serviceIdentifier,
                                String message,
                                String login)

Mark a given resource as non active.

deactivateNuxeoInstance

AdministrativeStatus deactivateNuxeoInstance(String message,
                                             String login)

Mark local Nuxeo instance as non active.