Return-Path: X-Original-To: apmail-incubator-cloudstack-commits-archive@minotaur.apache.org Delivered-To: apmail-incubator-cloudstack-commits-archive@minotaur.apache.org Received: from mail.apache.org (hermes.apache.org [140.211.11.3]) by minotaur.apache.org (Postfix) with SMTP id 4D15FC70A for ; Thu, 23 Aug 2012 21:31:05 +0000 (UTC) Received: (qmail 62586 invoked by uid 500); 23 Aug 2012 21:30:56 -0000 Delivered-To: apmail-incubator-cloudstack-commits-archive@incubator.apache.org Received: (qmail 62543 invoked by uid 500); 23 Aug 2012 21:30:56 -0000 Mailing-List: contact cloudstack-commits-help@incubator.apache.org; run by ezmlm Precedence: bulk List-Help: List-Unsubscribe: List-Post: List-Id: Reply-To: cloudstack-dev@incubator.apache.org Delivered-To: mailing list cloudstack-commits@incubator.apache.org Received: (qmail 61610 invoked by uid 99); 23 Aug 2012 21:30:55 -0000 Received: from tyr.zones.apache.org (HELO tyr.zones.apache.org) (140.211.11.114) by apache.org (qpsmtpd/0.29) with ESMTP; Thu, 23 Aug 2012 21:30:55 +0000 Received: by tyr.zones.apache.org (Postfix, from userid 65534) id 2597A1F421; Thu, 23 Aug 2012 21:30:55 +0000 (UTC) Content-Type: text/plain; charset="us-ascii" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit From: kelveny@apache.org To: cloudstack-commits@incubator.apache.org X-Mailer: ASF-Git Admin Mailer Subject: [29/40] m2e doesn't like it when the project root is the source folder Message-Id: <20120823213055.2597A1F421@tyr.zones.apache.org> Date: Thu, 23 Aug 2012 21:30:55 +0000 (UTC) http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/blob/3976c747/deps/XenServerJava/src/com/xensource/xenapi/Session.java ---------------------------------------------------------------------- diff --git a/deps/XenServerJava/src/com/xensource/xenapi/Session.java b/deps/XenServerJava/src/com/xensource/xenapi/Session.java new file mode 100644 index 0000000..042ed1a --- /dev/null +++ b/deps/XenServerJava/src/com/xensource/xenapi/Session.java @@ -0,0 +1,653 @@ +// 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 session + * + * @author Citrix Systems, Inc. + */ +public class Session extends XenAPIObject { + + /** + * The XenAPI reference to this object. + */ + protected final String ref; + + /** + * For internal use only. + */ + Session(String ref) { + this.ref = ref; + } + + public String toWireString() { + return this.ref; + } + + /** + * If obj is a Session, compares XenAPI references for equality. + */ + @Override + public boolean equals(Object obj) + { + if (obj != null && obj instanceof Session) + { + Session other = (Session) obj; + return other.ref.equals(this.ref); + } else + { + return false; + } + } + + @Override + public int hashCode() + { + return ref.hashCode(); + } + + /** + * Represents all the fields in a Session + */ + 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", "thisHost", this.thisHost); + print.printf("%1$20s: %2$s\n", "thisUser", this.thisUser); + print.printf("%1$20s: %2$s\n", "lastActive", this.lastActive); + print.printf("%1$20s: %2$s\n", "pool", this.pool); + print.printf("%1$20s: %2$s\n", "otherConfig", this.otherConfig); + print.printf("%1$20s: %2$s\n", "isLocalSuperuser", this.isLocalSuperuser); + print.printf("%1$20s: %2$s\n", "subject", this.subject); + print.printf("%1$20s: %2$s\n", "validationTime", this.validationTime); + print.printf("%1$20s: %2$s\n", "authUserSid", this.authUserSid); + print.printf("%1$20s: %2$s\n", "authUserName", this.authUserName); + print.printf("%1$20s: %2$s\n", "rbacPermissions", this.rbacPermissions); + print.printf("%1$20s: %2$s\n", "tasks", this.tasks); + print.printf("%1$20s: %2$s\n", "parent", this.parent); + return writer.toString(); + } + + /** + * Convert a session.Record to a Map + */ + public Map toMap() { + Map map = new HashMap(); + map.put("uuid", this.uuid == null ? "" : this.uuid); + map.put("this_host", this.thisHost == null ? new Host("OpaqueRef:NULL") : this.thisHost); + map.put("this_user", this.thisUser == null ? new User("OpaqueRef:NULL") : this.thisUser); + map.put("last_active", this.lastActive == null ? new Date(0) : this.lastActive); + map.put("pool", this.pool == null ? false : this.pool); + map.put("other_config", this.otherConfig == null ? new HashMap() : this.otherConfig); + map.put("is_local_superuser", this.isLocalSuperuser == null ? false : this.isLocalSuperuser); + map.put("subject", this.subject == null ? new Subject("OpaqueRef:NULL") : this.subject); + map.put("validation_time", this.validationTime == null ? new Date(0) : this.validationTime); + map.put("auth_user_sid", this.authUserSid == null ? "" : this.authUserSid); + map.put("auth_user_name", this.authUserName == null ? "" : this.authUserName); + map.put("rbac_permissions", this.rbacPermissions == null ? new LinkedHashSet() : this.rbacPermissions); + map.put("tasks", this.tasks == null ? new LinkedHashSet() : this.tasks); + map.put("parent", this.parent == null ? new Session("OpaqueRef:NULL") : this.parent); + return map; + } + + /** + * Unique identifier/object reference + */ + public String uuid; + /** + * Currently connected host + */ + public Host thisHost; + /** + * Currently connected user + */ + public User thisUser; + /** + * Timestamp for last time session was active + */ + public Date lastActive; + /** + * True if this session relates to a intra-pool login, false otherwise + */ + public Boolean pool; + /** + * additional configuration + */ + public Map otherConfig; + /** + * true iff this session was created using local superuser credentials + */ + public Boolean isLocalSuperuser; + /** + * references the subject instance that created the session. If a session instance has is_local_superuser set, then the value of this field is undefined. + */ + public Subject subject; + /** + * time when session was last validated + */ + public Date validationTime; + /** + * the subject identifier of the user that was externally authenticated. If a session instance has is_local_superuser set, then the value of this field is undefined. + */ + public String authUserSid; + /** + * the subject name of the user that was externally authenticated. If a session instance has is_local_superuser set, then the value of this field is undefined. + */ + public String authUserName; + /** + * list with all RBAC permissions for this session + */ + public Set rbacPermissions; + /** + * list of tasks created using the current session + */ + public Set tasks; + /** + * references the parent session that created this session + */ + public Session parent; + } + + /** + * Get a record containing the current state of the given session. + * + * @return all fields from the object + */ + public Session.Record getRecord(Connection c) throws + BadServerResponse, + XenAPIException, + XmlRpcException { + String method_call = "session.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.toSessionRecord(result); + } + + /** + * Get a reference to the session instance with the specified UUID. + * + * @param uuid UUID of object to return + * @return reference to the object + */ + public static Session getByUuid(Connection c, String uuid) throws + BadServerResponse, + XenAPIException, + XmlRpcException { + String method_call = "session.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.toSession(result); + } + + /** + * Get the uuid field of the given session. + * + * @return value of the field + */ + public String getUuid(Connection c) throws + BadServerResponse, + XenAPIException, + XmlRpcException { + String method_call = "session.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 this_host field of the given session. + * + * @return value of the field + */ + public Host getThisHost(Connection c) throws + BadServerResponse, + XenAPIException, + XmlRpcException { + String method_call = "session.get_this_host"; + 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.toHost(result); + } + + /** + * Get the this_user field of the given session. + * + * @return value of the field + */ + public User getThisUser(Connection c) throws + BadServerResponse, + XenAPIException, + XmlRpcException { + String method_call = "session.get_this_user"; + 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.toUser(result); + } + + /** + * Get the last_active field of the given session. + * + * @return value of the field + */ + public Date getLastActive(Connection c) throws + BadServerResponse, + XenAPIException, + XmlRpcException { + String method_call = "session.get_last_active"; + 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.toDate(result); + } + + /** + * Get the pool field of the given session. + * + * @return value of the field + */ + public Boolean getPool(Connection c) throws + BadServerResponse, + XenAPIException, + XmlRpcException { + String method_call = "session.get_pool"; + 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.toBoolean(result); + } + + /** + * Get the other_config field of the given session. + * + * @return value of the field + */ + public Map getOtherConfig(Connection c) throws + BadServerResponse, + XenAPIException, + XmlRpcException { + String method_call = "session.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 is_local_superuser field of the given session. + * + * @return value of the field + */ + public Boolean getIsLocalSuperuser(Connection c) throws + BadServerResponse, + XenAPIException, + XmlRpcException { + String method_call = "session.get_is_local_superuser"; + 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.toBoolean(result); + } + + /** + * Get the subject field of the given session. + * + * @return value of the field + */ + public Subject getSubject(Connection c) throws + BadServerResponse, + XenAPIException, + XmlRpcException { + String method_call = "session.get_subject"; + 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.toSubject(result); + } + + /** + * Get the validation_time field of the given session. + * + * @return value of the field + */ + public Date getValidationTime(Connection c) throws + BadServerResponse, + XenAPIException, + XmlRpcException { + String method_call = "session.get_validation_time"; + 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.toDate(result); + } + + /** + * Get the auth_user_sid field of the given session. + * + * @return value of the field + */ + public String getAuthUserSid(Connection c) throws + BadServerResponse, + XenAPIException, + XmlRpcException { + String method_call = "session.get_auth_user_sid"; + 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 auth_user_name field of the given session. + * + * @return value of the field + */ + public String getAuthUserName(Connection c) throws + BadServerResponse, + XenAPIException, + XmlRpcException { + String method_call = "session.get_auth_user_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 rbac_permissions field of the given session. + * + * @return value of the field + */ + public Set getRbacPermissions(Connection c) throws + BadServerResponse, + XenAPIException, + XmlRpcException { + String method_call = "session.get_rbac_permissions"; + 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); + } + + /** + * Get the tasks field of the given session. + * + * @return value of the field + */ + public Set getTasks(Connection c) throws + BadServerResponse, + XenAPIException, + XmlRpcException { + String method_call = "session.get_tasks"; + 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.toSetOfTask(result); + } + + /** + * Get the parent field of the given session. + * + * @return value of the field + */ + public Session getParent(Connection c) throws + BadServerResponse, + XenAPIException, + XmlRpcException { + String method_call = "session.get_parent"; + 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.toSession(result); + } + + /** + * Set the other_config field of the given session. + * + * @param otherConfig New value to set + */ + public void setOtherConfig(Connection c, Map otherConfig) throws + BadServerResponse, + XenAPIException, + XmlRpcException { + String method_call = "session.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 session. + * + * @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 = "session.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 session. 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 = "session.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; + } + + /** + * Attempt to authenticate the user, returning a session reference if successful + * + * @param uname Username for login. + * @param pwd Password for login. + * @param version Client API version. + * @return reference of newly created session + */ + public static Session loginWithPassword(Connection c, String uname, String pwd, String version) throws + BadServerResponse, + XenAPIException, + XmlRpcException, + Types.SessionAuthenticationFailed { + String method_call = "session.login_with_password"; + Object[] method_params = {Marshalling.toXMLRPC(uname), Marshalling.toXMLRPC(pwd), Marshalling.toXMLRPC(version)}; + Map response = c.dispatch(method_call, method_params); + Object result = response.get("Value"); + return Types.toSession(result); + } + + /** + * Log out of a session + * + */ + public static void logout(Connection c) throws + BadServerResponse, + XenAPIException, + XmlRpcException { + String method_call = "session.logout"; + String session = c.getSessionReference(); + Object[] method_params = {Marshalling.toXMLRPC(session)}; + Map response = c.dispatch(method_call, method_params); + return; + } + + /** + * Change the account password; if your session is authenticated with root priviledges then the old_pwd is validated and the new_pwd is set regardless + * + * @param oldPwd Old password for account + * @param newPwd New password for account + */ + public static void changePassword(Connection c, String oldPwd, String newPwd) throws + BadServerResponse, + XenAPIException, + XmlRpcException { + String method_call = "session.change_password"; + String session = c.getSessionReference(); + Object[] method_params = {Marshalling.toXMLRPC(session), Marshalling.toXMLRPC(oldPwd), Marshalling.toXMLRPC(newPwd)}; + Map response = c.dispatch(method_call, method_params); + return; + } + + /** + * Authenticate locally against a slave in emergency mode. Note the resulting sessions are only good for use on this host. + * + * @param uname Username for login. + * @param pwd Password for login. + * @return ID of newly created session + */ + public static Session slaveLocalLoginWithPassword(Connection c, String uname, String pwd) throws + BadServerResponse, + XenAPIException, + XmlRpcException { + String method_call = "session.slave_local_login_with_password"; + Object[] method_params = {Marshalling.toXMLRPC(uname), Marshalling.toXMLRPC(pwd)}; + Map response = c.dispatch(method_call, method_params); + Object result = response.get("Value"); + return Types.toSession(result); + } + + /** + * Log out of local session. + * + */ + public static void localLogout(Connection c) throws + BadServerResponse, + XenAPIException, + XmlRpcException { + String method_call = "session.local_logout"; + String session = c.getSessionReference(); + Object[] method_params = {Marshalling.toXMLRPC(session)}; + Map response = c.dispatch(method_call, method_params); + return; + } + + /** + * Return a list of all the user subject-identifiers of all existing sessions + * + * @return Task + */ + public static Task getAllSubjectIdentifiersAsync(Connection c) throws + BadServerResponse, + XenAPIException, + XmlRpcException { + String method_call = "Async.session.get_all_subject_identifiers"; + 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.toTask(result); + } + + /** + * Return a list of all the user subject-identifiers of all existing sessions + * + * @return The list of user subject-identifiers of all existing sessions + */ + public static Set getAllSubjectIdentifiers(Connection c) throws + BadServerResponse, + XenAPIException, + XmlRpcException { + String method_call = "session.get_all_subject_identifiers"; + 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.toSetOfString(result); + } + + /** + * Log out all sessions associated to a user subject-identifier, except the session associated with the context calling this function + * + * @param subjectIdentifier User subject-identifier of the sessions to be destroyed + * @return Task + */ + public static Task logoutSubjectIdentifierAsync(Connection c, String subjectIdentifier) throws + BadServerResponse, + XenAPIException, + XmlRpcException { + String method_call = "Async.session.logout_subject_identifier"; + String session = c.getSessionReference(); + Object[] method_params = {Marshalling.toXMLRPC(session), Marshalling.toXMLRPC(subjectIdentifier)}; + Map response = c.dispatch(method_call, method_params); + Object result = response.get("Value"); + return Types.toTask(result); + } + + /** + * Log out all sessions associated to a user subject-identifier, except the session associated with the context calling this function + * + * @param subjectIdentifier User subject-identifier of the sessions to be destroyed + */ + public static void logoutSubjectIdentifier(Connection c, String subjectIdentifier) throws + BadServerResponse, + XenAPIException, + XmlRpcException { + String method_call = "session.logout_subject_identifier"; + String session = c.getSessionReference(); + Object[] method_params = {Marshalling.toXMLRPC(session), Marshalling.toXMLRPC(subjectIdentifier)}; + Map response = c.dispatch(method_call, method_params); + return; + } + +} \ No newline at end of file http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/blob/3976c747/deps/XenServerJava/src/com/xensource/xenapi/Subject.java ---------------------------------------------------------------------- diff --git a/deps/XenServerJava/src/com/xensource/xenapi/Subject.java b/deps/XenServerJava/src/com/xensource/xenapi/Subject.java new file mode 100644 index 0000000..cbba9a4 --- /dev/null +++ b/deps/XenServerJava/src/com/xensource/xenapi/Subject.java @@ -0,0 +1,374 @@ +// 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 toMap() { + Map map = new HashMap(); + 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() : this.otherConfig); + map.put("roles", this.roles == null ? new LinkedHashSet() : 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 otherConfig; + /** + * the roles associated with this subject + */ + public Set 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 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 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 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 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 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 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 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); + } + +} \ No newline at end of file http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/blob/3976c747/deps/XenServerJava/src/com/xensource/xenapi/Task.java ---------------------------------------------------------------------- diff --git a/deps/XenServerJava/src/com/xensource/xenapi/Task.java b/deps/XenServerJava/src/com/xensource/xenapi/Task.java new file mode 100644 index 0000000..ee688c7 --- /dev/null +++ b/deps/XenServerJava/src/com/xensource/xenapi/Task.java @@ -0,0 +1,666 @@ +// 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 long-running asynchronous task + * + * @author Citrix Systems, Inc. + */ +public class Task extends XenAPIObject { + + /** + * The XenAPI reference to this object. + */ + protected final String ref; + + /** + * For internal use only. + */ + Task(String ref) { + this.ref = ref; + } + + public String toWireString() { + return this.ref; + } + + /** + * If obj is a Task, compares XenAPI references for equality. + */ + @Override + public boolean equals(Object obj) + { + if (obj != null && obj instanceof Task) + { + Task other = (Task) obj; + return other.ref.equals(this.ref); + } else + { + return false; + } + } + + @Override + public int hashCode() + { + return ref.hashCode(); + } + + /** + * Represents all the fields in a Task + */ + 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", "nameLabel", this.nameLabel); + print.printf("%1$20s: %2$s\n", "nameDescription", this.nameDescription); + print.printf("%1$20s: %2$s\n", "allowedOperations", this.allowedOperations); + print.printf("%1$20s: %2$s\n", "currentOperations", this.currentOperations); + print.printf("%1$20s: %2$s\n", "created", this.created); + print.printf("%1$20s: %2$s\n", "finished", this.finished); + print.printf("%1$20s: %2$s\n", "status", this.status); + print.printf("%1$20s: %2$s\n", "residentOn", this.residentOn); + print.printf("%1$20s: %2$s\n", "progress", this.progress); + print.printf("%1$20s: %2$s\n", "type", this.type); + print.printf("%1$20s: %2$s\n", "result", this.result); + print.printf("%1$20s: %2$s\n", "errorInfo", this.errorInfo); + print.printf("%1$20s: %2$s\n", "otherConfig", this.otherConfig); + print.printf("%1$20s: %2$s\n", "subtaskOf", this.subtaskOf); + print.printf("%1$20s: %2$s\n", "subtasks", this.subtasks); + return writer.toString(); + } + + /** + * Convert a task.Record to a Map + */ + public Map toMap() { + Map map = new HashMap(); + map.put("uuid", this.uuid == null ? "" : this.uuid); + map.put("name_label", this.nameLabel == null ? "" : this.nameLabel); + map.put("name_description", this.nameDescription == null ? "" : this.nameDescription); + map.put("allowed_operations", this.allowedOperations == null ? new LinkedHashSet() : this.allowedOperations); + map.put("current_operations", this.currentOperations == null ? new HashMap() : this.currentOperations); + map.put("created", this.created == null ? new Date(0) : this.created); + map.put("finished", this.finished == null ? new Date(0) : this.finished); + map.put("status", this.status == null ? Types.TaskStatusType.UNRECOGNIZED : this.status); + map.put("resident_on", this.residentOn == null ? new Host("OpaqueRef:NULL") : this.residentOn); + map.put("progress", this.progress == null ? 0.0 : this.progress); + map.put("type", this.type == null ? "" : this.type); + map.put("result", this.result == null ? "" : this.result); + map.put("error_info", this.errorInfo == null ? new LinkedHashSet() : this.errorInfo); + map.put("other_config", this.otherConfig == null ? new HashMap() : this.otherConfig); + map.put("subtask_of", this.subtaskOf == null ? new Task("OpaqueRef:NULL") : this.subtaskOf); + map.put("subtasks", this.subtasks == null ? new LinkedHashSet() : this.subtasks); + return map; + } + + /** + * Unique identifier/object reference + */ + public String uuid; + /** + * a human-readable name + */ + public String nameLabel; + /** + * a notes field containg human-readable description + */ + public String nameDescription; + /** + * list of the operations allowed in this state. This list is advisory only and the server state may have changed by the time this field is read by a client. + */ + public Set allowedOperations; + /** + * links each of the running tasks using this object (by reference) to a current_operation enum which describes the nature of the task. + */ + public Map currentOperations; + /** + * Time task was created + */ + public Date created; + /** + * Time task finished (i.e. succeeded or failed). If task-status is pending, then the value of this field has no meaning + */ + public Date finished; + /** + * current status of the task + */ + public Types.TaskStatusType status; + /** + * the host on which the task is running + */ + public Host residentOn; + /** + * if the task is still pending, this field contains the estimated fraction complete (0.-1.). If task has completed (successfully or unsuccessfully) this should be 1. + */ + public Double progress; + /** + * if the task has completed successfully, this field contains the type of the encoded result (i.e. name of the class whose reference is in the result field). Undefined otherwise. + */ + public String type; + /** + * if the task has completed successfully, this field contains the result value (either Void or an object reference). Undefined otherwise. + */ + public String result; + /** + * if the task has failed, this field contains the set of associated error strings. Undefined otherwise. + */ + public Set errorInfo; + /** + * additional configuration + */ + public Map otherConfig; + /** + * Ref pointing to the task this is a substask of. + */ + public Task subtaskOf; + /** + * List pointing to all the substasks. + */ + public Set subtasks; + } + + /** + * Get a record containing the current state of the given task. + * + * @return all fields from the object + */ + public Task.Record getRecord(Connection c) throws + BadServerResponse, + XenAPIException, + XmlRpcException { + String method_call = "task.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.toTaskRecord(result); + } + + /** + * Get a reference to the task instance with the specified UUID. + * + * @param uuid UUID of object to return + * @return reference to the object + */ + public static Task getByUuid(Connection c, String uuid) throws + BadServerResponse, + XenAPIException, + XmlRpcException { + String method_call = "task.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.toTask(result); + } + + /** + * Get all the task instances with the given label. + * + * @param label label of object to return + * @return references to objects with matching names + */ + public static Set getByNameLabel(Connection c, String label) throws + BadServerResponse, + XenAPIException, + XmlRpcException { + String method_call = "task.get_by_name_label"; + String session = c.getSessionReference(); + Object[] method_params = {Marshalling.toXMLRPC(session), Marshalling.toXMLRPC(label)}; + Map response = c.dispatch(method_call, method_params); + Object result = response.get("Value"); + return Types.toSetOfTask(result); + } + + /** + * Get the uuid field of the given task. + * + * @return value of the field + */ + public String getUuid(Connection c) throws + BadServerResponse, + XenAPIException, + XmlRpcException { + String method_call = "task.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 name/label field of the given task. + * + * @return value of the field + */ + public String getNameLabel(Connection c) throws + BadServerResponse, + XenAPIException, + XmlRpcException { + String method_call = "task.get_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.toString(result); + } + + /** + * Get the name/description field of the given task. + * + * @return value of the field + */ + public String getNameDescription(Connection c) throws + BadServerResponse, + XenAPIException, + XmlRpcException { + String method_call = "task.get_name_description"; + 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 allowed_operations field of the given task. + * + * @return value of the field + */ + public Set getAllowedOperations(Connection c) throws + BadServerResponse, + XenAPIException, + XmlRpcException { + String method_call = "task.get_allowed_operations"; + 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.toSetOfTaskAllowedOperations(result); + } + + /** + * Get the current_operations field of the given task. + * + * @return value of the field + */ + public Map getCurrentOperations(Connection c) throws + BadServerResponse, + XenAPIException, + XmlRpcException { + String method_call = "task.get_current_operations"; + 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.toMapOfStringTaskAllowedOperations(result); + } + + /** + * Get the created field of the given task. + * + * @return value of the field + */ + public Date getCreated(Connection c) throws + BadServerResponse, + XenAPIException, + XmlRpcException { + String method_call = "task.get_created"; + 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.toDate(result); + } + + /** + * Get the finished field of the given task. + * + * @return value of the field + */ + public Date getFinished(Connection c) throws + BadServerResponse, + XenAPIException, + XmlRpcException { + String method_call = "task.get_finished"; + 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.toDate(result); + } + + /** + * Get the status field of the given task. + * + * @return value of the field + */ + public Types.TaskStatusType getStatus(Connection c) throws + BadServerResponse, + XenAPIException, + XmlRpcException { + String method_call = "task.get_status"; + 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.toTaskStatusType(result); + } + + /** + * Get the resident_on field of the given task. + * + * @return value of the field + */ + public Host getResidentOn(Connection c) throws + BadServerResponse, + XenAPIException, + XmlRpcException { + String method_call = "task.get_resident_on"; + 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.toHost(result); + } + + /** + * Get the progress field of the given task. + * + * @return value of the field + */ + public Double getProgress(Connection c) throws + BadServerResponse, + XenAPIException, + XmlRpcException { + String method_call = "task.get_progress"; + 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.toDouble(result); + } + + /** + * Get the type field of the given task. + * + * @return value of the field + */ + public String getType(Connection c) throws + BadServerResponse, + XenAPIException, + XmlRpcException { + String method_call = "task.get_type"; + 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 result field of the given task. + * + * @return value of the field + */ + public String getResult(Connection c) throws + BadServerResponse, + XenAPIException, + XmlRpcException { + String method_call = "task.get_result"; + 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 error_info field of the given task. + * + * @return value of the field + */ + public Set getErrorInfo(Connection c) throws + BadServerResponse, + XenAPIException, + XmlRpcException { + String method_call = "task.get_error_info"; + 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); + } + + /** + * Get the other_config field of the given task. + * + * @return value of the field + */ + public Map getOtherConfig(Connection c) throws + BadServerResponse, + XenAPIException, + XmlRpcException { + String method_call = "task.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 subtask_of field of the given task. + * + * @return value of the field + */ + public Task getSubtaskOf(Connection c) throws + BadServerResponse, + XenAPIException, + XmlRpcException { + String method_call = "task.get_subtask_of"; + 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); + } + + /** + * Get the subtasks field of the given task. + * + * @return value of the field + */ + public Set getSubtasks(Connection c) throws + BadServerResponse, + XenAPIException, + XmlRpcException { + String method_call = "task.get_subtasks"; + 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.toSetOfTask(result); + } + + /** + * Set the other_config field of the given task. + * + * @param otherConfig New value to set + */ + public void setOtherConfig(Connection c, Map otherConfig) throws + BadServerResponse, + XenAPIException, + XmlRpcException { + String method_call = "task.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 task. + * + * @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 = "task.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 task. 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 = "task.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; + } + + /** + * Create a new task object which must be manually destroyed. + * + * @param label short label for the new task + * @param description longer description for the new task + * @return The reference of the created task object + */ + public static Task create(Connection c, String label, String description) throws + BadServerResponse, + XenAPIException, + XmlRpcException { + String method_call = "task.create"; + String session = c.getSessionReference(); + Object[] method_params = {Marshalling.toXMLRPC(session), Marshalling.toXMLRPC(label), Marshalling.toXMLRPC(description)}; + Map response = c.dispatch(method_call, method_params); + Object result = response.get("Value"); + return Types.toTask(result); + } + + /** + * Destroy the task object + * + */ + public void destroy(Connection c) throws + BadServerResponse, + XenAPIException, + XmlRpcException { + String method_call = "task.destroy"; + String session = c.getSessionReference(); + Object[] method_params = {Marshalling.toXMLRPC(session), Marshalling.toXMLRPC(this.ref)}; + Map response = c.dispatch(method_call, method_params); + return; + } + + /** + * Request that a task be cancelled. Note that a task may fail to be cancelled and may complete or fail normally and note that, even when a task does cancel, it might take an arbitrary amount of time. + * + * @return Task + */ + public Task cancelAsync(Connection c) throws + BadServerResponse, + XenAPIException, + XmlRpcException, + Types.OperationNotAllowed { + String method_call = "Async.task.cancel"; + 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); + } + + /** + * Request that a task be cancelled. Note that a task may fail to be cancelled and may complete or fail normally and note that, even when a task does cancel, it might take an arbitrary amount of time. + * + */ + public void cancel(Connection c) throws + BadServerResponse, + XenAPIException, + XmlRpcException, + Types.OperationNotAllowed { + String method_call = "task.cancel"; + String session = c.getSessionReference(); + Object[] method_params = {Marshalling.toXMLRPC(session), Marshalling.toXMLRPC(this.ref)}; + Map response = c.dispatch(method_call, method_params); + return; + } + + /** + * Return a list of all the tasks known to the system. + * + * @return references to all objects + */ + public static Set getAll(Connection c) throws + BadServerResponse, + XenAPIException, + XmlRpcException { + String method_call = "task.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.toSetOfTask(result); + } + + /** + * Return a map of task references to task records for all tasks known to the system. + * + * @return records of all objects + */ + public static Map getAllRecords(Connection c) throws + BadServerResponse, + XenAPIException, + XmlRpcException { + String method_call = "task.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.toMapOfTaskTaskRecord(result); + } + +} \ No newline at end of file http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/blob/3976c747/deps/XenServerJava/src/com/xensource/xenapi/Tunnel.java ---------------------------------------------------------------------- diff --git a/deps/XenServerJava/src/com/xensource/xenapi/Tunnel.java b/deps/XenServerJava/src/com/xensource/xenapi/Tunnel.java new file mode 100644 index 0000000..660eafb --- /dev/null +++ b/deps/XenServerJava/src/com/xensource/xenapi/Tunnel.java @@ -0,0 +1,452 @@ +// 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 tunnel for network traffic + * + * @author Citrix Systems, Inc. + */ +public class Tunnel extends XenAPIObject { + + /** + * The XenAPI reference to this object. + */ + protected final String ref; + + /** + * For internal use only. + */ + Tunnel(String ref) { + this.ref = ref; + } + + public String toWireString() { + return this.ref; + } + + /** + * If obj is a Tunnel, compares XenAPI references for equality. + */ + @Override + public boolean equals(Object obj) + { + if (obj != null && obj instanceof Tunnel) + { + Tunnel other = (Tunnel) obj; + return other.ref.equals(this.ref); + } else + { + return false; + } + } + + @Override + public int hashCode() + { + return ref.hashCode(); + } + + /** + * Represents all the fields in a Tunnel + */ + 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", "accessPIF", this.accessPIF); + print.printf("%1$20s: %2$s\n", "transportPIF", this.transportPIF); + print.printf("%1$20s: %2$s\n", "status", this.status); + print.printf("%1$20s: %2$s\n", "otherConfig", this.otherConfig); + return writer.toString(); + } + + /** + * Convert a tunnel.Record to a Map + */ + public Map toMap() { + Map map = new HashMap(); + map.put("uuid", this.uuid == null ? "" : this.uuid); + map.put("access_PIF", this.accessPIF == null ? new PIF("OpaqueRef:NULL") : this.accessPIF); + map.put("transport_PIF", this.transportPIF == null ? new PIF("OpaqueRef:NULL") : this.transportPIF); + map.put("status", this.status == null ? new HashMap() : this.status); + map.put("other_config", this.otherConfig == null ? new HashMap() : this.otherConfig); + return map; + } + + /** + * Unique identifier/object reference + */ + public String uuid; + /** + * The interface through which the tunnel is accessed + */ + public PIF accessPIF; + /** + * The interface used by the tunnel + */ + public PIF transportPIF; + /** + * Status information about the tunnel + */ + public Map status; + /** + * Additional configuration + */ + public Map otherConfig; + } + + /** + * Get a record containing the current state of the given tunnel. + * + * @return all fields from the object + */ + public Tunnel.Record getRecord(Connection c) throws + BadServerResponse, + XenAPIException, + XmlRpcException { + String method_call = "tunnel.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.toTunnelRecord(result); + } + + /** + * Get a reference to the tunnel instance with the specified UUID. + * + * @param uuid UUID of object to return + * @return reference to the object + */ + public static Tunnel getByUuid(Connection c, String uuid) throws + BadServerResponse, + XenAPIException, + XmlRpcException { + String method_call = "tunnel.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.toTunnel(result); + } + + /** + * Get the uuid field of the given tunnel. + * + * @return value of the field + */ + public String getUuid(Connection c) throws + BadServerResponse, + XenAPIException, + XmlRpcException { + String method_call = "tunnel.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 access_PIF field of the given tunnel. + * + * @return value of the field + */ + public PIF getAccessPIF(Connection c) throws + BadServerResponse, + XenAPIException, + XmlRpcException { + String method_call = "tunnel.get_access_PIF"; + 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.toPIF(result); + } + + /** + * Get the transport_PIF field of the given tunnel. + * + * @return value of the field + */ + public PIF getTransportPIF(Connection c) throws + BadServerResponse, + XenAPIException, + XmlRpcException { + String method_call = "tunnel.get_transport_PIF"; + 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.toPIF(result); + } + + /** + * Get the status field of the given tunnel. + * + * @return value of the field + */ + public Map getStatus(Connection c) throws + BadServerResponse, + XenAPIException, + XmlRpcException { + String method_call = "tunnel.get_status"; + 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 other_config field of the given tunnel. + * + * @return value of the field + */ + public Map getOtherConfig(Connection c) throws + BadServerResponse, + XenAPIException, + XmlRpcException { + String method_call = "tunnel.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 status field of the given tunnel. + * + * @param status New value to set + */ + public void setStatus(Connection c, Map status) throws + BadServerResponse, + XenAPIException, + XmlRpcException { + String method_call = "tunnel.set_status"; + String session = c.getSessionReference(); + Object[] method_params = {Marshalling.toXMLRPC(session), Marshalling.toXMLRPC(this.ref), Marshalling.toXMLRPC(status)}; + Map response = c.dispatch(method_call, method_params); + return; + } + + /** + * Add the given key-value pair to the status field of the given tunnel. + * + * @param key Key to add + * @param value Value to add + */ + public void addToStatus(Connection c, String key, String value) throws + BadServerResponse, + XenAPIException, + XmlRpcException { + String method_call = "tunnel.add_to_status"; + 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 status field of the given tunnel. If the key is not in that Map, then do nothing. + * + * @param key Key to remove + */ + public void removeFromStatus(Connection c, String key) throws + BadServerResponse, + XenAPIException, + XmlRpcException { + String method_call = "tunnel.remove_from_status"; + 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; + } + + /** + * Set the other_config field of the given tunnel. + * + * @param otherConfig New value to set + */ + public void setOtherConfig(Connection c, Map otherConfig) throws + BadServerResponse, + XenAPIException, + XmlRpcException { + String method_call = "tunnel.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 tunnel. + * + * @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 = "tunnel.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 tunnel. 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 = "tunnel.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; + } + + /** + * Create a tunnel + * + * @param transportPIF PIF which receives the tagged traffic + * @param network Network to receive the tunnelled traffic + * @return Task + */ + public static Task createAsync(Connection c, PIF transportPIF, Network network) throws + BadServerResponse, + XenAPIException, + XmlRpcException, + Types.OpenvswitchNotActive, + Types.TransportPifNotConfigured, + Types.IsTunnelAccessPif { + String method_call = "Async.tunnel.create"; + String session = c.getSessionReference(); + Object[] method_params = {Marshalling.toXMLRPC(session), Marshalling.toXMLRPC(transportPIF), Marshalling.toXMLRPC(network)}; + Map response = c.dispatch(method_call, method_params); + Object result = response.get("Value"); + return Types.toTask(result); + } + + /** + * Create a tunnel + * + * @param transportPIF PIF which receives the tagged traffic + * @param network Network to receive the tunnelled traffic + * @return The reference of the created tunnel object + */ + public static Tunnel create(Connection c, PIF transportPIF, Network network) throws + BadServerResponse, + XenAPIException, + XmlRpcException, + Types.OpenvswitchNotActive, + Types.TransportPifNotConfigured, + Types.IsTunnelAccessPif { + String method_call = "tunnel.create"; + String session = c.getSessionReference(); + Object[] method_params = {Marshalling.toXMLRPC(session), Marshalling.toXMLRPC(transportPIF), Marshalling.toXMLRPC(network)}; + Map response = c.dispatch(method_call, method_params); + Object result = response.get("Value"); + return Types.toTunnel(result); + } + + /** + * Destroy a tunnel + * + * @return Task + */ + public Task destroyAsync(Connection c) throws + BadServerResponse, + XenAPIException, + XmlRpcException { + String method_call = "Async.tunnel.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 a tunnel + * + */ + public void destroy(Connection c) throws + BadServerResponse, + XenAPIException, + XmlRpcException { + String method_call = "tunnel.destroy"; + String session = c.getSessionReference(); + Object[] method_params = {Marshalling.toXMLRPC(session), Marshalling.toXMLRPC(this.ref)}; + Map response = c.dispatch(method_call, method_params); + return; + } + + /** + * Return a list of all the tunnels known to the system. + * + * @return references to all objects + */ + public static Set getAll(Connection c) throws + BadServerResponse, + XenAPIException, + XmlRpcException { + String method_call = "tunnel.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.toSetOfTunnel(result); + } + + /** + * Return a map of tunnel references to tunnel records for all tunnels known to the system. + * + * @return records of all objects + */ + public static Map getAllRecords(Connection c) throws + BadServerResponse, + XenAPIException, + XmlRpcException { + String method_call = "tunnel.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.toMapOfTunnelTunnelRecord(result); + } + +} \ No newline at end of file