Package org.jenkinsci.plugins.workflow.cps.actions

Class ArgumentsActionImpl

java.lang.Object
org.jenkinsci.plugins.workflow.actions.ArgumentsAction
org.jenkinsci.plugins.workflow.cps.actions.ArgumentsActionImpl
All Implemented Interfaces:
Action, ModelObject, org.jenkinsci.plugins.workflow.actions.PersistentAction
@Restricted(org.kohsuke.accmod.restrictions.NoExternalUse.class) public class ArgumentsActionImpl extends org.jenkinsci.plugins.workflow.actions.ArgumentsAction
Implements ArgumentsAction by storing step arguments, with sanitization.

  • Nested Class Summary

    Nested classes/interfaces inherited from class org.jenkinsci.plugins.workflow.actions.ArgumentsAction

    org.jenkinsci.plugins.workflow.actions.ArgumentsAction.NotStoredReason

  • Field Summary

    Fields inherited from class org.jenkinsci.plugins.workflow.actions.ArgumentsAction

    MAX_RETAINED_LENGTH

  • Constructor Summary

    Constructors
    Constructor
    Description
    ArgumentsActionImpl(Map<String,Object> stepArguments)
    Create a step, sanitizing strings for secured content
    ArgumentsActionImpl(Map<String,Object> stepArguments, EnvVars env, Set<String> sensitiveVariables)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    protected Map<String,Object>
    getArgumentsInternal()
     
    boolean
    isUnmodifiedArguments()
     
    static String
    replaceSensitiveVariables(String input, EnvVars variables, Set<String> sensitiveVariables)
    See if sensitive environment variable content is in a string and replace the content with its associated variable name, otherwise return string unmodified

    Methods inherited from class org.jenkinsci.plugins.workflow.actions.ArgumentsAction

    getArguments, getArguments, getArgumentValue, getArgumentValueOrReason, getDisplayName, getFilteredArguments, getFilteredArguments, getIconFileName, getResolvedArguments, getStepArgumentsAsString, getUrlName, isOversized, isOversized

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Constructor Details

    • ArgumentsActionImpl

      public ArgumentsActionImpl(@NonNull Map<String,Object> stepArguments, @CheckForNull EnvVars env, @NonNull Set<String> sensitiveVariables)

    • ArgumentsActionImpl

      public ArgumentsActionImpl(@NonNull Map<String,Object> stepArguments)
      Create a step, sanitizing strings for secured content

  • Method Details

    • replaceSensitiveVariables

      public static String replaceSensitiveVariables(@NonNull String input, @CheckForNull EnvVars variables, @NonNull Set<String> sensitiveVariables)
      See if sensitive environment variable content is in a string and replace the content with its associated variable name, otherwise return string unmodified

    • getArgumentsInternal

      @NonNull protected Map<String,Object> getArgumentsInternal()
      Specified by:
      getArgumentsInternal in class org.jenkinsci.plugins.workflow.actions.ArgumentsAction

    • isUnmodifiedArguments

      public boolean isUnmodifiedArguments()
      Overrides:
      isUnmodifiedArguments in class org.jenkinsci.plugins.workflow.actions.ArgumentsAction