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

Class SiteManagerGeneric

java.lang.Object

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

All Implemented Interfaces:

SiteManager

public class SiteManagerGeneric
extends Object
implements SiteManager

Constructor Summary

Constructors

Constructor and Description
SiteManagerGeneric(SiteDAO siteDAO, SiteApprovalDAO siteApprovalDAO, ProfileManager profileManager, AddressRestrictionDAO addressRestrictionDAO, OpenIDPropertyManager openIDPropertyManager, ApprovalWhitelist siteApprovalWhitelist)

Method Summary

Modifier and Type	Method and Description
void	addRPAddressRestriction(String address)
SiteApproval	createApprovalFromWhitelist(User user, String url) Generate approval if this site is configured in the server's white list, otherwise return null.
List<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<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.

Methods inherited from class java.lang.Object

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

Constructor Detail

SiteManagerGeneric

public SiteManagerGeneric(SiteDAO siteDAO,
                          SiteApprovalDAO siteApprovalDAO,
                          ProfileManager profileManager,
                          AddressRestrictionDAO addressRestrictionDAO,
                          OpenIDPropertyManager openIDPropertyManager,
                          ApprovalWhitelist siteApprovalWhitelist)

Method Detail

findSiteApproval

public SiteApproval findSiteApproval(User user,
                                     String url)

Description copied from interface: SiteManager

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

Specified by:

findSiteApproval in interface SiteManager

Parameters:

user - user to search in.

url - URL of Site in SiteApproval.

Returns:

SiteApproval or null if none exists.

createApprovalFromWhitelist

public SiteApproval createApprovalFromWhitelist(User user,
                                                String url)

Description copied from interface: SiteManager

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

Specified by:

createApprovalFromWhitelist in interface SiteManager

Parameters:

user - user which this approval is for

url - the url which the approval is for

Returns:

SiteApproval or null

findOrCreateSite

public Site findOrCreateSite(String url)

Description copied from interface: SiteManager

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

Specified by:

findOrCreateSite in interface SiteManager

Parameters:

url - URL of the Site.

Returns:

Site.

setSiteApproval

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

Description copied from interface: SiteManager

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

Specified by:

setSiteApproval in interface SiteManager

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

public List<SiteApproval> getAllAlwaysAllowSites(User user)

Description copied from interface: SiteManager

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

Specified by:

getAllAlwaysAllowSites in interface SiteManager

Parameters:

user - user to search for.

Returns:

List<SiteApproval>

updateAlwaysAllowApprovals

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

Description copied from interface: SiteManager

Updates which sites are always allowed to authenticate.

Specified by:

updateAlwaysAllowApprovals in interface SiteManager

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

public List<AddressRestriction> findAllRPAddressRestrictions()

Description copied from interface: SiteManager

Finds all of the whitelist or blacklist server approvals.

Specified by:

findAllRPAddressRestrictions in interface SiteManager

Returns:

The list of whitelist or blacklist mode to enforce.

See Also:

OpenIDPropertyManager.getTrustRelationshipMode()

addRPAddressRestriction

public void addRPAddressRestriction(String address)

Specified by:

addRPAddressRestriction in interface SiteManager

removeRPAddressRestriction

public void removeRPAddressRestriction(String address)

Specified by:

removeRPAddressRestriction in interface SiteManager

isSiteAllowedToAuthenticate

public boolean isSiteAllowedToAuthenticate(URL url)

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

Specified by:

isSiteAllowedToAuthenticate in interface SiteManager

Parameters:

url - url of the site.

Returns:

true if site is allowed to authenticate, false otherwise.