Java Messages._envinject_permissions_title Examples

Example #1

File: EnvInjectPlugin.java Project: jenkinsci/envinject-plugin

/**
 * Stores permissions for EnvInject plugin.
 *
 * @author Oleg Nenashev
 * @since 1.92
 */
@ExportedBean
public class EnvInjectPlugin extends Plugin {

  private static final Logger LOGGER = Logger.getLogger(EnvInjectPlugin.class.getName());

  public static final PermissionGroup PERMISSIONS =
      new PermissionGroup(EnvInjectPlugin.class, Messages._envinject_permissions_title());

  public static final String DEFAULT_MASK = "[*******]";

  /**
   * Allows to view injected variables. Even Jenkins admins may have no such permission in
   * particular installations.
   */
  public static final Permission VIEW_INJECTED_VARS =
      new Permission(
          PERMISSIONS,
          "ViewVars",
          Messages._envinject_permissions_viewVars_description(),
          null,
          PermissionScope.RUN);

  /**
   * Retrieves the plugin instance.
   *
   * @return {@link EnvInjectPlugin}
   * @throws IllegalStateException the plugin has not been loaded yet
   */
  public static @Nonnull EnvInjectPlugin getInstance() {
    EnvInjectPlugin plugin = Jenkins.getActiveInstance().getPlugin(EnvInjectPlugin.class);
    if (plugin == null) { // Fail horribly
      // TODO: throw a graceful error
      throw new IllegalStateException(
          "Cannot get the plugin's instance. Jenkins or the plugin have not been initialized yet");
    }
    return plugin;
  }

  /*package*/ void onConfigChange(@Nonnull EnvInjectPluginConfiguration config) {
    VIEW_INJECTED_VARS.setEnabled(config.isEnablePermissions());
  }

  @Nonnull
  public EnvInjectPluginConfiguration getConfiguration() {
    final EnvInjectPluginConfiguration config = EnvInjectPluginConfiguration.getInstance();
    return config != null ? config : EnvInjectPluginConfiguration.getDefault();
  }

  /**
   * Checks if the current user can view injected variables in the run.
   *
   * @param run Run to be checked
   * @return true if the injected variables can be displayed.
   */
  @Restricted(NoExternalUse.class)
  public static boolean canViewInjectedVars(@Nonnull Run<?, ?> run) {
    // We allow security engines to block the output
    if (VIEW_INJECTED_VARS.getEnabled() && !run.hasPermission(VIEW_INJECTED_VARS)) {
      return false;
    }

    // Last check - global configs
    final EnvInjectPluginConfiguration configuration = getInstance().getConfiguration();
    return !configuration.isHideInjectedVars();
  }

  @Override
  public void start() throws Exception {
    VIEW_INJECTED_VARS.setEnabled(getConfiguration().isEnablePermissions());
  }
}