org.nuiton.jredmine.service

Class DefaultRedmineAnonymousService

java.lang.Object

org.nuiton.jredmine.service.AbstractRedmineService

org.nuiton.jredmine.service.DefaultRedmineAnonymousService

All Implemented Interfaces:

RedmineAnonymousService

public class DefaultRedmineAnonymousService
extends AbstractRedmineService
implements RedmineAnonymousService

Default implementation of RedmineAnonymousService.

Since:

1.5

Author:

tchemit

Plexus component:

role: "org.nuiton.jredmine.service.RedmineAnonymousService" role-hint: "default"

Constructor Summary

Constructors

Constructor and Description
DefaultRedmineAnonymousService()

Method Summary

Methods

Modifier and Type	Method and Description
Attachment[]	getAttachments(String projectName, String versionName) Obtain all attachments for a specific version on a given project.
Issue[]	getClosedIssues(String projectName) Obtain all closed issues for a given project.
IssueCategory[]	getIssueCategories(String projectName) Obtain all categories defined on issues for a given project.
IssuePriority[]	getIssuePriorities() Obtain all the priorities defined on a Issue.
Issue[]	getIssues(String projectName) Obtain all issues for a given project.
Issue[]	getIssues(String projectName, String versionName) Obtain all issues for a specific version on a given project.
IssueStatus[]	getIssueStatuses() Obtain all the statuses defined on a Issue.
TimeEntry[]	getIssueTimeEntries(String projectName, String issueId) Obtain for a given issue of a given project all the time entries.
News[]	getNews(String projectName) Obtain all news defined on a given project.
Issue[]	getOpenedIssues(String projectName) Obtain all opened issues for a given project.
Project	getProject(String projectName) Obtain a project given his name.
User[]	getProjectMembers(String projectName) Obtain all users defined on a given project.
Project[]	getProjects() Obtain all accessible projects.
Tracker[]	getTrackers(String projectName) Obtain all trackers defined on a given project.
Version	getVersion(String projectName, String versionName) Obtain a specific version for a given project.
Version[]	getVersions(String projectName) Obtain all versions defined on a given project.
void	init(RedmineServiceConfiguration configuration) Initialize the service.

Methods inherited from class org.nuiton.jredmine.service.AbstractRedmineService

checkInit, checkLoggued, checkSessionConfigurationNotNull, checkSessionNotNull, destroy, executeRequestAndReturnData, executeRequestAndReturnDatas, getClient, isInit

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.nuiton.jredmine.service.RedmineAnonymousService

destroy, isInit

Constructor Detail

DefaultRedmineAnonymousService

public DefaultRedmineAnonymousService()

Method Detail

init

public void init(RedmineServiceConfiguration configuration)
          throws RedmineServiceException

Description copied from interface: RedmineAnonymousService

Initialize the service.

Specified by:

init in interface RedmineAnonymousService

Overrides:

init in class AbstractRedmineService

Parameters:

configuration - the configuration to be used to init the internal redmine client

Throws:

RedmineServiceException - if any pb

getIssueStatuses

public IssueStatus[] getIssueStatuses()
                               throws RedmineServiceException

Description copied from interface: RedmineAnonymousService

Obtain all the statuses defined on a Issue.

Note : The statuses are common for all projects.

Specified by:

getIssueStatuses in interface RedmineAnonymousService

Returns:

all the issue statuses

Throws:

RedmineServiceException - if any pb while retriving datas

See Also:

IssueStatus

getIssuePriorities

public IssuePriority[] getIssuePriorities()
                                   throws RedmineServiceException

Description copied from interface: RedmineAnonymousService

Obtain all the priorities defined on a Issue.

Note : The priorities are common for all projects.

Specified by:

getIssuePriorities in interface RedmineAnonymousService

Returns:

all the issue properties

Throws:

RedmineServiceException - if any pb while retriving datas

See Also:

IssuePriority

getProjects

public Project[] getProjects()
                      throws RedmineServiceException

Description copied from interface: RedmineAnonymousService

Obtain all accessible projects.

Specified by:

getProjects in interface RedmineAnonymousService

Returns:

all the projects

Throws:

RedmineServiceException - if any pb while retriving datas

See Also:

Project

getIssueCategories

public IssueCategory[] getIssueCategories(String projectName)
                                   throws RedmineServiceException

Description copied from interface: RedmineAnonymousService

Obtain all categories defined on issues for a given project.

Specified by:

getIssueCategories in interface RedmineAnonymousService

Parameters:

projectName - the name of the project

Returns:

the categories of issues for the given project.

Throws:

RedmineServiceException - if any pb while retriving datas

See Also:

IssueCategory

getProject

public Project getProject(String projectName)
                   throws RedmineServiceException

Description copied from interface: RedmineAnonymousService

Obtain a project given his name.

Specified by:

getProject in interface RedmineAnonymousService

Parameters:

projectName - the name of the project

Returns:

the project

Throws:

RedmineServiceException - if any pb while retriving datas

See Also:

Project

getTrackers

public Tracker[] getTrackers(String projectName)
                      throws RedmineServiceException

Description copied from interface: RedmineAnonymousService

Obtain all trackers defined on a given project.

Specified by:

getTrackers in interface RedmineAnonymousService

Parameters:

projectName - the name of the project

Returns:

the trackers for the given project.

Throws:

RedmineServiceException - if any pb while retriving datas

See Also:

Tracker

getNews

public News[] getNews(String projectName)
               throws RedmineServiceException

Description copied from interface: RedmineAnonymousService

Obtain all news defined on a given project.

Specified by:

getNews in interface RedmineAnonymousService

Parameters:

projectName - the name of the project

Returns:

the news for the given project.

Throws:

RedmineServiceException - if any pb while retriving datas

See Also:

News

getProjectMembers

public User[] getProjectMembers(String projectName)
                         throws RedmineServiceException

Description copied from interface: RedmineAnonymousService

Obtain all users defined on a given project.

Specified by:

getProjectMembers in interface RedmineAnonymousService

Parameters:

projectName - the name of the project

Returns:

the users for the given project.

Throws:

RedmineServiceException - if any pb while retriving datas

See Also:

User

getVersions

public Version[] getVersions(String projectName)
                      throws RedmineServiceException

Description copied from interface: RedmineAnonymousService

Obtain all versions defined on a given project.

Specified by:

getVersions in interface RedmineAnonymousService

Parameters:

projectName - the name of the project

Returns:

the versions of the given project.

Throws:

RedmineServiceException - if any pb while retriving datas

See Also:

Version

getVersion

public Version getVersion(String projectName,
                 String versionName)
                   throws RedmineServiceException

Description copied from interface: RedmineAnonymousService

Obtain a specific version for a given project.

Specified by:

getVersion in interface RedmineAnonymousService

Parameters:

projectName - the name of the project

versionName - the name of the version

Returns:

the version

Throws:

RedmineServiceException - if any pb while retriving datas

See Also:

Version

getAttachments

public Attachment[] getAttachments(String projectName,
                          String versionName)
                            throws RedmineServiceException

Description copied from interface: RedmineAnonymousService

Obtain all attachments for a specific version on a given project.

Specified by:

getAttachments in interface RedmineAnonymousService

Parameters:

projectName - the name of the project

versionName - the name of the version

Returns:

the attachments

Throws:

RedmineServiceException - if any pb while retriving datas

See Also:

Attachment

getIssues

public Issue[] getIssues(String projectName,
                String versionName)
                  throws RedmineServiceException

Description copied from interface: RedmineAnonymousService

Obtain all issues for a specific version on a given project.

Specified by:

getIssues in interface RedmineAnonymousService

Parameters:

projectName - the name of the project

versionName - the name of the version

Returns:

the issues

Throws:

RedmineServiceException - if any pb while retriving datas

See Also:

Issue

getIssueTimeEntries

public TimeEntry[] getIssueTimeEntries(String projectName,
                              String issueId)
                                throws RedmineServiceException

Description copied from interface: RedmineAnonymousService

Obtain for a given issue of a given project all the time entries.

Specified by:

getIssueTimeEntries in interface RedmineAnonymousService

Parameters:

projectName - the name of the project

issueId - the id of the issue

Returns:

the time entries of the issue

Throws:

RedmineServiceException - if any pb while retrieving time entries of the issue

getIssues

public Issue[] getIssues(String projectName)
                  throws RedmineServiceException

Description copied from interface: RedmineAnonymousService

Obtain all issues for a given project.

Specified by:

getIssues in interface RedmineAnonymousService

Parameters:

projectName - the name of the project

Returns:

the issues

Throws:

RedmineServiceException - if any pb while retriving datas

See Also:

Issue

getOpenedIssues

public Issue[] getOpenedIssues(String projectName)
                        throws RedmineServiceException

Description copied from interface: RedmineAnonymousService

Obtain all opened issues for a given project.

Specified by:

getOpenedIssues in interface RedmineAnonymousService

Parameters:

projectName - the name of the project

Returns:

the issues

Throws:

RedmineServiceException - if any pb while retriving datas

See Also:

Issue

getClosedIssues

public Issue[] getClosedIssues(String projectName)
                        throws RedmineServiceException

Description copied from interface: RedmineAnonymousService

Obtain all closed issues for a given project.

Specified by:

getClosedIssues in interface RedmineAnonymousService

Parameters:

projectName - the name of the project

Returns:

the issues

Throws:

RedmineServiceException - if any pb while retriving datas

See Also:

Issue