org.alfresco.repo.management.subsystems

Interface PropertyBackedBeanState

All Known Subinterfaces:

ApplicationContextFactory, PropertyBackedBean

All Known Implementing Classes:

AbstractPropertyBackedBean, AuditModelRegistryImpl, AuditModelRegistryImpl.AuditModelRegistryState, ChildApplicationContextFactory, ChildApplicationContextFactory.ApplicationContextState, CompositeDataBean, CompositeDataBean.CompositeDataBeanState, DefaultChildApplicationContextManager, DefaultChildApplicationContextManager.ApplicationContextManagerState, SolrChildApplicationContextFactory, SwitchableApplicationContextFactory, SwitchableApplicationContextFactory.SwitchableState

public interface PropertyBackedBeanState

A PropertyBackedBeanState represents the state of a configurable sub-component or subsystem in the Alfresco server. It exposes configurable properties, along with PropertyBackedBeanState.stop() and PropertyBackedBeanState.start() methods. To modify the state, first ensure its associated component is stopped by calling PropertyBackedBeanState.stop(). Then set one or more properties. Then test out the changes with PropertyBackedBeanState.start(). In the Alfresco enterprise edition PropertyBackedBeanStates are exposed as persistent MBeans and can be reconfigured at runtime across a cluster via JMX.

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getProperty(java.lang.String name) Gets a property value.
java.util.Set	getPropertyNames() Gets the names of all properties.
void	setProperty(java.lang.String name, java.lang.String value) Sets the value of a property.
void	start() Starts up the component, using its new property values.
void	stop() Stops the component, so that its property values can be changed.

Method Detail

getPropertyNames

java.util.Set getPropertyNames()

Gets the names of all properties.

Returns:

the property names

getProperty

java.lang.String getProperty(java.lang.String name)

Gets a property value.

Parameters:

name - the name

Returns:

the property value

setProperty

void setProperty(java.lang.String name,
               java.lang.String value)

Sets the value of a property. This may only be called after PropertyBackedBeanState.stop() and should only be called for property names for which the #isUpdateable(String) method returns true.

Parameters:

name - the property name

value - the property value

start

void start()

Starts up the component, using its new property values.

stop

void stop()

Stops the component, so that its property values can be changed.