Index: lams_contentrepository/doc/allclasses-frame.html =================================================================== RCS file: /usr/local/cvsroot/lams_contentrepository/doc/allclasses-frame.html,v diff -u -r1.8 -r1.9 --- lams_contentrepository/doc/allclasses-frame.html 20 Jul 2005 06:50:47 -0000 1.8 +++ lams_contentrepository/doc/allclasses-frame.html 26 Jul 2005 14:51:33 -0000 1.9 @@ -2,7 +2,7 @@ - + All Classes @@ -42,6 +42,8 @@
CredentialDAO
+Download +
Download
FileDAO @@ -62,6 +64,8 @@
ITicket
+IToolContentHandler +
IValue
IVersionDetail Index: lams_contentrepository/doc/allclasses-noframe.html =================================================================== RCS file: /usr/local/cvsroot/lams_contentrepository/doc/allclasses-noframe.html,v diff -u -r1.8 -r1.9 --- lams_contentrepository/doc/allclasses-noframe.html 20 Jul 2005 06:50:47 -0000 1.8 +++ lams_contentrepository/doc/allclasses-noframe.html 26 Jul 2005 14:51:33 -0000 1.9 @@ -2,7 +2,7 @@ - + All Classes @@ -42,6 +42,8 @@
CredentialDAO
+Download +
Download
FileDAO @@ -62,6 +64,8 @@
ITicket
+IToolContentHandler +
IValue
IVersionDetail Index: lams_contentrepository/doc/index.html =================================================================== RCS file: /usr/local/cvsroot/lams_contentrepository/doc/index.html,v diff -u -r1.8 -r1.9 --- lams_contentrepository/doc/index.html 20 Jul 2005 06:50:47 -0000 1.8 +++ lams_contentrepository/doc/index.html 26 Jul 2005 14:51:33 -0000 1.9 @@ -2,7 +2,7 @@ - + Generated Documentation (Untitled) Index: lams_contentrepository/doc/overview-frame.html =================================================================== RCS file: /usr/local/cvsroot/lams_contentrepository/doc/overview-frame.html,v diff -u -r1.6 -r1.7 --- lams_contentrepository/doc/overview-frame.html 20 Jul 2005 06:50:47 -0000 1.6 +++ lams_contentrepository/doc/overview-frame.html 26 Jul 2005 14:51:33 -0000 1.7 @@ -2,7 +2,7 @@ - + Overview Index: lams_contentrepository/doc/overview-summary.html =================================================================== RCS file: /usr/local/cvsroot/lams_contentrepository/doc/overview-summary.html,v diff -u -r1.6 -r1.7 --- lams_contentrepository/doc/overview-summary.html 20 Jul 2005 06:50:47 -0000 1.6 +++ lams_contentrepository/doc/overview-summary.html 26 Jul 2005 14:51:33 -0000 1.7 @@ -2,7 +2,7 @@ - + Overview Index: lams_contentrepository/doc/overview-tree.html =================================================================== RCS file: /usr/local/cvsroot/lams_contentrepository/doc/overview-tree.html,v diff -u -r1.8 -r1.9 --- lams_contentrepository/doc/overview-tree.html 20 Jul 2005 06:50:47 -0000 1.8 +++ lams_contentrepository/doc/overview-tree.html 26 Jul 2005 14:51:33 -0000 1.9 @@ -2,7 +2,7 @@ - + Class Hierarchy @@ -108,6 +108,8 @@
  • class org.lamsfoundation.lams.contentrepository.dao.hibernate.WorkspaceDAO (implements org.lamsfoundation.lams.contentrepository.dao.IWorkspaceDAO)
  • class HttpServlet +
  • class HttpServlet @@ -126,8 +128,9 @@
  • class org.lamsfoundation.lams.contentrepository.RepositoryRuntimeException -
  • class org.lamsfoundation.lams.contentrepository.client.ToolContentHandler +
  • class org.lamsfoundation.lams.contentrepository.client.ToolContentHandler (implements org.lamsfoundation.lams.contentrepository.client.IToolContentHandler) +

    Interface Hierarchy

    @@ -136,7 +139,7 @@
  • interface org.lamsfoundation.lams.contentrepository.IVersionDetail
  • interface org.lamsfoundation.lams.contentrepository.dao.ICredentialDAO
  • interface org.lamsfoundation.lams.contentrepository.dao.IFileDAO
  • interface org.lamsfoundation.lams.contentrepository.dao.INodeDAO
  • interface org.lamsfoundation.lams.contentrepository.service.IRepositoryService -
  • interface org.lamsfoundation.lams.contentrepository.ITicket
  • interface org.lamsfoundation.lams.contentrepository.IValue
  • interface org.lamsfoundation.lams.contentrepository.IVersionedNode For example:
      	<bean id="toolContentHandler" class="your class name here">
    - 		<property name="repositoryService"><ref local="coreSessionFactory"/></property>
    + 		<property name="repositoryService"> <ref bean="repositoryService"/</property>
     	</bean> 
      
    + You do not need to include repositoryService as a instance variable in your own class as it is already defined in the ToolContentHandler abstract class.

    @@ -153,6 +159,13 @@

    If you want to see this class used, have a look at the test code in org.lamsfoundation.lams.contentrepository.client in the test/java area. +

    + You may be wondering why we don't make the workspaceName, user, id, etc + parameters in the Spring file, rather than creating a concrete class. Using + the Spring file would be easier, but then the id (equivalent to passsword) + is easier to hack. The id is a char[], rather than a String for + security. If you don't care that your tool's id is stored as a String + then you can include it in your Spring file.

    @@ -174,30 +187,15 @@ Field Summary - - -static java.lang.String -FILE_TYPE_PROPERTY_NAME - -
    -          The "name" used to store the online/offline property in the repository + +  + + + - - + - - - -
    Fields inherited from interface org.lamsfoundation.lams.contentrepository.client.IToolContentHandler
    -static java.lang.StringTYPE_OFFLINE - -
    -          File is for Offline Instructions
    FILE_TYPE_PROPERTY_NAME, SPRING_BEAN_NAME, TYPE_OFFLINE, TYPE_ONLINE
    -static java.lang.StringTYPE_ONLINE - -
    -          File is for Online Instructions
      @@ -242,6 +240,14 @@ + java.util.Set +getFileProperties(java.lang.Long uuid) + +
    +          Get just the properties of a file. + + + abstract  char[] getRepositoryId() @@ -274,6 +280,14 @@ + ITicket +getTicket(boolean forceLogin) + +
    +          Get the ticket to access the repository. + + +  boolean isOffline(IVersionedNode node) @@ -322,49 +336,7 @@ - - - - - -
    -Field Detail
    -

    -TYPE_ONLINE

    -
    -public static final java.lang.String TYPE_ONLINE
    -
    -
    File is for Online Instructions -

    -

    -
    See Also:
    Constant Field Values
    -
    -
    - -

    -TYPE_OFFLINE

    -
    -public static final java.lang.String TYPE_OFFLINE
    -
    -
    File is for Offline Instructions -

    -

    -
    See Also:
    Constant Field Values
    -
    -
    - -

    -FILE_TYPE_PROPERTY_NAME

    -
    -public static final java.lang.String FILE_TYPE_PROPERTY_NAME
    -
    -
    The "name" used to store the online/offline property in the repository -

    -

    -
    See Also:
    Constant Field Values
    -
    - @@ -398,6 +370,9 @@ public abstract java.lang.String getRepositoryWorkspaceName()
    +
    Specified by:
    getRepositoryWorkspaceName in interface IToolContentHandler
    +
    +
    Returns:
    Returns the repositoryWorkspaceName.
    @@ -410,6 +385,9 @@ public abstract java.lang.String getRepositoryUser()
    +
    Specified by:
    getRepositoryUser in interface IToolContentHandler
    +
    +
    Returns:
    Returns the repositoryUser.
    @@ -422,13 +400,37 @@ public abstract char[] getRepositoryId()
    +
    Specified by:
    getRepositoryId in interface IToolContentHandler
    +
    +
    Returns:
    Returns the repository identification string. This is the "password" field the credential.

    +

    +getTicket

    +
    +public ITicket getTicket(boolean forceLogin)
    +                  throws RepositoryCheckedException
    +
    +
    Get the ticket to access the repository. If the workspace/credential + hasn't been set up, then it will be set up automatically. +

    +

    +
    Specified by:
    getTicket in interface IToolContentHandler
    +
    +
    + +
    Returns:
    the repository ticket +
    Throws: +
    RepositoryCheckedException
    +
    +
    +
    +

    uploadFile

    @@ -443,6 +445,9 @@
     
    Save a file in the content repository.

    +
    Specified by:
    uploadFile in interface IToolContentHandler
    +
    +
    Parameters:
    stream - Input filestream. Mandatory.
    fileName - Input filename. Mandatory.
    mimeType - Mimetype of file. Optional.
    fileProperty - is this for online or offline instructions? Should be TYPE_ONLINE or TYPE_OFFLINE. Mandatory.
    Returns:
    key to the new content repository node
    Throws: @@ -463,6 +468,9 @@
    Delete a file node. If the node does not exist, then nothing happens (ie ItemNotFoundException is NOT thrown).

    +
    Specified by:
    deleteFile in interface IToolContentHandler
    +
    +
    Parameters:
    uuid - id of the file node. Mandatory
    Throws:
    InvalidParameterException - One of the mandatory parameters is missing. @@ -482,6 +490,9 @@
    Get a file node.

    +
    Specified by:
    getFileNode in interface IToolContentHandler
    +
    +
    Parameters:
    uuid - id of the file node. Mandatory
    Throws:
    FileException - An error occured writing the input stream to disk. @@ -491,12 +502,40 @@

    +

    +getFileProperties

    +
    +public java.util.Set getFileProperties(java.lang.Long uuid)
    +                                throws ItemNotFoundException,
    +                                       FileException,
    +                                       RepositoryCheckedException
    +
    +
    Get just the properties of a file. Convenience method - equivalent of + calling getFileNode(uuid).getProperties(). Useful if all you want are + the properties and you don't want to access the file itself. +

    +

    +
    Specified by:
    getFileProperties in interface IToolContentHandler
    +
    +
    +
    Parameters:
    uuid - id of the file node. Mandatory +
    Throws: +
    FileException - An error occured writing the input stream to disk. +
    ItemNotFoundException - This file node does not exist, so cannot delete it. +
    RepositoryCheckedException - Some other error occured.
    +
    +
    +
    +

    isOffline

     public boolean isOffline(IVersionedNode node)
    +
    Specified by:
    isOffline in interface IToolContentHandler
    +
    +
    @@ -508,6 +547,9 @@ public boolean isOnline(IVersionedNode node)
    +
    Specified by:
    isOnline in interface IToolContentHandler
    +
    +
    @@ -519,6 +561,9 @@ public IRepositoryService getRepositoryService()
    +
    Specified by:
    getRepositoryService in interface IToolContentHandler
    +
    +
    Returns:
    Returns the repositoryService.
    @@ -531,6 +576,9 @@ public void setRepositoryService(IRepositoryService repositoryService)
    +
    Specified by:
    setRepositoryService in interface IToolContentHandler
    +
    +
    Parameters:
    repositoryService - The repositoryService to set.
    @@ -565,7 +613,7 @@ - PREV CLASS  + PREV CLASS   NEXT CLASS FRAMES   @@ -585,9 +633,9 @@ - SUMMARY: NESTED | FIELD | CONSTR | METHOD + SUMMARY: NESTED | FIELD | CONSTR | METHOD -DETAIL: FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD Index: lams_contentrepository/doc/org/lamsfoundation/lams/contentrepository/client/package-frame.html =================================================================== RCS file: /usr/local/cvsroot/lams_contentrepository/doc/org/lamsfoundation/lams/contentrepository/client/package-frame.html,v diff -u -r1.1 -r1.2 --- lams_contentrepository/doc/org/lamsfoundation/lams/contentrepository/client/package-frame.html 20 Jul 2005 06:50:47 -0000 1.1 +++ lams_contentrepository/doc/org/lamsfoundation/lams/contentrepository/client/package-frame.html 26 Jul 2005 14:49:51 -0000 1.2 @@ -2,7 +2,7 @@ - + org.lamsfoundation.lams.contentrepository.client @@ -20,9 +20,22 @@ + +
    +Interfaces  + +
    +IToolContentHandler
    + + + + +
    Classes 
    +Download +
    ToolContentHandler
    Index: lams_contentrepository/doc/org/lamsfoundation/lams/contentrepository/client/package-summary.html =================================================================== RCS file: /usr/local/cvsroot/lams_contentrepository/doc/org/lamsfoundation/lams/contentrepository/client/package-summary.html,v diff -u -r1.1 -r1.2 --- lams_contentrepository/doc/org/lamsfoundation/lams/contentrepository/client/package-summary.html 20 Jul 2005 06:50:47 -0000 1.1 +++ lams_contentrepository/doc/org/lamsfoundation/lams/contentrepository/client/package-summary.html 26 Jul 2005 14:49:51 -0000 1.2 @@ -2,7 +2,7 @@ - + org.lamsfoundation.lams.contentrepository.client @@ -80,9 +80,29 @@ + + + + + +
    +Interface Summary
    IToolContentHandlerToolContentHander is an abstract class that implements most of the functionality + of the interface.
    +  + +

    + + + + + + + + Index: lams_contentrepository/doc/org/lamsfoundation/lams/contentrepository/client/package-tree.html =================================================================== RCS file: /usr/local/cvsroot/lams_contentrepository/doc/org/lamsfoundation/lams/contentrepository/client/package-tree.html,v diff -u -r1.1 -r1.2 --- lams_contentrepository/doc/org/lamsfoundation/lams/contentrepository/client/package-tree.html 20 Jul 2005 06:50:47 -0000 1.1 +++ lams_contentrepository/doc/org/lamsfoundation/lams/contentrepository/client/package-tree.html 26 Jul 2005 14:49:51 -0000 1.2 @@ -2,7 +2,7 @@ - + org.lamsfoundation.lams.contentrepository.client Class Hierarchy @@ -85,8 +85,16 @@
    • class java.lang.Object +
    • class HttpServlet
        +
      • class org.lamsfoundation.lams.contentrepository.client.Download
      +
    • class org.lamsfoundation.lams.contentrepository.client.ToolContentHandler (implements org.lamsfoundation.lams.contentrepository.client.IToolContentHandler)
    + +

    +Interface Hierarchy +

    +
    Index: lams_contentrepository/doc/org/lamsfoundation/lams/contentrepository/client/package-use.html =================================================================== RCS file: /usr/local/cvsroot/lams_contentrepository/doc/org/lamsfoundation/lams/contentrepository/client/package-use.html,v diff -u -r1.1 -r1.2 --- lams_contentrepository/doc/org/lamsfoundation/lams/contentrepository/client/package-use.html 20 Jul 2005 06:50:47 -0000 1.1 +++ lams_contentrepository/doc/org/lamsfoundation/lams/contentrepository/client/package-use.html 26 Jul 2005 14:49:51 -0000 1.2 @@ -2,7 +2,7 @@ - + Uses of Package org.lamsfoundation.lams.contentrepository.client @@ -76,8 +76,35 @@

    Uses of Package
    org.lamsfoundation.lams.contentrepository.client

    -No usage of org.lamsfoundation.lams.contentrepository.client + +
    Class Summary
    DownloadThis is a specialised servlet that supports the downloading of single + files and the rendering of packages.
    ToolContentHandler Handles the connection to the content repository, and allows a file to be stored and retrieved.
    + + + + + + + +
    +Packages that use org.lamsfoundation.lams.contentrepository.client
    org.lamsfoundation.lams.contentrepository.client  

    + + + + + + + + +
    +Classes in org.lamsfoundation.lams.contentrepository.client used by org.lamsfoundation.lams.contentrepository.client
    IToolContentHandler + +
    +          ToolContentHander is an abstract class that implements most of the functionality + of the interface.
    +  +


    Index: lams_contentrepository/doc/org/lamsfoundation/lams/contentrepository/client/class-use/Download.html =================================================================== RCS file: /usr/local/cvsroot/lams_contentrepository/doc/org/lamsfoundation/lams/contentrepository/client/class-use/Download.html,v diff -u --- /dev/null 1 Jan 1970 00:00:00 -0000 +++ lams_contentrepository/doc/org/lamsfoundation/lams/contentrepository/client/class-use/Download.html 26 Jul 2005 14:49:51 -0000 1.1 @@ -0,0 +1,136 @@ + + + + + + +Uses of Class org.lamsfoundation.lams.contentrepository.client.Download + + + + + + + + + + + + + + + + + + + + + + + + + +
    + +
    + + + +
    +
    +

    +Uses of Class
    org.lamsfoundation.lams.contentrepository.client.Download

    +
    +No usage of org.lamsfoundation.lams.contentrepository.client.Download +

    +


    + + + + + + + + + + + + + + + +
    + +
    + + + +
    + + + Index: lams_contentrepository/doc/org/lamsfoundation/lams/contentrepository/client/class-use/IToolContentHandler.html =================================================================== RCS file: /usr/local/cvsroot/lams_contentrepository/doc/org/lamsfoundation/lams/contentrepository/client/class-use/IToolContentHandler.html,v diff -u --- /dev/null 1 Jan 1970 00:00:00 -0000 +++ lams_contentrepository/doc/org/lamsfoundation/lams/contentrepository/client/class-use/IToolContentHandler.html 26 Jul 2005 14:49:51 -0000 1.1 @@ -0,0 +1,189 @@ + + + + + + +Uses of Interface org.lamsfoundation.lams.contentrepository.client.IToolContentHandler + + + + + + + + + + + + + + + + + + + + + + + + + +
    + +
    + + + +
    +
    +

    +Uses of Interface
    org.lamsfoundation.lams.contentrepository.client.IToolContentHandler

    +
    + + + + + + + + + +
    +Packages that use IToolContentHandler
    org.lamsfoundation.lams.contentrepository.client  
    +  +

    + + + + + +
    +Uses of IToolContentHandler in org.lamsfoundation.lams.contentrepository.client
    +  +

    + + + + + + + + + +
    Classes in org.lamsfoundation.lams.contentrepository.client that implement IToolContentHandler
    + classToolContentHandler + +
    +          Handles the connection to the content repository, and allows a file + to be stored and retrieved.
    +  +

    + + + + + + + + + +
    Methods in org.lamsfoundation.lams.contentrepository.client that return IToolContentHandler
    + IToolContentHandlerDownload.getToolContentHandler() + +
    +           
    +  +

    +


    + + + + + + + + + + + + + + + +
    + +
    + + + +
    + + + Index: lams_contentrepository/doc/org/lamsfoundation/lams/contentrepository/client/class-use/ToolContentHandler.html =================================================================== RCS file: /usr/local/cvsroot/lams_contentrepository/doc/org/lamsfoundation/lams/contentrepository/client/class-use/ToolContentHandler.html,v diff -u -r1.1 -r1.2 --- lams_contentrepository/doc/org/lamsfoundation/lams/contentrepository/client/class-use/ToolContentHandler.html 20 Jul 2005 06:50:48 -0000 1.1 +++ lams_contentrepository/doc/org/lamsfoundation/lams/contentrepository/client/class-use/ToolContentHandler.html 26 Jul 2005 14:49:51 -0000 1.2 @@ -2,7 +2,7 @@ - + Uses of Class org.lamsfoundation.lams.contentrepository.client.ToolContentHandler