com.icodeon.rte.plugins
Interface PlugIn_Resolver

All Known Subinterfaces:

PlugIn_RelativeResolver

public interface PlugIn_Resolver

Inteface for plugins that are used to resolve Method 1:fetchManifestDocument() is used to resolve a courseID to a fully qualified URL that returns an imsmanifest.xml from some remote network location, such as a web server, LCMS or repository. Method 2:getContentObjectUrl() is used to return a URL based on the value of the href attribute of the element associated with an element.

Author:

Icodeon Ltd Copyright 2005 All Rights Reserved You may not make or distribute copies of this Software, or electronically transfer the Software from one computer to another or over a network. You may not alter, merge, modify, adapt or translate this Software, or decompile, reverse engineer, disassemble, or otherwise reduce this Software. Icodeon Ltd St Johns Innovation Centre Cowley Road Cambridge CB4 0WS England Registered in England and Wales No: 5068195 sales@icodeon.com See Legal Terms, Conditions and License in legal/ICODEON_PLAYER_LICENSE.txt

Field Summary

static java.lang.String	DEFAULT_IMPL_CLASSNAME
static java.lang.String	KEY
static java.lang.String	LCMS_ENDPOINT_KEY
static java.lang.String	LCMS_PASSWORD_KEY
static java.lang.String	LCMS_USERNAME_KEY

Method Summary

java.lang.Object	fetchManifestDocument(HttpServlet servlet, HttpServletRequest request, java.net.URL lcmsEndPoint, java.lang.String username, char[] password, java.lang.String launchQueryString) Method to to resolve the URL for an imsmanifest.xml, read in the imsmanifest.xml file and return as a document object.
long	fetchManifestLastModified(HttpServlet servlet, HttpServletRequest request, java.net.URL lcmsEndPoint, java.lang.String username, char[] password, java.lang.String launchQueryString)
java.net.URL	getContentObjectUrl(HttpServlet servlet, HttpServletRequest request, java.net.URL lcmsEndPoint, java.lang.String resourceHref, java.lang.String launchQueryString) Method to resolve the URL for a resource listed in the imsmanifest.xml file.

Field Detail

DEFAULT_IMPL_CLASSNAME

static final java.lang.String DEFAULT_IMPL_CLASSNAME

See Also:

Constant Field Values

KEY

static final java.lang.String KEY

See Also:

Constant Field Values

LCMS_ENDPOINT_KEY

static final java.lang.String LCMS_ENDPOINT_KEY

See Also:

Constant Field Values

LCMS_USERNAME_KEY

static final java.lang.String LCMS_USERNAME_KEY

See Also:

Constant Field Values

LCMS_PASSWORD_KEY

static final java.lang.String LCMS_PASSWORD_KEY

See Also:

Constant Field Values

Method Detail

fetchManifestDocument

java.lang.Object fetchManifestDocument(HttpServlet servlet,
                                       HttpServletRequest request,
                                       java.net.URL lcmsEndPoint,
                                       java.lang.String username,
                                       char[] password,
                                       java.lang.String launchQueryString)
                                       throws java.lang.Exception

Method to to resolve the URL for an imsmanifest.xml, read in the imsmanifest.xml file and return as a document object. If no authentication is required, leave the username and password fields as null.

Parameters:

servlet - - the servlet and its confirguration

request - - the request and any parameters

lcmsEndPoint - - the target endpoint of the LCMS

username - - username credentials

password - - password credentials

launchQueryString - - the query string used in the Player window launch

Returns:

Object document object for the imsmanifest.xml file

Throws:

java.lang.Exception

fetchManifestLastModified

long fetchManifestLastModified(HttpServlet servlet,
                               HttpServletRequest request,
                               java.net.URL lcmsEndPoint,
                               java.lang.String username,
                               char[] password,
                               java.lang.String launchQueryString)
                               throws java.lang.Exception

Parameters:

servlet -

request -

lcmsEndPoint -

username -

password -

launchQueryString -

Returns:

Throws:

java.lang.Exception

getContentObjectUrl

java.net.URL getContentObjectUrl(HttpServlet servlet,
                                 HttpServletRequest request,
                                 java.net.URL lcmsEndPoint,
                                 java.lang.String resourceHref,
                                 java.lang.String launchQueryString)
                                 throws java.lang.Exception

Method to resolve the URL for a resource listed in the imsmanifest.xml file. The element in a an imsmanifest.xml file has an href attribute that is typically a relative path, relative to the location of the imsmanifest.xml file. However, the SCORM 1.2 specification allows this path to also be an absolute path. This can lead to a cross-domain scripting issue, in which case some solution, such as a SCO Fetcher proxy configuration, might be included in the implementation of this method. This method resolves the relative path of a resouce in the imsmanifest.xml file to a fully qualified URL, using the courseID for the imsmanifest.xml and the url for the the network endpoint of the LCMS. Username and password are not used here, as they were supplied at the start of the session that read in the imsmanifest.xml file.

Parameters:

servlet - - the servlet and its confirguration

request - - the request and any parameters

lcmsEndPoint - - the target endpoint of the LCMS

resourceHref - - value of resource href attribute from imsmanifest.xml file

launchQueryString - - the query string used in the Player window launch

Returns:

url for the resource

Throws:

java.lang.Exception