org.xlcloud.openstack.api.identity.UsersResource Maven / Gradle / Ivy
/*
* Copyright 2012 AMG.lab, a Bull Group Company
*
* 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.xlcloud.openstack.api.identity;
import org.xlcloud.openstack.api.Resource;
import org.xlcloud.openstack.model.identity.User;
import org.xlcloud.openstack.model.identity.UserForCreate;
import org.xlcloud.openstack.model.identity.UserList;
import org.xlcloud.openstack.model.identity.keystone.KeystoneUser;
import org.xlcloud.openstack.model.identity.keystone.KeystoneUserList;
import com.sun.jersey.api.client.Client;
/**
* {@inheritDoc}
*
* This resource corresponds to all users.
*
* @author Tomek Adamczewski, AMG.net
*/
public class UsersResource extends Resource {
/**
* This constructor is not public as it should be accessed only by
* {@link IdentityAdministrationEndpoint}
*
* @param client
* Jersey client used for connection
* @param resourceUri
* absolute URI to the resource
*/
UsersResource( Client client, String resourceUri ) {
super(client, resourceUri);
}
/**
* Get the list of all users.
*
* @return
*/
public UserList get() {
return client.resource(resourceUri).get(KeystoneUserList.class);
}
/**
* Get user with the specified name.
*
* @param name
* @return
*/
public User getUserByName(String name) {
return client.resource(resourceUri).queryParam("name", name).get(KeystoneUser.class);
}
/**
* Get the resource corresponding to a particular user (based on their id).
*
* @param id
* @return
*/
public UserResource user(String id) {
return new UserResource(client, resourceUri + "/" + id);
}
/**
* Add new user.
*
* @param user
* @return
*/
public User post(UserForCreate user) {
return client.resource(resourceUri).post(KeystoneUser.class, user);
}
}