org.ovirt.engine.sdk4.services.GroupService Maven / Gradle / Ivy

Go to download
/*
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 org.ovirt.engine.sdk4.services;

import java.io.IOException;
import org.ovirt.engine.sdk4.Request;
import org.ovirt.engine.sdk4.Response;
import org.ovirt.engine.sdk4.Service;
import org.ovirt.engine.sdk4.types.Group;

/**
 * Manages a group of users. Use this service to either get groups details or remove groups. In order
 * to add new groups please use <> that manages the collection of groups.
 */
public interface GroupService extends Service {
    /**
     * Gets the system group information.
     * 
     * Usage:
     * 
     * ....
     * GET /ovirt-engine/api/groups/123
     * ....
     * 
     * Will return the group information:
     * 
     * [source,xml]
     * ----
     * 
     *   mygroup
     *   
     *   
     *   
     *   476652557A382F67696B6D2B32762B37796E46476D513D3D
     *   DC=example,DC=com
     *   
     *     myextension-authz
     *   
     * 
     * ----
     */
    public interface GetRequest extends Request {
        /**
         * Indicates which inner links should be _followed_. The objects referenced by these links will be fetched as part
         * of the current request. See <> for details.
         */
        GetRequest follow(String follow);
    }
    
    /**
     * Gets the system group information.
     * 
     * Usage:
     * 
     * ....
     * GET /ovirt-engine/api/groups/123
     * ....
     * 
     * Will return the group information:
     * 
     * [source,xml]
     * ----
     * 
     *   mygroup
     *   
     *   
     *   
     *   476652557A382F67696B6D2B32762B37796E46476D513D3D
     *   DC=example,DC=com
     *   
     *     myextension-authz
     *   
     * 
     * ----
     */
    public interface GetResponse extends Response {
        /**
         * The system group.
         */
        Group get();
    }
    
    /**
     * Gets the system group information.
     * 
     * Usage:
     * 
     * ....
     * GET /ovirt-engine/api/groups/123
     * ....
     * 
     * Will return the group information:
     * 
     * [source,xml]
     * ----
     * 
     *   mygroup
     *   
     *   
     *   
     *   476652557A382F67696B6D2B32762B37796E46476D513D3D
     *   DC=example,DC=com
     *   
     *     myextension-authz
     *   
     * 
     * ----
     */
    GetRequest get();
    
    /**
     * Removes the system group.
     * 
     * Usage:
     * 
     * ....
     * DELETE /ovirt-engine/api/groups/123
     * ....
     */
    public interface RemoveRequest extends Request {
        /**
         * Indicates if the remove should be performed asynchronously.
         */
        RemoveRequest async(Boolean async);
    }
    
    /**
     * Removes the system group.
     * 
     * Usage:
     * 
     * ....
     * DELETE /ovirt-engine/api/groups/123
     * ....
     */
    public interface RemoveResponse extends Response {
    }
    
    /**
     * Removes the system group.
     * 
     * Usage:
     * 
     * ....
     * DELETE /ovirt-engine/api/groups/123
     * ....
     */
    RemoveRequest remove();
    
    /**
     * Reference to the service that manages the collection of permissions assigned to this system group.
     */
    AssignedPermissionsService permissionsService();
    /**
     * Reference to the service that manages the collection of roles assigned to this system group.
     */
    AssignedRolesService rolesService();
    /**
     * Reference to the service that manages the collection of tags assigned to this system group.
     */
    AssignedTagsService tagsService();
    /**
     * Service locator method, returns individual service on which the URI is dispatched.
     */
    Service service(String path);
}