org.eclipse.ditto.connectivity.service.mapping.MessageMapperRegistry Maven / Gradle / Ivy

/*
 * Copyright (c) 2017 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.mapping;

import java.util.List;

import org.eclipse.ditto.connectivity.model.PayloadMapping;

/**
 * Defines a collection of mappers with a fallback default mapper.
 */
public interface MessageMapperRegistry {

    /**
     * Returns a mapper with the supposed role of a fallback mapping strategy.
     *
     * @return the default mapper
     */
    MessageMapper getDefaultMapper();

    /**
     * Returns the {@link MessageMapper}s to use for mapping.
     *
     * @param payloadMapping the payload mapping
     * @return the list of resolved mappers
     */
    List getMappers(PayloadMapping payloadMapping);

    /**
     * Checks if the defined {@link PayloadMapping} can be resolved using this registry.
     *
     * @param payloadMapping the payload mapping
     * @throws org.eclipse.ditto.connectivity.model.ConnectionConfigurationInvalidException if one or more mappers
     * cannot be resolved by the registry
     */
    void validatePayloadMapping(PayloadMapping payloadMapping);
}