|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object blackboard.platform.security.authentication.HttpAuthConfig
public class HttpAuthConfig
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.
Field Summary | |
---|---|
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 |
getAvailableAuthTypes()
Accessors |
static java.util.ArrayList |
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(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.Hashtable |
getPropObjLoadErrs()
|
java.util.ArrayList |
getSubConfigs()
|
java.util.Hashtable |
getUiFormattedAuthProps()
|
java.util.ArrayList |
getUiFormattedPropKeys()
|
java.util.ArrayList |
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 |
---|
public static final int NUM_SUPPORTED_AUTH_TYPES
Method Detail |
---|
public static void init(ConfigurationService configSvc) throws InitializationException
InitializationException
public static void configure(HttpAuthModule module) throws InitializationException
InitializationException
public static HttpAuthModule getModule(java.lang.String authType)
public boolean getUseChallenge()
public static java.lang.Class getImplClassForAuthType(java.lang.String authType) throws InitializationException
InitializationException
public static HttpAuthConfig getInstalledInstance() throws InitializationException
InitializationException
public static HttpAuthConfig getInstance() throws InitializationException
InitializationException
public static java.lang.String getInstalledAuthType()
public static HttpAuthConfig getInstance(java.lang.String authType) throws InitializationException
InitializationException
public static HttpAuthConfig getInstance(java.lang.String authType, java.lang.String[] propKeys) throws InitializationException
InitializationException
public static HttpAuthConfig getInstance(VirtualInstallation vi, java.lang.String authType, java.lang.String[] propKeys) throws InitializationException
InitializationException
public static java.util.ArrayList getAvailableAuthTypes()
public static java.util.ArrayList getConfigKeys()
public java.util.ArrayList getUiFormattedPropKeys()
public java.lang.Object getProperty(java.lang.String key)
public java.util.Hashtable getPropObjLoadErrs()
public java.util.Hashtable getUiFormattedAuthProps()
public java.util.ArrayList getUiFormattedSubConfigs()
public java.util.ArrayList getSubConfigs()
public java.lang.String toString()
toString
in class java.lang.Object
public java.lang.String formatPropertyValue(java.lang.Object value)
public java.lang.String getFormattedPropertyKey(java.lang.String key)
public static java.lang.String getDisplayAuthType()
public static java.lang.String getDisplayAuthType(java.lang.String selectedAuthType)
public static java.util.Properties getConfigProperties(java.io.File configFile) throws InitializationException
InitializationException
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |