blackboard.platform.security.authentication
Class HttpAuthConfig

java.lang.Object
  blackboard.platform.security.authentication.HttpAuthConfig

public final class HttpAuthConfig
extends java.lang.Object

This class is responsible for storing in-memory the authentication properties for the Blackboard application. An HttpAuthConfig instance converts the property file entries into the appropriate objects ( Integer, Boolean, URL, Class or String ) makes those objects available via the getProperty(String) method.

This class is also responsible for providing the Blackboard authentication-configuration GUI with the appropriate user-friendly text describing each property file entry.

This class expects to find a /config/authentication.properties file in the directory to which the Blackboard application has been deployed.

Since:

Bb 6.3

Field Summary

static java.lang.String	LOGIN_PROMPT_SUPPRESS
static int	NUM_SUPPORTED_AUTH_TYPES

Method Summary

static void	configure(HttpAuthModule module) Public API
java.lang.String	formatPropertyValue(java.lang.Object value)
static java.util.ArrayList<java.lang.String>	getAvailableAuthTypes() Accessors
static java.util.ArrayList<java.lang.String>	getConfigKeys()
static java.util.Properties	getConfigProperties(java.io.File configFile)
static java.lang.String	getDisplayAuthType() Helper methods
static java.lang.String	getDisplayAuthType(java.lang.String selectedAuthType)
java.lang.String	getFormattedPropertyKey(java.lang.String key)
static java.lang.Class<?>	getImplClassForAuthType(java.lang.String authType) Singleton accessors
static java.lang.String	getInstalledAuthType()
static HttpAuthConfig	getInstalledInstance()
static HttpAuthConfig	getInstance()
static HttpAuthConfig	getInstance(java.lang.String authType)
static HttpAuthConfig	getInstance(java.lang.String authType, java.lang.String[] propKeys)
static HttpAuthConfig	getInstance(blackboard.platform.vxi.data.VirtualInstallation vi, java.lang.String authType, java.lang.String[] propKeys)
static HttpAuthModule	getModule(java.lang.String authType)
java.lang.Object	getProperty(java.lang.String key)
java.util.Map<java.lang.String,java.lang.String>	getPropObjLoadErrs()
java.util.ArrayList<HttpAuthConfig>	getSubConfigs()
java.util.Map<java.lang.String,java.lang.String>	getUiFormattedAuthProps()
java.util.ArrayList<java.lang.String>	getUiFormattedPropKeys()
java.util.ArrayList<java.util.Map<java.lang.String,java.lang.String>>	getUiFormattedSubConfigs()
boolean	getUseChallenge()
static void	init(ConfigurationService configSvc)
java.lang.String	toString() Printing

Methods inherited from class java.lang.Object

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

Field Detail

NUM_SUPPORTED_AUTH_TYPES

public static final int NUM_SUPPORTED_AUTH_TYPES

See Also:

Constant Field Values

LOGIN_PROMPT_SUPPRESS

public static final java.lang.String LOGIN_PROMPT_SUPPRESS

See Also:

Constant Field Values

Method Detail

init

public static void init(ConfigurationService configSvc)
                 throws InitializationException

Throws:

InitializationException

configure

public static void configure(HttpAuthModule module)
                      throws InitializationException

Public API

Throws:

InitializationException

getModule

public static HttpAuthModule getModule(java.lang.String authType)

getUseChallenge

public boolean getUseChallenge()

getImplClassForAuthType

public static java.lang.Class<?> getImplClassForAuthType(java.lang.String authType)
                                                  throws InitializationException

Singleton accessors

Throws:

InitializationException

getInstalledInstance

public static HttpAuthConfig getInstalledInstance()
                                           throws InitializationException

Throws:

InitializationException

getInstance

public static HttpAuthConfig getInstance()
                                  throws InitializationException

Throws:

InitializationException

getInstalledAuthType

public static java.lang.String getInstalledAuthType()

getInstance

public static HttpAuthConfig getInstance(java.lang.String authType)
                                  throws InitializationException

Throws:

InitializationException

getInstance

public static HttpAuthConfig getInstance(java.lang.String authType,
                                         java.lang.String[] propKeys)
                                  throws InitializationException

Throws:

InitializationException

getInstance

public static HttpAuthConfig getInstance(blackboard.platform.vxi.data.VirtualInstallation vi,
                                         java.lang.String authType,
                                         java.lang.String[] propKeys)
                                  throws InitializationException

Throws:

InitializationException

getAvailableAuthTypes

public static java.util.ArrayList<java.lang.String> getAvailableAuthTypes()

Accessors

getConfigKeys

public static java.util.ArrayList<java.lang.String> getConfigKeys()

getUiFormattedPropKeys

public java.util.ArrayList<java.lang.String> getUiFormattedPropKeys()

getProperty

public java.lang.Object getProperty(java.lang.String key)

getPropObjLoadErrs

public java.util.Map<java.lang.String,java.lang.String> getPropObjLoadErrs()

getUiFormattedAuthProps

public java.util.Map<java.lang.String,java.lang.String> getUiFormattedAuthProps()

getUiFormattedSubConfigs

public java.util.ArrayList<java.util.Map<java.lang.String,java.lang.String>> getUiFormattedSubConfigs()

getSubConfigs

public java.util.ArrayList<HttpAuthConfig> getSubConfigs()

toString

public java.lang.String toString()

Printing

Overrides:

toString in class java.lang.Object

formatPropertyValue

public java.lang.String formatPropertyValue(java.lang.Object value)

getFormattedPropertyKey

public java.lang.String getFormattedPropertyKey(java.lang.String key)

getDisplayAuthType

public static java.lang.String getDisplayAuthType()

Helper methods

getDisplayAuthType

public static java.lang.String getDisplayAuthType(java.lang.String selectedAuthType)

getConfigProperties

public static java.util.Properties getConfigProperties(java.io.File configFile)
                                                throws InitializationException

Throws:

InitializationException