View Javadoc

1   /*
2    * Copyright (c) 2005 The University of Reading
3    * All rights reserved.
4    *
5    * Redistribution and use in source and binary forms, with or without
6    * modification, are permitted provided that the following conditions
7    * are met:
8    * 1. Redistributions of source code must retain the above copyright
9    *    notice, this list of conditions and the following disclaimer.
10   * 2. Redistributions in binary form must reproduce the above copyright
11   *    notice, this list of conditions and the following disclaimer in the
12   *    documentation and/or other materials provided with the distribution.
13   * 3. Neither the name of the University of Reading, nor the names of the
14   *    authors or contributors may be used to endorse or promote products
15   *    derived from this software without specific prior written permission.
16   * 
17   * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
18   * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
19   * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
20   * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
21   * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
22   * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
23   * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
24   * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25   * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
26   * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27   */
28  
29  package uk.ac.rdg.resc.jstyx.messages;
30  
31  import org.apache.mina.common.ByteBuffer;
32  import org.apache.mina.protocol.ProtocolEncoder;
33  import org.apache.mina.protocol.ProtocolEncoderOutput;
34  import org.apache.mina.protocol.ProtocolSession;
35  import org.apache.mina.protocol.ProtocolViolationException;
36  
37  import uk.ac.rdg.resc.jstyx.messages.StyxMessage;
38  
39  /***
40   * Encoder for StyxMessages, used by MINA framework
41   *
42   * @author Jon Blower
43   * $Revision: 155 $
44   * $Date: 2005-03-16 17:56:24 +0000 (Wed, 16 Mar 2005) $
45   * $Log$
46   * Revision 1.3  2005/03/16 17:56:22  jonblower
47   * Replaced use of java.nio.ByteBuffer with MINA's ByteBuffer to minimise copying of buffers
48   *
49   * Revision 1.2  2005/03/11 14:02:16  jonblower
50   * Merged MINA-Test_20059309 into main line of development
51   *
52   * Revision 1.1.2.2  2005/03/10 18:28:44  jonblower
53   * Made decoder and encoder package-private
54   *
55   * Revision 1.1.2.1  2005/03/10 11:26:49  jonblower
56   * Moved from mina to messages package
57   *
58   * Revision 1.2  2005/03/09 16:58:42  jonblower
59   * Changes to MINA-related classes
60   *
61   * Revision 1.1  2005/03/09 08:52:25  jonblower
62   * Initial import of MINA-related classes
63   *
64   */
65  class StyxMessageEncoder implements ProtocolEncoder
66  {
67      public void encode( ProtocolSession session, Object message,
68          ProtocolEncoderOutput out )
69          throws ProtocolViolationException
70      {
71          if (!(message instanceof StyxMessage))
72          {
73              // This shouldn't happen
74              throw new ProtocolViolationException("message was not a StyxMessage");
75          }
76          StyxMessage styxMsg = (StyxMessage)message;
77          // Write the StyxMessage to the output
78          styxMsg.write(out);
79      }
80  }