io.helidon.service.metadata.DescriptorMetadata Maven / Gradle / Ivy

Go to download
/*
 * Copyright (c) 2024 Oracle and/or its affiliates.
 *
 * Licensed 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 io.helidon.service.metadata;

import java.util.Set;

import io.helidon.common.types.TypeName;
import io.helidon.metadata.hson.Hson;

/**
 * Metadata of a service descriptor, as stored in Helidon specific file {@value Descriptors#SERVICE_REGISTRY_LOCATION}.
 */
public interface DescriptorMetadata {
    /**
     * {@link #registryType()} for core services.
     */
    String REGISTRY_TYPE_CORE = "core";

    /**
     * Create a new instance from descriptor information, i.e. when code generating the descriptor metadata.
     *
     * @param registryType type of registry, such as {@link #REGISTRY_TYPE_CORE}
     * @param descriptor   type of the service descriptor (the generated file from {@code helidon-service-codegen})
     * @param weight       weight of the service descriptor
     * @param contracts    contracts the service implements
     * @return a new descriptor metadata instance
     */
    static DescriptorMetadata create(String registryType, TypeName descriptor, double weight, Set contracts) {
        return new DescriptorMetadataImpl(registryType, weight, descriptor, contracts);
    }

    /**
     * Type of registry, such as {@code core}.
     *
     * @return registry type this descriptor is created for
     */
    String registryType();

    /**
     * Descriptor type name.
     *
     * @return descriptor type
     */
    TypeName descriptorType();

    /**
     * Contracts of the service.
     *
     * @return contracts the service implements/provides.
     */
    Set contracts();

    /**
     * Weight of the service.
     *
     * @return service weight
     * @see io.helidon.common.Weight
     */
    double weight();

    /**
     * Create the metadata in Helidon metadata format. This is used by components that store
     * the metadata.
     *
     * @return HSON object (similar to JSON)
     */
    Hson.Struct toHson();
}