
com.hivemq.configuration.service.PersistenceConfigurationService Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of hivemq-community-edition-embedded Show documentation
Show all versions of hivemq-community-edition-embedded Show documentation
HiveMQ CE is a Java-based open source MQTT broker that fully supports MQTT 3.x and MQTT 5
The newest version!
/*
* Copyright 2019-present HiveMQ GmbH
*
* Licensed 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 com.hivemq.configuration.service;
import com.hivemq.extension.sdk.api.annotations.NotNull;
/**
* @author Lukas Brandl
*/
public interface PersistenceConfigurationService {
enum PersistenceMode {
/**
* All persistent data like queued messages, retained messages subscriptions and so on, will be stored on the
* file system.
*/
FILE,
/**
* All persistent data like queued messages, retained messages subscriptions and so on, will be stored in RAM.
*/
IN_MEMORY;
}
/**
* The mode that determines where persistent data is stored.
*
* @return the persistence mode.
*/
@NotNull PersistenceMode getMode();
/**
* Set the persistence mode.
* Changes will be ignored once the persistence is initialized.
*
* @param mode to use for persistent date
*/
void setMode(@NotNull final PersistenceMode mode);
}