source/mir/media/MediaHandler.java

   1 /*
   2  * Copyright (C) 2001, 2002 The Mir-coders group
   3  *
   4  * This file is part of Mir.
   5  *
   6  * Mir is free software; you can redistribute it and/or modify
   7  * it under the terms of the GNU General Public License as published by
   8  * the Free Software Foundation; either version 2 of the License, or
   9  * (at your option) any later version.
  10  *
  11  * Mir is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14  * GNU General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU General Public License
  17  * along with Mir; if not, write to the Free Software
  18  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  19  *
  20  * In addition, as a special exception, The Mir-coders gives permission to link
  21  * the code of this program with  any library licensed under the Apache Software License,
  22  * The Sun (tm) Java Advanced Imaging library (JAI), The Sun JIMI library
  23  * (or with modified versions of the above that use the same license as the above),
  24  * and distribute linked combinations including the two.  You must obey the
  25  * GNU General Public License in all respects for all of the code used other than
  26  * the above mentioned libraries.  If you modify this file, you may extend this
  27  * exception to your version of the file, but you are not obligated to do so.
  28  * If you do not wish to do so, delete this exception statement from your version.
  29  */
  30 package  mir.media;
  31
  32 import java.io.InputStream;
  33 import java.util.List;
  34
  35 import mir.entity.Entity;
  36
  37 /**
  38  * Interface for Media handling in Mir. All media handlers
  39  * must implement this interface. Each specific media type,
  40  * be it Gif, Jpeg, Mp3 audio, Real Audio or quicktime video
  41  * has special needs when it comes to representation on the various
  42  * pages (article, list, summary), must be stored differently and has a
  43  * different URL, etc... This interface allows Mir to support
  44  * an infinite (I hope) number of media types. Once this is done,
  45  * no code at any other level in Mir needs to be changed other than
  46  * adding the content-type <-> media handler name mapping in the
  47  * media_type table. The following is an example of the media_type
  48  * table:
  49  * <p>
  50  * id |  name   |        mime_type         | classname |   tablename   | dcname<br>
  51  *---+---------+--------------------------+-----------+---------------+-------<br>
  52  *  2 | unknown | application/octet-stream | --        | UploadedMedia | <br>
  53  *  3 | jpg     | image/gif                | ImagesGif | Images        | <br>
  54  *  4 | mp3     | audio/mp3                | Audio     | UploadedMedia | <br>
  55  * <p>
  56  * The "id" field is used as a mapping in the table that contains the media type
  57  * to the media_type table. For example, the images table has a to_media_type
  58  * field that contains the id in the media_type table.
  59  * <p>
  60  * The "name" field is used for various display/filenaming purposes. it should
  61  * match a valid file extension name for a media_type (we could have used the
  62  * content-type map for this....).
  63  * <p>
  64  * The "mime_type" field is the most important as it does maps the type to Java
  65  * classes (the storage and media_handler name). We call those classes using
  66  * reflection. This way, once a Handler for a specific media type is implemented
  67  * and entered into the media_type table, no other Mir code needs to be modified.
  68  * <p>
  69  * The "classname" field is the name of the media handler (e.g MediaHandlerAudio)
  70  * we use it to call the MediaHandler methods via reflection.
  71  * <p>
  72  * The "tablename" is the name of the database storage classes (e.g DatabaseImages
  73  * and EntityImages). We use this to fetch/storage the media (meta)data in the db.
  74  * <p?
  75  * The "dcname" field is as of yet unused. Do search for "Dublin Core" on google
  76  * to learn more.
  77  * <p>
  78  * Most media handlers should just extend MediaHandlerGeneric (i.e inherit from
  79  * ) and just override the things that need to be specific. see MediaHandlerAudio
  80  *
  81  * @author <mh@nadir.org>, the Mir-coders group
  82  * @version $Id: MediaHandler.java,v 1.1.2.2 2003/12/21 13:32:03 zapata Exp $
  83  */
  84
  85 public interface MediaHandler {
  86   /**
  87    * Takes the uploaded media data itself, along with the media Entity
  88    * which contains the Media metadata plus the MediaType entity containing
  89    * all the info for the specific media type itself. It's job is store the
  90    * Media data (content) itself, this could be on the local filesystem, in the
  91    * DB or even on a remote host. It then inserts the MetaData in the DB.
  92    * @param InputStream, a stream of the uploaded data.
  93    * @param ent, an Entity holding the media MetaData
  94    * @param mediaType, an Entity holding the media_table entry
  95    * @return boolean, success/fail
  96    * @see mir.entity.Entity
  97    */
  98   public void store(InputStream in, Entity ent, Entity mediaTypeEnt ) throws MediaExc, MediaFailure;
  99
 100   public void produce(Entity ent, Entity mediaTypeEnt ) throws MediaExc, MediaFailure;
 101   /**
 102    * Get's the media data from storage and returns it as an InputStream
 103    * Not very useful for most media types as they are stored in a file,
 104    * but very usefull for ones stored in the DB as it is necessary to get
 105    * it first before making a file out of it (in Producer*).
 106    * @param ent, an Entity holding the media MetaData
 107    * @param mediaType, an Entity holding the media_table entry
 108    * @return java.io.InputStream
 109    * @see mir.entity.Entity
 110    */
 111   public InputStream getMedia (Entity ent, Entity mediaTypeEnt) throws MediaExc, MediaFailure;
 112
 113   /**
 114    * Pretty much like get() above. But get's the specific Icon
 115    * representation. useful for media stored in the DB.
 116    * @param ent, an Entity holding the media MetaData
 117    * @return java.io.InputStream
 118    * @see mir.entity.Entity
 119    */
 120   public InputStream getThumbnail(Entity ent) throws MediaExc, MediaFailure;
 121
 122
 123   /**
 124    *
 125    * @param ent
 126    * @return
 127    * @throws MediaExc
 128    * @throws MediaFailure
 129    */
 130   public String getThumbnailMimeType(Entity aMediaEntity, Entity aMediaType) throws MediaExc, MediaFailure;
 131
 132   /**
 133    * gets the final content representation for the media
 134    * in the form of a URL (String) that allows someone to
 135    * download, look at or listen to the media. (HREF, img src
 136    * streaming link, etc..)
 137    * It should use the helper functions in the StringUtil class to
 138    * build URL's safely, eliminating any *illegal* user input.
 139    * @param ent, an Entity holding the media MetaData
 140    * @param mediaTypeEnt, an Entity holding the media_table entry
 141    * @return String, the url.
 142    * @see mir.entity.Entity
 143    * @see mir.misc.StringUtil
 144    */
 145   public List getURL (Entity ent, Entity mediaTypeEnt) throws MediaExc, MediaFailure;
 146
 147         /**
 148    * Returns the absolute filesystem path to where the media
 149    * content should be stored. This path is usually defined
 150    * in the configuration wich is accessible through the MirConfig
 151    * class.
 152    * @return String, the path.
 153    * @see mir.misc.MirConfig
 154    */
 155   public String getStoragePath () throws MediaExc, MediaFailure;
 156
 157         /**
 158    * Returns the *relative* filesystem path to where the media
 159    * icon content should be stored. It is relative to the path
 160    * returned by getStoragePath()
 161    * This path is usually defined
 162    * in the configuration wich is accessible through the MirConfig
 163    * class.
 164    * @return String, the path.
 165    * @see mir.misc.MirConfig
 166    */
 167   public String getIconStoragePath () throws MediaExc, MediaFailure;
 168
 169         /**
 170    * Returns the base URL to that the media is accessible from
 171    * to the end user. This could be a URL to another host.
 172    * This is used in the Metadata stored in the DB and later on
 173    * ,the templates use it.
 174    * It is usually defined
 175    * in the configuration witch is accessible through the MirConfig
 176    * class.
 177    * @return String, the base URL to the host.
 178    * @see mir.misc.MirConfig
 179    */
 180   public String getPublishHost () throws MediaExc, MediaFailure;
 181
 182         /**
 183    * Returns the file name of the Icon representing the media type.
 184    * It is used in the summary view.
 185    * It is usually defined
 186    * in the configuration wich is accessible through the MirConfig
 187    * class.
 188    * @return String, the icon filename.
 189    * @see mir.misc.MirConfig
 190    */
 191   public String getBigIconName ();
 192
 193         /**
 194    * Returns the file name of the small Icon representing
 195    * the media type.
 196    * It is used in the right hand newswire list of the startpage.
 197    * It is usually defined
 198    * in the configuration wich is accessible through the MirConfig
 199    * class.
 200    * @return String, the icon filename.
 201    * @see mir.misc.MirConfig
 202    */
 203   public String getTinyIconName ();
 204
 205   /**
 206    * Returns the IMG SRC "ALT" text to be used
 207    * for the Icon representations
 208    * @return String, the ALT text.
 209    */
 210   public String getIconAltName ();
 211
 212   /**
 213    * returns a brief text dscription of what this
 214    * media type is.
 215    * @return String
 216    */
 217   public String getDescr (Entity mediaTypeEnt);
 218
 219 }
 220
 221