<?xml version="1.0" encoding="ISO-8859-1"?>
<manifest>
  <!-- core extension information -->
  <plugin>
    <name value="Sample Learning Environment Connector" />
    <handle value="sample-ext-plgnhndl" />
    <description value="This plugin provides a Sample Learning Environment Connector" />
    <webapp-type value="javaext" />
    <version value="1.0.0.1" />
    <requires>
      <bbversion value="9.0.0" />
    </requires>
    <vendor>
      <id value="bb" />
      <name value="Blackboard, Inc." />
      <url value="http://www.blackboard.com/" />
      <description value="Blackboard Engineering" />
    </vendor>

    <!-- Extension implementations -->
    <module-defs>
      <definition namespace="blackboard.platform.integration">
        <extension id="sampleIntegrationExtension"
          point="blackboard.platform.integration.integrationExtension"
          class="blackboard.platform.integration.extension.sample.SampleIntegrationExtension"
          singleton="true" />
        <extension id="sampleAuthenticationProvider"
          point="blackboard.platform.integration.authenticationProvider"
          class="blackboard.platform.integration.extension.sample.SampleAuthenticationProvider"
          singleton="false" />
        <extension id="sampleNavigationProvider"
          point="blackboard.platform.integration.navigationProvider"
          class="blackboard.platform.integration.extension.sample.SampleNavigationProvider"
          singleton="false" />
        <extension id="samplePortletProvider"
          point="blackboard.platform.integration.portletProvider"
          class="blackboard.platform.integration.extension.sample.SamplePortletProvider"
          singleton="false" />
        <extension id="sampleSupportProvider"
          point="blackboard.platform.integration.supportProvider"
          class="blackboard.platform.integration.extension.sample.SampleSupportProvider"
          singleton="false" />
      </definition>
    </module-defs>

    <!-- code permissions required for proper operation -->
    <permissions>
      <permission type="runtime" name="getClassLoader" />
      <permission type="runtime" name="createClassLoader" />
      <permission type="java.lang.reflect.ReflectPermission" name="suppressAccessChecks" />
      <permission type="java.net.SocketPermission" name="*" actions="connect,resolve,listen" />
      <permission type="java.io.FilePermission" name="&lt;&lt;ALL FILES&gt;&gt;" actions="read" />
    </permissions>
  </plugin>
</manifest>

package blackboard.platform.integration.extension.sample;

import blackboard.platform.integration.extension.AbstractIntegrationExtension;
import blackboard.platform.integration.provider.IntegrationProvider.ProviderType;

import java.util.HashSet;
import java.util.Set;

public class SampleIntegrationExtension extends AbstractIntegrationExtension
{
  private static final Set<String> CONNECTOR_TYPES;
  static
  {
    CONNECTOR_TYPES = new HashSet<String>();
    CONNECTOR_TYPES.add( "SAMPLE" );
  }

  @Override
  public String getProviderId( ProviderType providerType )
  {
    switch ( providerType )
    {
      case Authentication:
        return "sampleAuthenticationProvider";
      case Navigation:
        return "sampleNavigationProvider";
      case Portlet:
        return "samplePortletProvider";
      case Support:
        return "sampleSupportProvider";
      case Announcement:
      case ContentSystem:
      case Migration:
        return null;
    }
    return super.getProviderId( providerType );
  }

  @Override
  public Set<String> getConnectorTypes()
  {
    return CONNECTOR_TYPES;
  }

  /**
   * {@inheritDoc}
   */
  @Override
  public String getConnectorName( String connectorType )
  {
    return "Sample Connector";

  }

  /**
   * {@inheritDoc}
   */
  public Version getVersion()
  {
    return Version.Version1;
  }

  /**
   * {@inheritDoc}
   */
  public void flushConnectorCache()
  {
  }
}

package blackboard.platform.integration.extension.sample;

import blackboard.platform.integration.extension.AbstractSupportProvider;
import blackboard.platform.integration.provider.SupportProvider;

public class SampleSupportProvider extends AbstractSupportProvider implements SupportProvider
{
  @Override
  public boolean isFeatureSupported( Feature feature )
  {
    return false;
  }
}

package blackboard.platform.integration.extension.sample;

import blackboard.persist.Id;
import blackboard.platform.integration.PasswordChangeForcedException;
import blackboard.platform.integration.PasswordChangeRequiredException;
import blackboard.platform.integration.extension.AbstractAuthenticationProvider;
import blackboard.platform.integration.provider.AuthenticationProvider;

import java.util.Set;

import javax.servlet.http.Cookie;

public class SampleAuthenticationProvider extends AbstractAuthenticationProvider implements AuthenticationProvider
{
  @Override
  public boolean login( Id userId, String password )
    throws PasswordChangeRequiredException, PasswordChangeForcedException
  {
    return false;
  }

  @Override
  public void logout( Id userId )
  {
  }

  @Override
  public Set<Cookie> getCookies( Id userId )
  {
    return null;
  }

  @Override
  public void setCookies( Id userId, Set<Cookie> cookies )
  {
  }

  @Override
  public String getSharedCookieDomain( Id userId )
  {
    return null;
  }

  @Override
  public Set<Id> checkActivity( Set<Id> userIds )
  {
    return null;
  }

  @Override
  public void flushCachedCredentials( Id userId )
  {
  }
}

/*
 * (C) Copyright Blackboard Inc. 1998-2007 - All Rights Reserved
 *
 * Permission to use, copy, modify, and distribute this software without prior explicit
 * written approval is strictly prohibited. Please refer to the
 * file "copyright.html" for further important copyright and licensing information.
 *
 * BLACKBOARD MAKES NO REPRESENTATIONS OR WARRANTIES ABOUT THE SUITABILITY OF THE SOFTWARE,
 * EITHER EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO
 * THE IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, OR NON- INFRINGEMENT.
 * BLACKBOARD SHALL NOT BE LIABLE FOR ANY DAMAGES
 * SUFFERED BY LICENSEE AS A RESULT OF USING, MODIFYING OR DISTRIBUTING THIS SOFTWARE OR ITS DERIVATIVES.
 */
package blackboard.platform.integration.extension.sample;

import blackboard.platform.integration.CourseLmsIntegration;
import blackboard.platform.integration.UserLmsIntegration;
import blackboard.platform.integration.extension.AbstractNavigationProvider;
import blackboard.platform.integration.provider.NavigationProvider;

public class SampleNavigationProvider extends AbstractNavigationProvider implements NavigationProvider
{
  @Override
  public String getCourseHome( CourseLmsIntegration courseLmsInt, String returnUrl )
  {
    return "";
  }

  @Override
  public String getAdminCourseEdit( CourseLmsIntegration courseLmsInt, String returnUrl )
  {
    return "";
  }

  @Override
  public String getAdminCourseAdd( String returnUrl )
  {
    return "";
  }

  @Override
  public String getAdminCourseEnrollment( CourseLmsIntegration courseLmsInt, String returnUrl )
  {
    return "";
  }

  @Override
  public String getUserChangePassword( UserLmsIntegration userLmsInt, String returnUrl )
  {
    return "";
  }

  @Override
  public String getUserChangeExpiredPassword( UserLmsIntegration userLmsInt, String returnUrl )
  {
    return "";
  }

  @Override
  public String getUserForcedChangePassword( UserLmsIntegration userLmsInt, String returnUrl )
  {
    return "";
  }

  @Override
  public String getAdminUserAdd( String returnUrl )
  {
    return "";
  }

  @Override
  public String getAdminUserEdit( UserLmsIntegration userLmsInt, String returnUrl )
  {
    return "";
  }

  @Override
  public String getUserEditPersonalInformation( UserLmsIntegration userLmsInt, String returnUrl )
  {
    return "";
  }

  @Override
  public String getUserViewCourseGrades( CourseLmsIntegration courseLmsInt, String returnUrl )
  {
    return "";
  }

  @Override
  public String getUserForgotPassword( UserLmsIntegration userLmsInt )
  {
    return "";
  }

  @Override
  public String getUserPortfolio( UserLmsIntegration userLmsInt, String portfolioLcId )
  {
    return "";
  }

  @Override
  public String rewriteUrl( String preexistingUrl )
  {
    return "";
  }
}

package blackboard.platform.integration.extension.sample;

import blackboard.platform.integration.extension.AbstractPortletProvider;
import blackboard.platform.integration.portlet.IntegratedModuleCacheData;
import blackboard.platform.integration.portlet.PortletDataElement;
import blackboard.platform.integration.provider.PortletProvider;

import java.util.*;

public class SamplePortletProvider extends AbstractPortletProvider implements PortletProvider
{
  @Override
  public Set<PortletType> getSupportedPortletTypes()
  {
    Set<PortletType> result = new HashSet<PortletType>();
    return result;
  }

  @Override
  public List<PortletDataElement> getPortalData( PortletType portletType, Map<String, IntegratedModuleCacheData> cache )
  {
    return new ArrayList<PortletDataElement>();
  }
}

public class SampleAuthenticationProvider extends AbstractAuthenticationProvider implements AuthenticationProvider
{
  @Override
  public boolean login( Id userId, String password )
    throws PasswordChangeRequiredException, PasswordChangeForcedException
  {
    String ssoSettings = getIntegrationContext().getLmsIntegration().getSsoSettings();
    String authSettings = getIntegrationContext().getLmsIntegration().getAuthSettings();

    ...

    return false;
  }

package blackboard.platform.integration.extension.sample;

import blackboard.platform.integration.service.IntegrationContext;

import java.util.*;

public class SampleSettingsHelper
{
  public static String getSsoSetting( IntegrationContext integrationContext, String settingKey )
  {
    Map<String, String> settings = parseSettingsText( integrationContext.getLmsIntegration().getSsoSettings() );
    return settings.get( settingKey );
  }

  public static String getAuthSetting( IntegrationContext integrationContext, String settingKey )
  {
    Map<String, String> settings = parseSettingsText( integrationContext.getLmsIntegration().getAuthSettings() );
    return settings.get( settingKey );
  }

  static Map<String, String> parseSettingsText( String settingsText )
  {
    Map<String, String> properties = new HashMap<String, String>();

    String[] parameters = settingsText.split( "\\s*;\\s*" );
    if ( null != parameters )
    {
      for ( String parameter : parameters )
      {
        if ( null == parameter )
          continue;

        parameter = parameter.trim();
        if ( parameter.length() == 0 )
          continue;

        String[] parts = parameter.split( "\\s*=\\s*", 2 );
        if ( null == parts || parts.length != 2 )
          continue;

        properties.put( parts[ 0 ], parts[ 1 ] );
      }
    }

    return properties;
  }
}

<properties>
  <integrationId>foo</integrationId>
</properties>

<person recstatus="1">
  <sourcedid>
    <source>vendorA</source>
    <id>user_uid</id>
  </sourcedid>
  <userid>username</userid>
  <name>
    <n>
      <family>last name</family>
      <given>first name</given>
    </n>
  </name>
  <extension>
    <x_bb_password>Uw.xDeUgDOwgo</x_bb_password>
  </extension>
</person>

<group recstatus="1">
  <sourcedid>
    <source>vendorB</source>
    <id>course_uid</id>
  </sourcedid>
  <description>
    <short>course id</short>
    <long>course title</long>
    <full>course description</full>
  </description>
</group>

<membership>
  <sourcedid>
    <source>vendorB</source>
    <id>course_uid</id>
  </sourcedid>
  <member>
    <sourcedid>
      <source>vendorA</source>
      <id>user_uid</id>
    </sourcedid>
    <role roletype="01" recstatus="1"/>
  </member>
</membership>

<?xml version="1.0" encoding="UTF-8" ?>
<enterprise>
  <properties>
    <integrationId>SampleIntegration</integrationId>
  </properties>
  <person>
    <sourcedid>
      <source>vendorA</source>
      <id>user_uid</id>
    </sourcedid>
    <userid>username</userid>
    <name>
      <n>
        <family>last name</family>
        <given>first name</given>
      </n>
    </name>
  </person>
  <group>
    <sourcedid>
      <source>vendorB</source>
      <id>course_uid</id>
    </sourcedid>
    <description>
      <short>courseid</short>
      <long>course title</long>
      <full>course description</full>
    </description>
  </group>
  <membership>
    <sourcedid>
      <source>vendorB</source>
      <id>course_uid</id>
    </sourcedid>
    <member>
      <sourcedid>
        <source>vendorA</source>
        <id>user_uid</id>
      </sourcedid>
      <role roletype="01"/>
    </member>
  </membership>
</enterprise>

public class SampleAuthenticationProvider extends AbstractAuthenticationProvider implements AuthenticationProvider
{
  @Override
  public boolean login( Id userId, String password )
    throws PasswordChangeRequiredException, PasswordChangeForcedException
  {
    String lmsUserName = getIntegrationContext().getUserIntegration( userId ).getLmsUsername();

    // Simple hack to allow testing with the demo user
    if ( "username".equals( lmsUserName ) )
    {
      if ( "password".equals(password))
        return true;
      else if ( "changeRequired".equals(password))
        throw new PasswordChangeRequiredException( "Password has expired." );
      else if ( "changeForced".equals(password))
        throw new PasswordChangeForcedException( "Password must be changed on first login." );
      else
        return false;
    }

    //
    // You will need to provide a real method to contact the LMS here.  The following
    // is an example of how a fictional LMS might perform this action.
    //
    // Note: When implementing the real version, security concerns must be taken into account.
    //

    // Send a request to the LMS's authenticateUser SDK method, with the username and password
    // to validate.  The LMS will return a string indicating that the password was valid,
    // was valid and has expired, or was invalid.

    NameValuePair[] parameters = { new NameValuePair( "username", lmsUserName ),
                                   new NameValuePair( "password", password ) };
    try
    {
      String response = sendSecureRequest( "sdk/authenticateUser", parameters );
      if ( "true".equalsIgnoreCase( response ) )
        return true;
      else if ( "PasswordChangeRequired".equalsIgnoreCase( response ) )
        throw new PasswordChangeRequiredException( "Password has expired." );
      else if ( "PasswordChangeForced".equalsIgnoreCase( response ) )
        throw new PasswordChangeForcedException( "Password must be changed on first login." );
      else
        return false;
    }
    catch ( IOException e )
    {
      LogServiceFactory.getInstance().logError( "Unexpected exception", e );
      return false;
    }
  }

  @Override
  public void logout( Id userId )
  {
    String lmsUserName = getIntegrationContext().getUserIntegration( userId ).getLmsUsername();

    // Simple hack to allow testing with the demo user
    if ( "username".equals( lmsUserName ) )
    {
      return;
    }

    //
    // You will need to provide a real method to contact the LMS here.  The following
    // is an example of how a fictional LMS might perform this action.
    //
    // Note: When implementing the real version, security concerns must be taken into account.
    //

    // Send a request to the LMS's logoutUser SDK method, with the username of the user
    // to log out.  In this example, a shared secret is also being sent to prove that
    // this server is allowed to terminate the user's session.

    String sharedSecret = SampleSettingsHelper.getAuthSetting( getIntegrationContext(), "sharedSecret" );
    NameValuePair[] parameters = { new NameValuePair( "username", lmsUserName ),
                                   new NameValuePair( "sharedSecret", sharedSecret ) };
    try
    {
      sendSecureRequest( "sdk/logoutUser", parameters );
    }
    catch ( IOException e )
    {
      LogServiceFactory.getInstance().logError( "Unexpected exception", e );
    }
  }

  @Override
  public Set<Cookie> getCookies( Id userId )
  {
    String lmsUserName = getIntegrationContext().getUserIntegration( userId ).getLmsUsername();
    Set<Cookie> cookieList = new HashSet<Cookie>();

    // Simple hack to allow testing with the demo user
    if ( "username".equals( lmsUserName ) )
    {
      return cookieList;
    }

    //
    // You will need to provide a real method to contact the LMS here.  The following
    // is an example of how a fictional LMS might perform this action.
    //
    // Note: When implementing the real version, security concerns must be taken into account.
    //

    // Send a request to the LMS's getUserCookie SDK method, with the username of the
    // to get the cookie for, along with a shared secret to prove that this server is
    // allowed to request the user's cookie.  The LMS will return a specially encoded
    // string which we can transform into a cookie on our end.
    //
    // An alternate way to perform this action would be to have the LMS include the
    // user's cookie in the response headers.  This is how the Vista Connector is
    // implemented.

    String sharedSecret = SampleSettingsHelper.getAuthSetting( getIntegrationContext(), "sharedSecret" );
    String cookieDomain = SampleSettingsHelper.getAuthSetting( getIntegrationContext(), "cookieDomain" );

    NameValuePair[] parameters = { new NameValuePair( "username", lmsUserName ),
                                   new NameValuePair( "sharedSecret", sharedSecret ) };
    try
    {
      String cookieString = sendSecureRequest( "sdk/getUserCookie", parameters );
      Map<String, String> cookieParts = SampleSettingsHelper.parseSettingsText( cookieString );

      Cookie cookie = new Cookie( cookieParts.get( "key" ), cookieParts.get( "value" ) );
      cookie.setDomain( cookieDomain );
      cookie.setMaxAge( -1 );
      cookie.setPath( "/" );
      cookieList.add( cookie );
    }
    catch ( IOException e )
    {
      LogServiceFactory.getInstance().logError( "Unexpected exception", e );
    }

    // TODO - cache cookies internally so that we don't have to contact the LMS repeatedly

    return cookieList;
  }

  @Override
  public void setCookies( Id userId, Set<Cookie> cookies )
  {
    // TODO - cache cookies internally, and update the cache here
  }

  @Override
  public String getSharedCookieDomain( Id userId )
  {
    return SampleSettingsHelper.getAuthSetting( getIntegrationContext(), "cookieDomain" );
  }

  @Override
  public Set<Id> checkActivity( Set<Id> userIds )
  {
    // TODO - check for activity on remote LMS
    return null;
  }

  @Override
  public void flushCachedCredentials( Id userId )
  {
    // TODO - cache cookies internally, and flush the cache here
  }

  /**
   * Sends an https request to the remote LMS, and returns the LMS's response as a string.
   */
  private String sendSecureRequest( String targetUrl, NameValuePair[] parameters ) throws IOException
  {
    String lmsHostname = SampleSettingsHelper.getAuthSetting( getIntegrationContext(), "lmsHostname" );
    PostMethod httpPost = new PostMethod( "https://" + lmsHostname + "/" + targetUrl );
    httpPost.setRequestBody( parameters );

    try
    {
      int statusCode = new HttpClient().executeMethod( httpPost );
      if ( statusCode != HttpStatus.SC_OK )
      {
        LogServiceFactory.getInstance().logError( "Request failed: statusCode=" + statusCode );
        return null;
      }

      return httpPost.getResponseBodyAsString();
    }
    finally
    {
      httpPost.releaseConnection();
    }
  }
}

public class SampleNavigationProvider extends AbstractNavigationProvider implements NavigationProvider
{
  @Override
  public String getCourseHome( CourseLmsIntegration courseLmsInt, String returnUrl )
  {
    String target = "courseHome for course imsId=" + courseLmsInt.getSourcedidId() + "; imsSource="
                    + courseLmsInt.getSourcedidSource() + "; returnUrl=" + returnUrl;
    return "http://www.google.ca/search?q=" + UrlUtil.encodeUrl( target );
  }

  @Override
  public String getUserForgotPassword( UserLmsIntegration userLmsInt )
  {
    String target = "userForgotPassword for lmsUserName=" + userLmsInt.getLmsUsername();
    return "http://www.google.ca/search?q=" + UrlUtil.encodeUrl( target );
  }

  @Override
  public String getUserViewCourseGrades( CourseLmsIntegration courseLmsInt, String returnUrl )
  {
    String target = "userViewCourseGrades for course imsId=" + courseLmsInt.getSourcedidId() + "; imsSource="
                    + courseLmsInt.getSourcedidSource() + "; returnUrl=" + returnUrl;
    return "http://www.google.ca/search?q=" + UrlUtil.encodeUrl( target );
  }

  @Override
  public String rewriteUrl( String preexistingUrl )
  {
    return preexistingUrl;
  }
}

package blackboard.platform.integration.extension.sample;

import blackboard.platform.integration.extension.AbstractPortletProvider;
import blackboard.platform.integration.portlet.IntegratedModuleCacheData;
import blackboard.platform.integration.portlet.PortletDataElement;
import blackboard.platform.integration.provider.PortletProvider;

import java.util.*;

public class SamplePortletProvider extends AbstractPortletProvider implements PortletProvider
{
  @Override
  public Set<PortletType> getSupportedPortletTypes()
  {
    Set<PortletType> result = new HashSet<PortletType>();
    result.add( PortletType.CourseList );
    result.add( PortletType.MySettings );
    return result;
  }

  @Override
  public List<PortletDataElement> getPortalData( PortletType portletType, Map<String, IntegratedModuleCacheData> cache )
  {
    switch ( portletType )
    {
      case CourseList:
        return getCourseList();
      case MySettings:
        return getMySettings();
      default:
        return new ArrayList<PortletDataElement>();
    }
  }

  private List<PortletDataElement> getCourseList()
  {
    List<PortletDataElement> result = new ArrayList<PortletDataElement>();

    //
    // If information from the LMS is needed to build this module,
    // this is where you would load that information
    //

    PortletDataElement course1 = new PortletDataElement();
    course1.setDisplayText( "Course 1 (unavailable)" );
    result.add( course1 );

    PortletDataElement course2 = new PortletDataElement();
    course2.setDisplayText( "Course 2" );
    course2.setLinkUrl( "http://www.google.ca/search?q=course2" );
    course2.setLinkText( "link to course2" );
    result.add( course2 );

    return result;
  }

  private List<PortletDataElement> getMySettings()
  {
    List<PortletDataElement> result = new ArrayList<PortletDataElement>();

    //
    // If information from the LMS is needed to build this module,
    // this is where you would load that information
    //

    PortletDataElement setting1 = new PortletDataElement();
    setting1.setDisplayText( "Setting 1" );
    setting1.setLinkText( "Setting 1" );
    setting1.setLinkUrl( "http://www.google.ca/search?q=setting1" );
    result.add( setting1 );

    PortletDataElement setting2 = new PortletDataElement();
    setting2.setDisplayText( "Setting 2" );
    setting2.setLinkText( "Setting 2" );
    setting2.setLinkUrl( "http://www.google.ca/search?q=setting2" );
    result.add( setting2 );

    return result;
  }
}

<RESPONSE>
  <STATUS>
    Success
  </STATUS>
</RESPONSE>

<RESPONSE>
  <STATUS>
    Error
  </STATUS>
  <ERRORLIST>
    <ERROR>
      Exception.
    </ERROR>
    <PERSON>
      <SOURCE>
        user source
      </SOURCE>
      <ID>
        user unique id
      </ID>
      <ERROR>
        failure
      </ERROR>
    </PERSON>
    <GROUP>
      <SOURCE>
        group source
      </SOURCE>
      <ID>
        group unique id
      </ID>
      <ERROR>
        failure
      </ERROR>
    </GROUP>
    <ENROLLMENT>
      <GROUP_SOURCE_ID>
        group unique id
      </GROUP_SOURCE_ID>
      <PERSON_SOURCE_ID>
        user unique id
      </PERSON_SOURCE_ID>
      <ERROR>
        failure
      </ERROR>
    </ENROLLMENT>
  </ERRORLIST>
</RESPONSE>

package blackboard.platform.integration.extension.sample;

import blackboard.persist.Id;
import blackboard.platform.integration.IntegrationException;
import blackboard.platform.integration.exchange.AnnouncementXO;
import blackboard.platform.integration.extension.AbstractAnnouncementProvider;
import blackboard.platform.integration.provider.AnnouncementProvider;

public class SampleAnnouncementProvider extends AbstractAnnouncementProvider implements AnnouncementProvider
{

  @Override
  public void createAnnouncement( AnnouncementXO announcementXO ) throws IntegrationException
  {
    if ( announcementXO.getParentCourseLmsInt() != null )
    {
        Id courseId = announcementXO.getParentCourseLmsInt().getCourseId();
        announcementXO.setExtCourseId( courseId );
    }

    long announcmentId = -1L;
    //
    // You will need to provide a real method to contact the LMS here. The following
    // is an example of how a fictional LMS might perform this action.
    //
    //    AnnouncementSDK annSDK = new AnnouncementSDK( props );
    //    announcementId = annSDK.createAnnouncement( sessionVO, announcementVo )

    announcementXO.setExtAnnouncementId( announcmentId );

  }

  @Override
  public void deleteAnnouncement( AnnouncementXO announcementXO ) throws IntegrationException
  {
      //
      // You will need to provide a real method to contact the LMS here. The following
      // is an example of how a fictional LMS might perform this action.
      //
      //    AnnouncementSDK annSDK = new AnnouncementSDK( props );
      //    annSDK.deleteAnnouncement( sessionVO, delAnnVo );
  }

}

<?xml version="1.0" encoding="ISO-8859-1"?>
<manifest>
    ...
    <module-defs>
      <definition namespace="blackboard.platform.integration">
        ...
        <extension id="sampleMigrationProvider"
          point="blackboard.platform.integration.supportProvider"
          class="blackboard.platform.integration.extension.sample.SampleMigrationProvider"
          singleton="false" />
        ...
      </definition>
    </module-defs>
    ...
</manifest>

public class SampleIntegrationExtension extends AbstractIntegrationExtension
{
  ...

  @Override
  public String getProviderId( ProviderType providerType )
  {
    switch ( providerType )
    {
      ...
      case Migration:
        return "sampleMigrationProvider";
      ...
    }
    ...
  }

  ...
}

package blackboard.platform.integration.extension.sample;

import blackboard.platform.integration.CourseLmsIntegration;
import blackboard.platform.integration.exchange.CourseContentPackageXO;
import blackboard.platform.integration.exchange.UserPasswordXO;
import blackboard.platform.integration.extension.AbstractMigrationProvider;
import blackboard.platform.log.Log;

import java.io.InputStream;
import java.util.*;

public class SampleMigrationProvider extends AbstractMigrationProvider
{
  @Override
  public UserPasswordXO convertPassword( String lmsPassword )
  {
    //
    // This method will need to transform encrypted passwords from the LMS's
    // hashing format into one of the formats supported by Blackboard Learn.
    // If no compatible format is available, you can return UNSET_PASSWORD,
    // which means the user must reset their password after conversion.
    //
    return UserPasswordXO.UNSET_PASSWORD;
  }

  @Override
  public Map<String, UserPasswordXO> getUserPasswords( Set<String> lmsUserNames, Log auditLog )
  {
    //
    // This method will need to contact the LMS to acquire the current passwords
    // for the specified users.  These passwords can then be transformed into
    // one of the formats supported by Blackboard Learn.
    //

    Map<String, UserPasswordXO> result = new HashMap<String, UserPasswordXO>();
    for ( String lmsUserName : lmsUserNames )
    {
      result.put( lmsUserName, UserPasswordXO.UNSET_PASSWORD );
    }

    return result;
  }

  @Override
  public Map<String, Boolean> markUsersConverted( Set<String> lmsUserNames, boolean isConverted, Log auditLog )
  {
    //
    // This method will need to notify the LMS that the users have been successfully
    // converted, and are now native Blackboard Learn users.
    //

    Map<String, Boolean> result = new HashMap<String, Boolean>();
    for ( String lmsUserName : lmsUserNames )
    {
      result.put( lmsUserName, Boolean.TRUE );
    }

    return result;
  }

  @Override
  public CourseContentPackageXO convertCourse( CourseLmsIntegration courseIntegration )
  {
    //
    // This method will need to do the following:
    //   1. Make the LMS instance of the course unavailable in the UI
    //   2. Export a Blackboard Learn-compatible content package from the LMS course
    //   3. Make the content package available to Blackboard Learn in the form of
    //      an input stream.
    //

    InputStream packageStream = null; // TODO - acquire a valid input stream from the LMS
    String packageName = "mypackage.zip";

    return new CourseContentPackageXO(packageStream, packageName);
  }

  @Override
  public void undoCourseConversion( CourseLmsIntegration courseIntegration )
  {
    //
    // Notify the LMS that the conversion operation failed, and that any
    // changes made to support conversion should be rolled back.
    //
  }

  @Override
  public CourseContentPackageXO exportCourse( CourseLmsIntegration courseIntegration )
  {
    //
    // This method is very similar to convertCourse; it will need to do the following:
    //   1. Export a Blackboard Learn-compatible content package from the LMS course
    //   2. Make the content package available to Blackboard Learn in the form of
    //      an input stream.
    //

    InputStream packageStream = null; // TODO - acquire a valid input stream from the LMS
    String packageName = "mypackage.zip";

    return new CourseContentPackageXO(packageStream, packageName);
  }

  @Override
  public boolean isPublisherCourse( CourseLmsIntegration courseIntegration )
  {
    //
    // If the LMS supports the concept of publisher-protected content, this is where
    // Blackboard Learn can be notified whether the current course contains any
    // of this publisher content.
    //

    return false;
  }
}

%AS_SERVER_URL%/webapps/blackboard/execute/getLicense?cmd=isContentSystemLicensed

%AS_SERVER_URL%/webapps/blackboard/execute/getLicense?cmd=isOutcomesSystemLicensed

%AS_SERVER_URL%/webapps/bb-integration-gateway-bb_bb60/cs-file-browser?glcId=xxx

%AS_SERVER_URL%/webapps/blackboard/admin/lms_course_conversion_in_progress.jsp

%AS_SERVER_URL%/webapps/bb-integration-gateway-bb_bb60/cs-file?timestamp=xxx&mac=xxx&id=xxx&integrationId=xxx

%AS_SERVER_URL%/webapps/bb-integration-gateway-bb_bb60/xml-feed + MultipartPostMethod

%AS_SERVER_URL%/webapps/bb-integration-gateway-bb_bb60/sso?username=xxx&integrationId=xxx&targetLocation=xxx&mac=xxx

%AS_SERVER_URL%/webapps/blackboard/execute/getCourseObjectives?id=xxx&name=xxx

(Secure protocal)%AS_SERVER_URL%/

!Learning Environment Connector Developer Guide^sequence_sso.png!

[http://tick.bbbb.net/webapps/bb-integration-gateway-bb_bb60/sso?username=testuser&integrationId=myintegrationid&targetLocation=]

[http://tick.bbbb.net/webapps/bb-integration-gateway-bb_bb60/sso?username=testuser&
  integrationId=myintegrationid&targetLocation=/lms/content/here.html&mac=05e6ea29e3fe7536f62c30d1358400b4]

<?xml version="1.0" encoding="ISO-8859-1"?>
<manifest>
    ...
    <module-defs>
      <definition namespace="blackboard.platform.integration">
        ...
        <extension id="sampleIntegrationEventListener"
          point="blackboard.platform.integration.integrationEventListener"
          class="blackboard.platform.integration.extension.sample.SampleIntegrationEventListener"
          singleton="true" />
        ...
      </definition>
    </module-defs>
    ...
</manifest>

package blackboard.platform.integration.extension.sample;

import blackboard.persist.Id;
import blackboard.platform.integration.IntegrationException;

public class SampleIntegrationEventListener extends AbstractIntegrationEventListener
{
  @Override
  public void integrationDeleted( Id id ) throws IntegrationException
  {
    //
    // This integration instance has been deleted.  This is a good time to
    // clean up any cached data related to the integration.
    //
  }

  @Override
  public void userDeintegrated( Id id ) throws IntegrationException
  {
    //
    // This user has been removed from one or more integration instances.
    // This is a good time to clean up any cached data related to the user.
    //
  }
}