org.nuiton.jredmine
Interface RedmineServiceImplementor

All Known Implementing Classes:

DefaultRedmineService

public interface RedmineServiceImplementor

Technical contrat te be implemented in a RedmineService. Any concrete implentation of a RedmineService should also implements this service.

Since:

1.0.0

Author:

chemit

Method Summary

void	destroy() Close the service and destroy any connexions to the redmine service.
<T> T	getData(java.lang.Class<T> type, java.lang.Object... args) Generic method to obtain a single data from a redmine server.
<T> T[]	getDatas(java.lang.Class<T> type, java.lang.Object... args) Generic method to obtain a array of data from a redmine server.
<T> java.io.InputStream	getDatasStream(java.lang.Class<T> type, java.lang.Object... args) Generic method to obtain an input stream of an array of data from a redmine server.
<T> java.io.InputStream	getDataStream(java.lang.Class<T> type, java.lang.Object... args) Generic method to obtain an input stream of a data from a redmine server.
RedmineServiceImplementor	init(org.nuiton.io.rest.RestClient client) Initialize the service given a redmine client already initialized.
RedmineServiceImplementor	init(org.nuiton.io.rest.RestClientConfiguration configuration) Initialize the service given a client configuration.
boolean	isInit() Tests if the service is loogued to the redmine service.

Method Detail

isInit

boolean isInit()

Tests if the service is loogued to the redmine service.

Returns:

true is service is init and loggued to Redmine service, false otherwise.

init

RedmineServiceImplementor init(org.nuiton.io.rest.RestClient client)
                               throws RedmineServiceException

Initialize the service given a redmine client already initialized.

Parameters:

client - the redmine client to be used by the service

Returns:

the initialized service

Throws:

RedmineServiceException

See Also:

RedmineRestClient

init

RedmineServiceImplementor init(org.nuiton.io.rest.RestClientConfiguration configuration)
                               throws RedmineServiceException

Initialize the service given a client configuration.

Parameters:

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

Returns:

the initialized service

Throws:

RedmineServiceException

destroy

void destroy()
             throws RedmineServiceException

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

Throws:

RedmineServiceException

getData

<T> T getData(java.lang.Class<T> type,
              java.lang.Object... args)
          throws RedmineServiceException

Generic method to obtain a single data from a redmine server.

Type Parameters:

T - the type of data to obtain

Parameters:

type - the type of data to obtain

args - the parameters to obtain the data

Returns:

the obtained data

Throws:

RedmineServiceException

getDatas

<T> T[] getDatas(java.lang.Class<T> type,
                 java.lang.Object... args)
             throws RedmineServiceException

Generic method to obtain a array of data from a redmine server.

Type Parameters:

T - the type of data to obtain

Parameters:

type - the type of data to obtain

args - the parameters to obtain the datas

Returns:

the obtained datas

Throws:

RedmineServiceException

getDataStream

<T> java.io.InputStream getDataStream(java.lang.Class<T> type,
                                      java.lang.Object... args)
                                  throws RedmineServiceException

Generic method to obtain an input stream of a data from a redmine server.

Type Parameters:

T - the type of data to obtain

Parameters:

type - the type of data to obtain

args - the parameters to obtain the data

Returns:

the input stream containing the data

Throws:

RedmineServiceException

getDatasStream

<T> java.io.InputStream getDatasStream(java.lang.Class<T> type,
                                       java.lang.Object... args)
                                   throws RedmineServiceException

Generic method to obtain an input stream of an array of data from a redmine server.

Type Parameters:

T - the type of data to obtain

Parameters:

type - the type of data to obtain

args - the parameters to obtain the datas

Returns:

the input stream containing the datas

Throws:

RedmineServiceException