io.micronaut.management.endpoint.beans.impl.DefaultBeanDefinitionData Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of micronaut-management Show documentation
Core components supporting the Micronaut Framework
There is a newer version: 4.6.5
/*
 * Copyright 2017-2020 original authors
 *
 * 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
 *
 * https://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.micronaut.management.endpoint.beans.impl;

import io.micronaut.context.Qualifier;
import io.micronaut.context.annotation.Requires;
import io.micronaut.core.annotation.NonNull;
import io.micronaut.core.annotation.Nullable;
import io.micronaut.inject.BeanDefinition;
import io.micronaut.management.endpoint.beans.BeanDefinitionData;
import io.micronaut.management.endpoint.beans.BeansEndpoint;
import jakarta.inject.Singleton;

import java.util.LinkedHashMap;
import java.util.List;
import java.util.Map;

/**
 * The default {@link BeanDefinitionData} implementation. Returns a {@link Map} with
 * 3 keys; "dependencies": A list of class names the bean depends on, "scope": The
 * scope of the bean {@link jakarta.inject.Scope}, "type": The bean class name.
 *
 * @author James Kleeh
 * @since 1.0
 */
@Singleton
@Requires(beans = BeansEndpoint.class)
public class DefaultBeanDefinitionData implements BeanDefinitionData> {

    /**
     * Default constructor.
     */
    DefaultBeanDefinitionData() {
    }

    @SuppressWarnings("MagicNumber")
    @Override
    public Map getData(BeanDefinition beanDefinition) {
        Map beanData = new LinkedHashMap<>(3);
        beanData.put("dependencies", getDependencies(beanDefinition));
        beanData.put("scope", getScope(beanDefinition));
        beanData.put("type", getType(beanDefinition));
        beanData.put("qualifier", getQualifier(beanDefinition));

        return beanData;
    }

    /**
     * Obtains the qualifier.
     * @param beanDefinition The bean definition.
     * @return The qualifier
     */
    @Nullable
    protected String getQualifier(@NonNull BeanDefinition beanDefinition) {
        Qualifier q = beanDefinition.getDeclaredQualifier();
        if (q != null) {
            return q.toString();
        }
        return null;
    }

    /**
     * @param beanDefinition A bean definition
     * @return A list of dependencies for the bean definition
     */
    @NonNull
    protected List getDependencies(@NonNull BeanDefinition beanDefinition) {
        return beanDefinition.getRequiredComponents().stream().map(Class::getName).sorted().toList();
    }

    /**
     * @param beanDefinition A bean definition
     * @return The scope for the bean
     */
    @Nullable
    protected String getScope(@NonNull BeanDefinition beanDefinition) {
        return beanDefinition.getScopeName().orElse(null);
    }

    /**
     * @param beanDefinition A bean definition
     * @return The type of the bean as String
     */
    @NonNull
    protected String getType(@NonNull BeanDefinition beanDefinition) {
        return beanDefinition.getBeanType().getName();
    }
}