nl.surfnet.coin.selfservice.service
Interface JiraService

All Known Implementing Classes:
JiraServiceImpl, JiraServiceMock

public interface JiraService


Method Summary
 String create(JiraTask task, CoinUser user)
          Create a new task in Jira.
 void delete(String key)
          Delete a task from Jira.
 void doAction(String key, JiraTask.Action action)
          Re-open or close a Jira task.
 List<JiraTask> getTasks(List<String> keys)
          Retrieve specific tasks from Jira.
 void setBaseUrl(String baseUrl)
          Set the base URL of the Jira instance to use
 void setPassword(String password)
          Set the password to use to authenticate against Jira
 void setProjectKey(String projectKey)
          The project key used to submit issues
 void setUsername(String username)
          Set the username to use to authenticate against Jira
 

Method Detail

create

String create(JiraTask task,
              CoinUser user)
              throws IOException
Create a new task in Jira.

Parameters:
task - the task you want to create
user - the user which issued the request
Returns:
the new task key
Throws:
IOException - when communicating with jira fails

delete

void delete(String key)
            throws IOException
Delete a task from Jira.

Parameters:
key - the task key
Throws:
IOException - when communicating with jira fails

doAction

void doAction(String key,
              JiraTask.Action action)
              throws IOException
Re-open or close a Jira task.

Parameters:
key - the task key
action - what action to undertake
Throws:
IOException - when communicating with jira fails

getTasks

List<JiraTask> getTasks(List<String> keys)
                        throws IOException
Retrieve specific tasks from Jira.

Parameters:
keys - a list of the task keys you want to retrieve
Returns:
a list of tasks
Throws:
IOException - when communicating with jira fails

setBaseUrl

void setBaseUrl(String baseUrl)
Set the base URL of the Jira instance to use

Parameters:
baseUrl - String

setUsername

void setUsername(String username)
Set the username to use to authenticate against Jira

Parameters:
username - the username as a String

setPassword

void setPassword(String password)
Set the password to use to authenticate against Jira

Parameters:
password - String

setProjectKey

void setProjectKey(String projectKey)
The project key used to submit issues

Parameters:
projectKey - String


Copyright © 2012 SURFnet bv, The Netherlands. All Rights Reserved.