Package de.fraunhofer.iese.mydata.client

Interface ILibraryClientService

All Known Subinterfaces:

IManagementService

public interface ILibraryClientService

Method Summary

Modifier and Type	Method	Description
LibraryClientResponseDTO	createLibraryClient(String clientIdStr, boolean isMasterClient)
OAuthClientDetailsDTO	createOAuthClientDetails(LibraryClientResponseDTO libraryClient, String username)	Class returns created ClientDetails for an LibraryClient with the username of the Auhtentificated which is trying create it.
void	deleteLibraryClient(ClientId clientId, String username)
void	deleteLibraryClient(String clientIdStr, String username)
LibraryClient	getLibraryClient(ClientId clientId)	Get a client by its ID
Set<LibraryClient>	getLibraryClients(SolutionId solutionId)	Get a set of library clients by solution id
Map<ClientId,Long>	listClientsForPolicy(PolicyId policyId)
Map<ClientId,Long>	listClientsForTimer(TimerId timerId)
Map<PolicyId,Long>	listDeployedPolicyVersions(ClientId libraryClientId)
Map<TimerId,Long>	listDeployedTimerVersions(ClientId libraryClientId)
void	notifySync(SyncNotification syncNotification)

Method Detail

notifySync

void notifySync(SyncNotification syncNotification)
         throws IOException,
                InvalidEntityException,
                NoSuchEntityException

Parameters:

syncNotification -

Throws:

IOException

InvalidEntityException - if the sync notification is not valid

NoSuchEntityException - if there is no client with the id specified in the sync notification

listDeployedPolicyVersions

Map<PolicyId,Long> listDeployedPolicyVersions(ClientId libraryClientId)
                                             throws IOException,
                                                    InvalidEntityException,
                                                    NoSuchEntityException

Parameters:

libraryClientId -

Returns:

a map of policyIds and policyVersions for a specific clientId

Throws:

IOException

InvalidEntityException - if the client id is not valid

NoSuchEntityException - if there is no library client with the client id given

listClientsForPolicy

Map<ClientId,Long> listClientsForPolicy(PolicyId policyId)
                                       throws IOException,
                                              InvalidEntityException,
                                              NoSuchEntityException

Parameters:

policyId -

Returns:

a map of libraryClientIds and policyVersions for a specific policyId

Throws:

IOException

InvalidEntityException - if the policy id is not valid

NoSuchEntityException - if there is no policy with the policy id given

listDeployedTimerVersions

Map<TimerId,Long> listDeployedTimerVersions(ClientId libraryClientId)
                                           throws IOException,
                                                  InvalidEntityException,
                                                  NoSuchEntityException

Parameters:

libraryClientId -

Returns:

a map of timerIds and timerVersions for a specific libraryClientId

Throws:

IOException

InvalidEntityException - if the client id is not valid

NoSuchEntityException - if there is no library client with the client id given

listClientsForTimer

Map<ClientId,Long> listClientsForTimer(TimerId timerId)
                                      throws IOException,
                                             InvalidEntityException,
                                             NoSuchEntityException

Parameters:

timerId -

Returns:

a map of libraryClientIds and policyVersions for a specific policyId

Throws:

IOException

InvalidEntityException - if the timer id is not valid

NoSuchEntityException - if there is not imer with the timer id given

createLibraryClient

LibraryClientResponseDTO createLibraryClient(String clientIdStr,
                                             boolean isMasterClient)
                                      throws InvalidEntityException,
                                             IOException,
                                             ConflictingResourceException,
                                             NoSuchEntityException

Parameters:

clientIdStr - a ClientId as String for this new LibraryClient

isMasterClient -

Returns:

Throws:

InvalidEntityException - if the client id string is not valid

IOException - clientIdStr must fit the soultionIdStr

ConflictingResourceException - if there already exists a library client with the same id or already a master client

NoSuchEntityException - if the solution does not exist

deleteLibraryClient

void deleteLibraryClient(ClientId clientId,
                         String username)
                  throws NoSuchEntityException,
                         InvalidEntityException,
                         IOException

Parameters:

clientId - the Client of the LibraryClient you want to delete

username - the username of the User who wants to accesss this method it will delete also the regarding OAtuhClientDetails if existing

Throws:

NoSuchEntityException - if the client does not exist

InvalidEntityException - if the client id is not valid

IOException

deleteLibraryClient

void deleteLibraryClient(String clientIdStr,
                         String username)
                  throws InvalidEntityException,
                         NoSuchEntityException,
                         IOException

Parameters:

clientIdStr - as String the Client of the LibraryClient you want to delete

username - the username of the User who wants to accesss this method it will delete also the regarding OAtuhClientDetails if existing

Throws:

InvalidEntityException

NoSuchEntityException - if the client does not exist

IOException

getLibraryClient

LibraryClient getLibraryClient(ClientId clientId)
                        throws NoSuchEntityException,
                               InvalidEntityException,
                               IOException

Get a client by its ID

Parameters:

clientId - the client ID

Returns:

Throws:

NoSuchEntityException - if the client does not exists

InvalidEntityException - if the client id is not valid

IOException

getLibraryClients

Set<LibraryClient> getLibraryClients(SolutionId solutionId)
                              throws NoSuchEntityException,
                                     InvalidEntityException,
                                     IOException

Get a set of library clients by solution id

Parameters:

solutionId - Solution ID

Returns:

Set of library clients

Throws:

NoSuchEntityException - if the solution does not exist

InvalidEntityException - if the solution id is not valid

IOException

createOAuthClientDetails

OAuthClientDetailsDTO createOAuthClientDetails(LibraryClientResponseDTO libraryClient,
                                               String username)
                                        throws InvalidEntityException,
                                               ConflictingResourceException,
                                               IOException

Class returns created ClientDetails for an LibraryClient with the username of the Auhtentificated which is trying create it.

Parameters:

libraryClient -

username -

Returns:

Throws:

InvalidEntityException - if the library client is not valid

ConflictingResourceException - if the library client already exists

IOException