summaryrefslogtreecommitdiff
path: root/qpid/java/common/src/main/java/org/apache/qpid/codec/AMQDecoder.java
blob: 7732ff2fd51fd8ba8796065863535532052937b1 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
/*
 *
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 *
 */
package org.apache.qpid.codec;

import java.util.ArrayList;

import org.apache.mina.common.ByteBuffer;
import org.apache.mina.common.SimpleByteBufferAllocator;

import org.apache.qpid.framing.AMQDataBlock;
import org.apache.qpid.framing.AMQDataBlockDecoder;
import org.apache.qpid.framing.AMQFrameDecodingException;
import org.apache.qpid.framing.AMQMethodBodyFactory;
import org.apache.qpid.framing.AMQProtocolVersionException;
import org.apache.qpid.framing.ProtocolInitiation;
import org.apache.qpid.protocol.AMQVersionAwareProtocolSession;

/**
 * AMQDecoder delegates the decoding of AMQP either to a data block decoder, or in the case of new connections, to a
 * protocol initiation decoder. It is a cumulative decoder, which means that it can accumulate data to decode in the
 * buffer until there is enough data to decode.
 *
 * <p/>One instance of this class is created per session, so any changes or configuration done at run time to the
 * decoder will only affect decoding of the protocol session data to which is it bound.
 *
 * <p/><table id="crc"><caption>CRC Card</caption>
 * <tr><th> Responsibilities <th> Collaborations
 * <tr><td> Delegate protocol initiation to its decoder. <td> {@link ProtocolInitiation.Decoder}
 * <tr><td> Delegate AMQP data to its decoder. <td> {@link AMQDataBlockDecoder}
 * <tr><td> Accept notification that protocol initiation has completed.
 * </table>
 *
 * @todo If protocol initiation decoder not needed, then don't create it. Probably not a big deal, but it adds to the
 *       per-session overhead.
 */
public class AMQDecoder
{
    /** Holds the 'normal' AMQP data decoder. */
    private AMQDataBlockDecoder _dataBlockDecoder = new AMQDataBlockDecoder();

    /** Holds the protocol initiation decoder. */
    private ProtocolInitiation.Decoder _piDecoder = new ProtocolInitiation.Decoder();

    /** Flag to indicate whether this decoder needs to handle protocol initiation. */
    private boolean _expectProtocolInitiation;
    private boolean firstDecode = true;

    private AMQMethodBodyFactory _bodyFactory;

    private ByteBuffer _remainingBuf;
    
    /**
     * Creates a new AMQP decoder.
     *
     * @param expectProtocolInitiation <tt>true</tt> if this decoder needs to handle protocol initiation.
     */
    public AMQDecoder(boolean expectProtocolInitiation, AMQVersionAwareProtocolSession session)
    {
        _expectProtocolInitiation = expectProtocolInitiation;
        _bodyFactory = new AMQMethodBodyFactory(session);
    }



    /**
     * Sets the protocol initation flag, that determines whether decoding is handled by the data decoder of the protocol
     * initation decoder. This method is expected to be called with <tt>false</tt> once protocol initation completes.
     *
     * @param expectProtocolInitiation <tt>true</tt> to use the protocol initiation decoder, <tt>false</tt> to use the
     *                                data decoder.
     */
    public void setExpectProtocolInitiation(boolean expectProtocolInitiation)
    {
        _expectProtocolInitiation = expectProtocolInitiation;
    }


    private static final SimpleByteBufferAllocator SIMPLE_BYTE_BUFFER_ALLOCATOR = new SimpleByteBufferAllocator();

    public ArrayList<AMQDataBlock> decodeBuffer(java.nio.ByteBuffer buf) throws AMQFrameDecodingException, AMQProtocolVersionException
    {

        // get prior remaining data from accumulator
        ArrayList<AMQDataBlock> dataBlocks = new ArrayList<AMQDataBlock>();
        ByteBuffer msg;
        // if we have a session buffer, append data to that otherwise
        // use the buffer read from the network directly
        if( _remainingBuf != null )
        {
            _remainingBuf.put(buf);
            _remainingBuf.flip();
            msg = _remainingBuf;
        }
        else
        {
            msg = ByteBuffer.wrap(buf);
        }
        
        if (_expectProtocolInitiation  
            || (firstDecode
                && (msg.remaining() > 0)
                && (msg.get(msg.position()) == (byte)'A')))
        {
            if (_piDecoder.decodable(msg.buf()))
            {
                dataBlocks.add(new ProtocolInitiation(msg.buf()));
            }
        }
        else
        {
            boolean enoughData = true;
            while (enoughData)
            {
                int pos = msg.position();

                enoughData = _dataBlockDecoder.decodable(msg);
                msg.position(pos);
                if (enoughData)
                {
                    dataBlocks.add(_dataBlockDecoder.createAndPopulateFrame(_bodyFactory, msg));
                }
                else
                {
                    _remainingBuf = SIMPLE_BYTE_BUFFER_ALLOCATOR.allocate(msg.remaining(), false);
                    _remainingBuf.setAutoExpand(true);
                    _remainingBuf.put(msg);
                }
            }
        }
        if(firstDecode && dataBlocks.size() > 0)
        {
            firstDecode = false;
        }
        return dataBlocks;
    }
}