org.nuiton.jredmine

Class DefaultRedmineService

java.lang.Object

org.nuiton.jredmine.DefaultRedmineService

All Implemented Interfaces:

RedmineAnonymousService, RedmineLogguedService, RedmineService

public class DefaultRedmineService
extends Object
implements RedmineService

Default RedmineService implementation.

Since:

1.0.0

Author:

tchemit

Plexus component:

role: "org.nuiton.jredmine.RedmineService" role-hint: "default"

Field Summary

Fields

Modifier and Type	Field and Description
protected RedmineAnonymousService	anonymousService Delegate all anonymous call to the anonymous service.
protected RedmineServiceImplementor	delegateImplementor Delegate all the technical layer to a implementor.
protected static org.apache.commons.logging.Log	log

Fields inherited from interface org.nuiton.jredmine.RedmineService

ROLE

Constructor Summary

Constructors

Constructor and Description
DefaultRedmineService() Default constructor.
DefaultRedmineService(RedmineServiceImplementor delegateImplementor) Service constructor using the givne implementator to deal this technical layer.

Method Summary

Methods

Modifier and Type	Method and Description
Attachment	addAttachment(String projectName, String versionName, Attachment attachement) Add a attachment for a given version of a given project.
TimeEntry	addIssueTimeEntry(String projectName, String issueId, TimeEntry entry) Add a new time entry to the given issue for the given project and return the updated time entry.
News	addNews(String projectName, News news) Add a news for a given project.
Version	addVersion(String projectName, Version version) Add a version for a given project.
void	destroy() Close the service and destroy any connexion to the redmine service.
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.
RedmineServiceImplementor	getDelegateImplementor() Get the technical layer.
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.
Project[]	getUserProjects() Obtain for the loggued user, all projets where he belongs.
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.
Version	nextVersion(String projectName, String oldVersionName, Version newVersion) Prepare a new version (create it or update it).
Version	updateVersion(String projectName, Version version) Update a version for a given project.

Methods inherited from class java.lang.Object

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

Field Detail

log

protected static final org.apache.commons.logging.Log log

delegateImplementor

protected final RedmineServiceImplementor delegateImplementor

Delegate all the technical layer to a implementor.

Since:

1.4

See Also:

RedmineServiceImplementor

anonymousService

protected final RedmineAnonymousService anonymousService

Delegate all anonymous call to the anonymous service.

Since:

1.4

See Also:

RedmineAnonymousService

Constructor Detail

DefaultRedmineService

public DefaultRedmineService()

Default constructor.

Make this service use the default RedmineServiceImplementor.

Since:

1.4

See Also:

DefaultRedmineServiceImplementor

DefaultRedmineService

public DefaultRedmineService(RedmineServiceImplementor delegateImplementor)

Service constructor using the givne implementator to deal this technical layer.

Parameters:

delegateImplementor - the implementator to use

Since:

1.4

Method Detail

init

public void init(RedmineServiceConfiguration configuration)
          throws RedmineServiceException

Description copied from interface: RedmineAnonymousService

Initialize the service.

Specified by:

init in interface RedmineAnonymousService

Parameters:

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

Throws:

RedmineServiceException - if any pb

destroy

public void destroy()
             throws RedmineServiceException

Description copied from interface: RedmineAnonymousService

Close the service and destroy any connexion to the redmine service.

Specified by:

destroy in interface RedmineAnonymousService

Throws:

RedmineServiceException - if any pb

getDelegateImplementor

public RedmineServiceImplementor getDelegateImplementor()

Description copied from interface: RedmineAnonymousService

Get the technical layer.

Specified by:

getDelegateImplementor in interface RedmineAnonymousService

Returns:

the technical layer.

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

getUserProjects

public Project[] getUserProjects()
                          throws RedmineServiceException

Description copied from interface: RedmineLogguedService

Obtain for the loggued user, all projets where he belongs.

Note: This method requires to be loggued on redmine server.

Specified by:

getUserProjects in interface RedmineLogguedService

Returns:

all the projects belonged by the loggued user

Throws:

RedmineServiceException - if any pb while retriving datas

See Also:

Project

addVersion

public Version addVersion(String projectName,
                 Version version)
                   throws RedmineServiceException

Description copied from interface: RedmineLogguedService

Add a version for a given project.

b>Note: This method requires to be loggued on redmine server.

Specified by:

addVersion in interface RedmineLogguedService

Parameters:

projectName - the name of the project

version - the version to add

Returns:

the added version

Throws:

RedmineServiceException - if any pb while sending and retriving datas to redmine server

See Also:

Version

updateVersion

public Version updateVersion(String projectName,
                    Version version)
                      throws RedmineServiceException

Description copied from interface: RedmineLogguedService

Update a version for a given project.

b>Note: This method requires to be loggued on redmine server.

Specified by:

updateVersion in interface RedmineLogguedService

Parameters:

projectName - the name of the project

version - the version to update

Returns:

the updated version

Throws:

RedmineServiceException - if any pb while sending and retriving datas to redmine server

See Also:

Version

nextVersion

public Version nextVersion(String projectName,
                  String oldVersionName,
                  Version newVersion)
                    throws RedmineServiceException

Description copied from interface: RedmineLogguedService

Prepare a new version (create it or update it).

If the oldVersionName is given, then all issues unclosed from this old version will be move to the new version.

b>Note: This method requires to be loggued on redmine server.

Specified by:

nextVersion in interface RedmineLogguedService

Parameters:

projectName - the name of the project

oldVersionName - the name of the old version (optional)

newVersion - the newVersion to create or update

Returns:

the created version

Throws:

RedmineServiceException - if any pb while sending and retriving datas to redmine server

See Also:

Version

addAttachment

public Attachment addAttachment(String projectName,
                       String versionName,
                       Attachment attachement)
                         throws RedmineServiceException

Description copied from interface: RedmineLogguedService

Add a attachment for a given version of a given project.

b>Note: This method requires to be loggued on redmine server.

Specified by:

addAttachment in interface RedmineLogguedService

Parameters:

projectName - the name of the project

versionName - the name of the version

attachement - the attachment to add

Returns:

the added attachment

Throws:

RedmineServiceException - if any pb while sending and retriving datas to redmine server

See Also:

Attachment

addNews

public News addNews(String projectName,
           News news)
             throws RedmineServiceException

Description copied from interface: RedmineLogguedService

Add a news for a given project.

b>Note: This method requires to be loggued on redmine server.

Specified by:

addNews in interface RedmineLogguedService

Parameters:

projectName - the name of the project

news - the news to add

Returns:

the added news.

Throws:

RedmineServiceException - if any pb while sending and retriving datas to redmine server

See Also:

News

addIssueTimeEntry

public TimeEntry addIssueTimeEntry(String projectName,
                          String issueId,
                          TimeEntry entry)
                            throws RedmineServiceException

Description copied from interface: RedmineLogguedService

Add a new time entry to the given issue for the given project and return the updated time entry.

b>Note: This method requires to be loggued on redmine server.

Specified by:

addIssueTimeEntry in interface RedmineLogguedService

Parameters:

projectName - the name of the project

issueId - the id of the issue to update

entry - time entry to add

Returns:

the created time entry

Throws:

RedmineServiceException - if any pb while sending or retrieving datas to redmine server

See Also:

Issue, TimeEntry