/* ====================================================================== The Bodington System Software License, Version 1.0 Copyright (c) 2001 The University of Leeds. All rights reserved. Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: 1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. 2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. 3. The end-user documentation included with the redistribution, if any, must include the following acknowledgement: "This product includes software developed by the University of Leeds (http://www.bodington.org/)." Alternately, this acknowledgement may appear in the software itself, if and wherever such third-party acknowledgements normally appear. 4. The names "Bodington", "Nathan Bodington", "Bodington System", "Bodington Open Source Project", and "The University of Leeds" must not be used to endorse or promote products derived from this software without prior written permission. For written permission, please contact d.gardner@leeds.ac.uk. 5. The name "Bodington" may not appear in the name of products derived from this software without prior written permission of the University of Leeds. THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, TITLE, THE IMPLIED WARRANTIES OF QUALITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE UNIVERSITY OF LEEDS OR ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. ========================================================= This software was originally created by the University of Leeds and may contain voluntary contributions from others. For more information on the Bodington Open Source Project, please see http://bodington.org/ ====================================================================== */ package org.bodington.server; import java.awt.Color; import java.io.File; import java.rmi.*; import java.net.URL; import java.util.Vector; import java.util.zip.*; import org.bodington.server.BuildingServerException; import org.bodington.database.PrimaryKey; import org.bodington.server.resources.*; import org.bodington.xml.XMLQuery; /** * Represents a user's session with the site. Subclasses may represent * a session with a specific resource or a navigating session that can change * its currently selected resource. Contains methods appropriate to all * types of session. * * @author Jon Maber * @version 1.0 */ public interface BuildingSession extends Remote { public static final int BYTES_UPLOADED_GRAND_TOTAL = 0; public static final int BYTES_UPLOADED_RESOURCE = 1; public static final int BYTES_UPLOADED_USER = 2; public static final int BYTES_UPLOADED_USER_TO_RESOURCE = 3; public void init( PrimaryKey user_id, PrimaryKey resource_id ) throws RemoteException, BuildingServerException; /** * Set the ID of the current resource for this session. * @param k the ID of the resource for this instance. * @throws java.rmi.RemoteException Thrown if the method is accessed * remotely and there is a problem transmitting parameters or return * value. * @throws BuildingServerException */ public void setResource( PrimaryKey k ) throws RemoteException, BuildingServerException; /** * Set the current resource for this session. * @param resource the the resource for this instance. * @throws java.rmi.RemoteException Thrown if the method is accessed * remotely and there is a problem transmitting parameters or return * value. * @throws BuildingServerException * @see #setResource(PrimaryKey) */ public void setResource( Resource resource ) throws RemoteException, BuildingServerException; public PrimaryKey getResourceId() throws RemoteException, BuildingServerException; public long getPropertiesLastModifiedTime() throws RemoteException, BuildingServerException; public void unspecifyProperty( String name ) throws RemoteException, BuildingServerException; public void specifyProperty( String name, String value ) throws RemoteException, BuildingServerException; public String getSpecifiedProperty( String name ) throws RemoteException, BuildingServerException; public String getProperty( String name ) throws RemoteException, BuildingServerException; public String getProperty( Resource r, String name ) throws RemoteException, BuildingServerException; public Color getPropertyColor( String name ) throws RemoteException, BuildingServerException; public Color getPropertyColor( String name, Color def ) throws RemoteException, BuildingServerException; public Color getPropertyColor( Resource r, String name ) throws RemoteException, BuildingServerException; public Color getPropertyColor( Resource r, String name, Color def ) throws RemoteException, BuildingServerException; public String getProperty( String name, String def ) throws RemoteException, BuildingServerException; public String getProperty( Resource r, String name, String def ) throws RemoteException, BuildingServerException; public PrimaryKey getStyleResourceId() throws RemoteException, BuildingServerException; public String[] getStyleResourcePath() throws RemoteException, BuildingServerException; /** * Specifies a file on the file system of VM implementing the session to copy into the * currently selected resource. (Uses * {@link #transferFile(String, String, String)}, without deleting original file.)

* (WebLearn modification (method added): 02/12/2003 Colin Tatham) * @param current_pathname The file system pathname of the file. * @param resource_pathname The destination of the file relative to the resource storage area. URL encoded. * @param mime_type The mime type of the file to record. * @return Reference to the file that was copied. * @exception java.rmi.RemoteException Thrown if the method is accessed remotely and there is a problem * transmitting parameters or return value. * @exception org.bodington.server.BuildingServerException Thrown if there is a problem servicing the method call. */ public UploadedFileSummary copyFile( String current_pathname, String resource_pathname, String mime_type ) throws RemoteException, BuildingServerException; /** * Specifies a file on the file system of VM implementing the session to move into the * currently selected resource. Most likely used by servlet running on same computer * to put file into resource. Applet running on client computer would have to use another * * @param current_pathname The file system pathname of the file. * @param resource_pathname The destination of the file relative to the resource storage area. * @param mime_type The mime type of the file to record. * @exception java.rmi.RemoteException Thrown if the method is accessed remotely and there is a problem * transmitting parameters or return value. * @exception org.bodington.server.BuildingServerException Thrown if there is a problem servicing the method call. */ public UploadedFileSummary transferFile( String current_pathname, String resource_pathname, String mime_type ) throws RemoteException, BuildingServerException; public void transferZipFile( ZipFile archive, String startfilename ) throws RemoteException, BuildingServerException; /** * Create a folder in the resource for uploading files. * Should check with resource to see if it is capable of * accepting uploaded files. * * @param pathname The pathname of the folder without separators. * @exception java.rmi.RemoteException Thrown if the method is accessed remotely and there is a problem * transmitting parameters or return value. * @exception org.bodington.server.BuildingServerException Thrown if there is a problem servicing the method call. */ public UploadedFileSummary createFolder( String pathname ) throws RemoteException, BuildingServerException; /** * Create an empty file in a resource which is initially empty * and ready to receive data. * * @param pathname The name of the file including folder name. * @param size The size of the file to create. * @param mime_type The mime type of the file to record. * @exception java.rmi.RemoteException Thrown if the method is accessed remotely and there is a problem * transmitting parameters or return value. * @exception org.bodington.server.BuildingServerException Thrown if there is a problem servicing the method call. */ public void createFile( String pathname, long size, String mime_type ) throws RemoteException, BuildingServerException; /** * Check the validity of creating a folder in the resource. * * @param pathname * @exception java.rmi.RemoteException Thrown if the method is accessed remotely and there is a problem * transmitting parameters or return value. * @exception org.bodington.server.BuildingServerException Thrown if there is a problem servicing the method call. */ public void checkCreateFolder( String pathname ) throws RemoteException, BuildingServerException; /** * Check the validity of creating a file. * * @param pathname * @param size * @exception java.rmi.RemoteException Thrown if the method is accessed remotely and there is a problem * transmitting parameters or return value. * @exception org.bodington.server.BuildingServerException Thrown if there is a problem servicing the method call. */ public void checkCreateFile( String pathname, long size ) throws RemoteException, BuildingServerException; /** * Delete the specified file or folder. * * @param pathname * @exception java.rmi.RemoteException Thrown if the method is accessed remotely and there is a problem * transmitting parameters or return value. * @exception org.bodington.server.BuildingServerException Thrown if there is a problem servicing the method call. */ public void deleteFile( String pathname ) throws RemoteException, BuildingServerException; /** * Delete the specified file or folder. * * @param pathname * @exception java.rmi.RemoteException Thrown if the method is accessed remotely and there is a problem * transmitting parameters or return value. * @exception org.bodington.server.BuildingServerException Thrown if there is a problem servicing the method call. */ public void renameFile( String pathname, String newname ) throws RemoteException, BuildingServerException; /** * UnDelete the specified file or folder. * * @param pathname * @exception java.rmi.RemoteException Thrown if the method is accessed remotely and there is a problem * transmitting parameters or return value. * @exception org.bodington.server.BuildingServerException Thrown if there is a problem servicing the method call. */ public void undeleteFile( String pathname, boolean recurse ) throws RemoteException, BuildingServerException; /** * Put bytes into the file at the end of where bytes were last put. * Method will check offset parameter to see if this call has come * in sequence and will check the CRC32 against the data received. * * @param pathname * @param offset * @param data * @param crc32 * @exception java.rmi.RemoteException Thrown if the method is accessed remotely and there is a problem * transmitting parameters or return value. * @exception org.bodington.server.BuildingServerException Thrown if there is a problem servicing the method call. */ public void writeToFile( String pathname, long offset, byte[] data, int crc32 ) throws RemoteException, BuildingServerException; /** * Looks at the data segment in the file and calculates a CRC32. * Checks the calculated CRC32 against the crc32 parameter. * * @param pathname * @param offset * @param length * @param crc32 * @exception java.rmi.RemoteException Thrown if the method is accessed remotely and there is a problem * transmitting parameters or return value. * @exception org.bodington.server.BuildingServerException Thrown if there is a problem servicing the method call. */ public void compareWithFile( String pathname, long offset, long length, int crc32 ) throws RemoteException, BuildingServerException; /** * Fetches a set of bytes from the file. * * @param pathname * @param offset * @param data * @return The crc32 of the requested bytes. * @exception java.rmi.RemoteException Thrown if the method is accessed remotely and there is a problem * transmitting parameters or return value. * @exception org.bodington.server.BuildingServerException Thrown if there is a problem servicing the method call. */ public int readFromFile( String pathname, long offset, byte[] data ) throws RemoteException, BuildingServerException; /** * If the resource published the file on the web return the URL that reference where * the file is actually stored. This is not to be published on a page. * * @param uf_id Id of the file * @exception java.rmi.RemoteException Thrown if the method is accessed remotely and there is a problem * transmitting parameters or return value. * @exception org.bodington.server.BuildingServerException Thrown if there is a problem servicing the method call. */ public String getRealURL( PrimaryKey uf_id ) throws RemoteException, BuildingServerException; /** * If the resource published the file on the web return the URL that can be published as * a reference to it. * * @param uf_id Id of the file * @exception java.rmi.RemoteException Thrown if the method is accessed remotely and there is a problem * transmitting parameters or return value. * @exception org.bodington.server.BuildingServerException Thrown if there is a problem servicing the method call. */ public String getPublishedURL( PrimaryKey uf_id ) throws RemoteException, BuildingServerException; /** * Get the MIME type of a file. * * @param pathname * @return The MIME type. * @exception java.rmi.RemoteException Thrown if the method is accessed remotely and there is a problem * transmitting parameters or return value. * @exception org.bodington.server.BuildingServerException Thrown if there is a problem servicing the method call. */ public String getFileMimeType( String pathname ) throws RemoteException, BuildingServerException; /** * Change the MIME type of an existing file. * * @param pathname * @param mime_type * @exception java.rmi.RemoteException Thrown if the method is accessed remotely and there is a problem * transmitting parameters or return value. * @exception org.bodington.server.BuildingServerException Thrown if there is a problem servicing the method call. */ public void setFileMimeType( String pathname, String mime_type ) throws RemoteException, BuildingServerException; /** * Get properties of file. * * @param pathname Pathname of folder or null to indicate the root. * @exception java.rmi.RemoteException Thrown if the method is accessed remotely and there is a problem * transmitting parameters or return value. * @exception org.bodington.server.BuildingServerException Thrown if there is a problem servicing the method call. */ public UploadedFileSummary getFileSummary( String pathname ) throws RemoteException, BuildingServerException; /** * Get properties of file. * * @param path Pathname, split into parts of folder. * @exception java.rmi.RemoteException Thrown if the method is accessed remotely and there is a problem * transmitting parameters or return value. * @exception org.bodington.server.BuildingServerException Thrown if there is a problem servicing the method call. */ public UploadedFileSummary getFileSummary( String[] path ) throws RemoteException, BuildingServerException; /** * Get properties of file. * * @param id ID of file in database * @exception java.rmi.RemoteException Thrown if the method is accessed remotely and there is a problem * transmitting parameters or return value. * @exception org.bodington.server.BuildingServerException Thrown if there is a problem servicing the method call. */ public UploadedFileSummary getFileSummary( PrimaryKey id ) throws RemoteException, BuildingServerException; /** * Get reference to the file in the host file system. * * @param id ID of file in database * @exception java.rmi.RemoteException Thrown if the method is accessed remotely and there is a problem * transmitting parameters or return value. * @exception org.bodington.server.BuildingServerException Thrown if there is a problem servicing the method call. */ public File getFile( PrimaryKey id ) throws RemoteException, BuildingServerException; /** * Get properties of file and its descendents in visitation model order. * * @param pathname Pathname of folder or null to indicate the root. * @exception java.rmi.RemoteException Thrown if the method is accessed remotely and there is a problem * transmitting parameters or return value. * @exception org.bodington.server.BuildingServerException Thrown if there is a problem servicing the method call. */ public UploadedFileSummary[] getFileAndDescendentSummaries( String pathname, boolean omit_deleted ) throws RemoteException, BuildingServerException; /** * Get properties of file and its ancestors from root to the file itself. * * @param pathname Pathname of folder or null to indicate the root. * @exception java.rmi.RemoteException Thrown if the method is accessed remotely and there is a problem * transmitting parameters or return value. * @exception org.bodington.server.BuildingServerException Thrown if there is a problem servicing the method call. */ public UploadedFileSummary[] getFileAndAncestorSummaries( String pathname ) throws RemoteException, BuildingServerException; public long bytesUploaded( int query_type ) throws RemoteException, BuildingServerException; public String getNameOfUser( PrimaryKey uid ) throws RemoteException, BuildingServerException; public void parseManifest() throws RemoteException, BuildingServerException; public void generateImsManifest() throws RemoteException, BuildingServerException; public void generateFileListing() throws RemoteException, BuildingServerException; public int importMetadata( String file_name ) throws RemoteException, BuildingServerException; //public void saveMetadata( XmlDocument doc ) // throws RemoteException, BuildingServerException; public String exportMetadata() throws RemoteException, BuildingServerException; //public XmlDocument getMetadata() // throws RemoteException, BuildingServerException; public Vector searchMetadata( XMLQuery query ) throws RemoteException, BuildingServerException; public String[] getFieldValuesFromMetadata( String elementName ) throws RemoteException, BuildingServerException; public void updateBasicMetadata( String title, String description ) throws RemoteException, BuildingServerException; public void updateMetaDataTitleField( String text, String languageCode ) throws RemoteException; public void updateMetadataDescriptionField( String text, String languageCode ) throws RemoteException; public void updateMetadataAuthorField( String authorName, String contactDetails ) throws RemoteException; public void updateMetadataEditorField( String editorName, String contactDetails ) throws RemoteException; public void updateMetadataContributorField( String roleName, String contributorName, String contactDetails, String languageCode ) throws RemoteException; public void updateMetadataKeywords( String[] keywords, String languageCode ) throws RemoteException; public void importImsPackage( String url, boolean parentacl, String zipfile ) throws RemoteException, BuildingServerException; public Menu getResourceMenu() throws RemoteException, BuildingServerException; public void generateResourceMenu() throws RemoteException, BuildingServerException; public void invalidateResourceMenu() throws RemoteException, BuildingServerException; public String transferResourceMenu( String current_pathname ) throws RemoteException, BuildingServerException; }