001: /*
002: * JOnAS: Java(TM) Open Application Server
003: * Copyright (C) 1999-2004 Bull S.A.
004: * Contact: jonas-team@objectweb.org
005: *
006: * This library is free software; you can redistribute it and/or
007: * modify it under the terms of the GNU Lesser General Public
008: * License as published by the Free Software Foundation; either
009: * version 2.1 of the License, or any later version.
010: *
011: * This library is distributed in the hope that it will be useful,
012: * but WITHOUT ANY WARRANTY; without even the implied warranty of
013: * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
014: * Lesser General Public License for more details.
015: *
016: * You should have received a copy of the GNU Lesser General Public
017: * License along with this library; if not, write to the Free Software
018: * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
019: * USA
020: *
021: * Initial developer(s): ____________________________________.
022: * Contributor(s): ______________________________________.
023: *
024: * --------------------------------------------------------------------------
025: * $Id$
026: * --------------------------------------------------------------------------
027: */
028:
029: package emb.sample.session;
030:
031: import java.io.InputStream;
032: import java.net.URL;
033:
034: import javax.ejb.EJBLocalObject;
035: import javax.emb.Media;
036: import javax.emb.MediaEntityLocal;
037:
038: import emb.sample.MediaSampleException;
039:
040: /**
041: * Local interface for the bean MediaSampleSessionLocal
042: */
043: public interface MediaSampleSessionLocal extends EJBLocalObject {
044:
045: /**
046: * Set if the media has to be show in media list
047: */
048: byte SHOW_IN_LIST = 0;
049:
050: /**
051: * Set if the media has to be show in media list and if the media has been
052: * upload
053: */
054: byte USER_ADDED = 1;
055:
056: /**
057: * Set if the media is not showed is media list
058: */
059: byte DONT_SHOW = -1;
060:
061: /**
062: * Create a new MediaEntity from a stream
063: *
064: * @param contentStream content of the MediaEntity
065: * @param name name of the MediaEntity
066: * @param description description of the MediaEntity
067: * @param status is ones of {@link MediaSampleSessionLocal#DONT_SHOW},
068: * {@link MediaSampleSessionLocal#SHOW_IN_LIST},
069: * {@link MediaSampleSessionLocal#USER_ADDED}
070: * @param registeredName name to acces it with
071: * {@link #getMediaFromRegistredName(String)}
072: * @return MediaEntity
073: * @throws MediaSampleException if the mediaEntity cannot be create
074: */
075: MediaEntityLocal createMediaEntity(InputStream contentStream,
076: String name, String description, byte status,
077: String registeredName) throws MediaSampleException;
078:
079: /**
080: * Create a new MediaEntity from an URL
081: *
082: * @param urlToImport of the media to import
083: * @param description description of the MediaEntity
084: * @param status is ones of {@link MediaSampleSessionLocal#DONT_SHOW},
085: * {@link MediaSampleSessionLocal#SHOW_IN_LIST},
086: * {@link MediaSampleSessionLocal#USER_ADDED}
087: * @return MediaEntity
088: * @throws MediaSampleException if the mediaEntity cannot be create
089: */
090: MediaEntityLocal createMediaEntity(URL urlToImport,
091: String description, byte status)
092: throws MediaSampleException;
093:
094: /**
095: * Create a new MediaEntity from a Media
096: *
097: * @param media to copy
098: * @return MediaEntity
099: * @throws MediaSampleException if the mediaEntity cannot be create
100: */
101: MediaEntityLocal copyMediaEntity(Media media)
102: throws MediaSampleException;
103:
104: /**
105: * Get media list (only status {@link MediaSampleSessionLocal#SHOW_IN_LIST},
106: * {@link MediaSampleSessionLocal#USER_ADDED}
107: *
108: * @return MediaEntity array
109: * @throws MediaSampleException if media cannot be retrive
110: */
111:
112: MediaEntityLocal[] getMediaList() throws MediaSampleException;
113:
114: /**
115: * Get media from its premary key
116: *
117: * @param primaryKey the primary key of the wanted media
118: * @return MediaEntity
119: * @throws MediaSampleException if the mediaEntity cannot be retrive
120: */
121: MediaEntityLocal getMediaFromPrimaryKey(String primaryKey)
122: throws MediaSampleException;
123:
124: /**
125: * Get media from registered name
126: *
127: * @param registeredName the registeredName of the wanted media
128: * @return MediaEntity
129: * @throws MediaSampleException if the mediaEntity cannot be retrive
130: */
131: MediaEntityLocal getMediaFromRegistredName(String registeredName)
132: throws MediaSampleException;
133:
134: /**
135: * Remove default media to reinit the database, except uploaded media
136: */
137: void removeDefaultMedia();
138: }
|