com.twitter.aurora.scheduler.configuration.SanitizedConfiguration.java Source code

Introduction

Here is the source code for com.twitter.aurora.scheduler.configuration.SanitizedConfiguration.java

Source

/*
 * 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.aurora.scheduler.configuration;

import java.util.Map;

import com.google.common.annotations.VisibleForTesting;
import com.google.common.base.Functions;
import com.google.common.base.Objects;
import com.google.common.collect.ContiguousSet;
import com.google.common.collect.DiscreteDomain;
import com.google.common.collect.Maps;
import com.google.common.collect.Range;

import com.twitter.aurora.scheduler.configuration.ConfigurationManager.TaskDescriptionException;
import com.twitter.aurora.scheduler.storage.entities.IJobConfiguration;
import com.twitter.aurora.scheduler.storage.entities.ITaskConfig;

/**
 * Wrapper for a configuration that has been fully-sanitized and populated with defaults.
 */
public final class SanitizedConfiguration {

    private final IJobConfiguration sanitized;
    private final Map<Integer, ITaskConfig> tasks;

    /**
     * Constructs a SanitizedConfiguration object and populates the set of {@link ITaskConfig}s for
     * the provided config.
     *
     * @param sanitized A sanitized configuration.
     */
    @VisibleForTesting
    public SanitizedConfiguration(IJobConfiguration sanitized) {
        this.sanitized = sanitized;
        this.tasks = Maps.toMap(
                ContiguousSet.create(Range.closedOpen(0, sanitized.getInstanceCount()), DiscreteDomain.integers()),
                Functions.constant(sanitized.getTaskConfig()));
    }

    /**
     * Wraps an unsanitized job configuration.
     *
     * @param unsanitized Unsanitized configuration to sanitize/populate and wrap.
     * @return A wrapper containing the sanitized configuration.
     * @throws TaskDescriptionException If the configuration is invalid.
     */
    public static SanitizedConfiguration fromUnsanitized(IJobConfiguration unsanitized)
            throws TaskDescriptionException {

        return new SanitizedConfiguration(ConfigurationManager.validateAndPopulate(unsanitized));
    }

    public IJobConfiguration getJobConfig() {
        return sanitized;
    }

    // TODO(William Farner): Rework this API now that all configs are identical.
    public Map<Integer, ITaskConfig> getTaskConfigs() {
        return tasks;
    }

    @Override
    public boolean equals(Object o) {
        if (!(o instanceof SanitizedConfiguration)) {
            return false;
        }

        SanitizedConfiguration other = (SanitizedConfiguration) o;

        return Objects.equal(sanitized, other.sanitized);
    }

    @Override
    public int hashCode() {
        return sanitized.hashCode();
    }

    @Override
    public String toString() {
        return sanitized.toString();
    }
}