org.ovirt.engine.sdk4.services.UserService 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.builders.UserBuilder;
import org.ovirt.engine.sdk4.types.User;

/**
 * A service to manage a user in the system.
 * Use this service to either get users details or remove users.
 * In order to add new users please use
 * <>.
 */
public interface UserService extends Service {
    /**
     * Gets the system user information.
     * 
     * Usage:
     * 
     * ....
     * GET /ovirt-engine/api/users/1234
     * ....
     * 
     * Will return the user information:
     * 
     * [source,xml]
     * ----
     * 
     *   admin
     *   
     *   
     *   
     *   
     *   
     *   23456
     *   [email protected]
     *   Lastname
     *   *
     *   user1
     *   user1@domain-authz
     *   
     *     domain-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 user information.
     * 
     * Usage:
     * 
     * ....
     * GET /ovirt-engine/api/users/1234
     * ....
     * 
     * Will return the user information:
     * 
     * [source,xml]
     * ----
     * 
     *   admin
     *   
     *   
     *   
     *   
     *   
     *   23456
     *   [email protected]
     *   Lastname
     *   *
     *   user1
     *   user1@domain-authz
     *   
     *     domain-authz
     *   
     * 
     * ----
     */
    public interface GetResponse extends Response {
        /**
         * The system user.
         */
        User user();
    }
    
    /**
     * Gets the system user information.
     * 
     * Usage:
     * 
     * ....
     * GET /ovirt-engine/api/users/1234
     * ....
     * 
     * Will return the user information:
     * 
     * [source,xml]
     * ----
     * 
     *   admin
     *   
     *   
     *   
     *   
     *   
     *   23456
     *   [email protected]
     *   Lastname
     *   *
     *   user1
     *   user1@domain-authz
     *   
     *     domain-authz
     *   
     * 
     * ----
     */
    GetRequest get();
    
    /**
     * Removes the system user.
     * 
     * Usage:
     * 
     * ....
     * DELETE /ovirt-engine/api/users/1234
     * ....
     */
    public interface RemoveRequest extends Request {
        /**
         * Indicates if the remove should be performed asynchronously.
         */
        RemoveRequest async(Boolean async);
    }
    
    /**
     * Removes the system user.
     * 
     * Usage:
     * 
     * ....
     * DELETE /ovirt-engine/api/users/1234
     * ....
     */
    public interface RemoveResponse extends Response {
    }
    
    /**
     * Removes the system user.
     * 
     * Usage:
     * 
     * ....
     * DELETE /ovirt-engine/api/users/1234
     * ....
     */
    RemoveRequest remove();
    
    /**
     * Updates information about the user.
     * 
     * Only the `user_options` field can be updated.
     * 
     * For example, to update user options:
     * 
     * [source]
     * ----
     * PUT /ovirt-engine/api/users/123
     * ----
     * 
     * With a request body like this:
     * 
     * [source,xml]
     * ----
     * 
     *    
     *       
     *          test
     *          test1
     *       
     *    
     * 
     * ----
     */
    public interface UpdateRequest extends Request {
        UpdateRequest user(User user);
        UpdateRequest user(UserBuilder user);
    }
    
    /**
     * Updates information about the user.
     * 
     * Only the `user_options` field can be updated.
     * 
     * For example, to update user options:
     * 
     * [source]
     * ----
     * PUT /ovirt-engine/api/users/123
     * ----
     * 
     * With a request body like this:
     * 
     * [source,xml]
     * ----
     * 
     *    
     *       
     *          test
     *          test1
     *       
     *    
     * 
     * ----
     */
    public interface UpdateResponse extends Response {
        User user();
    }
    
    /**
     * Updates information about the user.
     * 
     * Only the `user_options` field can be updated.
     * 
     * For example, to update user options:
     * 
     * [source]
     * ----
     * PUT /ovirt-engine/api/users/123
     * ----
     * 
     * With a request body like this:
     * 
     * [source,xml]
     * ----
     * 
     *    
     *       
     *          test
     *          test1
     *       
     *    
     * 
     * ----
     */
    UpdateRequest update();
    
    /**
     * List of event-subscriptions for this user.
     */
    EventSubscriptionsService eventSubscriptionsService();
    DomainUserGroupsService groupsService();
    AssignedPermissionsService permissionsService();
    AssignedRolesService rolesService();
    SshPublicKeysService sshPublicKeysService();
    AssignedTagsService tagsService();
    /**
     * Service locator method, returns individual service on which the URI is dispatched.
     */
    Service service(String path);
}