blackboard.platform.security
Class SecurityDbUtil

java.lang.Object
  blackboard.platform.security.SecurityDbUtil

public class SecurityDbUtil
extends java.lang.Object

A utility class that encapsulates a handful database operations performed by blackboard.platform.security classes and/or classes within its sub-package.

Since:

Bb 6.0

Constructor Summary

SecurityDbUtil()

Method Summary

static boolean	getBackpackUIAllowed() Convenience method to determine whether to display Bbackpack links.
static boolean	getCreateAccountAllowed(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Convenience method to determine whether users may create new accounts.
static EntitlementDbLoader	getEntitlementDbLoader() Returns the EntitlementDbLoader instance associated with the default instance of the database BbPersistenceManager.
static java.lang.String	getForgotPasswordUrl() Convenience method to determine whether users may request their password.
static boolean	getGuestAllowed() Convenience method to determine whether guests may access Blackboard installation.
static boolean	getPortalDirectEntry(javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse res) Convenience method to determine whether Portal Direct Entry is enabled.
static boolean	getRetrievePasswordAllowed(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Convenience method to determine whether users may request their password.
static java.lang.String	getSoftwareTitle(javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse res) Convenience method to determine the proper name for this Blackboard system.

Methods inherited from class java.lang.Object

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

Constructor Detail

SecurityDbUtil

public SecurityDbUtil()

Method Detail

getEntitlementDbLoader

public static EntitlementDbLoader getEntitlementDbLoader()

Returns the EntitlementDbLoader instance associated with the default instance of the database BbPersistenceManager.

Calling this method is equivalent to executing the following code:

 BbPersistenceManager bbPm = BbServiceManager.getPersistenceService().getDbPersistenceManager();
 entitlementLoader = (EntitlementDbLoader) bbPm.getLoader ( EntitlementDbLoader.TYPE );
 

Returns:

the EntitlementDbLoader instance associated with the default database persistence manager

Throws:

PersistenceException - if an error occurs when trying to retrieve the EntitlementDbLoader instance

getSoftwareTitle

public static java.lang.String getSoftwareTitle(javax.servlet.http.HttpServletRequest req,
                                                javax.servlet.http.HttpServletResponse res)

Convenience method to determine the proper name for this Blackboard system.

Parameters:

req - the HttpServletRequest

res - the HttpServletResponse

getPortalDirectEntry

public static boolean getPortalDirectEntry(javax.servlet.http.HttpServletRequest req,
                                           javax.servlet.http.HttpServletResponse res)

Convenience method to determine whether Portal Direct Entry is enabled.

Parameters:

req - the current HttpServletRequest

res - the current HttpServletResponse

getGuestAllowed

public static boolean getGuestAllowed()

Convenience method to determine whether guests may access Blackboard installation.

getCreateAccountAllowed

public static boolean getCreateAccountAllowed(javax.servlet.http.HttpServletRequest request,
                                              javax.servlet.http.HttpServletResponse response)

Convenience method to determine whether users may create new accounts.

Parameters:

req - the current HttpServletRequest

res - the current HttpServletResponse

Returns:

a boolean indicating if system registry key user_creation is true

getRetrievePasswordAllowed

public static boolean getRetrievePasswordAllowed(javax.servlet.http.HttpServletRequest request,
                                                 javax.servlet.http.HttpServletResponse response)

Convenience method to determine whether users may request their password.

Parameters:

req - the the HttpServletRequest

res - the the HttpServletResponse

Returns:

a boolean

getForgotPasswordUrl

public static java.lang.String getForgotPasswordUrl()

Convenience method to determine whether users may request their password.

Returns:

the URL to request a password as a String if true or null if false

getBackpackUIAllowed

public static boolean getBackpackUIAllowed()

Convenience method to determine whether to display Bbackpack links.

Parameters:

req - the current HttpServletRequest

res - the current HttpServletResponse