services.SystemOptionService Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of model Show documentation
Model management tools for the oVirt Engine API.
There is a newer version: 4.6.0
/*
Copyright (c) 2017 Red Hat, Inc.

Licensed 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 services;

import org.ovirt.api.metamodel.annotations.In;
import org.ovirt.api.metamodel.annotations.Out;
import org.ovirt.api.metamodel.annotations.Service;
import types.SystemOption;

/**
 * A service that provides values of specific configuration option of the system.
 *
 * @author Miroslava Voglova 
 * @date 18 Sep 2017
 * @status added
 * @since 4.2
 */
@Service
public interface SystemOptionService {
    /**
     * Get the values of specific configuration option.
     *
     * For example to retrieve the values of configuration option `MigrationPoliciesSupported` send a request like this:
     *
     * [source]
     * ----
     * GET /ovirt-engine/api/options/MigrationPoliciesSupported
     * ----
     *
     * The response to that request will be the following:
     *
     * [source,xml]
     * ----
     * 
     *   MigrationPoliciesSupported
     *   
     *     
     *       true
     *       4.0
     *     
     *     
     *       true
     *       4.1
     *     
     *     
     *       true
     *       4.2
     *     
     *     
     *       false
     *       3.6
     *     
     *   
     * 
     * ----
     *
     * NOTE: The appropriate permissions are required to query configuration options. Some options can be queried
     * only by users with administrator permissions.
     *
     * [IMPORTANT]
     * ====
     * There is NO backward compatibility and no guarantee about the names or values of the options. Options may be
     * removed and their meaning can be changed at any point.
     *
     * We strongly discourage the use of this service for applications other than the ones that are released
     * simultaneously with the engine. Usage by other applications is not supported. Therefore there will be no
     * documentation listing accessible configuration options.
     * ====
     *
     * @author Miroslava Voglova 
     * @date 18 Sep 2017
     * @status added
     * @since 4.2
     */
    interface Get{
        /**
         * The returned configuration option of the system.
         *
         * @author Miroslava Voglova 
         * @date 18 Sep 2017
         * @status added
         * @since 4.2
         */
        @Out SystemOption option();

        /**
         * Optional version parameter that specifies that only particular version of the configuration option
         * should be returned.
         * If this parameter isn't used then all the versions will be returned.
         *
         * For example, to get the value of the `MigrationPoliciesSupported` option but only for version `4.2` send
         * a request like this:
         *
         * [source]
         * ----
         * GET /ovirt-engine/api/options/MigrationPoliciesSupported?version=4.2
         * ----
         *
         * The response to that request will be like this:
         *
         * [source,xml]
         * ----
         * 
         *   MigrationPoliciesSupported
         *   
         *     
         *       true
         *       4.2
         *     
         *   
         * 
         * ----
         *
         * @author Miroslava Voglova 
         * @date 18 Sep 2017
         * @status added
         * @since 4.2
         */
        @In String version();
    }
}