Files
alfresco-community-repo/source/java/org/alfresco/repo/management/subsystems/PropertyBackedBeanState.java
Tatyana Valkevych 7dd2291753 Merged HEAD-BUG-FIX (5.1/Cloud) to HEAD (5.1/Cloud)
107541: Merged 5.0.N (5.0.3) to HEAD-BUG-FIX (5.1/Cloud) (PARTIAL MERGE)
      107413: Merged DEV to 5.0.N (5.0.3)
         106858 : MNT-13545: JavaDoc : Inconsistencies between the Java doc and the actual code
            - Cleaning of Javadoc,
   107565: MNT-13545 Fix compilation after merge of Javadoc


git-svn-id: https://svn.alfresco.com/repos/alfresco-enterprise/alfresco/HEAD/root@107633 c4b6b30b-aa2e-2d43-bbcb-ca4b014f7261
2015-07-02 16:13:03 +00:00

79 lines
2.5 KiB
Java

/*
* Copyright (C) 2005-2013 Alfresco Software Limited.
*
* This file is part of Alfresco
*
* Alfresco is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* Alfresco is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with Alfresco. If not, see <http://www.gnu.org/licenses/>.
*/
package org.alfresco.repo.management.subsystems;
import java.util.Set;
/**
* A <code>PropertyBackedBeanState</code> represents the state of a configurable sub-component or subsystem in the
* Alfresco server. It exposes configurable properties, along with {@link #stop()} and {@link #start()} methods. To
* modify the state, first ensure its associated component is stopped by calling {@link #stop()}. Then set one or more
* properties. Then test out the changes with {@link #start()}. In the Alfresco enterprise edition
* <code>PropertyBackedBeanState</code>s are exposed as persistent MBeans and can be reconfigured at runtime across a
* cluster via JMX.
*
* @author dward
*/
public interface PropertyBackedBeanState
{
/**
* Gets the names of all properties.
*
* @return the property names
*/
public Set<String> getPropertyNames();
/**
* Gets a property value.
*
* @param name
* the name
* @return the property value
*/
public String getProperty(String name);
/**
* Sets the value of a property. This may only be called after {@link #stop()}.
*
* @param name
* the property name
* @param value
* the property value
*/
public void setProperty(String name, String value);
/**
* Removes a property. This may only be called after {@link #stop()}.
*
* @param name
* the property name
*/
public void removeProperty(String name);
/**
* Starts up the component, using its new property values.
*/
public void start();
/**
* Stops the component, so that its property values can be changed.
*/
public void stop();
}