import com.indexdata.mkjsf.pazpar2.data.ResponseParser;\r
import com.indexdata.mkjsf.pazpar2.data.sp.SpResponseDataObject;\r
\r
+/**\r
+ * Represents a Service Proxy <code>auth</code> command. \r
+ * \r
+ * <p>Authenticates a user against a Pazpar2 Service Proxy</p>\r
+ * \r
+ * @author Niels Erik\r
+ *\r
+ */\r
public class AuthCommand extends Pazpar2Command implements ServiceProxyCommand {\r
\r
private static final long serialVersionUID = 5487611235664162578L;\r
return responseObject;\r
}\r
\r
+ /**\r
+ * Normalizes the response XML for the benefit of the SAX parser that creates data objects. \r
+ * <p>The parser expects responses to have document element names corresponding to the names of\r
+ * the commands that created the responses.</p>\r
+ * \r
+ * @param responseString\r
+ * @param newName\r
+ * @return\r
+ */\r
private String renameResponseElement(String responseString, String newName) {\r
responseString = responseString.replace("<response>", "<" + newName + ">");\r
responseString = responseString.replace("</response>", "</" + newName + ">");\r
return responseString;\r
}\r
\r
- \r
+ /**\r
+ * Sets Service Proxy command parameter <code>action</code>. See Service Proxy documentation for details. \r
+ */\r
public void setAction (String action) {\r
setParameterInState(new CommandParameter("action","=",action));\r
} \r
\r
+ /**\r
+ * Gets parameter value for <code>action</cod>\r
+ */\r
public String getAction () {\r
return getParameterValue("action");\r
}\r
\r
+ /**\r
+ * Sets Service Proxy command parameter <code>username</code>. See Service Proxy documentation for details. \r
+ */\r
public void setUsername(String username) {\r
setParameterInState(new CommandParameter("username","=",username));\r
}\r
\r
+ /**\r
+ * Gets parameter value for <code>username</cod>\r
+ */\r
public String getUsername () {\r
return getParameterValue("username");\r
}\r
- \r
+ \r
+ /**\r
+ * Sets Service Proxy command parameter <code>password</code>. See Service Proxy documentation for details. \r
+ */\r
public void setPassword (String password) {\r
setParameterInState(new CommandParameter("password","=",password));\r
}\r
\r
+ /**\r
+ * Gets parameter value for <code>password</cod>\r
+ */\r
public String getPassword () {\r
return getParameterValue("password");\r
}\r