org.swisspush.gateleen.logging.LoggingResource Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of gateleen-logging Show documentation
There is a newer version: 2.1.15
package org.swisspush.gateleen.logging;

import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;

/**
 * Class representing the json logging resource
 *
 * @author https://github.com/mcweba [Marc-Andre Weber]
 */
public class LoggingResource {

    /**
     * Logging strategy for the headers
     */
    public enum HeaderLogStrategy {
        LOG_ALL, LOG_NONE, LOG_LIST
    }

    private HeaderLogStrategy headerLogStrategy = HeaderLogStrategy.LOG_ALL;

    private List headers = new ArrayList<>();

    private List> payloadFilters = new ArrayList<>();
    private Map> destinationEntries = new HashMap<>();

    /**
     * Returns the strategy for the headers logging. Default value is {@link HeaderLogStrategy#LOG_ALL}
     * 
     * @return the current strategy for the headers logging
     */
    public HeaderLogStrategy getHeaderLogStrategy() {
        if (headerLogStrategy == null) {
            headerLogStrategy = HeaderLogStrategy.LOG_ALL;
        }
        return headerLogStrategy;
    }

    /**
     * Set the strategy for the headers logging
     * 
     * @param headerLogStrategy HeaderLogStrategy enum
     */
    public void setHeaderLogStrategy(HeaderLogStrategy headerLogStrategy) {
        this.headerLogStrategy = headerLogStrategy;
    }

    /**
     * Returns a list of header names to log. Can be empty.
     * 
     * @return a list of header names to log
     */
    public List getHeaders() {
        if (headers == null) {
            headers = new ArrayList<>();
        }
        return headers;
    }

    /**
     * Adds a list of header names to log
     * 
     * @param headers list of headers
     */
    public void addHeaders(List headers) {
        getHeaders().addAll(headers);
    }

    /**
     * Returns a list of payload filters
     * 
     * @return list of payload filters
     */
    public final List> getPayloadFilters() {
        if (payloadFilters == null) {
            Map filters = new HashMap<>();
            payloadFilters = new ArrayList<>();
            payloadFilters.add(filters);
        }
        return payloadFilters;
    }

    /**
     * Returns a map with destinations
     * 
     * @return map with destinations
     */
    public final Map> getDestinationEntries() {
        if (destinationEntries == null) {
            destinationEntries = new HashMap<>();
        }
        return destinationEntries;
    }

    /**
     * Clears all logging resource values like payload filters and headers
     */
    public void reset() {
        getHeaders().clear();
        getPayloadFilters().clear();
        getDestinationEntries().clear();
    }

    /**
     * Adds a payloadfilter to the logging resource
     * 
     * @param payloadFilter payloadFilter to add
     */
    public void addPayloadFilter(Map payloadFilter) {
        getPayloadFilters().add(payloadFilter);
    }

    /**
     * Adds destination entries for the payloadFilter to the logging resources.
     * 
     * @param destinationEntries entries for the payloadFilter
     */
    public void addFilterDestinations(Map> destinationEntries) {
        getDestinationEntries().putAll(destinationEntries);
    }
}