summaryrefslogtreecommitdiff
path: root/trunk/qpid/java/management/client/src/main/java/org/apache/qpid/management/messages/ManagementMessage.java
blob: 2fa20fb456723c5bea30ea834f9fd5125ee8eec1 (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
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
/*
 *
 * 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.management.messages;

import java.io.IOException;
import java.nio.ByteBuffer;

import org.apache.qpid.api.Message;
import org.apache.qpid.management.configuration.Configuration;
import org.apache.qpid.management.domain.services.SequenceNumberGenerator;
import org.apache.qpid.transport.DeliveryProperties;
import org.apache.qpid.transport.Header;
import org.apache.qpid.transport.MessageProperties;
import org.apache.qpid.transport.codec.BBEncoder;

/**
 * Message implementation used for specific management purposes.
 * 
 * @author Andrea Gazzarini
 */
public abstract class ManagementMessage implements Message
{
    /**
     * Strategy interface for building / getting data.
     * 
     * @author Andrea Gazzarini
     */
    private interface IDataBuilderStrategy 
    {
       ByteBuffer getData(); 
    };
    
    /**
     * Strategy used for retrieving raw data from this message when it has been already encoded.
     */
    IDataBuilderStrategy READING = new IDataBuilderStrategy()
    {
        public ByteBuffer getData() {
            return _data;
        };
    };
    
    /**
     * Strategy used for retrieving raw data from this message when it hasn't been already encoded.
     */
    IDataBuilderStrategy ACCUMULATING = new IDataBuilderStrategy()
    {
        public ByteBuffer getData() {
        	_codec.writeInt8((byte)opcode());
            _codec.writeSequenceNo(sequenceNumber());
            
            specificMessageEncoding();
            
            _data =_codec.segment(); 
            _reader = READING;
            return _data;
        }
    };    
    
    protected BBEncoder _codec;
    protected ByteBuffer _data;
    private int _messageTransferId;
    private IDataBuilderStrategy _reader = ACCUMULATING;    
    
    /**
     * Builds an empty  management message.
     */
    ManagementMessage()
    {
        _codec = new BBEncoder(100);
        _codec.writeMagicNumber();
    }

    /**
     * Returns the sequence number that will be used for this message.
     * 
     * @return the sequence number that will be used for this message.
     */
    protected int sequenceNumber ()
    {
        return SequenceNumberGenerator.getNextSequenceNumber();
    }

    /**
     * Returns the opcode that will be used for this message.
     * 
     * @return the opcode that will be used for this message.
     */
    abstract char opcode ();

    /**
     * Returns the delivery properties of this message.
     * 
     * @return the delivery properties of this message.
     */
    public DeliveryProperties getDeliveryProperties ()
    {
        return Configuration.getInstance().getCommandDeliveryProperties();
    }

    /**
     * Returns the header of this message.
     * 
     * @return the header of this message.
     */
    public Header getHeader ()
    {
        return Configuration.getInstance().getCommandMessageHeader();
    }

    /**
     * Returns the messages header properties of this message.
     * 
     * @return the message header properties of this message.
     */
    public MessageProperties getMessageProperties ()
    {
        return Configuration.getInstance().getCommandMessageProperties();
    }
    
    /**
     * Returns the transfer Id of this message.
     * 
     * @return the transfer Id of this message.
     */
    public int getMessageTransferId ()
    {
        return _messageTransferId;
    }

    /**
     * Returns the encoded data of this message.
     * 
     * @return the encoded data of this message.
     */
    public ByteBuffer readData () throws IOException
    {
        return _reader.getData();
    }

    /**
     * Sets the header for this message.
     * 
     * @param header the new message header.
     */
    public void setHeader (Header header)
    {
       // N.A. at the moment.
    }

    public void appendData (byte[] src) throws IOException
    {
    }

    public void appendData (ByteBuffer src) throws IOException
    {
    }

    public void clearData ()
    {
    }

    public void readData (byte[] target) throws IOException
    {
    }
    
    /**
     * Concrete subclasses (message implementations) must define here their specific data encoding.
     */
    abstract void specificMessageEncoding();    
}