nl.surfnet.coin.selfservice.service

Interface LmngService

All Known Implementing Classes:

LmngServiceImpl, LmngServiceMock

public interface LmngService

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

Method Summary

Methods

Modifier and Type	Method and Description
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, Date validOn) Gets a list with Licenses for the given identityProvider and services (lmngIdentifiers) which are valid on the given day
String	getServiceName(String lmngId) Get the name of the service/product in LMNG belonging to given GUID
boolean	isActiveMode() Is the LMNG service active? If not then no calls should be made and the entire distribution channel runs without license / article information from LMNG.

Method Detail

getLicensesForIdpAndSp

List<License> getLicensesForIdpAndSp(IdentityProvider identityProvider,
                                   String articleIdentifier,
                                   Date validOn)
                                     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

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

validOn - Date on which the license should be valid

Returns:

a (possible) list of licenses

Throws:

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

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

getServiceName

String getServiceName(String lmngId)

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

Parameters:

lmngId -

Returns:

isActiveMode

boolean isActiveMode()

Is the LMNG service active? If not then no calls should be made and the entire distribution channel runs without license / article information from LMNG.

Returns:

whether the LicensingService is active