com.twitter.hraven.rest.SerializationContext Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of hraven-core Show documentation
Core components of hRaven, including model classes and data access layer
There is a newer version: 1.0.1
/*
Copyright 2013 Twitter, Inc.

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.twitter.hraven.rest;

import java.util.HashSet;
import java.util.List;
import java.util.Set;
import java.util.regex.Pattern;

import com.google.common.base.Predicate;
import com.google.common.collect.Lists;

/**
*/
public class SerializationContext {
  public enum DetailLevel {

    /**
     * Indicating that everything in the object should be returned
     */
    EVERYTHING,

    /**
     * Indicating that only summary stats are to be returned
     */
    FLOW_SUMMARY_STATS_ONLY,

    /**
     * Indicating that job details along with summary stats are to be returned
     */
    FLOW_SUMMARY_STATS_WITH_JOB_STATS;
  }

  /**
   * Restricts returned job configuration data to specific configuration
   * properties.
   */
  public static class ConfigurationFilter implements Predicate {
    private final Set allowedKeys;

    public ConfigurationFilter(List keys) {
      if (keys != null) {
        this.allowedKeys = new HashSet(keys);
      } else {
        this.allowedKeys = null;
      }
    }

    /**
     * Returns true if the given configuration property
     * is contained in the set of allowed configuration keys.
     */
    @Override
    public boolean apply(String potentialKey) {
      return allowedKeys != null && allowedKeys.contains(potentialKey);
    }
  }

  /**
   * Restricts returned job configuration data to configuration properties matching a set
   * of regular expressions.
   */
  public static class RegexConfigurationFilter implements Predicate {
    private final List allowedPatterns;

    public RegexConfigurationFilter(List patterns) {
      if (patterns != null) {
        allowedPatterns = Lists.newArrayListWithCapacity(patterns.size());
        for (String p : patterns) {
          allowedPatterns.add(Pattern.compile(p));
        }
      } else {
        allowedPatterns = null;
      }
    }

    @Override
    public boolean apply(String potentialKey) {
      if (allowedPatterns != null) {
        for (Pattern p : allowedPatterns) {
          if (p.matcher(potentialKey).matches()) {
            return true;
          }
        }
      }
      return false;
    }
  }

  private final DetailLevel level;
  private final Predicate filter;

  public SerializationContext(DetailLevel serializationLevel) {
    this.level = serializationLevel;
    this.filter = null;
  }

  public SerializationContext(DetailLevel serializationLevel,
                              Predicate filter) {
    this.level = serializationLevel;
    this.filter = filter;
  }

  public DetailLevel getLevel() {
    return this.level;
  }

  public Predicate getConfigurationFilter() {
    return this.filter;
  }
}