com.thoughtworks.go.i18n.LocalizedMessage.java Source code

Introduction

Here is the source code for com.thoughtworks.go.i18n.LocalizedMessage.java

Source

/*
 * Copyright 2019 ThoughtWorks, 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.thoughtworks.go.i18n;

import com.thoughtworks.go.config.CaseInsensitiveString;

import java.util.List;

import static org.apache.commons.lang3.StringUtils.join;

/**
 * @understands converting the localized message for a given key
 */
public abstract class LocalizedMessage {

    public static String cannotDeleteResourceBecauseOfDependentPipelines(String resourceTypeBeingDeleted,
            CaseInsensitiveString resourceNameBeingDeleted, List<String> dependentPipelines) {
        return cannotDeleteResourceBecauseOfDependentPipelines(resourceTypeBeingDeleted,
                resourceNameBeingDeleted.toString(), dependentPipelines);
    }

    public static String cannotDeleteResourceBecauseOfDependentPipelines(String resourceTypeBeingDeleted,
            String resourceNameBeingDeleted, List<String> dependentPipelines) {
        return "Cannot delete the " + resourceTypeBeingDeleted + " '" + resourceNameBeingDeleted
                + "' as it is used by pipeline(s): '" + join(dependentPipelines, ", ") + "'";
    }

    public static String cannotDeleteResourceBecauseOfDependentResources(String resourceTypeBeingDeleted,
            String resourceNameBeingDeleted, String dependentResourceType, List<String> dependentResourceUUIDs) {
        return String.format("Cannot delete %s '%s' as it is referenced from %s(s) [%s]", resourceTypeBeingDeleted,
                resourceNameBeingDeleted, dependentResourceType, join(dependentResourceUUIDs, ", "));
    }

    public static String forbiddenToDelete(String resourceType, CaseInsensitiveString resourceName) {
        return forbiddenToDelete(resourceType, resourceName.toString());
    }

    public static String forbiddenToDelete(String resourceType, String resourceName) {
        return "Unauthorized to delete " + resourceType + "' " + resourceName + "'";
    }

    public static String staleResourceConfig(String resourceType, String resourceName) {
        return "Someone has modified the configuration for " + resourceType + " '" + resourceName
                + "'. Please update your copy of the config with the changes.";
    }

    public static String staleResourceConfig(String resourceType, CaseInsensitiveString resourceName) {
        return staleResourceConfig(resourceType, resourceName.toString());
    }

    public static String forbiddenToViewPipeline(CaseInsensitiveString pipelineName) {
        return forbiddenToViewPipeline(pipelineName.toString());
    }

    public static String forbiddenToViewPipeline(String pipelineName) {
        return "You do not have view permissions for pipeline '" + pipelineName + "'.";
    }

    public static String modifiedBy(String who, String when) {
        return who + " on " + when;
    }

    public static String resourceNotFound(String resourceType, String resourceName) {
        return resourceType + " '" + resourceName + "' not found.";
    }

    public static String resourceNotFound(String resourceType, CaseInsensitiveString resourceName) {
        return resourceNotFound(resourceType, resourceName.toString());
    }

    public static String forbiddenToEditGroup(String groupName) {
        return "Unauthorized to edit '" + groupName + "' group.";
    }

    public static String forbiddenToEdit() {
        return "Unauthorized to edit.";
    }

    public static String forbiddenToEditPipeline(String pipelineName) {
        return "Unauthorized to edit '" + pipelineName + "' pipeline.";
    }

    public static String forbiddenToEditPipeline(CaseInsensitiveString pipelineName) {
        return forbiddenToEditPipeline(pipelineName.toString());
    }

    public static String forbiddenToEditResource(String resourceType, String resourceName, String username) {
        return String.format("Failed to access %s '%s'. User '%s' does not have permission to access %s.",
                resourceType, resourceName, username, resourceType);
    }

    public static String forbiddenToEditResource(String resourceType, CaseInsensitiveString resourceName,
            String username) {
        return forbiddenToEditResource(resourceType, resourceName.toString(), username);
    }

    public static String resourceAlreadyExists(String resourceType, String resourceName) {
        return "Failed to add " + resourceType + ". The " + resourceType + " '" + resourceName
                + "' already exists.";
    }

    public static String resourceAlreadyExists(String resourceType, CaseInsensitiveString resourceName) {
        return resourceAlreadyExists(resourceType, resourceName.toString());
    }

    public static String tooltipBuildFilePath(String toolName) {
        if (toolName.equalsIgnoreCase("ANT")) {
            return "Path to Ant build file. If not specified, the path defaults to 'build.xml'.";
        }
        if (toolName.equalsIgnoreCase("NANT")) {
            return "Relative path to a NAnt build file. If not specified, the path defaults to 'default.build'.";
        }
        if (toolName.equalsIgnoreCase("RAKE")) {
            return "Path to Rake file. If not specified, the path defaults to 'rakefile'.";
        }

        throw new IllegalArgumentException("Unknown tool name " + toolName);
    }

    public static String tooltipDefaultTarget(String toolName) {
        if (toolName.equalsIgnoreCase("ANT")) {
            return "Ant target(s) to run. If not specified, the target defaults to 'default'.";
        }
        if (toolName.equalsIgnoreCase("NANT")) {
            return "NAnt target(s) to run. If not specified, defaults to the default target of the build file.";
        }
        if (toolName.equalsIgnoreCase("RAKE")) {
            return "Path to Rake file. If not specified, the path defaults to 'rakefile'.";
        }
        throw new IllegalArgumentException("Unknown tool name " + toolName);
    }

    public static String renamingNotAllowed(String resourceType) {
        return "Renaming the " + resourceType + " resource is not supported by this API.";
    }

    public static String userOperationSuccessful(String operation, int count) {
        if (operation.equalsIgnoreCase("ENABLE")) {
            return "Enabled " + count + " user(s) successfully.";
        }
        if (operation.equalsIgnoreCase("DISABLE")) {
            return "Disabled " + count + " user(s) successfully.";
        }

        if (operation.equalsIgnoreCase("APPLY_ROLES")) {
            return "Role(s)/Admin-Privilege modified for " + count + " user(s) successfully.";
        }

        if (operation.equalsIgnoreCase("ADD_ROLE")) {
            return "New role assigned to " + count + " user(s) successfully.";
        }

        throw new IllegalArgumentException("Unknown operation " + operation);
    }

    public static String entityConfigValidationFailed(String entityType, String entityName, String errors) {
        return "Validations failed for " + entityType + " '" + entityName + "'. Error(s): [" + errors
                + "]. Please correct and resubmit.";
    }

    public static String entityConfigValidationFailed(String entityType, String errors) {
        return "Validations failed for " + entityType + ". Error(s): [" + errors
                + "]. Please correct and resubmit.";
    }

    public static String entityConfigValidationFailed(String entityType, CaseInsensitiveString entityName,
            String errors) {
        return entityConfigValidationFailed(entityType, entityName.toString(), errors);
    }

    public static String saveFailedWithReason(String reason) {
        return "Save failed. " + reason;
    }

    public static String composite(String... messages) {
        return join(messages, " ");
    }

    public static String resourceDeleteSuccessful(String entityType, String entityName) {
        return "The " + entityType + " '" + entityName + "' was deleted successfully.";
    }

    public static String resourceDeleteSuccessful(String entityType, CaseInsensitiveString entityName) {
        return resourceDeleteSuccessful(entityType, entityName.toString());
    }

    public static String resourcesDeleteSuccessful(String entityType, List<String> names) {
        return entityType + " '" + join(names, ", ") + "' were deleted successfully.";
    }

}