org.mitre.openid.connect.service

Interface WhitelistedSiteService

All Known Implementing Classes:

DefaultWhitelistedSiteService

public interface WhitelistedSiteService

Interface for WhitelistedSite service

Author:

Michael Joseph Walsh, aanganes

Method Summary

Modifier and Type	Method and Description
Collection<WhitelistedSite>	getAll() Return a collection of all WhitelistedSite managed by this service
WhitelistedSite	getByClientId(String clientId) Find a WhitelistedSite by its associated ClientDetails reference
WhitelistedSite	getById(Long id) Returns the WhitelistedSite for the given id
void	remove(WhitelistedSite whitelistedSite) Removes the given WhitelistedSite from the repository
WhitelistedSite	saveNew(WhitelistedSite whitelistedSite) Persists a new WhitelistedSite
WhitelistedSite	update(WhitelistedSite oldWhitelistedSite, WhitelistedSite whitelistedSite) Updates an existing whitelisted site

Method Detail

getAll

Collection<WhitelistedSite> getAll()

Return a collection of all WhitelistedSite managed by this service

Returns:

the WhitelistedSite collection, or null

getById

WhitelistedSite getById(Long id)

Returns the WhitelistedSite for the given id

Parameters:

id - id the id of the WhitelistedSite

Returns:

a valid WhitelistedSite if it exists, null otherwise

getByClientId

WhitelistedSite getByClientId(String clientId)

Find a WhitelistedSite by its associated ClientDetails reference

Parameters:

client - the Relying Party

Returns:

the corresponding WhitelistedSite if one exists for the RP, or null

remove

void remove(WhitelistedSite whitelistedSite)

Removes the given WhitelistedSite from the repository

Parameters:

address - the WhitelistedSite object to remove

saveNew

WhitelistedSite saveNew(WhitelistedSite whitelistedSite)

Persists a new WhitelistedSite

Parameters:

whitelistedSite - the WhitelistedSite to be saved

Returns:

update

WhitelistedSite update(WhitelistedSite oldWhitelistedSite,
                       WhitelistedSite whitelistedSite)

Updates an existing whitelisted site