summaryrefslogtreecommitdiff
path: root/qpid/java/broker/src/main/java/org/apache/qpid/server/queue/AMQMessage.java
blob: e96d2ba874681ec441261e23edd3836562aa88b0 (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
/*
 *
 * 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.server.queue;

import org.apache.qpid.framing.AMQDataBlock;
import org.apache.qpid.framing.ContentHeaderBody;
import org.apache.qpid.framing.abstraction.ContentChunk;
import org.apache.qpid.framing.abstraction.MessagePublishInfo;
import org.apache.qpid.server.protocol.AMQProtocolSession;
import org.apache.qpid.server.store.StoreContext;
import org.apache.qpid.AMQException;

import java.util.Iterator;

public interface AMQMessage
{
    //Get Content relating to this message

    Long getMessageId();

    Iterator<AMQDataBlock> getBodyFrameIterator(AMQProtocolSession protocolSession, int channel);

    Iterator<ContentChunk> getContentBodyIterator();

    ContentHeaderBody getContentHeaderBody();

    ContentChunk getContentChunk(int index);

    Object getPublisherClientInstance();

    Object getPublisherIdentifier();

    MessagePublishInfo getMessagePublishInfo();

    int getBodyCount();

    long getSize();

    long getArrivalTime();



    //Check the status of this message

    /**
     * Called selectors to determin if the message has already been sent
     *
     * @return _deliveredToConsumer
     */
    boolean getDeliveredToConsumer();

    /**
     * Called to enforce the 'immediate' flag.
     *
     * @returns  true if the message is marked for immediate delivery but has not been marked as delivered
     *                              to a consumer
     */
    boolean immediateAndNotDelivered();

    /**
     * Checks to see if the message has expired. If it has the message is dequeued.
     *
     * @return true if the message has expire
     *
     * @throws org.apache.qpid.AMQException
     */
    boolean expired() throws AMQException;

    /** Is this a persistent message
     *
     * @return true if the message is persistent
     */
    boolean isPersistent();


    /**
     * Called when this message is delivered to a consumer. (used to implement the 'immediate' flag functionality).
     * And for selector efficiency.
     */
    void setDeliveredToConsumer();

    void setExpiration(long expiration);

    void setClientIdentifier(AMQProtocolSession.ProtocolSessionIdentifier sessionIdentifier);

    /**
     * This is called when all the content has been received.
     * @param storeContext
     *@param messagePublishInfo
     * @param contentHeaderBody @throws org.apache.qpid.AMQException
     */
    void setPublishAndContentHeaderBody(StoreContext storeContext, MessagePublishInfo messagePublishInfo, ContentHeaderBody contentHeaderBody)
            throws AMQException;

    void addContentBodyFrame(StoreContext storeContext, ContentChunk contentChunk, boolean isLastContentBody)
            throws AMQException;



    String toString();

    String debugIdentity();
}