com.spvsoftwareproducts.blackboard.utils

Class B2Context

java.lang.Object

com.spvsoftwareproducts.blackboard.utils.B2Context

public class B2Context
extends java.lang.Object

B2Context provides basic support functions for Building Blocks including easy access to language bundle values, configuration settings, navigation items, receipt messages and simple logging.

For example,

   B2Context b2Context = new B2Context(request);
   pageContext.setAttribute("bundle", b2Context.getResourceStrings());
   pageContext.setAttribute("setting", b2Context.getSettings());
 

will create an instance of this class and save all the resource strings from the bb-manifest bundle for the current locale in a map named bundle and all the systemwide setting values in a map named setting. This allows these values to be inserted within a JSP file using references such as:

   ${bundle['plugin.name']}
   ${setting.homeURL}
 

New settings can be added, or existing settings updated, as follows:

   setSetting("homeURL", "/");
 

Changes made to setting values can be saved permanently as follows:

   persistSettings();
 

The class supports 2 types of setting (giving 4 possible combinations):

• global: apply to all instances (contexts) of the building block
• anonymous: apply to all users of the building block

By default (as in the above examples), a setting is assumed to be global and anonymous, but alternative versions of the settings methods are provided which allow the global and anonymous parameters to be specified. For example, if global and anonymous are both false then the setting values will apply only to the current user and in the current context (course or content-item). The settings file used to persist these settings will be saved within the applicable context.

Associating anonymous global settings with a node in the Institutional Hierarchy requires Learn 9.1SP8 (or higher); accessing these settings from a module requires Learn 9.1SP10 (or higher).

Version:

1.9 (22-Apr-18)

Author:

Stephen P Vickers

Constructor Summary

Constructors

Constructor and Description
B2Context() Class constructor.
B2Context(blackboard.platform.context.Context context) Deprecated.
B2Context(javax.servlet.http.HttpServletRequest request) Class constructor using request.

Method Summary

Methods

Modifier and Type	Method and Description
void	addReceiptOptionsToRequest(java.lang.String success, java.lang.String warning, java.lang.String error) Add receipts in current request.
void	clearNode() Clears the current node.
void	clearSettings() Deletes all global anonymous configuration settings.
void	clearSettings(boolean global, boolean anonymous, java.lang.String suffix) Deletes all configuration settings.
java.util.List<blackboard.platform.institutionalhierarchy.service.Node>	getActiveNodes() Gets the list of nodes for which there is at least one setting value.
java.util.List<blackboard.platform.institutionalhierarchy.service.Node>	getActiveNodes(java.lang.String settingName) Gets the list of nodes for which the named setting value exists.
java.lang.String	getB2Version() Gets the version for the current Building Block.
blackboard.data.content.Content	getContent() Gets the current content.
blackboard.persist.Id	getContentId() Gets the current content ID.
java.lang.String	getContentIdAsString() Gets the current content ID.
blackboard.platform.context.Context	getContext() Gets the current Blackboard context object.
blackboard.data.course.Course	getCourse() Gets the current course.
blackboard.persist.Id	getCourseId() Gets the current course ID.
java.lang.String	getCourseIdAsString() Gets the current course ID.
static boolean	getEditMode() Gets the current status of edit mode (Learn 9.1+).
blackboard.data.course.Group	getGroup() Gets the current group.
blackboard.persist.Id	getGroupId() Gets the current group ID.
java.lang.String	getGroupIdAsString() Gets the current group ID.
java.lang.String	getHandle() Gets the handle for the current Building Block.
boolean	getIgnoreContentContext() Gets the IgnoreContentContext setting.
boolean	getIgnoreCourseContext() Deprecated.
boolean	getIgnoreGroupContext() Gets the IgnoreGroupContext setting.
boolean	getInheritSettings() Gets the current inherit settings value.
boolean	getIsActiveNode() Checks if the current node has any settings.
boolean	getIsActiveNode(java.lang.String settingName) Checks if the current node has a setting of a specified name.
boolean	getIsB2Version(int major, int minor, int build) Checks whether the current Building Block is at a specific version, or later.
boolean	getIsRootNode() Checks if the current node is the root of the Institutional Hierarchy.
static boolean	getIsVersion(int major, int minor, int servicePack) Checks whether the Blackboard is at a specific release, or later.
static boolean	getLogDebug() Gets the debug level for the logger.
blackboard.data.navigation.NavigationItem	getNavigationItem(java.lang.String name) Gets a named navigation item.
blackboard.platform.institutionalhierarchy.service.Node	getNode() Gets the current node.
static boolean	getNodeSupport() Gets the current node support setting.
java.lang.String	getPath() Gets the path for the current Building Block.
java.lang.String	getPath(java.lang.String schema) Gets the path for the current Building Block using a specified schema name.
blackboard.platform.plugin.PlugIn	getPlugIn() Gets the plugin object for this building block.
javax.servlet.http.HttpServletRequest	getRequest() Gets the current request object.
javax.servlet.http.HttpServletRequest	getRequest(boolean unfiltered) Gets the current request object.
java.lang.String	getRequestParameter(java.lang.String name, java.lang.String defaultValue) Gets a parameter from the current request object.
java.lang.String	getRequestParameter(java.lang.String name, java.lang.String defaultValue, boolean unfiltered) Gets a parameter from the current request object.
java.util.Map<java.lang.String,java.lang.String>	getRequestParameters() Gets the values of all parameters from a request object.
java.util.Map<java.lang.String,java.lang.String>	getRequestParameters(boolean unfiltered) Gets the values of all parameters from a request object.
java.lang.String	getRequestParameterValues(java.lang.String name, java.lang.String defaultValue) Gets the values for a parameter from a request object.
java.lang.String	getRequestParameterValues(java.lang.String name, java.lang.String defaultValue, boolean unfiltered) Gets the values for a parameter from a request object.
java.lang.String	getResourceString(java.lang.String key) Gets a resource string from the bundle for the current locale.
java.lang.String	getResourceString(java.lang.String key, java.lang.String defaultValue) Gets a resource string from the bundle for the current locale.
java.util.Map<java.lang.String,java.lang.String>	getResourceStrings() Gets all the resource strings from the bundle for the current locale.
boolean	getSaveEmptyValues() Gets the SaveEmptyValues setting.
java.lang.String	getSchema() Gets the schema for the current Learn 9 instance.
java.lang.String	getServerUrl() Gets the path for the current Building Block.
java.lang.String	getSetting(boolean global, boolean anonymous, java.lang.String key) Gets a configuration setting value.
java.lang.String	getSetting(boolean global, boolean anonymous, java.lang.String key, java.lang.String defaultValue) Gets a configuration setting value.
java.lang.String	getSetting(boolean global, boolean anonymous, java.lang.String key, java.lang.String defaultValue, blackboard.platform.institutionalhierarchy.service.Node aNode) Gets a configuration setting value from a specific node.
java.lang.String	getSetting(java.lang.String key) Gets a global anonymous configuration setting value.
java.lang.String	getSetting(java.lang.String key, java.lang.String defaultValue) Gets a global anonymous configuration setting value.
java.util.Map<java.lang.String,java.lang.String>	getSettings() Gets a list of all global anonymous configuration settings.
java.util.Map<java.lang.String,java.lang.String>	getSettings(boolean global, boolean anonymous) Gets a list of all configuration settings.
java.util.Map<java.lang.String,java.lang.String>	getSettings(boolean global, boolean anonymous, boolean nodeOnly) Gets a list of all configuration settings.
java.util.Map<java.lang.String,java.lang.String>	getSettings(boolean global, boolean anonymous, java.lang.String fileSuffix) Gets a list of all configuration settings.
java.util.Map<java.lang.String,java.lang.String>	getSettings(boolean global, boolean anonymous, java.lang.String fileSuffix, boolean nodeOnly) Gets a list of all configuration settings.
java.util.Map<java.lang.String,java.lang.String>	getSettings(java.lang.String fileSuffix) Gets a list of all global anonymous configuration settings.
blackboard.data.user.User	getUser() Gets the current user.
blackboard.persist.Id	getUserId() Gets the current user ID.
java.lang.String	getUserIdAsString() Gets the current user ID.
java.lang.String	getVendorId() Gets the vendor ID for the current Building Block.
static int[]	getVersionNumber() Gets the Blackboard version number as an array of its elements.
static java.lang.String	getVersionNumber(java.lang.String defaultValue) Gets the Blackboard version number.
java.lang.String	getWebappRoot() Gets the file root for the current Building Block.
boolean	hasContentContext() Checks if the current context has a Content reference.
boolean	hasCourseContext() Checks if the current context has a Course reference.
boolean	hasGroupContext() Checks if the current context has a Group reference.
boolean	hasUserContext() Checks if the current context has a User reference.
static void	log(boolean isError, java.lang.String message) Sends a log message to the logs/bb-services-log.txt file.
static void	log(boolean isError, java.lang.String prefix, java.lang.Object obj) Sends an object to the logs/bb-services-log.txt file.
static void	log(java.lang.String message) Sends an error message to the logs/bb-services-log.txt file.
void	persistSettings() Permanently saves the current global anonymous configuration setting values.
void	persistSettings(boolean global, boolean anonymous) Permanently saves the current configuration setting values.
void	persistSettings(boolean global, boolean anonymous, java.util.Properties properties) Permanently saves a set of setting values.
void	persistSettings(boolean global, boolean anonymous, java.lang.String suffix, java.util.Map<java.lang.String,java.lang.String> settings) Permanently saves the current configuration setting values.
void	persistSettings(java.lang.String suffix, java.util.Map<java.lang.String,java.lang.String> settings) Permanently saves the global anonymous configuration setting values.
static void	processCourseCopy(blackboard.platform.cx.component.CopyControl copyControl) Processes changes arising from a course copy.
static java.util.Map<java.lang.String,java.lang.String>	processCourseExport(blackboard.platform.cx.component.ExportControl exportControl) Processes changes arising from a course export/archive.
static void	processCourseImport(blackboard.platform.cx.component.ImportControl importControl, java.util.Properties props) Processes changes arising from a course export/archive.
void	setContent(blackboard.data.content.Content content) Sets the current content.
void	setContentId(blackboard.persist.Id contentId) Sets the current content ID.
boolean	setContentId(java.lang.String contentIdString) Sets the current content ID.
void	setContext(blackboard.platform.context.Context context) Deprecated. Replaced by setUser(User), setCourse(Course), setGroup(Group), setContent(Content)
void	setCourse(blackboard.data.course.Course course) Sets the current course.
void	setCourseId(blackboard.persist.Id courseId) Sets the current course ID.
boolean	setCourseId(java.lang.String courseIdString) Sets the current course ID.
void	setGroup(blackboard.data.course.Group group) Sets the current group.
void	setGroupId(blackboard.persist.Id groupId) Sets the current group ID.
boolean	setGroupId(java.lang.String groupIdString) Sets the current group ID.
void	setIgnoreContentContext(boolean ignoreContentContext) Sets the IgnoreContentContext setting.
void	setIgnoreCourseContext(boolean ignoreCourseContext) Deprecated.
void	setIgnoreGroupContext(boolean ignoreGroupContext) Sets the IgnoreGroupContext setting.
void	setInheritSettings(boolean inheritSettings) Gets the current inherit settings value.
static void	setLogDebug(boolean logDebugSetting) Sets the debug level for the logger.
void	setNode(blackboard.platform.institutionalhierarchy.service.Node aNode) Sets the current node.
void	setReceipt(java.lang.String message) Sets a success receipt option.
void	setReceipt(java.lang.String message, boolean isSuccess) Sets a success or error receipt option.
void	setReceipt(java.lang.String message, java.lang.Exception exception) Sets a warning receipt option.
void	setReceiptOptions(java.lang.String success, java.lang.String error) Set receipts in session.
java.lang.String	setReceiptOptions(java.lang.String url, java.lang.String success, java.lang.String error) Set receipts to a URL.
void	setSaveEmptyValues(boolean saveEmptyValues) Sets the SaveEmptyValues setting.
void	setSetting(boolean global, boolean anonymous, java.lang.String key, java.lang.String value) Adds a configuration setting value.
void	setSetting(java.lang.String key, java.lang.String value) Adds a global anonymous configuration setting value.
void	setUser(blackboard.data.user.User user) Sets the current user.
void	setUserId(blackboard.persist.Id userId) Sets the current user ID.
boolean	setUserId(java.lang.String userIdString) Sets the current user ID.

Methods inherited from class java.lang.Object

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

Constructor Detail

B2Context

public B2Context(blackboard.platform.context.Context context)

Deprecated.

Class constructor using context.

Parameters:

context - the current context object

B2Context

public B2Context(javax.servlet.http.HttpServletRequest request)

Class constructor using request.

Parameters:

request - the current request object

B2Context

public B2Context()

Class constructor.

Method Detail

getRequest

public javax.servlet.http.HttpServletRequest getRequest()

Gets the current request object.

Returns:

the request object

getRequest

public javax.servlet.http.HttpServletRequest getRequest(boolean unfiltered)

Gets the current request object.

Parameters:

unfiltered - true if an unfiltered value should be returned

Returns:

the request object

getInheritSettings

public boolean getInheritSettings()

Gets the current inherit settings value.

Returns:

true if settings are being inherited by nodes

setInheritSettings

public void setInheritSettings(boolean inheritSettings)

Gets the current inherit settings value.

Parameters:

inheritSettings - true if settings are to be inherited by nodes

getNodeSupport

public static boolean getNodeSupport()

Gets the current node support setting.

Returns:

true if node support is enabled

getNode

public blackboard.platform.institutionalhierarchy.service.Node getNode()

Gets the current node.

Returns:

the node

clearNode

public void clearNode()

Clears the current node.

setNode

public void setNode(blackboard.platform.institutionalhierarchy.service.Node aNode)

Sets the current node.

Parameters:

aNode - the node

getIsRootNode

public boolean getIsRootNode()

Checks if the current node is the root of the Institutional Hierarchy.

Returns:

true if the current node is the root of the Institutional Hierarchy

getActiveNodes

public java.util.List<blackboard.platform.institutionalhierarchy.service.Node> getActiveNodes()

Gets the list of nodes for which there is at least one setting value.

Returns:

the list of nodes

getActiveNodes

public java.util.List<blackboard.platform.institutionalhierarchy.service.Node> getActiveNodes(java.lang.String settingName)

Gets the list of nodes for which the named setting value exists.

Parameters:

settingName - name of setting to confirm node is active (null for any setting)

Returns:

the list of nodes

getIsActiveNode

public boolean getIsActiveNode()

Checks if the current node has any settings.

Returns:

true if the current node has at least one setting

getIsActiveNode

public boolean getIsActiveNode(java.lang.String settingName)

Checks if the current node has a setting of a specified name.

Parameters:

settingName - name of setting to check for (null for any name)

Returns:

true if the current node has the setting specified

getContext

public blackboard.platform.context.Context getContext()

Gets the current Blackboard context object.

Returns:

the Blackboard context object

setUser

public void setUser(blackboard.data.user.User user)

Sets the current user.

Parameters:

user - The current user

getUser

public blackboard.data.user.User getUser()

Gets the current user.

Returns:

the user

setCourse

public void setCourse(blackboard.data.course.Course course)

Sets the current course.

Parameters:

course - The current course

getCourse

public blackboard.data.course.Course getCourse()

Gets the current course.

Returns:

the course

setGroup

public void setGroup(blackboard.data.course.Group group)

Sets the current group.

Parameters:

group - The current group

getGroup

public blackboard.data.course.Group getGroup()

Gets the current group.

Returns:

the group

setContent

public void setContent(blackboard.data.content.Content content)

Sets the current content.

Parameters:

content - The current content

getContent

public blackboard.data.content.Content getContent()

Gets the current content.

Returns:

the content

setUserId

public void setUserId(blackboard.persist.Id userId)

Sets the current user ID.

Parameters:

userId - the user ID

setUserId

public boolean setUserId(java.lang.String userIdString)

Sets the current user ID.

Parameters:

userIdString - the user ID as a string

Returns:

true if the user ID was set

hasUserContext

public boolean hasUserContext()

Checks if the current context has a User reference.

Returns:

true if a User reference exists

getUserId

public blackboard.persist.Id getUserId()

Gets the current user ID.

Returns:

the user ID

getUserIdAsString

public java.lang.String getUserIdAsString()

Gets the current user ID.

Returns:

the user ID

setCourseId

public void setCourseId(blackboard.persist.Id courseId)

Sets the current course ID.

Parameters:

courseId - the course ID

setCourseId

public boolean setCourseId(java.lang.String courseIdString)

Sets the current course ID.

Parameters:

courseIdString - the course ID as a string

Returns:

true if the course ID was set

hasCourseContext

public boolean hasCourseContext()

Checks if the current context has a Course reference.

Returns:

true if a Course reference exists

getCourseId

public blackboard.persist.Id getCourseId()

Gets the current course ID.

Returns:

the course ID

getCourseIdAsString

public java.lang.String getCourseIdAsString()

Gets the current course ID.

Returns:

the course ID

setGroupId

public void setGroupId(blackboard.persist.Id groupId)

Sets the current group ID.

Parameters:

groupId - the group ID

setGroupId

public boolean setGroupId(java.lang.String groupIdString)

Sets the current group ID.

Parameters:

groupIdString - the group ID as a string

Returns:

true if the group ID was set

hasGroupContext

public boolean hasGroupContext()

Checks if the current context has a Group reference.

Returns:

true if a Group reference exists

getGroupId

public blackboard.persist.Id getGroupId()

Gets the current group ID.

Returns:

the group ID

getGroupIdAsString

public java.lang.String getGroupIdAsString()

Gets the current group ID.

Returns:

the group ID

setContentId

public void setContentId(blackboard.persist.Id contentId)

Sets the current content ID.

Parameters:

contentId - the content ID

setContentId

public boolean setContentId(java.lang.String contentIdString)

Sets the current content ID.

Parameters:

contentIdString - the content ID as a string

Returns:

true if the content ID was set

hasContentContext

public boolean hasContentContext()

Checks if the current context has a Content reference.

Returns:

true if a Content reference exists

getContentId

public blackboard.persist.Id getContentId()

Gets the current content ID.

Returns:

the content ID

getContentIdAsString

public java.lang.String getContentIdAsString()

Gets the current content ID.

Returns:

the content ID

setContext

public void setContext(blackboard.platform.context.Context context)

Deprecated. Replaced by setUser(User), setCourse(Course), setGroup(Group), setContent(Content)

Sets the current Blackboard context object.

Parameters:

context - the context object

getVendorId

public java.lang.String getVendorId()

Gets the vendor ID for the current Building Block.

Returns:

the value of the vendor ID

getHandle

public java.lang.String getHandle()

Gets the handle for the current Building Block.

Returns:

the value of the handle

getSchema

public java.lang.String getSchema()

Gets the schema for the current Learn 9 instance.

Returns:

the value of the schema

getB2Version

public java.lang.String getB2Version()

Gets the version for the current Building Block.

Returns:

the version of the building block

getIsB2Version

public boolean getIsB2Version(int major,
                     int minor,
                     int build)

Checks whether the current Building Block is at a specific version, or later.

For example, to check if the current version of the Building Block is 2.12.5, or later use parameters of 2, 12 and 5.

Parameters:

major - the major release number

minor - the minor release number

build - the build number

Returns:

true if this building block has the specified version number or greater

getServerUrl

public java.lang.String getServerUrl()

Gets the path for the current Building Block.

Returns:

the URL path

getPath

public java.lang.String getPath()

Gets the path for the current Building Block.

Returns:

the URL path

getPath

public java.lang.String getPath(java.lang.String schema)

Gets the path for the current Building Block using a specified schema name.

Parameters:

schema - name of schema to use in path

Returns:

the URL path

getWebappRoot

public java.lang.String getWebappRoot()

Gets the file root for the current Building Block.

Returns:

the file root

getRequestParameter

public java.lang.String getRequestParameter(java.lang.String name,
                                   java.lang.String defaultValue)

Gets a parameter from the current request object.

The default value is returned if no value exists for the specified parameter.

Parameters:

name - the name of the request parameter

defaultValue - the default value

Returns:

the value of the request parameter

getRequestParameter

public java.lang.String getRequestParameter(java.lang.String name,
                                   java.lang.String defaultValue,
                                   boolean unfiltered)

Gets a parameter from the current request object.

The default value is returned if no value exists for the specified parameter.

Parameters:

name - the name of the request parameter

defaultValue - the default value

unfiltered - true if an unfiltered value should be returned

Returns:

the value of the request parameter

getRequestParameterValues

public java.lang.String getRequestParameterValues(java.lang.String name,
                                         java.lang.String defaultValue)

Gets the values for a parameter from a request object.

If more than one value is included in the request for the specified parameter, the values are concatenated into a single string separated by a comma.

The default value is returned if no value exists for the specified parameter.

Parameters:

name - the name of the request parameter

defaultValue - the default value

Returns:

the value of the request parameter

getRequestParameterValues

public java.lang.String getRequestParameterValues(java.lang.String name,
                                         java.lang.String defaultValue,
                                         boolean unfiltered)

Gets the values for a parameter from a request object.

If more than one value is included in the request for the specified parameter, the values are concatenated into a single string separated by a comma.

The default value is returned if no value exists for the specified parameter.

Parameters:

name - the name of the request parameter

defaultValue - the default value

unfiltered - true if unfiltered values should be returned

Returns:

the value of the request parameter

getRequestParameters

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

Gets the values of all parameters from a request object.

If more than one value is included in the request for a parameter, the values are concatenated into a single entry separated by a comma.

Returns:

a map of the request parameters (name=value)

getRequestParameters

public java.util.Map<java.lang.String,java.lang.String> getRequestParameters(boolean unfiltered)

Gets the values of all parameters from a request object.

If more than one value is included in the request for a parameter, the values are concatenated into a single entry separated by a comma.

Parameters:

unfiltered - true if unfiltered values should be returned

Returns:

a map of the request parameters (name=value)

getPlugIn

public blackboard.platform.plugin.PlugIn getPlugIn()

Gets the plugin object for this building block.

Returns:

the plugin object

getResourceString

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

Gets a resource string from the bundle for the current locale.

The resource strings are loaded from the bb-manifest bundle file for the current locale as located in the WEB-INF/bundles directory.

Parameters:

key - the name of the resource string

Returns:

the value of the resource string

getResourceString

public java.lang.String getResourceString(java.lang.String key,
                                 java.lang.String defaultValue)

Gets a resource string from the bundle for the current locale.

The default value is returned if no value exists for the specified key.

The resource strings are loaded from the bb-manifest bundle file for the current locale as located in the WEB-INF/bundles directory.

Parameters:

key - the name of the resource string

defaultValue - the default value

Returns:

the value of the resource string

getResourceStrings

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

Gets all the resource strings from the bundle for the current locale.

The resource strings are loaded from the bb-manifest bundle file for the current locale as located in the WEB-INF/bundles directory.

Returns:

a map containing the key and value of each resource string

getSaveEmptyValues

public boolean getSaveEmptyValues()

Gets the SaveEmptyValues setting.

Returns:

the value of the setting

setSaveEmptyValues

public void setSaveEmptyValues(boolean saveEmptyValues)

Sets the SaveEmptyValues setting.

Parameters:

saveEmptyValues - true (default) if settings with empty values should be saved; false if settings should be deleted if they have no value (empty string)

getIgnoreCourseContext

public boolean getIgnoreCourseContext()

Deprecated.

Gets the IgnoreCourseContext setting.

Returns:

the value of the setting

setIgnoreCourseContext

public void setIgnoreCourseContext(boolean ignoreCourseContext)

Deprecated.

Sets the IgnoreCourseContext setting.

Parameters:

ignoreCourseContext - true if the existence of a course context is to be ignored (default = true)

getIgnoreGroupContext

public boolean getIgnoreGroupContext()

Gets the IgnoreGroupContext setting.

Returns:

the value of the setting

setIgnoreGroupContext

public void setIgnoreGroupContext(boolean ignoreGroupContext)

Sets the IgnoreGroupContext setting.

Parameters:

ignoreGroupContext - true if the existence of a group context is to be ignored (default = true)

getIgnoreContentContext

public boolean getIgnoreContentContext()

Gets the IgnoreContentContext setting.

Returns:

the value of the setting

setIgnoreContentContext

public void setIgnoreContentContext(boolean ignoreContentContext)

Sets the IgnoreContentContext setting.

Parameters:

ignoreContentContext - true if the existence of a content context is to be ignored (default = true)

getSetting

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

Gets a global anonymous configuration setting value.

The global anonymous configuration settings are loaded from a file named vvvv-hhhhhh.properties where vvvv and hhhhhh are the vendor ID and handle for the current Building Block, respectively. This file is located in the Building Block config directory.

Parameters:

key - the name of the setting

Returns:

the value of the setting

getSetting

public java.lang.String getSetting(boolean global,
                          boolean anonymous,
                          java.lang.String key)

Gets a configuration setting value.

Anonymous configuration settings are loaded from a file named vvvv-hhhhhh.properties where vvvv and hhhhhh are the vendor ID and handle for the current Building Block, respectively. Files containing global settings are located in the Building Block config directory. Non-global settings files are located in the content directory (for content-item tools) or the course directory (for course tools).

Non-anonymous settings are retrieved from the Blackboard user registry.

Parameters:

global - true if the setting applies to all instances of the tool

anonymous - true if the setting applies to all users

key - the name of the setting

Returns:

the value of the setting

getSetting

public java.lang.String getSetting(java.lang.String key,
                          java.lang.String defaultValue)

Gets a global anonymous configuration setting value.

The default value is returned if no value exists for the specified key.

The global anonymous configuration settings are loaded from a file named vvvv-hhhhhh.properties where vvvv and hhhhhh are the vendor ID and handle for the current Building Block, respectively. This file is located in the Building Block config directory.

Parameters:

key - the name of the setting

defaultValue - the default value of the setting

Returns:

the value of the setting

getSetting

public java.lang.String getSetting(boolean global,
                          boolean anonymous,
                          java.lang.String key,
                          java.lang.String defaultValue)

Gets a configuration setting value.

The default value is returned if no value exists for the specified key.

Anonymous configuration settings are loaded from a file named vvvv-hhhhhh.properties where vvvv and hhhhhh are the vendor ID and handle for the current Building Block, respectively. Files containing global settings are located in the Building Block config directory. Non-global settings files are located in the content directory (for content-item tools) or the course directory (for course tools).

Non-anonymous settings are retrieved from the Blackboard user registry.

Parameters:

global - true if the setting applies to all instances of the tool

anonymous - true if the setting applies to all users

key - the name of the setting

defaultValue - the default value of the setting

Returns:

the value of the setting

getSetting

public java.lang.String getSetting(boolean global,
                          boolean anonymous,
                          java.lang.String key,
                          java.lang.String defaultValue,
                          blackboard.platform.institutionalhierarchy.service.Node aNode)

Gets a configuration setting value from a specific node.

The default value is returned if no value exists for the specified key.

Anonymous configuration settings are loaded from a file named vvvv-hhhhhh.properties where vvvv and hhhhhh are the vendor ID and handle for the current Building Block, respectively. Files containing global settings are located in the Building Block config directory. Non-global settings files are located in the content directory (for content-item tools) or the course directory (for course tools).

Non-anonymous settings are retrieved from the Blackboard user registry.

Parameters:

global - true if the setting applies to all instances of the tool

anonymous - true if the setting applies to all users

key - the name of the setting

defaultValue - the default value of the setting

aNode - the node to get the setting value from

Returns:

the value of the setting

getSettings

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

Gets a list of all global anonymous configuration settings.

The global anonymous configuration settings are loaded from a file named vvvv-hhhhhh.properties where vvvv and hhhhhh are the vendor ID and handle for the current Building Block, respectively. This file is located in the Building Block config directory.

Returns:

a map containing the settings found

getSettings

public java.util.Map<java.lang.String,java.lang.String> getSettings(boolean global,
                                                           boolean anonymous)

Gets a list of all configuration settings.

Anonymous configuration settings are loaded from a file named vvvv-hhhhhh.properties where vvvv and hhhhhh are the vendor ID and handle for the current Building Block, respectively. Files containing global settings are located in the Building Block config directory. Non-global settings files are located in the content directory (for content-item tools) or the course directory (for course tools).

Non-anonymous settings are retrieved from the Blackboard user registry.

Parameters:

global - true if the setting applies to all instances of the tool

anonymous - true if the setting applies to all users

Returns:

a map containing the settings found

getSettings

public java.util.Map<java.lang.String,java.lang.String> getSettings(boolean global,
                                                           boolean anonymous,
                                                           boolean nodeOnly)

Gets a list of all configuration settings.

Anonymous configuration settings are loaded from a file named vvvv-hhhhhh.properties where vvvv and hhhhhh are the vendor ID and handle for the current Building Block, respectively. Files containing global settings are located in the Building Block config directory. Non-global settings files are located in the content directory (for content-item tools) or the course directory (for course tools).

Non-anonymous settings are retrieved from the Blackboard user registry.

Parameters:

global - true if the setting applies to all instances of the tool

anonymous - true if the setting applies to all users

nodeOnly - true if only settings specified at the current node level should be returned

Returns:

a map containing the settings found

getSettings

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

Gets a list of all global anonymous configuration settings.

The global anonymous configuration settings are loaded from a file named vvvv-hhhhhh-x.properties where vvvv and hhhhhh are the vendor ID and handle for the current Building Block, respectively, and x is the specified suffix. This file is located in the Building Block config directory.

Parameters:

fileSuffix - suffix of the settings file name

Returns:

a map containing the settings found

getSettings

public java.util.Map<java.lang.String,java.lang.String> getSettings(boolean global,
                                                           boolean anonymous,
                                                           java.lang.String fileSuffix)

Gets a list of all configuration settings.

Anonymous configuration settings are loaded from a file named vvvv-hhhhhh.properties where vvvv and hhhhhh are the vendor ID and handle for the current Building Block, respectively. Files containing global settings are located in the Building Block config directory. Non-global settings files are located in the content directory (for content-item tools) or the course directory (for course tools).

Non-anonymous settings are retrieved from the Blackboard user registry.

Parameters:

global - true if the setting applies to all instances of the tool

anonymous - true if the setting applies to all users

fileSuffix - suffix of the settings file name

Returns:

a map containing the settings found

getSettings

public java.util.Map<java.lang.String,java.lang.String> getSettings(boolean global,
                                                           boolean anonymous,
                                                           java.lang.String fileSuffix,
                                                           boolean nodeOnly)

Gets a list of all configuration settings.

Anonymous configuration settings are loaded from a file named vvvv-hhhhhh.properties where vvvv and hhhhhh are the vendor ID and handle for the current Building Block, respectively. Files containing global settings are located in the Building Block config directory. Non-global settings files are located in the content directory (for content-item tools) or the course directory (for course tools).

Non-anonymous settings are retrieved from the Blackboard user registry.

Parameters:

global - true if the setting applies to all instances of the tool

anonymous - true if the setting applies to all users

fileSuffix - suffix of the settings file name

nodeOnly - true if only settings specified at the current node level should be returned

Returns:

a map containing the settings found

setSetting

public void setSetting(java.lang.String key,
              java.lang.String value)

Adds a global anonymous configuration setting value.

If no value exists for the setting then it is added, otherwise the existing entry is updated. Null values are ignored and any existing entry for the setting is deleted.

Note: this only saves the setting value in memory; use the persistSettings() method to permanently save the values.

Parameters:

key - the name of the setting

value - the value of the setting

setSetting

public void setSetting(boolean global,
              boolean anonymous,
              java.lang.String key,
              java.lang.String value)

Adds a configuration setting value.

If no value exists for the setting then it is added, otherwise the existing entry is updated. Null values are ignored and any existing entry for the setting is deleted.

Note: this only saves the setting value in memory; use the persistSettings() method to permanently save the values.

Parameters:

global - true if the setting applies to all instances of the tool

anonymous - true if the setting applies to all users

key - the name of the setting

value - the value of the setting

clearSettings

public void clearSettings()

Deletes all global anonymous configuration settings.

Note: this only clears the setting values in memory; use the persistSettings() method to permanently delete the values.

clearSettings

public void clearSettings(boolean global,
                 boolean anonymous,
                 java.lang.String suffix)

Deletes all configuration settings.

Note: this only clears the setting values in memory; use the persistSettings() method to permanently delete the values.

Parameters:

global - true if the setting applies to all instances of the tool

anonymous - true if the setting applies to all users

suffix -

persistSettings

public void persistSettings()

Permanently saves the current global anonymous configuration setting values.

The global anonymous configuration settings are loaded from a file named vvvv-hhhhhh.properties where vvvv and hhhhhh are the vendor ID and handle for the current Building Block, respectively. This file is located in the Building Block config directory.

persistSettings

public void persistSettings(boolean global,
                   boolean anonymous)

Permanently saves the current configuration setting values.

Anonymous configuration settings are loaded from a file named vvvv-hhhhhh.properties where vvvv and hhhhhh are the vendor ID and handle for the current Building Block, respectively. Files containing global settings are located in the Building Block config directory. Non-global settings files are located in the content directory (for content-item tools) or the course directory (for course tools).

Non-anonymous settings are saved to the Blackboard user registry.

Parameters:

global - true if the setting applies to all instances of the tool

anonymous - true if the setting applies to all users

persistSettings

public void persistSettings(boolean global,
                   boolean anonymous,
                   java.util.Properties properties)

Permanently saves a set of setting values.

Anonymous configuration settings are loaded from a file named vvvv-hhhhhh.properties where vvvv and hhhhhh are the vendor ID and handle for the current Building Block, respectively. Files containing global settings are located in the Building Block config directory. Non-global settings files are located in the content directory (for content-item tools) or the course directory (for course tools).

Non-anonymous settings are saved to the Blackboard user registry.

Parameters:

global - true if the setting applies to all instances of the tool

anonymous - true if the setting applies to all users

properties - a properties object containing the settings to be saved

persistSettings

public void persistSettings(java.lang.String suffix,
                   java.util.Map<java.lang.String,java.lang.String> settings)

Permanently saves the global anonymous configuration setting values.

Parameters:

suffix - suffix of the settings file name

settings - Map containing the settings to save

persistSettings

public void persistSettings(boolean global,
                   boolean anonymous,
                   java.lang.String suffix,
                   java.util.Map<java.lang.String,java.lang.String> settings)

Permanently saves the current configuration setting values.

Anonymous configuration settings are loaded from a file named vvvv-hhhhhh.properties where vvvv and hhhhhh are the vendor ID and handle for the current Building Block, respectively. Files containing global settings are located in the Building Block config directory. Non-global settings files are located in the content directory (for content-item tools) or the course directory (for course tools).

Non-anonymous settings are saved to the Blackboard user registry.

Parameters:

global - true if the setting applies to all instances of the tool

anonymous - true if the setting applies to all users

suffix - suffix for the settings set

settings - Map containing the settings to save

getNavigationItem

public blackboard.data.navigation.NavigationItem getNavigationItem(java.lang.String name)

Gets a named navigation item.

Parameters:

name - name of navigation item

Returns:

navigation item

setReceipt

public void setReceipt(java.lang.String message)

Sets a success receipt option.

Parameters:

message - message to be displayed

setReceipt

public void setReceipt(java.lang.String message,
              boolean isSuccess)

Sets a success or error receipt option.

Parameters:

message - message to be displayed

isSuccess - true if this is a success receipt

setReceipt

public void setReceipt(java.lang.String message,
              java.lang.Exception exception)

Sets a warning receipt option.

Parameters:

message - message to be displayed

exception - error exception or null for a success receipt

setReceiptOptions

public void setReceiptOptions(java.lang.String success,
                     java.lang.String error)

Set receipts in session.

Parameters:

success - success message to be displayed

error - error message to be displayed

addReceiptOptionsToRequest

public void addReceiptOptionsToRequest(java.lang.String success,
                              java.lang.String warning,
                              java.lang.String error)

Add receipts in current request.

Parameters:

success - success message to be displayed

warning - warning message to be displayed

error - error message to be displayed

setReceiptOptions

public java.lang.String setReceiptOptions(java.lang.String url,
                                 java.lang.String success,
                                 java.lang.String error)

Set receipts to a URL.

Parameters:

url - URL

success - success message to be displayed

error - error message to be displayed

Returns:

URL with receipt parameters

getEditMode

public static boolean getEditMode()

Gets the current status of edit mode (Learn 9.1+).

Returns:

false if edit mode is off or Learn 9.0, otherwise true

processCourseCopy

public static void processCourseCopy(blackboard.platform.cx.component.CopyControl copyControl)

Processes changes arising from a course copy. This method should be called from within the blackboard.platform.cx.component.CxComponent.doCopy method.

Parameters:

copyControl - the CopyControl object for the course copy in progress

processCourseExport

public static java.util.Map<java.lang.String,java.lang.String> processCourseExport(blackboard.platform.cx.component.ExportControl exportControl)

Processes changes arising from a course export/archive. This method should be called from within the blackboard.platform.cx.component.CxComponent.doExport method.

Parameters:

exportControl - the ExportControl object for the course export/archive in progress

Returns:

a Map of any settings to be added

processCourseImport

public static void processCourseImport(blackboard.platform.cx.component.ImportControl importControl,
                       java.util.Properties props)

Processes changes arising from a course export/archive. This method should be called from within the blackboard.platform.cx.component.CxComponent.doExport method.

Parameters:

importControl - the ImportControl object for the course import in progress

props - the properties saved during the export of the file being imported

getVersionNumber

public static java.lang.String getVersionNumber(java.lang.String defaultValue)

Gets the Blackboard version number.

Parameters:

defaultValue - the default value to return when unable to access version number

Returns:

version number as a string (e.g. 9.1.90132)

getVersionNumber

public static int[] getVersionNumber()

Gets the Blackboard version number as an array of its elements.

The third element is split into two to separate the service pack from the build number.

Returns:

version number separated into its 4 integer elements (e.g. 9, 1, 9, 132)

getIsVersion

public static boolean getIsVersion(int major,
                   int minor,
                   int servicePack)

Checks whether the Blackboard is at a specific release, or later.

For example, to check if the current version of Blackboard is 9.1 SP10, or later use parameters of 9, 1 and 10. For the Q4 2017 CU1 release (or later) use parameters of 3300, 0 and 1.

Parameters:

major - the major release number

minor - the minor release number

servicePack - the service pack number

Returns:

true if the Blackboard release has the specified version number or greater

getLogDebug

public static boolean getLogDebug()

Gets the debug level for the logger.

Returns:

boolean true if information messages are to be logged as well as errors

setLogDebug

public static void setLogDebug(boolean logDebugSetting)

Sets the debug level for the logger.

Parameters:

logDebugSetting - true if information messages are to be logged as well as errors

log

public static void log(java.lang.String message)

Sends an error message to the logs/bb-services-log.txt file.

Parameters:

message - error to be logged

log

public static void log(boolean isError,
       java.lang.String prefix,
       java.lang.Object obj)

Sends an object to the logs/bb-services-log.txt file.

Parameters:

isError - true if the message being logged is an error; false if it is just for information

prefix - prefix to log before object

obj - object to be logged

log

public static void log(boolean isError,
       java.lang.String message)

Sends a log message to the logs/bb-services-log.txt file.

Parameters:

isError - true if the message being logged is an error; false if it is just for information

message - string to be logged