summaryrefslogtreecommitdiff
path: root/java/broker/src/main/java/org/apache/qpid/server/queue/AMQMessageHandle.java
blob: 31b1f668fe730af76dcf71045a085f587d37f0cc (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
/**
 * User: Robert Greig
 * Date: 23-Oct-2006
 ******************************************************************************
 * (c) Copyright JP Morgan Chase Ltd 2006. All rights reserved. No part of
 * this program may be photocopied reproduced or translated to another
 * program language without prior written consent of JP Morgan Chase Ltd
 ******************************************************************************/
package org.apache.qpid.server.queue;

import org.apache.qpid.AMQException;
import org.apache.qpid.server.store.StoreContext;
import org.apache.qpid.framing.BasicPublishBody;
import org.apache.qpid.framing.ContentBody;
import org.apache.qpid.framing.ContentHeaderBody;

/**
 * A pluggable way of getting message data. Implementations can provide intelligent caching for example or
 * even no caching at all to minimise the broker memory footprint.
 *
 * The method all take a messageId to avoid having to store it in the instance - the AMQMessage container
 * must already keen the messageId so it is pointless storing it twice.
 */
public interface AMQMessageHandle
{
    ContentHeaderBody getContentHeaderBody(long messageId) throws AMQException;

    /**
     * @return the number of body frames associated with this message
     */
    int getBodyCount(long messageId) throws AMQException;

    /**
     * @return the size of the body
     */
    long getBodySize(long messageId) throws AMQException;

    /**
     * Get a particular content body
     * @param index the index of the body to retrieve, must be between 0 and getBodyCount() - 1
     * @return a content body
     * @throws IllegalArgumentException if the index is invalid
     */
    ContentBody getContentBody(long messageId, int index) throws IllegalArgumentException, AMQException;

    void addContentBodyFrame(StoreContext storeContext, long messageId, ContentBody contentBody) throws AMQException;

    BasicPublishBody getPublishBody(long messageId) throws AMQException;

    boolean isRedelivered();

    void setRedelivered(boolean redelivered);

    boolean isPersistent(long messageId) throws AMQException;

    void setPublishAndContentHeaderBody(StoreContext storeContext, long messageId, BasicPublishBody publishBody,
                                        ContentHeaderBody contentHeaderBody)
            throws AMQException;

    void removeMessage(StoreContext storeContext, long messageId) throws AMQException;

    void enqueue(StoreContext storeContext, long messageId, AMQQueue queue) throws AMQException;

    void dequeue(StoreContext storeContext, long messageId, AMQQueue queue) throws AMQException;
}