blackboard.platform.integration.provider
Interface ContentSystemProvider

All Superinterfaces:
IntegrationProvider
All Known Implementing Classes:
AbstractContentSystemProvider

public interface ContentSystemProvider
extends IntegrationProvider

Provides Content System support to external LMSs

Implementation of this provider is optional.

Since:
Bb 7.3

Nested Class Summary
static class ContentSystemProvider.ContentSystemItem
           
 
Nested classes/interfaces inherited from interface blackboard.platform.integration.provider.IntegrationProvider
IntegrationProvider.ProviderType
 
Method Summary
 HttpPost getContentSystemCallbackUrl(ContentSystemProvider.ContentSystemItem item, java.lang.String extraInfo)
          Returns a callback URL which Content System can use to notify the LMS of the file selected by the user.
 void updateContentSystemAvailability(boolean availability)
          Notifies the external LMS whether Content System is currently available or not.
 
Methods inherited from interface blackboard.platform.integration.provider.IntegrationProvider
initializeProvider
 

Method Detail

updateContentSystemAvailability

void updateContentSystemAvailability(boolean availability)
Notifies the external LMS whether Content System is currently available or not.

Parameters:
availability - True if CS is available, false otherwise.

getContentSystemCallbackUrl

HttpPost getContentSystemCallbackUrl(ContentSystemProvider.ContentSystemItem item,
                                     java.lang.String extraInfo)
                                     throws IntegrationException
Returns a callback URL which Content System can use to notify the LMS of the file selected by the user. The URL should accept both POST and GET requests. This URL will be triggered when the user clicks 'Submit' within the Content System popup. The LMS will be expected to direct the browser to a reasonable target location afterwards.

This is an optional method. If the LMS does not expose an embedded version of Content System, it will not be called.

Note also that there are legacy hooks from Bb 9.0 that allowed the LMS to expose a JavaScript function named CSAddCallBack in the parent frame. This code has not been removed, but should be considered deprecated because it depends on cross-site scripting, which violates most browser's security models.

Parameters:
item - Selected item.
extraInfo - (optional) Information passed from the LMS in the 'extraInfo' parameter when loading the cs-file-browser URL. This allows the LMS to provide context information, such as the target folder to store the item in.
Throws:
IntegrationException - if an error occurs


Copyright © 2012 Blackboard, Inc. All Rights Reserved.