com.atlassian.crowd.openid.server.manager.site

Interface SiteManager

All Known Implementing Classes:

SiteManagerGeneric

public interface SiteManager

Method Summary

Modifier and Type	Method and Description
void	addRPAddressRestriction(String restriction)
SiteApproval	createApprovalFromWhitelist(User user, String url) Generate approval if this site is configured in the server's white list, otherwise return null.
List<? extends AddressRestriction>	findAllRPAddressRestrictions() Finds all of the whitelist or blacklist server approvals.
Site	findOrCreateSite(String url) Gets the Site object corresponding to the URL or creates a Site object corresponding to the URL.
SiteApproval	findSiteApproval(User user, String url) Finds the SiteApproval of a user for a given URL.
List<? extends SiteApproval>	getAllAlwaysAllowSites(User user) Returns all the sites marked 'always allow' for a user.
boolean	isSiteAllowedToAuthenticate(URL url) Determines is a URL is allowed to authenticate.
void	removeRPAddressRestriction(String address)
SiteApproval	setSiteApproval(User user, String url, long profileID, boolean alwaysAllow) Updates or creates site approval for a particular site (URL) associated with a user and a profile of that user.
void	updateAlwaysAllowApprovals(User user, List<String> urls, List<String> profileIDs) Updates which sites are always allowed to authenticate.

Method Detail

findSiteApproval

@Nullable
SiteApproval findSiteApproval(User user,
                                        String url)

Finds the SiteApproval of a user for a given URL. Returns null if user does not have SiteApproval for the URL.

Parameters:

user - user to search in.

url - URL of Site in SiteApproval.

Returns:

SiteApproval or null if none exists.

createApprovalFromWhitelist

SiteApproval createApprovalFromWhitelist(User user,
                                         String url)

Generate approval if this site is configured in the server's white list, otherwise return null.

Parameters:

user - user which this approval is for

url - the url which the approval is for

Returns:

SiteApproval or null

findOrCreateSite

Site findOrCreateSite(String url)

Gets the Site object corresponding to the URL or creates a Site object corresponding to the URL.

Parameters:

url - URL of the Site.

Returns:

Site.

setSiteApproval

SiteApproval setSiteApproval(User user,
                             String url,
                             long profileID,
                             boolean alwaysAllow)
                      throws SiteManagerException

Updates or creates site approval for a particular site (URL) associated with a user and a profile of that user.

Parameters:

user - user to associate to.

url - URL of site.

profileID - default profile to use for attribute information when interacting with site.

alwaysAllow - true if authentication with this site is always allowed.

Returns:

SiteApproval which just got added or updated.

Throws:

SiteManagerException - thrown if profile with given profileID does not exist OR user does not own profile.

getAllAlwaysAllowSites

List<? extends SiteApproval> getAllAlwaysAllowSites(User user)

Returns all the sites marked 'always allow' for a user.

Parameters:

user - user to search for.

Returns:

List<SiteApproval>

updateAlwaysAllowApprovals

void updateAlwaysAllowApprovals(User user,
                                List<String> urls,
                                List<String> profileIDs)
                         throws SiteManagerException

Updates which sites are always allowed to authenticate.

Parameters:

user - user to update.

urls - list of URLS of sites.

profileIDs - corresponding list of default profile IDs for the sites.

Throws:

SiteManagerException - thrown if URL/ProfileID lists are null or not the same size OR profile with given profileID does not exist OR user does not own profile.

findAllRPAddressRestrictions

List<? extends AddressRestriction> findAllRPAddressRestrictions()

Finds all of the whitelist or blacklist server approvals.

Returns:

The list of whitelist or blacklist mode to enforce.

See Also:

OpenIDPropertyManager.getTrustRelationshipMode()

addRPAddressRestriction

void addRPAddressRestriction(String restriction)

removeRPAddressRestriction

void removeRPAddressRestriction(String address)

isSiteAllowedToAuthenticate

boolean isSiteAllowedToAuthenticate(URL url)

Determines is a URL is allowed to authenticate. 1. on blacklist: disallow. 2. on whitelist: allow. 3. otherwise: allow.

Parameters:

url - url of the site.

Returns:

true if site is allowed to authenticate, false otherwise.