All Downloads are FREE. Search and download functionalities are using the official Maven repository.
  • Log In
  • Register

    • io.tracee.contextlogger.builder.gson.TraceeGenericGsonSerializer Maven / Gradle / Ivy

    The newest version!
    package io.tracee.contextlogger.builder.gson;

import com.google.gson.JsonElement;
import com.google.gson.JsonObject;
import com.google.gson.JsonSerializationContext;
import com.google.gson.JsonSerializer;
import io.tracee.Tracee;
import io.tracee.TraceeLogger;
import io.tracee.contextlogger.TraceeContextLoggerConstants;
import io.tracee.contextlogger.api.TraceeContextLogProvider;
import io.tracee.contextlogger.data.subdata.NameObjectValuePair;
import io.tracee.contextlogger.data.subdata.NameStringValuePair;
import io.tracee.contextlogger.profile.ProfileSettings;
import io.tracee.contextlogger.utility.ListUtilities;
import io.tracee.contextlogger.utility.RecursiveReflectionToStringStyle;
import io.tracee.contextlogger.utility.TraceeContextLogAnnotationUtilities;
import org.apache.commons.lang3.builder.ReflectionToStringBuilder;

import java.lang.reflect.Type;
import java.util.Collections;
import java.util.List;

/**
 * Generic serializer for context logging output.
 * Handles field order and applies Profiles (suppresses output)
 * Created by Tobias Gindler on 14.03.14.
 */
public final class TraceeGenericGsonSerializer implements JsonSerializer {

    private final TraceeLogger logger = Tracee.getBackend().getLoggerFactory().getLogger(TraceeGenericGsonSerializer.class);

    private final ProfileSettings profileSettings;

    public TraceeGenericGsonSerializer(final ProfileSettings profileSettings) {
        this.profileSettings = profileSettings;
    }

    @Override
    public JsonElement serialize(Object instance, Type type, JsonSerializationContext jsonSerializationContext) {

        JsonObject result;

        TraceeContextLogProvider annotation = TraceeContextLogAnnotationUtilities.getAnnotationFromType(instance);
        if (annotation == null) {

            // to be ignored
			logger.debug("TRACEE-CONTEXTLOGGER-GSON-SERIALIZER - Got non annotated class");
            result = new JsonObject();

        } else {

            // get those annotated methods
            final List entriesToPrint = TraceeContextLogAnnotationUtilities.getAnnotatedMethodsOfInstance(instance);

            // sort those methods
            Collections.sort(entriesToPrint, new MethodAnnotationPairComparator());

            // now wrap json object and add those items
            result = new JsonObject();


            for (MethodAnnotationPair singleEntry : entriesToPrint) {

                if (!singleEntry.shouldBeProcessed(profileSettings)) {
                    continue;
                }

                try {

                    Object returnValue = singleEntry.getMethod().invoke(instance, null);

                    if (TraceeContextLogAnnotationUtilities.isFlatable(singleEntry.getMethod()) && (isNameStringValuePair(returnValue))) {

                        // returnValue is single NameStringValuePair
                        final NameStringValuePair nameStringValuePair = (NameStringValuePair) returnValue;
                        result.add(nameStringValuePair.getName(), jsonSerializationContext.serialize(nameStringValuePair.getValue()));

                    }
                    if (TraceeContextLogAnnotationUtilities.isFlatable(singleEntry.getMethod()) && (isNameObjectValuePair(returnValue))) {

                        // returnValue is single NameObjectValuePair
                        final NameObjectValuePair nameObjectValuePair = (NameObjectValuePair) returnValue;

                        //  ObjectValuePairs will be deserialized by ReflectionToStringBuilder
                        final Object value = getValueOfNameObjectValuePair(nameObjectValuePair);
                        result.add(nameObjectValuePair.getName(), jsonSerializationContext.serialize(value));

                    } else if (TraceeContextLogAnnotationUtilities.isFlatable(singleEntry.getMethod())
							&& ListUtilities.isListOfType(returnValue, NameStringValuePair.class)) {

                        // returnValue is List of NameValuePairs
                        final List list = (List) returnValue;

                        for (NameStringValuePair nameStringValuePair : list) {
                            result.add(nameStringValuePair.getName(), jsonSerializationContext.serialize(nameStringValuePair.getValue()));
                        }

                    } else if (TraceeContextLogAnnotationUtilities.isFlatable(singleEntry.getMethod())
							&& ListUtilities.isListOfType(returnValue, NameObjectValuePair.class)) {

                        // returnValue is List of NameValuePairs
                        List list = (List) returnValue;

                        for (NameObjectValuePair nameObjectValuePair : list) {
                            //  ObjectValuePairs will be deserialized by ReflectionToStringBuilder
                            final Object value = getValueOfNameObjectValuePair(nameObjectValuePair);
                            result.add(nameObjectValuePair.getName(), jsonSerializationContext.serialize(value));
                        }

                    } else {

                        // returnValue is not a NameStringValuePair == static context data
                        result.add(singleEntry.getAnnotation().displayName(), jsonSerializationContext.serialize(returnValue));

                    }

                } catch (Exception e) {

                    // to be ignored
					logger.debug("TRACEE-CONTEXTLOGGER-GSON-SERIALIZER - Exception during serialization.", e);

                }

            }

        }

        return result;
    }

    /**
     * selects the best macthing serialization depending on value type.
     *
     * @param nameObjectValuePair
     * @return
     */
    private Object getValueOfNameObjectValuePair(final NameObjectValuePair nameObjectValuePair) {
        if (nameObjectValuePair != null && nameObjectValuePair.getValue() != null) {

            if (TraceeContextLogAnnotationUtilities.getAnnotationFromType(nameObjectValuePair.getValue()) != null) {
                return nameObjectValuePair.getValue();
            } else if (!shouldBeIgnoreAtDeSerialization(nameObjectValuePair.getValue())) {
                return ReflectionToStringBuilder.reflectionToString(nameObjectValuePair.getValue(), new RecursiveReflectionToStringStyle());
            } else {
                // not null value - but type is in IGNORED_AT_DESERIALIZATION set
                return nameObjectValuePair.getValue().toString();
            }

        } else {
            return null;
        }
    }

    /**
     * Checks if the passed instance is of type {@link io.tracee.contextlogger.data.subdata.NameStringValuePair}.
     *
     * @param instance the instance to check
     * @return returns true if the instance is of type {@link io.tracee.contextlogger.data.subdata.NameStringValuePair}, otherwise false
     */
    static boolean isNameStringValuePair(Object instance) {

        return instance != null && NameStringValuePair.class.isInstance(instance);

    }

    /**
     * Checks if the passed instance is of type {@link io.tracee.contextlogger.data.subdata.NameStringValuePair}.
     *
     * @param instance the instance to check
     * @return returns true if the instance is of type {@link io.tracee.contextlogger.data.subdata.NameStringValuePair}, otherwise false
     */
    static boolean isNameObjectValuePair(Object instance) {

        return instance != null && NameObjectValuePair.class.isInstance(instance);

    }

    /**
     * Checks whether the passed instance has to be ignore at the deserialization.
     *
     * @param instance the instance to check
     * @return true if passed instance is null or type of passed instance is in IGNORED_AT_DESERIALIZATION set.
     */
    static boolean shouldBeIgnoreAtDeSerialization(final Object instance) {
        return instance == null || TraceeContextLoggerConstants.IGNORED_AT_DESERIALIZATION.contains(instance.getClass());
    }


}
    
    
    
    

    




    
    
    © 2015 - 2025 Weber Informatics LLC | Privacy Policy