IPropertyService.java

/*
 *  Copyright (c) WSO2 Inc. (http://wso2.com) All Rights Reserved.
 *
 *  WSO2 Inc. licenses this file to you under the Apache License,
 *  Version 2.0 (the "License"); you may not use this file except
 *  in compliance with the License.
 *  You may obtain a copy of the License at
 *
 *  http://www.apache.org/licenses/LICENSE-2.0
 *
 *  Unless required by applicable law or agreed to in writing,
 *  software distributed under the License is distributed on an
 *  "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 *  KIND, either express or implied.  See the License for the
 *  specific language governing permissions and limitations
 *  under the License.
 *
 */
package org.wso2.carbon.registry.admin.api.jmx;

/**
 * Contains API for managing properties.
 */
public interface IPropertyService {

    /**
     * Retrieves all properties of a given resource.
     *
     * @param path The resource path.
     *
     * @return list of properties.
     */
    String[] getProperties(String path);

    /**
     * Method to retrieve the value of a specific property.
     *
     * @param path The resource path.
     * @param key  The property key.
     *
     * @return the property value.
     */
    String getProperty(String path, String key);

    /**
     * Method to set a property.
     *
     * @param path  The resource path.
     * @param key   The property key.
     * @param value The property value.
     */
    void setProperty(String path, String key, String value);

    /**
     * Method to delete a property.
     *
     * @param path  The resource path.
     * @param key   The property key.
     */
    void removeProperty(String path, String key);

}