io.micronaut.microstream.rest.MicroStreamRestService Maven / Gradle / Ivy

Go to download
/*
 * Copyright 2017-2022 original authors
 *
 * 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
 *
 * https://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 io.micronaut.microstream.rest;

import io.micronaut.core.annotation.NonNull;
import one.microstream.storage.restadapter.types.StorageRestAdapter;

import java.util.Optional;

/**
 * MicroStream REST service.
 *
 * @author Tim Yates
 * @since 1.0.0
 */
public interface MicroStreamRestService {

    /**
     * Get the single adapter for a given storage name.
     *
     * @param name the storage name
     * @return the adapter
     */
    @NonNull
    StorageRestAdapter getAdapter(@NonNull String name);

    /**
     * Returns a single adaptor if only one is available.
     *
     * @return The adaptor if only one is defined, or an empty optional if multiple are defined.
     */
    @NonNull
    Optional singleAdapter();
}