ch.ethz.origo
Class OrigoApiClient

java.lang.Object
  ch.ethz.origo.OrigoApiClient

public class OrigoApiClient
extends java.lang.Object

Client for the origo api, abstracts the xmlrpc interface.

Author:

Patrick Ruckstuhl

Constructor Summary

OrigoApiClient(java.net.URL apiUrl)
Create with an apiUrl

Method Summary

void	addIssue(java.lang.String session, java.lang.Integer projectId, java.lang.String issueSubject, java.lang.String issueDescription, java.lang.String issueTag, java.lang.Boolean issuePrivate) Add a new issue.
protected java.lang.Object	call(java.lang.String method, java.lang.Object... params) Execute an xmlrpc call.
void	extendedCommentIssue(java.lang.String session, java.lang.Integer projectId, java.lang.Integer bugId, java.lang.String description, java.lang.String tags) Extended comment for an issue.
java.lang.String	login(java.lang.String userKey, java.lang.String applicationKey) Login for a user
java.lang.Integer	retrieveProjectId(java.lang.String session, java.lang.String projectName) Retrieve the project id.
java.lang.Object[]	searchIssue(java.lang.String session, java.lang.Integer projectId, java.util.HashMap<java.lang.String,java.lang.String> searchArgs) Search an issue.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

OrigoApiClient

public OrigoApiClient(java.net.URL apiUrl)

Create with an apiUrl

Parameters:

apiUrl - url

Method Detail

call

protected java.lang.Object call(java.lang.String method,
                                java.lang.Object... params)
                         throws org.apache.xmlrpc.XmlRpcException

Execute an xmlrpc call.

Parameters:

method - the method to call

params - the parameters for the call

Returns:

the result of the call

Throws:

org.apache.xmlrpc.XmlRpcException - if error occurs

login

public java.lang.String login(java.lang.String userKey,
                              java.lang.String applicationKey)
                       throws org.apache.xmlrpc.XmlRpcException

Login for a user

Parameters:

userKey - the user key

applicationKey - the application key

Returns:

login

Throws:

org.apache.xmlrpc.XmlRpcException - if error occurs

retrieveProjectId

public java.lang.Integer retrieveProjectId(java.lang.String session,
                                           java.lang.String projectName)
                                    throws org.apache.xmlrpc.XmlRpcException

Retrieve the project id.

Parameters:

session - a session

projectName - name of the project

Returns:

projectID

Throws:

org.apache.xmlrpc.XmlRpcException - if error occurs

searchIssue

public java.lang.Object[] searchIssue(java.lang.String session,
                                      java.lang.Integer projectId,
                                      java.util.HashMap<java.lang.String,java.lang.String> searchArgs)
                               throws org.apache.xmlrpc.XmlRpcException

Search an issue.

Parameters:

session - a session

projectId - a project id

searchArgs - search arguments

Returns:

issues

Throws:

org.apache.xmlrpc.XmlRpcException - if error occurs

extendedCommentIssue

public void extendedCommentIssue(java.lang.String session,
                                 java.lang.Integer projectId,
                                 java.lang.Integer bugId,
                                 java.lang.String description,
                                 java.lang.String tags)
                          throws org.apache.xmlrpc.XmlRpcException

Extended comment for an issue.

Parameters:

session - a session

projectId - a project id

bugId - a bug id

description - description

tags - tags to add/set

Throws:

org.apache.xmlrpc.XmlRpcException - if error occurs

addIssue

public void addIssue(java.lang.String session,
                     java.lang.Integer projectId,
                     java.lang.String issueSubject,
                     java.lang.String issueDescription,
                     java.lang.String issueTag,
                     java.lang.Boolean issuePrivate)
              throws org.apache.xmlrpc.XmlRpcException

Add a new issue.

Parameters:

session - a session

projectId - a project id

issueSubject - subject of the issue

issueDescription - description of the issue

issueTag - tag of the issue

issuePrivate - is the issue private?

Throws:

org.apache.xmlrpc.XmlRpcException - if error occurs