KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > objectweb > dream > message > codec > CodecManager


1 /**
2  * Dream
3  * Copyright (C) 2003-2004 INRIA Rhone-Alpes
4  *
5  * This library is free software; you can redistribute it and/or
6  * modify it under the terms of the GNU Lesser General Public
7  * License as published by the Free Software Foundation; either
8  * version 2 of the License, or (at your option) any later version.
9  *
10  * This library is distributed in the hope that it will be useful,
11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13  * Lesser General Public License for more details.
14  *
15  * You should have received a copy of the GNU Lesser General Public
16  * License along with this library; if not, write to the Free Software
17  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
18  *
19  * Contact: dream@objectweb.org
20  *
21  * Initial developer(s): Matthieu Leclercq
22  * Contributor(s):
23  */
24
25 package org.objectweb.dream.message.codec;
26
27 import java.util.Map JavaDoc;
28
29 import org.objectweb.fractal.api.Component;
30
31 /**
32  * Component insterface that manage dynamic codecs. Each codec is identified
33  * with a codec name.
34  */
35 public interface CodecManager
36 {
37
38   /** The default name of interface of this type. */
39   String JavaDoc ITF_NAME = "codec-manager";
40
41   /**
42    * Adds a codec component for the specified codec name. If a codec component
43    * for the given codec name is already present, this method do nothig.
44    *
45    * @param codecName the name of the codec.
46    * @param context additional parameters.
47    * @throws CodecManagerException if the manager can't add the codec.
48    */
49   void addCodec(String JavaDoc codecName, Map JavaDoc context) throws CodecManagerException;
50
51   /**
52    * Removes a codec component. The codec component must not be in use (i.e. the
53    * component is not shared by different composites).
54    *
55    * @param codecName the name of the codec.
56    * @throws CodecManagerException the the given codec name is unknown, or if
57    * the codec component is in use.
58    */
59   void removeCodec(String JavaDoc codecName) throws CodecManagerException;
60
61   /**
62    * Returns the codec component for the given codec name.
63    *
64    * @param codecName the name of the codec.
65    * @return the codec component for the given codec name.
66    * @throws CodecManagerException the the given codec name is unknown.
67    */
68   Component getCodec(String JavaDoc codecName) throws CodecManagerException;
69 }
Popular Tags