org.tigris.scarab.xmlrpc
Class SimpleHandler

java.lang.Object
  org.tigris.scarab.xmlrpc.SimpleHandler

public class SimpleHandler

extends java.lang.Object

Provides a basic API for XML-RPC requests to the Scarab server. It makes the server side for scarab-post-commit.py script (in the extensions/script directory).

Version:

$Id$

Author:

Mick

See Also:

SimpleHandlerClient

Constructor Summary

SimpleHandler()

Method Summary

protected boolean	addComment(Issue issue, ScarabUser user, java.lang.String comment, boolean disableEmails) Append a comment to the specified issue.
java.util.Vector	addComment(java.lang.String issues, java.lang.String user, java.lang.String comment, int disableEmailsInt) Append a comment to the specified issue.
protected boolean	changeIssueAttributeOption(Issue issue, ScarabUser user, Attribute attribute, AttributeOption option, java.lang.String description) Update Issue's attribute option with a given user and description
java.util.Vector	changeIssueAttributeOption(java.lang.String issue, java.lang.String user, java.lang.String attribute, java.lang.String option, java.lang.String description) Update Issue's attribute option with a given user and description.
protected java.util.Vector	findIssuesWithAttributeValue(ScarabUser user, Attribute attribute, java.lang.String value)
java.util.Vector	findIssuesWithAttributeValue(java.lang.String user, java.lang.String attribute, java.lang.String value) returns a vector of federatedIds (prefix+count) for issues with the given attribute value.
protected static void	log(java.lang.String str)

Methods inherited from class java.lang.Object

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

Constructor Detail

SimpleHandler

public SimpleHandler()

Method Detail

log

protected static void log(java.lang.String str)

addComment

public java.util.Vector addComment(java.lang.String issues,
                                   java.lang.String user,
                                   java.lang.String comment,
                                   int disableEmailsInt)

Append a comment to the specified issue. Wrapper method with string parameters.

Parameters:

issues - string with the ids of the issue to add the comment to (can contain other words which will simply be ignored)

user - the username of the user who is adding the comment

comment - the comment to append to the issue

disableEmailsInt - do we want this change to trigger an email to every person assigned a role.

Returns:

Vector with first item a boolean indicating success.

addComment

protected boolean addComment(Issue issue,
                             ScarabUser user,
                             java.lang.String comment,
                             boolean disableEmails)
                      throws java.lang.Exception

Append a comment to the specified issue.

Parameters:

comment - the comment to append to the issue

Returns:

success.

Throws:

java.lang.Exception

changeIssueAttributeOption

public java.util.Vector changeIssueAttributeOption(java.lang.String issue,
                                                   java.lang.String user,
                                                   java.lang.String attribute,
                                                   java.lang.String option,
                                                   java.lang.String description)

Update Issue's attribute option with a given user and description. Wrapper method with string parameters.

Returns:

Vector with first item a boolean indicating success.

changeIssueAttributeOption

protected boolean changeIssueAttributeOption(Issue issue,
                                             ScarabUser user,
                                             Attribute attribute,
                                             AttributeOption option,
                                             java.lang.String description)
                                      throws java.lang.Exception

Update Issue's attribute option with a given user and description

Returns:

success.

Throws:

java.lang.Exception

findIssuesWithAttributeValue

public java.util.Vector findIssuesWithAttributeValue(java.lang.String user,
                                                     java.lang.String attribute,
                                                     java.lang.String value)

returns a vector of federatedIds (prefix+count) for issues with the given attribute value.

findIssuesWithAttributeValue

protected java.util.Vector findIssuesWithAttributeValue(ScarabUser user,
                                                        Attribute attribute,
                                                        java.lang.String value)
                                                 throws java.lang.Exception

Throws:

java.lang.Exception