de.agilecoders.wicket.logging.IParamValueExtractor Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of wicket-clientside-logging Show documentation
There is a newer version: 0.4.1
Show newest version
package de.agilecoders.wicket.logging;

import de.agilecoders.wicket.logging.util.ClientInfos;
import de.agilecoders.wicket.logging.util.DefaultValues;
import de.agilecoders.wicket.logging.util.ParamNames;
import org.apache.wicket.request.IRequestParameters;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import java.util.ArrayList;
import java.util.Collection;
import java.util.HashSet;
import java.util.List;
import java.util.Set;

/**
 * An {@link IParamValueExtractor} extracts key/values and parses given
 * {@link IRequestParameters}.
 *
 * @author miha
 */
public interface IParamValueExtractor {

    /**
     * parses given parameters
     *
     * @param params the parameters to parse
     * @return result that contains all log messages and the client information
     */
    Result parse(IRequestParameters params);

    /**
     * Default implementation of {@link IParamValueExtractor}
     */
    public static final class DefaultParamValueExtractor implements IParamValueExtractor {
        private static final Logger LOG = LoggerFactory.getLogger(DefaultParamValueExtractor.class);

        @Override
        public Result parse(IRequestParameters params) {
            final Set logObjects = new HashSet<>();
            final ClientInfos clientInfos = new ClientInfos();
            final List parsedIndex = new ArrayList<>();

            for (final String paramName : params.getParameterNames()) {
                final String realParamName = extractRealParamName(paramName);

                switch (realParamName) {
                    case ParamNames.TIMESTAMP:
                    case ParamNames.LEVEL:
                    case ParamNames.MESSAGE:
                    case ParamNames.FILE:
                    case ParamNames.LINE:
                    case ParamNames.STACKTRACE:
                        final int index = extractIndex(paramName);

                        if (index > -1 && !parsedIndex.contains(index)) {
                            ClientSideLogObject obj = new ClientSideLogObject(params.getParameterValue(ParamNames.LEVEL + DefaultValues.paramSplitter + index),
                                                                              params.getParameterValue(ParamNames.MESSAGE + DefaultValues.paramSplitter + index),
                                                                              params.getParameterValue(ParamNames.TIMESTAMP + DefaultValues.paramSplitter + index),
                                                                              params.getParameterValue(ParamNames.FILE + DefaultValues.paramSplitter + index),
                                                                              params.getParameterValue(ParamNames.LINE + DefaultValues.paramSplitter + index),
                                                                              params.getParameterValue(ParamNames.STACKTRACE + DefaultValues.paramSplitter + index),
                                                                              index);

                            if (obj.isValid()) {
                                logObjects.add(obj);
                            } else {
                                LOG.warn("skip log object because it isn't valid: {}", obj);
                            }

                            parsedIndex.add(index);
                        }
                        break;

                    case ParamNames.AJAX_BASE_URL:
                    case ParamNames.SCREEN_SIZE:
                    case ParamNames.WINDOW_SIZE:
                    case ParamNames.USER_AGENT:
                        clientInfos.put(paramName, params.getParameterValue(paramName).toString(DefaultValues.defaultClientInfoValue));
                }
            }

            return new Result(logObjects, clientInfos);
        }

        private int extractIndex(String paramName) {
            final int index = paramName.indexOf(DefaultValues.paramSplitterChar);

            if (index > -1) {
                return Integer.parseInt(paramName.substring(index + 1));
            } else {
                return -1;
            }
        }

        private String extractRealParamName(final String paramName) {
            final int index = paramName.indexOf(DefaultValues.paramSplitterChar);
            if (index >= 0) {
                return paramName.substring(0, index);
            }

            return paramName;
        }
    }

    /**
     * result of {@link IParamValueExtractor#parse(org.apache.wicket.request.IRequestParameters)}
     */
    public static final class Result {
        private final Set logObjects;
        private final ClientInfos clientInfos;

        /**
         * Construct.
         *
         * @param logObjects  all log messages
         * @param clientInfos the client information
         */
        public Result(Set logObjects, ClientInfos clientInfos) {
            this.logObjects = logObjects;
            this.clientInfos = clientInfos;
        }

        /**
         * @return the client information
         */
        public ClientInfos clientInfos() { return clientInfos; }

        /**
         * @return all log messages
         */
        public Collection logObjects() { return logObjects; }
    }
}