MessageService.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.sling.commons.messaging;

import java.util.Map;
import java.util.concurrent.CompletableFuture;

import javax.annotation.Nonnull;

import org.osgi.annotation.versioning.ProviderType;

@ProviderType
public interface MessageService {

    /**
     * @param message   the message to send
     * @param recipient the recipient of the message
     * @return result of sending the message
     */
    CompletableFuture<Result> send(@Nonnull final String message, @Nonnull final String recipient);

    /**
     * @param message   the message to send
     * @param recipient the recipient of the message
     * @param data      additional information (e.g. attachments) and/or parameters (e.g. sender) for the message
     * @return result of sending the message
     */
    CompletableFuture<Result> send(@Nonnull final String message, @Nonnull final String recipient, @Nonnull final Map data);

}