org.apache.activemq.artemis.core.paging.cursor.PagedReference Maven / Gradle / Ivy

/*
 * 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.activemq.artemis.core.paging.cursor;

import org.apache.activemq.artemis.core.paging.PagedMessage;
import org.apache.activemq.artemis.core.server.MessageReference;

public interface PagedReference extends MessageReference {

   PagePosition getPosition();

   PagedMessage getPagedMessage();

   boolean isLargeMessage();

   long getTransactionID();

   /** this method affects paging clean up
       It adds to the flag that prevents its page from cleanup.
       It's a helper method to call the proper {@link PageSubscription#addPendingDelivery(PagePosition)}

    @see PageSubscription#addPendingDelivery(PagePosition)
    */
   void addPendingFlag();

   /** this method affects paging clean up
    It adds to the flag that prevents its page from cleanup.
    It's a helper method to call the proper {@link PageSubscription#addPendingDelivery(PagePosition)}

    @see PageSubscription#addPendingDelivery(PagePosition)
    */
   void removePendingFlag();
}