com.aspectran.logging.LoggingGroupDiscriminator Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of aspectran-all Show documentation
Aspectran (All-in-One)
The newest version!
/*
 * Copyright (c) 2008-2025 The Aspectran Project
 *
 * 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 com.aspectran.logging;

import ch.qos.logback.classic.spi.ILoggingEvent;
import ch.qos.logback.core.sift.AbstractDiscriminator;
import com.aspectran.core.context.ActivityContext;
import com.aspectran.core.service.CoreService;
import com.aspectran.core.service.CoreServiceHolder;
import com.aspectran.utils.StringUtils;
import com.aspectran.utils.annotation.jsr305.NonNull;
import com.aspectran.utils.annotation.jsr305.Nullable;

import java.util.Map;

/**
 * Discriminates logging events based on the name given to the ActivityContext of the current CoreService.
 * ex)
 * 
{@code
 *   
 *     
 *       LOGGING_GROUP
 *       app
 *     
 *     
 *       
 *         ${aspectran.basePath:-app}/logs/${LOGGING_GROUP}.log
 *         ...
 *       
 *     
 *   
 * }

 * @see Logging separation
 */
public class LoggingGroupDiscriminator extends AbstractDiscriminator {

    private static final String DEFAULT_KEY = "LOGGING_GROUP";

    private String key = DEFAULT_KEY;

    private String defaultValue;

    /**
     * Returns the name of the current CoreService's ActivityContext.
     * If that value is null, then return the value assigned to the defaultValue
     * property.
     */
    @Override
    public String getDiscriminatingValue(@NonNull ILoggingEvent event) {
        String groupName = getGroupName(event);
        if (groupName == null) {
            CoreService service = CoreServiceHolder.acquire();
            if (service != null) {
                ActivityContext context = service.getActivityContext();
                if (context != null && context.getName() != null) {
                    groupName = context.getName();
                }
            }
        }
        if (StringUtils.hasText(groupName)) {
            return groupName;
        } else {
            return defaultValue;
        }
    }

    @Nullable
    private String getGroupName(@NonNull ILoggingEvent event) {
        Map mdcMap = event.getMDCPropertyMap();
        return (mdcMap != null ? mdcMap.get(key) : null);
    }

    @Override
    public String getKey() {
        return key;
    }

    public void setKey(String key) {
        this.key = key;
    }

    public String getDefaultValue() {
        return defaultValue;
    }

    public void setDefaultValue(String defaultValue) {
        this.defaultValue = defaultValue;
    }

    @Override
    public void start() {
        int errors = 0;
        if (!StringUtils.hasText(key)) {
            errors++;
            addError("The 'key' property must be set");
        }
        if (!StringUtils.hasText(defaultValue)) {
            errors++;
            addError("The 'defaultValue' property must be set");
        }
        if (errors == 0) {
            super.start();
        }
    }

}