broker-core/src/main/java/org/apache/qpid/server/store/serializer/MessageStoreSerializer.java

/*
 *
 * 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.store.serializer;

import java.io.DataInputStream;
import java.io.IOException;
import java.io.InputStream;
import java.io.OutputStream;
import java.util.Map;
import java.util.UUID;

import org.apache.qpid.server.plugin.Pluggable;
import org.apache.qpid.server.store.MessageStore;
import org.apache.qpid.server.store.serializer.v1.MessageStoreSerializer_v1;

public interface MessageStoreSerializer extends Pluggable
{
    String LATEST = MessageStoreSerializer_v1.VERSION;
    void serialize(final Map<UUID, String> queueMap,
                   final MessageStore.MessageStoreReader storeReader,
                   OutputStream outputStream) throws IOException;
    void deserialize(final Map<String, UUID> queueMap, MessageStore store, InputStream inputStream) throws IOException;

    interface Factory
    {
        MessageStoreSerializer newInstance();
        MessageStoreSerializer newInstance(DataInputStream input) throws IOException;
    }

    Factory FACTORY = new MessageStoreSerializerFactory();
}