nl.surfnet.coin.csa.service
Interface CrmService

All Known Implementing Classes:

CrmServiceNoop, LmngServiceImpl, LmngServiceMock

public interface CrmService

Interface of services that return Licensing and article information from LMNG (Licentie Modellen Next Generation)

Method Summary

void	evictCache()
List<Account>	getAccounts(boolean isInstitution) Get all institutions
List<Article>	getArticlesForServiceProviders(List<String> serviceProviderEntityIds) Get articles for the given serviceProviders.
String	getInstitutionName(String guid) Get the name of the institution in LMNG belonging to given GUID
List<License>	getLicensesForIdpAndSp(IdentityProvider identityProvider, String articleIdentifier) Gets a list with Licenses for the given identityProvider and services (lmngIdentifiers) which are valid on the given day
List<License>	getLicensesForIdpAndSps(IdentityProvider identityProvider, List<String> articleIdentifiers)
Article	getService(String guid) Get LMNG article by article ID
String	getServiceName(String lmngId) Get the name of the service/product in LMNG belonging to given GUID
String	performQuery(String rawQuery) Convenience method to run various queries

Method Detail

getLicensesForIdpAndSp

List<License> getLicensesForIdpAndSp(IdentityProvider identityProvider,
                                     String articleIdentifier)
                                     throws LmngException

Gets a list with Licenses for the given identityProvider and services (lmngIdentifiers) which are valid on the given day

Parameters:

identityProvider - the identityProvider to get the licenses for

articleIdentifier - lmngIdentifier (belonging to SP's) where the licenses are for.

Returns:

a (possible) list of licenses

Throws:

LmngException - If connection or call fails (rethrows all exceptions)

getLicensesForIdpAndSps

List<License> getLicensesForIdpAndSps(IdentityProvider identityProvider,
                                      List<String> articleIdentifiers)
                                      throws LmngException

Throws:

LmngException

getArticlesForServiceProviders

List<Article> getArticlesForServiceProviders(List<String> serviceProviderEntityIds)
                                             throws LmngException

Get articles for the given serviceProviders.

Parameters:

serviceProviderEntityIds - list of ID's of serviceproviders to get the lmng article for

Returns:

a list of possible articles

Throws:

LmngException

getInstitutionName

String getInstitutionName(String guid)

Get the name of the institution in LMNG belonging to given GUID

Parameters:

guid - guid of the IDP to check

Returns:

the name of the institution in LMNG

getService

Article getService(String guid)

Get LMNG article by article ID

Parameters:

guid - guid of the article

Returns:

the article found or null

getServiceName

String getServiceName(String lmngId)

Get the name of the service/product in LMNG belonging to given GUID

Parameters:

lmngId -

Returns:

getAccounts

List<Account> getAccounts(boolean isInstitution)

Get all institutions

Returns:

all accounts of the institutions / serviceproviders known in LMNG

performQuery

String performQuery(String rawQuery)

Convenience method to run various queries

Parameters:

rawQuery - the fetch string

Returns:

the raw response

evictCache

void evictCache()