mirror of
https://github.com/apache/cloudstack.git
synced 2025-10-26 08:42:29 +01:00
374 lines
13 KiB
Java
374 lines
13 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
|
|
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 or group that can log in xapi
|
|
*
|
|
* @author Citrix Systems, Inc.
|
|
*/
|
|
public class Subject extends XenAPIObject {
|
|
|
|
/**
|
|
* The XenAPI reference to this object.
|
|
*/
|
|
protected final String ref;
|
|
|
|
/**
|
|
* For internal use only.
|
|
*/
|
|
Subject(String ref) {
|
|
this.ref = ref;
|
|
}
|
|
|
|
public String toWireString() {
|
|
return this.ref;
|
|
}
|
|
|
|
/**
|
|
* If obj is a Subject, compares XenAPI references for equality.
|
|
*/
|
|
@Override
|
|
public boolean equals(Object obj)
|
|
{
|
|
if (obj != null && obj instanceof Subject)
|
|
{
|
|
Subject other = (Subject) obj;
|
|
return other.ref.equals(this.ref);
|
|
} else
|
|
{
|
|
return false;
|
|
}
|
|
}
|
|
|
|
@Override
|
|
public int hashCode()
|
|
{
|
|
return ref.hashCode();
|
|
}
|
|
|
|
/**
|
|
* Represents all the fields in a Subject
|
|
*/
|
|
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", "subjectIdentifier", this.subjectIdentifier);
|
|
print.printf("%1$20s: %2$s\n", "otherConfig", this.otherConfig);
|
|
print.printf("%1$20s: %2$s\n", "roles", this.roles);
|
|
return writer.toString();
|
|
}
|
|
|
|
/**
|
|
* Convert a subject.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("subject_identifier", this.subjectIdentifier == null ? "" : this.subjectIdentifier);
|
|
map.put("other_config", this.otherConfig == null ? new HashMap<String, String>() : this.otherConfig);
|
|
map.put("roles", this.roles == null ? new LinkedHashSet<Role>() : this.roles);
|
|
return map;
|
|
}
|
|
|
|
/**
|
|
* Unique identifier/object reference
|
|
*/
|
|
public String uuid;
|
|
/**
|
|
* the subject identifier, unique in the external directory service
|
|
*/
|
|
public String subjectIdentifier;
|
|
/**
|
|
* additional configuration
|
|
*/
|
|
public Map<String, String> otherConfig;
|
|
/**
|
|
* the roles associated with this subject
|
|
*/
|
|
public Set<Role> roles;
|
|
}
|
|
|
|
/**
|
|
* Get a record containing the current state of the given subject.
|
|
*
|
|
* @return all fields from the object
|
|
*/
|
|
public Subject.Record getRecord(Connection c) throws
|
|
BadServerResponse,
|
|
XenAPIException,
|
|
XmlRpcException {
|
|
String method_call = "subject.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.toSubjectRecord(result);
|
|
}
|
|
|
|
/**
|
|
* Get a reference to the subject instance with the specified UUID.
|
|
*
|
|
* @param uuid UUID of object to return
|
|
* @return reference to the object
|
|
*/
|
|
public static Subject getByUuid(Connection c, String uuid) throws
|
|
BadServerResponse,
|
|
XenAPIException,
|
|
XmlRpcException {
|
|
String method_call = "subject.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.toSubject(result);
|
|
}
|
|
|
|
/**
|
|
* Create a new subject instance, and return its handle.
|
|
*
|
|
* @param record All constructor arguments
|
|
* @return Task
|
|
*/
|
|
public static Task createAsync(Connection c, Subject.Record record) throws
|
|
BadServerResponse,
|
|
XenAPIException,
|
|
XmlRpcException {
|
|
String method_call = "Async.subject.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 subject instance, and return its handle.
|
|
*
|
|
* @param record All constructor arguments
|
|
* @return reference to the newly created object
|
|
*/
|
|
public static Subject create(Connection c, Subject.Record record) throws
|
|
BadServerResponse,
|
|
XenAPIException,
|
|
XmlRpcException {
|
|
String method_call = "subject.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.toSubject(result);
|
|
}
|
|
|
|
/**
|
|
* Destroy the specified subject instance.
|
|
*
|
|
* @return Task
|
|
*/
|
|
public Task destroyAsync(Connection c) throws
|
|
BadServerResponse,
|
|
XenAPIException,
|
|
XmlRpcException {
|
|
String method_call = "Async.subject.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 subject instance.
|
|
*
|
|
*/
|
|
public void destroy(Connection c) throws
|
|
BadServerResponse,
|
|
XenAPIException,
|
|
XmlRpcException {
|
|
String method_call = "subject.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 subject.
|
|
*
|
|
* @return value of the field
|
|
*/
|
|
public String getUuid(Connection c) throws
|
|
BadServerResponse,
|
|
XenAPIException,
|
|
XmlRpcException {
|
|
String method_call = "subject.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 subject_identifier field of the given subject.
|
|
*
|
|
* @return value of the field
|
|
*/
|
|
public String getSubjectIdentifier(Connection c) throws
|
|
BadServerResponse,
|
|
XenAPIException,
|
|
XmlRpcException {
|
|
String method_call = "subject.get_subject_identifier";
|
|
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 subject.
|
|
*
|
|
* @return value of the field
|
|
*/
|
|
public Map<String, String> getOtherConfig(Connection c) throws
|
|
BadServerResponse,
|
|
XenAPIException,
|
|
XmlRpcException {
|
|
String method_call = "subject.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);
|
|
}
|
|
|
|
/**
|
|
* Get the roles field of the given subject.
|
|
*
|
|
* @return value of the field
|
|
*/
|
|
public Set<Role> getRoles(Connection c) throws
|
|
BadServerResponse,
|
|
XenAPIException,
|
|
XmlRpcException {
|
|
String method_call = "subject.get_roles";
|
|
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.toSetOfRole(result);
|
|
}
|
|
|
|
/**
|
|
* This call adds a new role to a subject
|
|
*
|
|
* @param role The unique role reference
|
|
*/
|
|
public void addToRoles(Connection c, Role role) throws
|
|
BadServerResponse,
|
|
XenAPIException,
|
|
XmlRpcException {
|
|
String method_call = "subject.add_to_roles";
|
|
String session = c.getSessionReference();
|
|
Object[] method_params = {Marshalling.toXMLRPC(session), Marshalling.toXMLRPC(this.ref), Marshalling.toXMLRPC(role)};
|
|
Map response = c.dispatch(method_call, method_params);
|
|
return;
|
|
}
|
|
|
|
/**
|
|
* This call removes a role from a subject
|
|
*
|
|
* @param role The unique role reference in the subject's roles field
|
|
*/
|
|
public void removeFromRoles(Connection c, Role role) throws
|
|
BadServerResponse,
|
|
XenAPIException,
|
|
XmlRpcException {
|
|
String method_call = "subject.remove_from_roles";
|
|
String session = c.getSessionReference();
|
|
Object[] method_params = {Marshalling.toXMLRPC(session), Marshalling.toXMLRPC(this.ref), Marshalling.toXMLRPC(role)};
|
|
Map response = c.dispatch(method_call, method_params);
|
|
return;
|
|
}
|
|
|
|
/**
|
|
* This call returns a list of permission names given a subject
|
|
*
|
|
* @return a list of permission names
|
|
*/
|
|
public Set<String> getPermissionsNameLabel(Connection c) throws
|
|
BadServerResponse,
|
|
XenAPIException,
|
|
XmlRpcException {
|
|
String method_call = "subject.get_permissions_name_label";
|
|
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.toSetOfString(result);
|
|
}
|
|
|
|
/**
|
|
* Return a list of all the subjects known to the system.
|
|
*
|
|
* @return references to all objects
|
|
*/
|
|
public static Set<Subject> getAll(Connection c) throws
|
|
BadServerResponse,
|
|
XenAPIException,
|
|
XmlRpcException {
|
|
String method_call = "subject.get_all";
|
|
String session = c.getSessionReference();
|
|
Object[] method_params = {Marshalling.toXMLRPC(session)};
|
|
Map response = c.dispatch(method_call, method_params);
|
|
Object result = response.get("Value");
|
|
return Types.toSetOfSubject(result);
|
|
}
|
|
|
|
/**
|
|
* Return a map of subject references to subject records for all subjects known to the system.
|
|
*
|
|
* @return records of all objects
|
|
*/
|
|
public static Map<Subject, Subject.Record> getAllRecords(Connection c) throws
|
|
BadServerResponse,
|
|
XenAPIException,
|
|
XmlRpcException {
|
|
String method_call = "subject.get_all_records";
|
|
String session = c.getSessionReference();
|
|
Object[] method_params = {Marshalling.toXMLRPC(session)};
|
|
Map response = c.dispatch(method_call, method_params);
|
|
Object result = response.get("Value");
|
|
return Types.toMapOfSubjectSubjectRecord(result);
|
|
}
|
|
|
|
} |