mirror of
https://github.com/apache/cloudstack.git
synced 2025-10-26 08:42:29 +01:00
367 lines
12 KiB
Java
367 lines
12 KiB
Java
// Copyright 2012 Citrix Systems, Inc. Licensed under the
|
|
// Apache License, Version 2.0 (the "License"); you may not use this
|
|
// file except in compliance with the License. Citrix Systems, Inc.
|
|
// reserves all rights not expressly granted by 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.
|
|
//
|
|
// Automatically generated by addcopyright.py at 04/03/2012
|
|
* follows:
|
|
* Linking this library statically or dynamically with other modules is
|
|
* making a combined work based on this library. Thus, the terms and
|
|
* permission to link this library with independent modules to produce an
|
|
* Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
|
|
package com.xensource.xenapi;
|
|
|
|
import com.xensource.xenapi.Types.BadServerResponse;
|
|
import com.xensource.xenapi.Types.VersionException;
|
|
import com.xensource.xenapi.Types.XenAPIException;
|
|
|
|
import java.io.PrintWriter;
|
|
import java.io.StringWriter;
|
|
import java.util.Date;
|
|
import java.util.HashMap;
|
|
import java.util.LinkedHashSet;
|
|
import java.util.Map;
|
|
import java.util.Set;
|
|
|
|
import org.apache.xmlrpc.XmlRpcException;
|
|
|
|
/**
|
|
* A user of the system
|
|
*
|
|
* @author Citrix Systems, Inc.
|
|
*/
|
|
public class User extends XenAPIObject {
|
|
|
|
/**
|
|
* The XenAPI reference to this object.
|
|
*/
|
|
protected final String ref;
|
|
|
|
/**
|
|
* For internal use only.
|
|
*/
|
|
User(String ref) {
|
|
this.ref = ref;
|
|
}
|
|
|
|
public String toWireString() {
|
|
return this.ref;
|
|
}
|
|
|
|
/**
|
|
* If obj is a User, compares XenAPI references for equality.
|
|
*/
|
|
@Override
|
|
public boolean equals(Object obj)
|
|
{
|
|
if (obj != null && obj instanceof User)
|
|
{
|
|
User other = (User) obj;
|
|
return other.ref.equals(this.ref);
|
|
} else
|
|
{
|
|
return false;
|
|
}
|
|
}
|
|
|
|
@Override
|
|
public int hashCode()
|
|
{
|
|
return ref.hashCode();
|
|
}
|
|
|
|
/**
|
|
* Represents all the fields in a User
|
|
*/
|
|
public static class Record implements Types.Record {
|
|
public String toString() {
|
|
StringWriter writer = new StringWriter();
|
|
PrintWriter print = new PrintWriter(writer);
|
|
print.printf("%1$20s: %2$s\n", "uuid", this.uuid);
|
|
print.printf("%1$20s: %2$s\n", "shortName", this.shortName);
|
|
print.printf("%1$20s: %2$s\n", "fullname", this.fullname);
|
|
print.printf("%1$20s: %2$s\n", "otherConfig", this.otherConfig);
|
|
return writer.toString();
|
|
}
|
|
|
|
/**
|
|
* Convert a user.Record to a Map
|
|
*/
|
|
public Map<String,Object> toMap() {
|
|
Map<String,Object> map = new HashMap<String,Object>();
|
|
map.put("uuid", this.uuid == null ? "" : this.uuid);
|
|
map.put("short_name", this.shortName == null ? "" : this.shortName);
|
|
map.put("fullname", this.fullname == null ? "" : this.fullname);
|
|
map.put("other_config", this.otherConfig == null ? new HashMap<String, String>() : this.otherConfig);
|
|
return map;
|
|
}
|
|
|
|
/**
|
|
* Unique identifier/object reference
|
|
*/
|
|
public String uuid;
|
|
/**
|
|
* short name (e.g. userid)
|
|
*/
|
|
public String shortName;
|
|
/**
|
|
* full name
|
|
*/
|
|
public String fullname;
|
|
/**
|
|
* additional configuration
|
|
*/
|
|
public Map<String, String> otherConfig;
|
|
}
|
|
|
|
/**
|
|
* Get a record containing the current state of the given user.
|
|
* @deprecated
|
|
*
|
|
* @return all fields from the object
|
|
*/
|
|
@Deprecated public User.Record getRecord(Connection c) throws
|
|
BadServerResponse,
|
|
XenAPIException,
|
|
XmlRpcException {
|
|
String method_call = "user.get_record";
|
|
String session = c.getSessionReference();
|
|
Object[] method_params = {Marshalling.toXMLRPC(session), Marshalling.toXMLRPC(this.ref)};
|
|
Map response = c.dispatch(method_call, method_params);
|
|
Object result = response.get("Value");
|
|
return Types.toUserRecord(result);
|
|
}
|
|
|
|
/**
|
|
* Get a reference to the user instance with the specified UUID.
|
|
* @deprecated
|
|
*
|
|
* @param uuid UUID of object to return
|
|
* @return reference to the object
|
|
*/
|
|
@Deprecated public static User getByUuid(Connection c, String uuid) throws
|
|
BadServerResponse,
|
|
XenAPIException,
|
|
XmlRpcException {
|
|
String method_call = "user.get_by_uuid";
|
|
String session = c.getSessionReference();
|
|
Object[] method_params = {Marshalling.toXMLRPC(session), Marshalling.toXMLRPC(uuid)};
|
|
Map response = c.dispatch(method_call, method_params);
|
|
Object result = response.get("Value");
|
|
return Types.toUser(result);
|
|
}
|
|
|
|
/**
|
|
* Create a new user instance, and return its handle.
|
|
* @deprecated
|
|
*
|
|
* @param record All constructor arguments
|
|
* @return Task
|
|
*/
|
|
@Deprecated public static Task createAsync(Connection c, User.Record record) throws
|
|
BadServerResponse,
|
|
XenAPIException,
|
|
XmlRpcException {
|
|
String method_call = "Async.user.create";
|
|
String session = c.getSessionReference();
|
|
Map<String, Object> record_map = record.toMap();
|
|
Object[] method_params = {Marshalling.toXMLRPC(session), Marshalling.toXMLRPC(record_map)};
|
|
Map response = c.dispatch(method_call, method_params);
|
|
Object result = response.get("Value");
|
|
return Types.toTask(result);
|
|
}
|
|
|
|
/**
|
|
* Create a new user instance, and return its handle.
|
|
* @deprecated
|
|
*
|
|
* @param record All constructor arguments
|
|
* @return reference to the newly created object
|
|
*/
|
|
@Deprecated public static User create(Connection c, User.Record record) throws
|
|
BadServerResponse,
|
|
XenAPIException,
|
|
XmlRpcException {
|
|
String method_call = "user.create";
|
|
String session = c.getSessionReference();
|
|
Map<String, Object> record_map = record.toMap();
|
|
Object[] method_params = {Marshalling.toXMLRPC(session), Marshalling.toXMLRPC(record_map)};
|
|
Map response = c.dispatch(method_call, method_params);
|
|
Object result = response.get("Value");
|
|
return Types.toUser(result);
|
|
}
|
|
|
|
/**
|
|
* Destroy the specified user instance.
|
|
* @deprecated
|
|
*
|
|
* @return Task
|
|
*/
|
|
@Deprecated public Task destroyAsync(Connection c) throws
|
|
BadServerResponse,
|
|
XenAPIException,
|
|
XmlRpcException {
|
|
String method_call = "Async.user.destroy";
|
|
String session = c.getSessionReference();
|
|
Object[] method_params = {Marshalling.toXMLRPC(session), Marshalling.toXMLRPC(this.ref)};
|
|
Map response = c.dispatch(method_call, method_params);
|
|
Object result = response.get("Value");
|
|
return Types.toTask(result);
|
|
}
|
|
|
|
/**
|
|
* Destroy the specified user instance.
|
|
* @deprecated
|
|
*
|
|
*/
|
|
@Deprecated public void destroy(Connection c) throws
|
|
BadServerResponse,
|
|
XenAPIException,
|
|
XmlRpcException {
|
|
String method_call = "user.destroy";
|
|
String session = c.getSessionReference();
|
|
Object[] method_params = {Marshalling.toXMLRPC(session), Marshalling.toXMLRPC(this.ref)};
|
|
Map response = c.dispatch(method_call, method_params);
|
|
return;
|
|
}
|
|
|
|
/**
|
|
* Get the uuid field of the given user.
|
|
*
|
|
* @return value of the field
|
|
*/
|
|
public String getUuid(Connection c) throws
|
|
BadServerResponse,
|
|
XenAPIException,
|
|
XmlRpcException {
|
|
String method_call = "user.get_uuid";
|
|
String session = c.getSessionReference();
|
|
Object[] method_params = {Marshalling.toXMLRPC(session), Marshalling.toXMLRPC(this.ref)};
|
|
Map response = c.dispatch(method_call, method_params);
|
|
Object result = response.get("Value");
|
|
return Types.toString(result);
|
|
}
|
|
|
|
/**
|
|
* Get the short_name field of the given user.
|
|
*
|
|
* @return value of the field
|
|
*/
|
|
public String getShortName(Connection c) throws
|
|
BadServerResponse,
|
|
XenAPIException,
|
|
XmlRpcException {
|
|
String method_call = "user.get_short_name";
|
|
String session = c.getSessionReference();
|
|
Object[] method_params = {Marshalling.toXMLRPC(session), Marshalling.toXMLRPC(this.ref)};
|
|
Map response = c.dispatch(method_call, method_params);
|
|
Object result = response.get("Value");
|
|
return Types.toString(result);
|
|
}
|
|
|
|
/**
|
|
* Get the fullname field of the given user.
|
|
*
|
|
* @return value of the field
|
|
*/
|
|
public String getFullname(Connection c) throws
|
|
BadServerResponse,
|
|
XenAPIException,
|
|
XmlRpcException {
|
|
String method_call = "user.get_fullname";
|
|
String session = c.getSessionReference();
|
|
Object[] method_params = {Marshalling.toXMLRPC(session), Marshalling.toXMLRPC(this.ref)};
|
|
Map response = c.dispatch(method_call, method_params);
|
|
Object result = response.get("Value");
|
|
return Types.toString(result);
|
|
}
|
|
|
|
/**
|
|
* Get the other_config field of the given user.
|
|
*
|
|
* @return value of the field
|
|
*/
|
|
public Map<String, String> getOtherConfig(Connection c) throws
|
|
BadServerResponse,
|
|
XenAPIException,
|
|
XmlRpcException {
|
|
String method_call = "user.get_other_config";
|
|
String session = c.getSessionReference();
|
|
Object[] method_params = {Marshalling.toXMLRPC(session), Marshalling.toXMLRPC(this.ref)};
|
|
Map response = c.dispatch(method_call, method_params);
|
|
Object result = response.get("Value");
|
|
return Types.toMapOfStringString(result);
|
|
}
|
|
|
|
/**
|
|
* Set the fullname field of the given user.
|
|
*
|
|
* @param fullname New value to set
|
|
*/
|
|
public void setFullname(Connection c, String fullname) throws
|
|
BadServerResponse,
|
|
XenAPIException,
|
|
XmlRpcException {
|
|
String method_call = "user.set_fullname";
|
|
String session = c.getSessionReference();
|
|
Object[] method_params = {Marshalling.toXMLRPC(session), Marshalling.toXMLRPC(this.ref), Marshalling.toXMLRPC(fullname)};
|
|
Map response = c.dispatch(method_call, method_params);
|
|
return;
|
|
}
|
|
|
|
/**
|
|
* Set the other_config field of the given user.
|
|
*
|
|
* @param otherConfig New value to set
|
|
*/
|
|
public void setOtherConfig(Connection c, Map<String, String> otherConfig) throws
|
|
BadServerResponse,
|
|
XenAPIException,
|
|
XmlRpcException {
|
|
String method_call = "user.set_other_config";
|
|
String session = c.getSessionReference();
|
|
Object[] method_params = {Marshalling.toXMLRPC(session), Marshalling.toXMLRPC(this.ref), Marshalling.toXMLRPC(otherConfig)};
|
|
Map response = c.dispatch(method_call, method_params);
|
|
return;
|
|
}
|
|
|
|
/**
|
|
* Add the given key-value pair to the other_config field of the given user.
|
|
*
|
|
* @param key Key to add
|
|
* @param value Value to add
|
|
*/
|
|
public void addToOtherConfig(Connection c, String key, String value) throws
|
|
BadServerResponse,
|
|
XenAPIException,
|
|
XmlRpcException {
|
|
String method_call = "user.add_to_other_config";
|
|
String session = c.getSessionReference();
|
|
Object[] method_params = {Marshalling.toXMLRPC(session), Marshalling.toXMLRPC(this.ref), Marshalling.toXMLRPC(key), Marshalling.toXMLRPC(value)};
|
|
Map response = c.dispatch(method_call, method_params);
|
|
return;
|
|
}
|
|
|
|
/**
|
|
* Remove the given key and its corresponding value from the other_config field of the given user. If the key is not in that Map, then do nothing.
|
|
*
|
|
* @param key Key to remove
|
|
*/
|
|
public void removeFromOtherConfig(Connection c, String key) throws
|
|
BadServerResponse,
|
|
XenAPIException,
|
|
XmlRpcException {
|
|
String method_call = "user.remove_from_other_config";
|
|
String session = c.getSessionReference();
|
|
Object[] method_params = {Marshalling.toXMLRPC(session), Marshalling.toXMLRPC(this.ref), Marshalling.toXMLRPC(key)};
|
|
Map response = c.dispatch(method_call, method_params);
|
|
return;
|
|
}
|
|
|
|
} |