services.aaa.UsersService 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) 2015 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.aaa;

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.User;

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

/**
 * A service to manage the users in the system.
 *
 * @author Oved Ourfali 
 * @date 01 Dec 2016
 * @status added
 */
@Service
@Area("Infrastructure")
public interface UsersService {

    /**
     * Add user from a directory service.
     *
     * For example, to add the `myuser` user from the `myextension-authz` authorization provider send a request
     * like this:
     *
     * [source]
     * ----
     * POST /ovirt-engine/api/users
     * ----
     *
     * With a request body like this:
     *
     * [source,xml]
     * ----
     * 
     *   myuser@myextension-authz
     *   
     *     myextension-authz
     *   
     * 
     * ----
     *
     * In case you are working with Active Directory you have to pass user principal name (UPN) as `username`, followed
     * by authorization provider name. Due to https://bugzilla.redhat.com/1147900[bug 1147900] you need to provide
     * also `principal` parameter set to UPN of the user.
     *
     * For example, to add the user with UPN `[email protected]` from the `myextension-authz`
     * authorization provider send a request body like this:
     *
     * [source,xml]
     * ----
     * 
     *   [email protected]
     *   [email protected]@myextension-authz
     *   
     *     myextension-authz
     *   
     * 
     * ----
     *
     * @author Ondra Machacek 
     * @date 14 Sep 2016
     * @status added
     */
    interface Add {
        @InputDetail
        default void inputDetail() {
            mandatory(user().userName());
            or(mandatory(user().domain().id()), mandatory(user().domain().name()));
            optional(user().namespace());
            optional(user().principal());
        }
        @In @Out User user();
    }

    /**
     * List all the users in the system.
     *
     * Usage:
     *
     * ....
     * GET /ovirt-engine/api/users
     * ....
     *
     * Will return the list of users:
     *
     * [source,xml]
     * ----
     * 
     *   
     *     admin
     *     
     *     
     *     
     *     
     *     23456
     *     *
     *     user1
     *     user1@domain-authz
     *     
     *       domain-authz
     *     
     *   
     * 
     * ----
     *
     * The order of the returned list of users isn't guaranteed.
     *
     * @author Oved Ourfali 
     * @author Ravi Nori 
     * @date 12 Dec 2016
     * @status added
     */
    interface List extends Follow {
        /**
         * The list of users.
         *
         * @author Oved Ourfali 
         * @date 01 Dec 2016
         * @status added
         */
        @Out User[] users();

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

        /**
         * A query string used to restrict the returned users.
         */
        @In String search();

        /**
         * Indicates if the search performed using the `search` parameter should be performed taking case into
         * account. The default value is `true`, which means that case is taken into account. If you want to search
         * ignoring case set it to `false`.
         */
        @In Boolean caseSensitive();
    }

    @Service UserService user(String id);
}