Package org.alfresco.repo.management.subsystems

Interface PropertyBackedBean

All Superinterfaces:
PropertyBackedBeanState
All Known Subinterfaces:
ApplicationContextFactory
All Known Implementing Classes:
AbstractPropertyBackedBean, AuditModelRegistryImpl, ChildApplicationContextFactory, CompositeDataBean, CryptodocSwitchableApplicationContextFactory, DefaultChildApplicationContextManager, EncryptedContentStoreChildApplicationContextFactory, LuceneChildApplicationContextFactory, NoIndexChildApplicationContextFactory, SolrChildApplicationContextFactory, SwitchableApplicationContextFactory
public interface PropertyBackedBean extends PropertyBackedBeanState
A PropertyBackedBean is a reconfigurable sub-component or subsystem in the Alfresco server. It exposes its state through the PropertyBackedBeanState interface, along with fixed attributes and a method for reverting the bean to its default initial state. In the Alfresco enterprise edition PropertyBackedBeans are exposed as persistent MBeans and can be reconfigured across a cluster at runtime via JMX.
Author:
dward

  • Method Details

    • getId

      List<String> getId()
      Gets a unique identifier for the bean. The ID is a List to encourage hierarchical structuring of IDs, e.g. to aid construction of JMX Object names and presentation in JConsole.
      Returns:
      the id

    • isUpdateable

      boolean isUpdateable(String name)
      Checks if a property is updateable.
      Parameters:
      name - the property name
      Returns:
      true if the property is updateable

    • getDescription

      String getDescription(String name)
      Gets a Human readable description of the property, e.g. to provide via JMX.
      Parameters:
      name - the name
      Returns:
      the description

    • revert

      void revert()
      Reverts this component to its original default start state, removing any previously persisted state changes.

    • setProperties

      void setProperties(Map<String,String> properties)
      Tries setting the given properties on this component. Will leave the component in a started state consisting of the new properties if they are valid, or the previous state otherwise. Note that the new state still has to be confirmed to the entire cluster with PropertyBackedBeanState.start(), presumably after persistence of the new state has been completed.

    • removeProperties

      void removeProperties(Collection<String> attributes)
      Tries removing the given properties on this component. Will leave the component in a started state consisting of the new properties if they are valid, or the previous state otherwise. Note that the new state still has to be confirmed to the entire cluster with PropertyBackedBeanState.start(), presumably after persistence of the new state has been completed.