nl.surfnet.coin.csa

Class CsaClient

java.lang.Object

nl.surfnet.coin.csa.CsaClient

All Implemented Interfaces:

Csa

public class CsaClient
extends Object
implements Csa

Client for the CSA API.

Constructor Summary

Constructors

Constructor and Description
CsaClient()
CsaClient(String csaBaseLocation)

Method Summary

Methods

Modifier and Type	Method and Description
void	clearProviderCache()
Action	createAction(Action action)
List<OfferedService>	findOfferedServicesFor(String idpEntityId)
List<InstitutionIdentityProvider>	getAllInstitutionIdentityProviders()
List<InstitutionIdentityProvider>	getInstitutionIdentityProviders(String identityProviderId)
List<Action>	getJiraActions(String idpEntityId)
List<Service>	getProtectedServices() Get a list of all protected services scoped by the Idp of the logged in person
List<Service>	getPublicServices() Get a list of all services available to anyone.
Service	getServiceForIdp(String idpEntityId, long serviceId) Get a service's details, scoped by the given IDP entity ID
Service	getServiceForIdp(String idpEntityId, String spEntityId) Get a service's details, scoped by the given IDP entity ID and SP entity ID
List<Service>	getServicesForIdp(String idpEntityId) Get a list of services, scoped by the given IDP entity ID
Statistics	getStatistics(int month, int year) Retrieve statistical information from CSA for the given month and year.
Taxonomy	getTaxonomy()
void	setCsaBaseLocation(String csaBaseLocation) Setter for base location of CSA
void	setOauthClient(OauthClient oauthClient)

Methods inherited from class java.lang.Object

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

Constructor Detail

CsaClient

public CsaClient()

CsaClient

public CsaClient(String csaBaseLocation)

Method Detail

getPublicServices

public List<Service> getPublicServices()

Description copied from interface: Csa

Get a list of all services available to anyone.

Specified by:

getPublicServices in interface Csa

getProtectedServices

public List<Service> getProtectedServices()

Description copied from interface: Csa

Get a list of all protected services scoped by the Idp of the logged in person

Specified by:

getProtectedServices in interface Csa

getServicesForIdp

public List<Service> getServicesForIdp(String idpEntityId)

Description copied from interface: Csa

Get a list of services, scoped by the given IDP entity ID

Specified by:

getServicesForIdp in interface Csa

findOfferedServicesFor

public List<OfferedService> findOfferedServicesFor(String idpEntityId)

Specified by:

findOfferedServicesFor in interface Csa

getServiceForIdp

public Service getServiceForIdp(String idpEntityId,
                       long serviceId)

Description copied from interface: Csa

Get a service's details, scoped by the given IDP entity ID

Specified by:

getServiceForIdp in interface Csa

Returns:

getServiceForIdp

public Service getServiceForIdp(String idpEntityId,
                       String spEntityId)

Description copied from interface: Csa

Get a service's details, scoped by the given IDP entity ID and SP entity ID

Specified by:

getServiceForIdp in interface Csa

Parameters:

idpEntityId - idp entity ID

spEntityId - sp entity ID

Returns:

getTaxonomy

public Taxonomy getTaxonomy()

Specified by:

getTaxonomy in interface Csa

getJiraActions

public List<Action> getJiraActions(String idpEntityId)

Specified by:

getJiraActions in interface Csa

clearProviderCache

public void clearProviderCache()

Specified by:

clearProviderCache in interface Csa

createAction

public Action createAction(Action action)

Specified by:

createAction in interface Csa

getInstitutionIdentityProviders

public List<InstitutionIdentityProvider> getInstitutionIdentityProviders(String identityProviderId)

Specified by:

getInstitutionIdentityProviders in interface Csa

getAllInstitutionIdentityProviders

public List<InstitutionIdentityProvider> getAllInstitutionIdentityProviders()

Specified by:

getAllInstitutionIdentityProviders in interface Csa

setCsaBaseLocation

public void setCsaBaseLocation(String csaBaseLocation)

Description copied from interface: Csa

Setter for base location of CSA

Specified by:

setCsaBaseLocation in interface Csa

Parameters:

csaBaseLocation - base URL of CSA

getStatistics

public Statistics getStatistics(int month,
                       int year)

Description copied from interface: Csa

Retrieve statistical information from CSA for the given month and year. Statistical information consists of the number of questions, link- and unlinkrequests per IDP/SP.

Specified by:

getStatistics in interface Csa

Parameters:

month - month to retrieve information for (1-12)

year - the year to retrieve informaiton for

Returns:

the statistics

See Also:

Statistics

setOauthClient

public void setOauthClient(OauthClient oauthClient)

Specified by:

setOauthClient in interface Csa