Message.java
上传用户:xfwatch
上传日期:2020-12-14
资源大小:872k
文件大小:8k
源码类别:

中间件编程

开发平台:

Java

  1. /*
  2.  * JBoss, Home of Professional Open Source
  3.  * Copyright 2008, Red Hat, Inc., and others contributors as indicated
  4.  * by the @authors tag. All rights reserved.
  5.  * See the copyright.txt in the distribution for a
  6.  * full listing of individual contributors.
  7.  * This copyrighted material is made available to anyone wishing to use,
  8.  * modify, copy, or redistribute it subject to the terms and conditions
  9.  * of the GNU Lesser General Public License, v. 2.1.
  10.  * This program is distributed in the hope that it will be useful, but WITHOUT A
  11.  * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A
  12.  * PARTICULAR PURPOSE.  See the GNU Lesser General Public License for more details.
  13.  * You should have received a copy of the GNU Lesser General Public License,
  14.  * v.2.1 along with this distribution; if not, write to the Free Software
  15.  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
  16.  * MA  02110-1301, USA.
  17.  */
  18. package org.jboss.blacktie.jatmibroker.jab;
  19. /**
  20.  * The message interface is a wrapper around input output buffers.
  21.  * 
  22.  * @see JABMessage
  23.  * @see JABRemoteService
  24.  */
  25. public interface Message {
  26. /**
  27.  * Set part of the content to send. For non-array data types
  28.  * 
  29.  * @param key
  30.  *            The key of the data
  31.  * @param data
  32.  *            The data to send
  33.  * @throws JABException
  34.  *             In case the key is not of required type/does not exist
  35.  */
  36. public void setByte(String key, byte data) throws JABException;
  37. /**
  38.  * Set part of the content to send. For non-array data types
  39.  * 
  40.  * @param key
  41.  *            The key of the data
  42.  * @param data
  43.  *            The data to send
  44.  * @throws JABException
  45.  *             In case the key is not of required type/does not exist
  46.  */
  47. public void setShort(String key, short data) throws JABException;
  48. /**
  49.  * Set part of the content to send. For non-array data types
  50.  * 
  51.  * @param key
  52.  *            The key of the data
  53.  * @param data
  54.  *            The data to send
  55.  * @throws JABException
  56.  *             In case the key is not of required type/does not exist
  57.  */
  58. public void setInt(String key, int j) throws JABException;
  59. /**
  60.  * Set part of the content to send. For non-array data types
  61.  * 
  62.  * @param key
  63.  *            The key of the data
  64.  * @param data
  65.  *            The data to send
  66.  * @throws JABException
  67.  *             In case the key is not of required type/does not exist
  68.  */
  69. public void setFloat(String key, float data) throws JABException;
  70. /**
  71.  * Set part of the content to send. For non-array data types
  72.  * 
  73.  * @param key
  74.  *            The key of the data
  75.  * @param data
  76.  *            The data to send
  77.  * @throws JABException
  78.  *             In case the key is not of required type/does not exist
  79.  */
  80. public void setDouble(String key, double data) throws JABException;
  81. /**
  82.  * Get the content of the buffer at this location.
  83.  * 
  84.  * @return The content of the buffer
  85.  * @throws JABException
  86.  *             If the key does not exist or is not of requested type
  87.  */
  88. public byte getByte(String key) throws JABException;
  89. /**
  90.  * Get the content of the buffer at this location.
  91.  * 
  92.  * @return The content of the buffer
  93.  * @throws JABException
  94.  *             If the key does not exist or is not of requested type
  95.  */
  96. public short getShort(String key) throws JABException;
  97. /**
  98.  * Get the content of the buffer at this location.
  99.  * 
  100.  * @return The content of the buffer
  101.  * @throws JABException
  102.  *             If the key does not exist or is not of requested type
  103.  */
  104. public int getInt(String key) throws JABException;
  105. /**
  106.  * Get the content of the buffer at this location.
  107.  * 
  108.  * @return The content of the buffer
  109.  * @throws JABException
  110.  *             If the key does not exist or is not of requested type
  111.  */
  112. public float getFloat(String key) throws JABException;
  113. /**
  114.  * Get the content of the buffer at this location.
  115.  * 
  116.  * @return The content of the buffer
  117.  * @throws JABException
  118.  *             If the key does not exist or is not of requested type
  119.  */
  120. public double getDouble(String key) throws JABException;
  121. /**
  122.  * Set part of the content to send. For non-array data types,
  123.  * 
  124.  * @param key
  125.  *            The key of the data
  126.  * @param data
  127.  *            The data to send
  128.  * @throws JABException
  129.  *             In case the key is not of required type/does not exist
  130.  */
  131. public void setByteArray(String key, byte[] data) throws JABException;
  132. /**
  133.  * Set part of the content to send. For non-array data types,
  134.  * 
  135.  * @param key
  136.  *            The key of the data
  137.  * @param data
  138.  *            The data to send
  139.  * @throws JABException
  140.  *             In case the key is not of required type/does not exist
  141.  */
  142. public void setShortArray(String key, short[] data) throws JABException;
  143. /**
  144.  * Set part of the content to send. For non-array data types,
  145.  * 
  146.  * @param key
  147.  *            The key of the data
  148.  * @param data
  149.  *            The data to send
  150.  * @throws JABException
  151.  *             In case the key is not of required type/does not exist
  152.  */
  153. public void setIntArray(String key, int[] data) throws JABException;
  154. /**
  155.  * Set part of the content to send. For non-array data types,
  156.  * 
  157.  * @param key
  158.  *            The key of the data
  159.  * @param data
  160.  *            The data to send
  161.  * @throws JABException
  162.  *             In case the key is not of required type/does not exist
  163.  */
  164. public void setFloatArray(String key, float[] data) throws JABException;
  165. /**
  166.  * Set part of the content to send. For non-array data types,
  167.  * 
  168.  * @param key
  169.  *            The key of the data
  170.  * @param data
  171.  *            The data to send
  172.  * @throws JABException
  173.  *             In case the key is not of required type/does not exist
  174.  */
  175. public void setDoubleArray(String key, double[] data) throws JABException;
  176. /**
  177.  * Get the content of the buffer for this key.
  178.  * 
  179.  * @return The content of the buffer
  180.  * @throws JABException
  181.  *             If the key does not exist or is not of requested type
  182.  */
  183. public byte[] getByteArray(String key) throws JABException;
  184. /**
  185.  * Get the content of the buffer for this key.
  186.  * 
  187.  * @return The content of the buffer
  188.  * @throws JABException
  189.  *             If the key does not exist or is not of requested type
  190.  */
  191. public short[] getShortArray(String key) throws JABException;
  192. /**
  193.  * Get the content of the buffer for this key.
  194.  * 
  195.  * @return The content of the buffer
  196.  * @throws JABException
  197.  *             If the key does not exist or is not of requested type
  198.  */
  199. public int[] getIntArray(String key) throws JABException;
  200. /**
  201.  * Get the content of the buffer for this key.
  202.  * 
  203.  * @return The content of the buffer
  204.  * @throws JABException
  205.  *             If the key does not exist or is not of requested type
  206.  */
  207. public float[] getFloatArray(String key) throws JABException;
  208. /**
  209.  * Get the content of the buffer for this key.
  210.  * 
  211.  * @return The content of the buffer
  212.  * @throws JABException
  213.  *             If the key does not exist or is not of requested type
  214.  */
  215. public double[] getDoubleArray(String key) throws JABException;
  216. /**
  217.  * Set part of the content to send. For non-array data types,
  218.  * 
  219.  * @param key
  220.  *            The key of the data
  221.  * @param data
  222.  *            The data to send
  223.  * @throws JABException
  224.  *             In case the key is not of required type/does not exist
  225.  */
  226. public void setByteArrayArray(String key, byte[][] data)
  227. throws JABException;
  228. /**
  229.  * Get the content of the buffer for this key.
  230.  * 
  231.  * @return The content of the buffer
  232.  * @throws JABException
  233.  *             If the key does not exist or is not of requested type
  234.  */
  235. public byte[][] getByteArrayArray(String key) throws JABException;
  236. }