| /** |
| * Licensed to the Apache Software Foundation (ASF) under one |
| * or more contributor license agreements. See the NOTICE file |
| * distributed with this work for additional information |
| * regarding copyright ownership. The ASF licenses this file |
| * to you 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 org.apache.hadoop.yarn.server.resourcemanager.placement; |
| |
| /** |
| * This class represents the outcome of an action. |
| */ |
| public final class MappingRuleResult { |
| /** |
| * The name of the queue we should place our application into. |
| * Only valid if result == PLACE. |
| */ |
| private final String queue; |
| |
| /** |
| * This flag indicates whether the target queue can be created if it does not |
| * exist yet. |
| * Only valid if result == PLACE |
| */ |
| private boolean allowCreate = true; |
| |
| /** |
| * The normalized name of the queue, since CS allows users to reference queues |
| * by only their leaf name, we need to normalize those queues to have full |
| * reference. |
| */ |
| private String normalizedQueue; |
| |
| /** |
| * The result of the action. |
| */ |
| private MappingRuleResultType result; |
| |
| /** |
| * To the reject result has no variable field, so we don't have to create |
| * a new instance all the time. |
| * This is THE instance which will be used to represent REJECT |
| */ |
| private static final MappingRuleResult RESULT_REJECT |
| = new MappingRuleResult(null, MappingRuleResultType.REJECT); |
| |
| /** |
| * To the skip result has no variable field, so we don't have to create |
| * a new instance all the time. |
| * This is THE instance which will be used to represent SKIP |
| */ |
| private static final MappingRuleResult RESULT_SKIP |
| = new MappingRuleResult(null, MappingRuleResultType.SKIP); |
| |
| /** |
| * To the default placement result has no variable field, so we don't have to |
| * create a new instance all the time. |
| * This is THE instance which will be used to represent default placement |
| */ |
| private static final MappingRuleResult RESULT_DEFAULT_PLACEMENT |
| = new MappingRuleResult(null, MappingRuleResultType.PLACE_TO_DEFAULT); |
| |
| /** |
| * Constructor is private to force the user to use the predefined generator |
| * methods to create new instances in order to avoid inconsistent states. |
| * @param queue Name of the queue in which the application is supposed to be |
| * placed, only valid if result == PLACE |
| * otherwise it should be null |
| * @param result The type of the result |
| */ |
| private MappingRuleResult(String queue, MappingRuleResultType result) { |
| this.queue = queue; |
| this.normalizedQueue = queue; |
| this.result = result; |
| } |
| |
| /** |
| * Constructor is private to force the user to use the predefined generator |
| * methods to create new instances in order to avoid inconsistent states. |
| * @param queue Name of the queue in which the application is supposed to be |
| * placed, only valid if result == PLACE |
| * otherwise it should be null |
| * @param result The type of the result |
| * @param allowCreate Determines if the target queue should be created if it |
| * does not exist |
| */ |
| private MappingRuleResult( |
| String queue, MappingRuleResultType result, boolean allowCreate) { |
| this.queue = queue; |
| this.normalizedQueue = queue; |
| this.result = result; |
| this.allowCreate = allowCreate; |
| } |
| |
| /** |
| * This method returns the result queue. Currently only makes sense when |
| * result == PLACE. |
| * @return the queue this result is about |
| */ |
| public String getQueue() { |
| return queue; |
| } |
| |
| /** |
| * The method returns true if the result queue should be created when it does |
| * not exist yet. |
| * @return true if non-existent queues should be created |
| */ |
| public boolean isCreateAllowed() { |
| return allowCreate; |
| } |
| |
| /** |
| * External interface for setting the normalized version of the queue. This |
| * class cannot normalize on it's own, but provides a way to store the |
| * normalized name of the target queue. |
| * @param normalizedQueueName The normalized name of the queue |
| */ |
| public void updateNormalizedQueue(String normalizedQueueName) { |
| this.normalizedQueue = normalizedQueueName; |
| } |
| |
| /** |
| * This method returns the normalized name of the result queue. |
| * Currently only makes sense when result == PLACE |
| * Normalized value must be set externally, this class cannot normalize |
| * it just provides a way to store the normalized name of a queue |
| * @return the queue name this result is about |
| */ |
| public String getNormalizedQueue() { |
| return normalizedQueue; |
| } |
| |
| /** |
| * Returns the type of the result. |
| * @return the type of the result. |
| */ |
| public MappingRuleResultType getResult() { |
| return result; |
| } |
| |
| /** |
| * Generator method for place results. |
| * @param queue The name of the queue in which we shall place the application |
| * @return The generated MappingRuleResult |
| */ |
| public static MappingRuleResult createPlacementResult( |
| String queue, boolean allowCreate) { |
| return new MappingRuleResult( |
| queue, MappingRuleResultType.PLACE, allowCreate); |
| } |
| |
| /** |
| * Generator method for reject results. |
| * @return The generated MappingRuleResult |
| */ |
| public static MappingRuleResult createRejectResult() { |
| return RESULT_REJECT; |
| } |
| |
| /** |
| * Generator method for skip results. |
| * @return The generated MappingRuleResult |
| */ |
| public static MappingRuleResult createSkipResult() { |
| return RESULT_SKIP; |
| } |
| |
| /** |
| * Generator method for default placement results. It is a specialized |
| * placement result which will only use the "%default" as a queue name. |
| * @return The generated MappingRuleResult |
| */ |
| public static MappingRuleResult createDefaultPlacementResult() { |
| return RESULT_DEFAULT_PLACEMENT; |
| } |
| |
| /** |
| * Returns the string representation of the object. |
| * @return the string representation of the object |
| */ |
| @Override |
| public String toString() { |
| if (result == MappingRuleResultType.PLACE) { |
| return result.name() + ": '" + normalizedQueue + "' ('" + queue + "')"; |
| } else { |
| return result.name(); |
| } |
| } |
| } |