org.eclipse.ditto.connectivity.service.messaging.httppush.HttpPushContext Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of ditto-connectivity-service Show documentation

Eclipse Ditto is a framework for creating and managing digital twins in the IoT.

There is a newer version: 3.5.6

Show newest version

/*
 * Copyright (c) 2019 Contributors to the Eclipse Foundation
 *
 * See the NOTICE file(s) distributed with this work for additional
 * information regarding copyright ownership.
 *
 * This program and the accompanying materials are made available under the
 * terms of the Eclipse Public License 2.0 which is available at
 * http://www.eclipse.org/legal/epl-2.0
 *
 * SPDX-License-Identifier: EPL-2.0
 */
package org.eclipse.ditto.connectivity.service.messaging.httppush;

import org.eclipse.ditto.connectivity.api.ExternalMessage;
import org.eclipse.ditto.connectivity.service.messaging.monitoring.ConnectionMonitor;

import akka.http.javadsl.model.HttpResponse;
import scala.util.Try;

/**
 * Context which passes through the {@link ExternalMessage} to publish to an HTTP endpoint and the {@code requestUri}.
 * Contains the logic to handle 1 response from the HTTP endpoint.
 */
interface HttpPushContext {

    /**
     * @param response the tried {@code HttpResponse} to get status, headers from.
     */
    void onResponse(Try response);

    /**
     * @return the {@code InfoProvider} to e.g. extract a {@code correlation-id} from during connection logging.
     */
    ConnectionMonitor.InfoProvider getInfoProvider();
}