org.eclipse.ditto.wot.model.AdditionalSecurityScheme Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of ditto-wot-model Show documentation
Eclipse Ditto is a framework for creating and managing digital twins in the IoT.
The 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.wot.model;

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

import org.eclipse.ditto.json.JsonObject;

/**
 * An AdditionalSecurityScheme is a {@link SecurityScheme} which can be defined via {@code TD Context Extension}
 * mechanism for new security schemes not included in the "Security Vocabulary Definitions".
 *
 * @see WoT TD Context Extension
 * @see WoT TD Adding Security Schemes
 * @since 3.0.0
 */
public interface AdditionalSecurityScheme extends SecurityScheme {

    static AdditionalSecurityScheme fromJson(final String securitySchemeName, final JsonObject jsonObject) {
        return new ImmutableAdditionalSecurityScheme(securitySchemeName, jsonObject);
    }

    static AdditionalSecurityScheme.Builder newBuilder(final CharSequence securitySchemeName,
            final CharSequence contextExtensionScopedScheme) {
        return AdditionalSecurityScheme.Builder.newBuilder(securitySchemeName, contextExtensionScopedScheme);
    }

    static AdditionalSecurityScheme.Builder newBuilder(final CharSequence securitySchemeName,
            final CharSequence contextExtensionScopedScheme,
            final JsonObject jsonObject) {
        return AdditionalSecurityScheme.Builder.newBuilder(securitySchemeName, contextExtensionScopedScheme, jsonObject);
    }

    interface Builder extends SecurityScheme.Builder {

        static AdditionalSecurityScheme.Builder newBuilder(final CharSequence securitySchemeName,
                final CharSequence contextExtensionScopedScheme) {
            final SecuritySchemeScheme scheme = SecuritySchemeScheme.of(
                    checkNotNull(contextExtensionScopedScheme, "contextExtensionScopedScheme"));
            final MutableAdditionalSecuritySchemeBuilder additionalSecuritySchemeBuilder =
                    new MutableAdditionalSecuritySchemeBuilder(
                            checkNotNull(securitySchemeName, "securitySchemeName").toString(),
                            scheme,
                            JsonObject.newBuilder());
            return additionalSecuritySchemeBuilder.setScheme(scheme);
        }

        static AdditionalSecurityScheme.Builder newBuilder(final CharSequence securitySchemeName,
                final CharSequence contextExtensionScopedScheme, final JsonObject jsonObject) {
            return new MutableAdditionalSecuritySchemeBuilder(
                    checkNotNull(securitySchemeName, "securitySchemeName").toString(),
                    SecuritySchemeScheme.of(
                            checkNotNull(contextExtensionScopedScheme, "contextExtensionScopedScheme")),
                    jsonObject.toBuilder());
        }

    }
}