services.aaa.DomainService 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.Out;
import org.ovirt.api.metamodel.annotations.Service;
import types.Domain;

/**
 * A service to view details of an authentication domain in the system.
 *
 * @author Ravi Nori 
 * @date 12 Dec 2016
 * @status added
 */
@Service
@Area("Infrastructure")
public interface DomainService {
    /**
     * Gets the authentication domain information.
     *
     * Usage:
     *
     * ....
     * GET /ovirt-engine/api/domains/5678
     * ....
     *
     * Will return the domain information:
     *
     * [source,xml]
     * ----
     * 
     *   internal-authz
     *   
     *   
     *   
     *   
     * 
     * ----
     *
     * @author Ravi Nori 
     * @date 12 Dec 2017
     * @status added
     */
    interface Get extends Follow {
        /**
         * The authentication domain.
         *
         * @author Ravi Nori 
         * @date 12 Dec 2017
         * @status added
         */
        @Out Domain domain();
    }

    /**
     * Reference to a service to manage domain users.
     *
     * @author Ravi Nori 
     * @date 12 Dec 2016
     * @status added
     */
    @Service DomainUsersService users();

    /**
     * Reference to a service to manage domain groups.
     *
     * @author Ravi Nori 
     * @date 12 Dec 2016
     * @status added
     */
    @Service DomainGroupsService groups();
}