org.eclipse.ditto.connectivity.model.HonoConnection Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of ditto-connectivity-model Show documentation
Eclipse Ditto is a framework for creating and managing digital twins in the IoT.
There is a newer version: 3.6.2
Show newest version
/*
 * Copyright (c) 2022 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.model;

import static org.eclipse.ditto.base.model.common.ConditionChecker.checkNotNull;

import java.text.MessageFormat;

import javax.annotation.Nullable;
import javax.annotation.concurrent.Immutable;
import javax.annotation.concurrent.NotThreadSafe;

import org.eclipse.ditto.json.JsonObject;
import org.eclipse.ditto.json.JsonParseException;

/**
 * Immutable implementation of {@link AbstractConnection} of {@link ConnectionType} HONO.
 *
 * @since 3.2.0
 */
@Immutable
final class HonoConnection extends AbstractConnection {

    private HonoConnection(final Builder builder) {
        super(builder);
    }

    @Override
    ConnectionUri getConnectionUri(@Nullable String builderConnectionUri) {
        return ConnectionUri.of(builderConnectionUri);
    }

    static ConnectionType getConnectionTypeOrThrow(final JsonObject jsonObject) {
        final String readConnectionType = jsonObject.getValueOrThrow(JsonFields.CONNECTION_TYPE);
        return ConnectionType.forName(readConnectionType).filter(type -> type == ConnectionType.HONO)
                .orElseThrow(() -> JsonParseException.newBuilder()
                        .message(MessageFormat.format("Connection type <{0}> is invalid! Connection type must be of" +
                                " type <{1}>.", readConnectionType, ConnectionType.HONO))
                        .build());
    }

    /**
     * Returns a new {@code ConnectionBuilder} object.
     *
     * @param id the connection ID.
     * @param connectionType the connection type.
     * @param connectionStatus the connection status.
     * @param uri the URI.
     * @return new instance of {@code ConnectionBuilder}.
     * @throws NullPointerException if any argument is {@code null}.
     */
    public static ConnectionBuilder getBuilder(final ConnectionId id,
            final ConnectionType connectionType,
            final ConnectivityStatus connectionStatus,
            final String uri) {

        return new HonoConnection.Builder(connectionType)
                .id(id)
                .connectionStatus(connectionStatus)
                .uri(ConnectionUri.of(uri).toString());
    }

    /**
     * Returns a new {@code ConnectionBuilder} object.
     *
     * @param connection the connection to use for initializing the builder.
     * @return new instance of {@code ConnectionBuilder}.
     * @throws NullPointerException if {@code connection} is {@code null}.
     */
    public static ConnectionBuilder getBuilder(final Connection connection) {
        checkNotNull(connection, "connection");
        return fromConnection(connection,
                new HonoConnection.Builder(connection.getConnectionType()));
    }

    /**
     * Creates a new {@code Connection} object from the specified JSON object.
     *
     * @param jsonObject a JSON object which provides the data for the Connection to be created.
     * @return a new Connection which is initialised with the extracted data from {@code jsonObject}.
     * @throws NullPointerException if {@code jsonObject} is {@code null}.
     * @throws org.eclipse.ditto.json.JsonParseException if {@code jsonObject} is not an appropriate JSON object.
     * @throws org.eclipse.ditto.json.JsonMissingFieldException if {@code jsonObject} does not contain a value at the defined location.
     */
    public static Connection fromJson(final JsonObject jsonObject) {
        final ConnectionType type = getConnectionTypeOrThrow(jsonObject);
        final HonoConnection.Builder builder = new HonoConnection.Builder(type);
        buildFromJson(getJsonObjectWithEmptyUri(jsonObject), builder);
        return builder.build();
    }

    private static JsonObject getJsonObjectWithEmptyUri(final JsonObject jsonObject) {
        if (!jsonObject.contains(JsonFields.URI.getPointer())) {
            return jsonObject.set(JsonFields.URI, "");
        }
        if (!jsonObject.getValue(Connection.JsonFields.URI).isPresent()) {
            return jsonObject.set(JsonFields.URI, "");
        }
        return jsonObject;
    }

    /**
     * Builder for {@code AbstractConnectionBuilder}.
     */
    @NotThreadSafe
    private static final class Builder extends AbstractConnectionBuilder {

        Builder(final ConnectionType connectionType) {
            super(connectionType);
        }

        @Override
        public Connection build() {
            super.checkSourceAndTargetAreValid();
            super.checkAuthorizationContextsAreValid();
            super.checkConnectionAnnouncementsOnlySetIfClientCount1();
            super.migrateLegacyConfigurationOnTheFly();
            return new HonoConnection(this);
        }

    }

}