org.ovirt.engine.sdk.decorators.Users Maven / Gradle / Ivy
Show all versions of ovirt-engine-sdk-java Show documentation
//
// Copyright (c) 2012 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.
//
// *********************************************************************
// ********************* GENERATED CODE - DO NOT MODIFY ****************
// *********************************************************************
package org.ovirt.engine.sdk.decorators;
import java.io.IOException;
import java.util.List;
import java.util.UUID;
import org.apache.http.Header;
import org.apache.http.client.ClientProtocolException;
import org.ovirt.engine.sdk.common.CollectionDecorator;
import org.ovirt.engine.sdk.exceptions.ServerException;
import org.ovirt.engine.sdk.utils.CollectionUtils;
import org.ovirt.engine.sdk.utils.HttpHeaderBuilder;
import org.ovirt.engine.sdk.utils.HttpHeaderUtils;
import org.ovirt.engine.sdk.utils.UrlBuilder;
import org.ovirt.engine.sdk.utils.UrlBuilder;
import org.ovirt.engine.sdk.utils.UrlHelper;
import org.ovirt.engine.sdk.web.HttpProxyBroker;
import org.ovirt.engine.sdk.web.UrlParameterType;
import org.ovirt.engine.sdk.entities.Action;
/**
* Users providing relation and functional services
*
to {@link org.ovirt.engine.sdk.entities.Users }.
*/
@SuppressWarnings("unused")
public class Users extends
CollectionDecorator {
/**
* @param proxy HttpProxyBroker
*/
public Users(HttpProxyBroker proxy) {
super(proxy, "users");
}
/**
* Lists User objects.
*
* @return
* List of {@link User }
*
* @throws ClientProtocolException
* Signals that HTTP/S protocol error has occurred.
* @throws ServerException
* Signals that an oVirt api error has occurred.
* @throws IOException
* Signals that an I/O exception of some sort has occurred.
*/
@Override
public List list() throws ClientProtocolException,
ServerException, IOException {
String url = SLASH + getName();
return list(url, org.ovirt.engine.sdk.entities.Users.class, User.class);
}
/**
* Fetches User object by id.
*
* @return {@link User }
*
* @throws ClientProtocolException
* Signals that HTTP/S protocol error has occurred.
* @throws ServerException
* Signals that an oVirt api error has occurred.
* @throws IOException
* Signals that an I/O exception of some sort has occurred.
*/
@Override
public User get(UUID id) throws ClientProtocolException,
ServerException, IOException {
String url = SLASH + getName() + SLASH + id.toString();
return getProxy().get(url, org.ovirt.engine.sdk.entities.User.class, User.class);
}
/**
* Fetches User object by id.
*
* @return {@link User }
*
* @throws ClientProtocolException
* Signals that HTTP/S protocol error has occurred.
* @throws ServerException
* Signals that an oVirt api error has occurred.
* @throws IOException
* Signals that an I/O exception of some sort has occurred.
*/
@Override
public User getById(String id) throws ClientProtocolException,
ServerException, IOException {
String url = SLASH + getName() + SLASH + id;
return getProxy().get(url, org.ovirt.engine.sdk.entities.User.class, User.class);
}
/**
* Adds User object.
*
* @param user {@link org.ovirt.engine.sdk.entities.User}
*
* user.user_name
* user.domain.id|name
* [user.namespace]
* [user.principal]
*
*
*
* @return
* {@link User }
*
* @throws ClientProtocolException
* Signals that HTTP/S protocol error has occurred.
* @throws ServerException
* Signals that an oVirt api error has occurred.
* @throws IOException
* Signals that an I/O exception of some sort has occurred.
*/
public User add(org.ovirt.engine.sdk.entities.User user) throws
ClientProtocolException, ServerException, IOException {
String url = SLASH + getName();
HttpHeaderBuilder headersBuilder = new HttpHeaderBuilder();
List headers = headersBuilder.build();
UrlBuilder urlBuilder = new UrlBuilder(url);
url = urlBuilder.build();
return getProxy().add(url, user,
org.ovirt.engine.sdk.entities.User.class,
User.class, headers);
}
/**
* Adds User object.
*
* @param user {@link org.ovirt.engine.sdk.entities.User}
*
* user.user_name
* user.domain.id|name
* [user.namespace]
* [user.principal]
*
*
* @param expect
*
* [201-created]
*
* @return
* {@link User }
*
* @throws ClientProtocolException
* Signals that HTTP/S protocol error has occurred.
* @throws ServerException
* Signals that an oVirt api error has occurred.
* @throws IOException
* Signals that an I/O exception of some sort has occurred.
*/
public User add(org.ovirt.engine.sdk.entities.User user, String expect) throws
ClientProtocolException, ServerException, IOException {
String url = SLASH + getName();
HttpHeaderBuilder headersBuilder = new HttpHeaderBuilder();
if (expect != null) {
headersBuilder.add("Expect", expect);
}
List headers = headersBuilder.build();
UrlBuilder urlBuilder = new UrlBuilder(url);
url = urlBuilder.build();
return getProxy().add(url, user,
org.ovirt.engine.sdk.entities.User.class,
User.class, headers);
}
/**
* Adds User object.
*
* @param user {@link org.ovirt.engine.sdk.entities.User}
*
* user.user_name
* user.domain.id|name
* [user.namespace]
* [user.principal]
*
*
* @param expect
*
* [201-created]
*
* @param correlationId
*
* [any string]
*
* @return
* {@link User }
*
* @throws ClientProtocolException
* Signals that HTTP/S protocol error has occurred.
* @throws ServerException
* Signals that an oVirt api error has occurred.
* @throws IOException
* Signals that an I/O exception of some sort has occurred.
*/
public User add(org.ovirt.engine.sdk.entities.User user, String expect, String correlationId) throws
ClientProtocolException, ServerException, IOException {
String url = SLASH + getName();
HttpHeaderBuilder headersBuilder = new HttpHeaderBuilder();
if (expect != null) {
headersBuilder.add("Expect", expect);
}
if (correlationId != null) {
headersBuilder.add("Correlation-Id", correlationId);
}
List headers = headersBuilder.build();
UrlBuilder urlBuilder = new UrlBuilder(url);
url = urlBuilder.build();
return getProxy().add(url, user,
org.ovirt.engine.sdk.entities.User.class,
User.class, headers);
}
/**
* Lists User objects.
*
* @param query
*
* [search query]
*
*
* @return List of {@link User }
*
* @throws ClientProtocolException
* Signals that HTTP/S protocol error has occurred.
* @throws ServerException
* Signals that an oVirt api error has occurred.
* @throws IOException
* Signals that an I/O exception of some sort has occurred.
*/
public List list(String query) throws ClientProtocolException,
ServerException, IOException {
HttpHeaderBuilder headersBuilder = new HttpHeaderBuilder();
List headers = headersBuilder.build();
UrlBuilder urlBuilder = new UrlBuilder(SLASH + getName());
if (query != null) {
urlBuilder.add("search", query, UrlParameterType.QUERY);
}
String url = urlBuilder.build();
return list(url, org.ovirt.engine.sdk.entities.Users.class,
User.class, headers);
}
/**
* Lists User objects.
*
* @param query
*
* [search query]
*
* @param caseSensitive
*
* [true|false]
*
*
* @return List of {@link User }
*
* @throws ClientProtocolException
* Signals that HTTP/S protocol error has occurred.
* @throws ServerException
* Signals that an oVirt api error has occurred.
* @throws IOException
* Signals that an I/O exception of some sort has occurred.
*/
public List list(String query, Boolean caseSensitive) throws ClientProtocolException,
ServerException, IOException {
HttpHeaderBuilder headersBuilder = new HttpHeaderBuilder();
List headers = headersBuilder.build();
UrlBuilder urlBuilder = new UrlBuilder(SLASH + getName());
if (query != null) {
urlBuilder.add("search", query, UrlParameterType.QUERY);
}
if (caseSensitive != null) {
urlBuilder.add("case_sensitive", caseSensitive, UrlParameterType.MATRIX);
}
String url = urlBuilder.build();
return list(url, org.ovirt.engine.sdk.entities.Users.class,
User.class, headers);
}
/**
* Lists User objects.
*
* @param query
*
* [search query]
*
* @param caseSensitive
*
* [true|false]
*
* @param max
*
* [max results]
*
*
* @return List of {@link User }
*
* @throws ClientProtocolException
* Signals that HTTP/S protocol error has occurred.
* @throws ServerException
* Signals that an oVirt api error has occurred.
* @throws IOException
* Signals that an I/O exception of some sort has occurred.
*/
public List list(String query, Boolean caseSensitive, Integer max) throws ClientProtocolException,
ServerException, IOException {
HttpHeaderBuilder headersBuilder = new HttpHeaderBuilder();
List headers = headersBuilder.build();
UrlBuilder urlBuilder = new UrlBuilder(SLASH + getName());
if (query != null) {
urlBuilder.add("search", query, UrlParameterType.QUERY);
}
if (caseSensitive != null) {
urlBuilder.add("case_sensitive", caseSensitive, UrlParameterType.MATRIX);
}
if (max != null) {
urlBuilder.add("max", max, UrlParameterType.MATRIX);
}
String url = urlBuilder.build();
return list(url, org.ovirt.engine.sdk.entities.Users.class,
User.class, headers);
}
}