java/code/src/com/redhat/rhn/frontend/xmlrpc/sync/master/MasterHandler.java | 18
+++----
java/code/src/com/redhat/rhn/frontend/xmlrpc/sync/slave/SlaveHandler.java | 24
+++++-----
2 files changed, 21 insertions(+), 21 deletions(-)
New commits:
commit 2f850653010190ca840492935fd79052125871c3
Author: Grant Gainey <ggainey(a)redhat.com>
Date: Wed Sep 4 18:26:50 2013 -0400
1004547 - fixed API doc for some ISS calls
diff --git a/java/code/src/com/redhat/rhn/frontend/xmlrpc/sync/master/MasterHandler.java
b/java/code/src/com/redhat/rhn/frontend/xmlrpc/sync/master/MasterHandler.java
index e458649..61c9100 100644
--- a/java/code/src/com/redhat/rhn/frontend/xmlrpc/sync/master/MasterHandler.java
+++ b/java/code/src/com/redhat/rhn/frontend/xmlrpc/sync/master/MasterHandler.java
@@ -142,11 +142,11 @@ public class MasterHandler extends BaseHandler {
}
/**
- * Return the current default-master for this slave
+ * Return the current default-Master for this Slave
* @param sessionKey User's session key
- * @return current default master, null if there isn't one
+ * @return current default Master, null if there isn't one
*
- * @xmlrpc.doc Return the current default-master for this slave
+ * @xmlrpc.doc Return the current default-Master for this Slave
* @xmlrpc.param #param("string", "sessionKey")
* @xmlrpc.returntype $IssMasterSerializer
*/
@@ -179,7 +179,7 @@ public class MasterHandler extends BaseHandler {
* @param caCertFilename path to this Master's CA Cert on this Slave
* @return 1 on success, exception otherwise
*
- * @xmlrpc.doc Make the specified Master the default for this Slave's
satellite-sync
+ * @xmlrpc.doc Set the CA-CERT filename for specified Master on this Slave
* @xmlrpc.param #param("string", "sessionKey")
* @xmlrpc.param #param_desc("int", "id", "Id of the Master
to affect")
* @xmlrpc.param #param_desc("string", "caCertFilename",
@@ -198,7 +198,7 @@ public class MasterHandler extends BaseHandler {
* @param masterId Id of the Master to look for
* @return the specified Master if found, exception otherwise
*
- * @xmlrpc.doc Remove the specified Master
+ * @xmlrpc.doc Find a Master by specifying its ID
* @xmlrpc.param #param("string", "sessionKey")
* @xmlrpc.param #param_desc("int", "id", "Id of the desired
Master")
* @xmlrpc.returntype $IssMasterSerializer
@@ -217,7 +217,7 @@ public class MasterHandler extends BaseHandler {
* @param masterLabel Label of the Master to look for
* @return the specified Master if found, exception otherwise
*
- * @xmlrpc.doc Remove the specified Master
+ * @xmlrpc.doc Find a Master by specifying its label
* @xmlrpc.param #param("string", "sessionKey")
* @xmlrpc.param #param_desc("string", "label", "Label of
the desired Master")
* @xmlrpc.returntype $IssMasterSerializer
@@ -231,11 +231,11 @@ public class MasterHandler extends BaseHandler {
}
/**
- * Get all the masters this slave knows about
+ * Get all the Masters this Slave knows about
* @param sessionKey User's session key.
* @return list of all the IssMasters we know about
*
- * @xmlrpc.doc Get all the masters this slave knows about
+ * @xmlrpc.doc Get all the Masters this Slave knows about
* @xmlrpc.param #param("string", "sessionKey")
* @xmlrpc.returntype
* #array()
@@ -278,7 +278,7 @@ public class MasterHandler extends BaseHandler {
* @param orgMaps List of MasterOrgs we know about
* @return 1 if successful, exception otherwise
*
- * @xmlrpc.doc List all organizations the specified Master has exported to this
Slave
+ * @xmlrpc.doc Reset all organizations the specified Master has exported to this
Slave
* @xmlrpc.param #param("string", "sessionKey")
* @xmlrpc.param #param_desc("int", "id", "Id of the desired
Master")
* @xmlrpc.param
diff --git a/java/code/src/com/redhat/rhn/frontend/xmlrpc/sync/slave/SlaveHandler.java
b/java/code/src/com/redhat/rhn/frontend/xmlrpc/sync/slave/SlaveHandler.java
index 09b63a5..bd16a9c 100644
--- a/java/code/src/com/redhat/rhn/frontend/xmlrpc/sync/slave/SlaveHandler.java
+++ b/java/code/src/com/redhat/rhn/frontend/xmlrpc/sync/slave/SlaveHandler.java
@@ -48,7 +48,7 @@ public class SlaveHandler extends BaseHandler {
* @param inAllowAllOrgs Should we export all orgs to this Slave?
* @return Newly created ISSSlave object.
*
- * @xmlrpc.doc Create a new Slave, known to this Slave.
+ * @xmlrpc.doc Create a new Slave, known to this Master.
* @xmlrpc.param #param("string", "sessionKey")
* @xmlrpc.param #param_desc("string", "slave", "Slave's
fully-qualified domain name")
* @xmlrpc.param #param_desc("boolean",
@@ -77,22 +77,22 @@ public class SlaveHandler extends BaseHandler {
}
/**
- * Updates the label of the specified Slave
+ * Updates attributes of the specified Slave
* @param sessionKey User's session key.
- * @param inSlaveId id of slave to update
+ * @param inSlaveId id of Slave to update
* @param inSlave Slave's fully-qualified domain name
* @param inEnabled Is this Slave allowed to talk to us?
* @param inAllowAllOrgs Should we export all orgs to this Slave?
* @return updated IssSlave
*
- * @xmlrpc.doc Updates the label of the specified Slave
+ * @xmlrpc.doc Updates attributes of the specified Slave
* @xmlrpc.param #param("string", "sessionKey")
* @xmlrpc.param #param_desc("int", "id", "Id of the Slave
to update")
* @xmlrpc.param #param_desc("string", "slave", "Slave's
fully-qualified domain name")
* @xmlrpc.param #param_desc("boolean",
* "enabled", "Let this slave talk to us?")
* @xmlrpc.param #param_desc("boolean",
- * "allowAllOrgs", "Export all our orgs to this slave?")
+ * "allowAllOrgs", "Export all our orgs to this Slave?")
* @xmlrpc.returntype $IssSlaveSerializer
*/
public IssSlave update(String sessionKey,
@@ -166,11 +166,11 @@ public class SlaveHandler extends BaseHandler {
}
/**
- * Get all the slaves this master knows about
+ * Get all the Slaves this Master knows about
* @param sessionKey User's session key.
* @return list of all the IssSlaves we know about
*
- * @xmlrpc.doc Get all the slaves this master knows about
+ * @xmlrpc.doc Get all the Slaves this Master knows about
* @xmlrpc.param #param("string", "sessionKey")
* @xmlrpc.returntype
* #array()
@@ -184,12 +184,12 @@ public class SlaveHandler extends BaseHandler {
}
/**
- * Get all the orgs that this master is willing to export to the specified slave
+ * Get all the orgs that this Master is willing to export to the specified Slave
* @param sessionKey User's session key.
* @param slaveId Id of the Slave to look for
* @return list of all the IssSlaves we know about
*
- * @xmlrpc.doc Get all the slaves this master knows about
+ * @xmlrpc.doc Get all orgs this Master is willing to export to the specified Slave
* @xmlrpc.param #param("string", "sessionKey")
* @xmlrpc.param #param_desc("int", "id", "Id of the desired
Slave")
* @xmlrpc.returntype #array_single("int", "ids of allowed
organizations")
@@ -204,16 +204,16 @@ public class SlaveHandler extends BaseHandler {
}
/**
- * Set the orgs that this master is willing to export to the specified slave
+ * Set the orgs that this Master is willing to export to the specified Slave
* @param sessionKey User's session key.
* @param slaveId Id of the Slave to look for
* @param orgIds List of org-ids we're willing to export
* @return 1 for success, exception otherwise
*
- * @xmlrpc.doc Get all the slaves this master knows about
+ * @xmlrpc.doc Set the orgs this Master is willing to export to the specified Slave
* @xmlrpc.param #param("string", "sessionKey")
* @xmlrpc.param #param_desc("int", "id", "Id of the desired
Slave")
- * @xmlrpc.param #array_single("int", "List of revisions to
delete")
+ * @xmlrpc.param #array_single("int", "List of org-ids we're
willing to export")
* @xmlrpc.returntype #return_int_success()
*/
public int setAllowedOrgs(String sessionKey, Integer slaveId, List<Integer>
orgIds) {