services.RolesService 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) 2010 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 annotations.Area;
import mixins.Follow;
import org.ovirt.api.metamodel.annotations.In;
import org.ovirt.api.metamodel.annotations.InputDetail;
import org.ovirt.api.metamodel.annotations.Out;
import org.ovirt.api.metamodel.annotations.Service;
import types.Role;

import static org.ovirt.api.metamodel.language.ApiLanguage.COLLECTION;
import static org.ovirt.api.metamodel.language.ApiLanguage.mandatory;
import static org.ovirt.api.metamodel.language.ApiLanguage.optional;

/**
 * Provides read-only access to the global set of roles
 */
@Service
@Area("Infrastructure")
public interface RolesService {

    /**
     * Create a new role. The role can be administrative or non-administrative and can have different permits.
     *
     * For example, to add the `MyRole` non-administrative role with permits to login and create virtual machines
     * send a request like this (note that you have to pass permit id):
     *
     * [source]
     * ----
     * POST /ovirt-engine/api/roles
     * ----
     *
     * With a request body like this:
     *
     * [source,xml]
     * ----
     * 
     *   MyRole
     *   My custom role to create virtual machines
     *   false
     *   
     *     
     *     
     *   
     * 
     * ----
     *
     * @author Ondra Machacek 
     * @date 14 Sep 2016
     * @status added
     */
    interface Add {
        @InputDetail
        default void inputDetail() {
            mandatory(role().name());
            mandatory(role().permits()[COLLECTION].id());
            optional(role().administrative());
            optional(role().description());
        }
        /**
         * Role that will be added.
         *
         * @author Aleksei Slaikovskii 
         * @date 12 Dec 2016
         * @status added
         */
        @In @Out Role role();
    }

    /**
     * List roles.
     *
     * [source]
     * ----
     * GET /ovirt-engine/api/roles
     * ----
     *
     * You will receive response in XML like this one:
     *
     * [source,xml]
     * ----
     * 
     *   
     *      SuperUser
     *      Roles management administrator
     *      
     *      true
     *      false
     *   
     *   ...
     * 
     * ----
     *
     * The order of the returned list of roles isn't guaranteed.
     *
     * @author Aleksei Slaikovskii 
     * @date 12 Dec 2016
     * @status added
     */
    interface List extends Follow {
        /**
         * Retrieved list of roles.
         *
         * @author Aleksei Slaikovskii 
         * @date 12 Dec 2016
         * @status added
         */
        @Out Role[] roles();

        /**
         * Sets the maximum number of roles to return. If not specified all the roles are returned.
         */
        @In Integer max();
    }

    /**
     * Sub-resource locator method, returns individual role resource on which the remainder of the URI is dispatched.
     */
    @Service RoleService role(String id);
}