Package hudson

Class Functions

java.lang.Object
hudson.Functions
public class Functions extends Object
Utility functions used in views.

An instance of this class is created for each request and made accessible from view pages via the variable 'h' (h stands for Hudson.)

Author:
Kohsuke Kawaguchi

  • Field Details

    • DEBUG_YUI

      public static boolean DEBUG_YUI
      Set to true if you need to use the debug version of YUI.

  • Constructor Details

    • Functions

      public Functions()

  • Method Details

    • generateId

      public String generateId()
      Generates an unique ID.

    • isModel

      public static boolean isModel(Object o)

    • isModelWithContextMenu

      public static boolean isModelWithContextMenu(Object o)

    • isModelWithChildren

      public static boolean isModelWithChildren(Object o)

    • isMatrixProject

      @Deprecated public static boolean isMatrixProject(Object o)
      Deprecated.

    • xsDate

      public static String xsDate(Calendar cal)

    • iso8601DateTime

      @Restricted(org.kohsuke.accmod.restrictions.NoExternalUse.class) public static String iso8601DateTime(Date date)

    • localDate

      @Restricted(org.kohsuke.accmod.restrictions.NoExternalUse.class) public static String localDate(Date date)
      Returns a localized string for the specified date, not including time.

    • rfc822Date

      public static String rfc822Date(Calendar cal)

    • getTimeSpanString

      @Restricted(org.kohsuke.accmod.restrictions.NoExternalUse.class) public static String getTimeSpanString(Date date)
      Returns a human-readable string describing the time difference between now and the specified date.

    • isExtensionsAvailable

      public static boolean isExtensionsAvailable()
      During Jenkins start-up, before InitMilestone.PLUGINS_STARTED the extensions lists will be empty and they are not guaranteed to be fully populated until after InitMilestone.EXTENSIONS_AUGMENTED, similarly, during termination after Jenkins.isTerminating() is set, it is no longer safe to access the extensions lists. If you attempt to access the extensions list from a UI thread while the extensions are being loaded you will hit a big honking great monitor lock that will block until the effective extension list has been determined (as if a plugin fails to start, all of the failed plugin's extensions and any dependent plugins' extensions will have to be evicted from the list of extensions. In practical terms this only affects the "Jenkins is loading" screen, but as that screen uses the generic layouts we provide this utility method so that the generic layouts can avoid iterating extension lists while Jenkins is starting up. If you attempt to access the extensions list from a UI thread while Jenkins is being shut down, the extensions themselves may no longer be in a valid state and could attempt to revive themselves and block termination. In actual terms the termination only affects those views required to render HudsonIsRestarting's index.jelly which is the same set as the HudsonIsLoading pages so it makes sense to use both checks here.
      Returns:
      true if the extensions lists have been populated.
      Since:
      1.607

    • initPageVariables

      public static void initPageVariables(org.apache.commons.jelly.JellyContext context)

    • getTypeParameter

      public static <B> Class getTypeParameter(Class<? extends B> c, Class<B> base, int n)
      Given c=MyList (extends ArrayList<Foo>), base=List, compute the parameterization of 'base' that's assignable from 'c' (in this case List<Foo>), and return its n-th type parameter (n=0 would return Foo).

      This method is useful for doing type arithmetic.

      Throws:
      AssertionError - if c' is not parameterized.

    • getJDKDescriptor

      public JDK.DescriptorImpl getJDKDescriptor()

    • getDiffString

      public static String getDiffString(int i)
      Prints the integer as a string that represents difference, like "-5", "+/-0", "+3".

    • getDiffString2

      public static String getDiffString2(int i)
      getDiffString(int) that doesn't show anything for +/-0

    • getDiffString2

      public static String getDiffString2(String prefix, int i, String suffix)
      getDiffString2(int) that puts the result into prefix and suffix if there's something to print

    • addSuffix

      public static String addSuffix(int n, String singular, String plural)
      Adds the proper suffix.

    • decompose

      public static Functions.RunUrl decompose(org.kohsuke.stapler.StaplerRequest2 req)
      Since:
      2.475

    • decompose

      @Deprecated public static Functions.RunUrl decompose(org.kohsuke.stapler.StaplerRequest req)
      Deprecated.
      use decompose(StaplerRequest2)

    • getScreenResolution

      public static Area getScreenResolution()
      If we know the user's screen resolution, return it. Otherwise null.
      Since:
      1.213

    • useHidingPasswordFields

      @Restricted(org.kohsuke.accmod.restrictions.NoExternalUse.class) public static boolean useHidingPasswordFields()

    • getNodeModes

      public static Node.Mode[] getNodeModes()

    • getProjectListString

      public static String getProjectListString(List<AbstractProject> projects)

    • ifThenElse

      @Deprecated public static Object ifThenElse(boolean cond, Object thenValue, Object elseValue)
      Deprecated.
      as of 1.294 JEXL now supports the real ternary operator "x?y:z", so this work around is no longer necessary.

    • appendIfNotNull

      public static String appendIfNotNull(String text, String suffix, String nullText)

    • getSystemProperties

      public static Map getSystemProperties()

    • getSystemProperty

      @Restricted(org.kohsuke.accmod.restrictions.DoNotUse.class) public static String getSystemProperty(String key)
      Gets the system property indicated by the specified key. Delegates to SystemProperties.getString(String).

    • getEnvVars

      public static Map getEnvVars()

    • isWindows

      public static boolean isWindows()

    • isGlibcSupported

      public static boolean isGlibcSupported()

    • getLogRecords

      public static List<LogRecord> getLogRecords()

    • printLogRecord

      public static String printLogRecord(LogRecord r)

    • printLogRecordHtml

      @Restricted(org.kohsuke.accmod.restrictions.NoExternalUse.class) public static String[] printLogRecordHtml(LogRecord r, LogRecord prior)

    • reverse

      public static <T> Iterable<T> reverse(Collection<T> collection)
      Reverses a collection so that it can be easily walked in reverse order.
      Since:
      1.525

    • getCookie

      public static jakarta.servlet.http.Cookie getCookie(jakarta.servlet.http.HttpServletRequest req, String name)
      Since:
      2.475

    • getCookie

      @Deprecated public static javax.servlet.http.Cookie getCookie(javax.servlet.http.HttpServletRequest req, String name)
      Deprecated.
      use getCookie(HttpServletRequest, String)

    • getCookie

      public static String getCookie(jakarta.servlet.http.HttpServletRequest req, String name, String defaultValue)
      Since:
      2.475

    • getCookie

      @Deprecated public static String getCookie(javax.servlet.http.HttpServletRequest req, String name, String defaultValue)
      Deprecated.
      use getCookie(HttpServletRequest, String, String)

    • validateIconSize

      @Restricted(org.kohsuke.accmod.restrictions.NoExternalUse.class) public static String validateIconSize(String iconSize) throws SecurityException
      Throws:
      SecurityException

    • getYuiSuffix

      public static String getYuiSuffix()
      Gets the suffix to use for YUI JavaScript.

    • filter

      public static <V> SortedMap<Integer,V> filter(SortedMap<Integer,V> map, String from, String to)
      Creates a sub map by using the given range (both ends inclusive).

    • filterExcludingFrom

      @Restricted(org.kohsuke.accmod.restrictions.NoExternalUse.class) public static <V> SortedMap<Integer,V> filterExcludingFrom(SortedMap<Integer,V> map, String from, String to)
      Creates a sub map by using the given range (upper end inclusive).

    • configureAutoRefresh

      @Deprecated public static void configureAutoRefresh(jakarta.servlet.http.HttpServletRequest request, jakarta.servlet.http.HttpServletResponse response, boolean noAutoRefresh)
      Deprecated.
      auto refresh has been removed
      No longer used.

    • isAutoRefresh

      @Deprecated public static boolean isAutoRefresh(jakarta.servlet.http.HttpServletRequest request)
      Deprecated.

    • isCollapsed

      public static boolean isCollapsed(String paneId)

    • isUserTimeZoneOverride

      @Restricted(org.kohsuke.accmod.restrictions.NoExternalUse.class) public static boolean isUserTimeZoneOverride()

    • getUserTimeZone

      @CheckForNull @Restricted(org.kohsuke.accmod.restrictions.NoExternalUse.class) public static String getUserTimeZone()

    • getUserTimeZonePostfix

      @Restricted(org.kohsuke.accmod.restrictions.NoExternalUse.class) public static String getUserTimeZonePostfix(Date date)

    • getHourLocalTimezone

      @Restricted(org.kohsuke.accmod.restrictions.NoExternalUse.class) public static long getHourLocalTimezone()

    • getNearestAncestorUrl

      public static String getNearestAncestorUrl(org.kohsuke.stapler.StaplerRequest2 req, Object it)
      Finds the given object in the ancestor list and returns its URL. This is used to determine the "current" URL assigned to the given object, so that one can compute relative URLs from it.
      Since:
      2.475

    • getNearestAncestorUrl

      @Deprecated public static String getNearestAncestorUrl(org.kohsuke.stapler.StaplerRequest req, Object it)
      Deprecated.
      use getNearestAncestorUrl(StaplerRequest2, Object)

    • getSearchURL

      public static String getSearchURL()
      Finds the inner-most SearchableModelObject in scope.

    • appendSpaceIfNotNull

      public static String appendSpaceIfNotNull(String n)

    • nbspIndent

      public static String nbspIndent(String size)
      One nbsp per 10 pixels in given size, which may be a plain number or "NxN" (like an iconSize). Useful in a sortable table heading.

    • getWin32ErrorMessage

      public static String getWin32ErrorMessage(IOException e)

    • isMultiline

      public static boolean isMultiline(String s)

    • encode

      public static String encode(String s)
      Percent-encodes space and non-ASCII UTF-8 characters for use in URLs. 
       Input example  1: !"£$%^&*()_+}{:@~?><|¬`,./;'#[]- =
 Output example 1: !"%C2%A3$%^&*()_+}{:@~?><|%C2%AC`,./;'#[]-%20=
      Notes:
      • a blank space will render as %20
      • this methods only escapes non-ASCII but leaves other URL-unsafe characters, such as '#'
      • Util.rawEncode(String) in the Util library should generally be used instead (do check the documentation for that method)

    • urlEncode

      public static String urlEncode(String s)
      Shortcut function for calling URLEncoder.encode(String,String) (with UTF-8 encoding).
      Useful for encoding URL query parameters in jelly code (as in "...?param=${h.urlEncode(something)}").
      For convenience in jelly code, it also accepts null parameter, and then returns an empty string. 
       Input example  1: & " ' < >
 Output example 1: %26+%22+%27+%3C+%3E
 Input example  2: !"£$%^&*()_+}{:@~?><|¬`,./;'#[]-=
 Output example 2: %21%22%C2%A3%24%25%5E%26*%28%29_%2B%7D%7B%3A%40%7E%3F%3E%3C%7C%C2%AC%60%2C.%2F%3B%27%23%5B%5D-%3D
      Note: A blank space will render as + (You can see this in above examples)
      Since:
      2.200

    • escape

      public static String escape(String s)
      Transforms the input string so it renders as written in HTML output: newlines are converted to HTML line breaks, consecutive spaces are retained as &amp;nbsp;, and HTML metacharacters are escaped. 
       Input example  1: & " ' < >
 Output example 1: &amp; &quot; &#039; &lt; &gt;
 Input example  2: !"£$%^&*()_+}{:@~?><|¬`,./;'#[]-=
 Output example 2: !&quot;£$%^&amp;*()_+}{:@~?&gt;&lt;|¬`,./;&#039;#[]-=
      See Also:

    • xmlEscape

      public static String xmlEscape(String s)
      Escapes XML unsafe characters 
       Input example  1: < > &
 Output example 1: &lt; &gt; &amp;
 Input example  2: !"£$%^&*()_+}{:@~?><|¬`,./;'#[]-=
 Output example 2: !"£$%^&amp;*()_+}{:@~?&gt;&lt;|¬`,./;'#[]-=
      See Also:

    • xmlUnescape

      public static String xmlUnescape(String s)

    • htmlAttributeEscape

      public static String htmlAttributeEscape(String text)
      Escapes a string so it can be used in an HTML attribute value. 
       Input example  1: & " ' < >
 Output example 1: &amp; &quot; &#39; &lt; &gt;
 Input example  2: !"£$%^&*()_+}{:@~?><|¬`,./;'#[]-=
 Output example 2: !&quot;£$%^&amp;*()_+}{:@~?&gt;&lt;|¬`,./;&#39;#[]-=
      Note: 2 consecutive blank spaces will not render any special chars.

    • checkPermission

      public static void checkPermission(Permission permission) throws IOException, jakarta.servlet.ServletException
      Throws:
      IOException
      jakarta.servlet.ServletException

    • checkPermission

      public static void checkPermission(AccessControlled object, Permission permission) throws IOException, jakarta.servlet.ServletException
      Throws:
      IOException
      jakarta.servlet.ServletException

    • checkPermission

      public static void checkPermission(Object object, Permission permission) throws IOException, jakarta.servlet.ServletException
      This version is so that the 'checkPermission' on layout.jelly degrades gracefully if "it" is not an AccessControlled object. Otherwise it will perform no check and that problem is hard to notice.
      Throws:
      IOException
      jakarta.servlet.ServletException

    • hasPermission

      public static boolean hasPermission(Permission permission) throws IOException, jakarta.servlet.ServletException
      Returns true if the current user has the given permission.
      Parameters:
      permission - If null, returns true. This defaulting is convenient in making the use of this method terse.
      Throws:
      IOException
      jakarta.servlet.ServletException

    • hasPermission

      public static boolean hasPermission(Object object, Permission permission) throws IOException, jakarta.servlet.ServletException
      This version is so that the 'hasPermission' can degrade gracefully if "it" is not an AccessControlled object.
      Throws:
      IOException
      jakarta.servlet.ServletException

    • adminCheck

      public static void adminCheck(org.kohsuke.stapler.StaplerRequest2 req, org.kohsuke.stapler.StaplerResponse2 rsp, Object required, Permission permission) throws IOException, jakarta.servlet.ServletException
      Throws:
      IOException
      jakarta.servlet.ServletException
      Since:
      2.475

    • adminCheck

      @Deprecated public static void adminCheck(org.kohsuke.stapler.StaplerRequest req, org.kohsuke.stapler.StaplerResponse rsp, Object required, Permission permission) throws IOException, javax.servlet.ServletException
      Deprecated.
      use adminCheck(StaplerRequest2, StaplerResponse2, Object, Permission)
      Throws:
      IOException
      javax.servlet.ServletException

    • inferHudsonURL

      public static String inferHudsonURL(org.kohsuke.stapler.StaplerRequest2 req)
      Infers the hudson installation URL from the given request.
      Since:
      2.475

    • inferHudsonURL

      @Deprecated public static String inferHudsonURL(org.kohsuke.stapler.StaplerRequest req)
      Deprecated.
      use inferHudsonURL(StaplerRequest2)

    • getFooterURL

      public static String getFooterURL()
      Returns the link to be displayed in the footer of the UI.

    • getJobPropertyDescriptors

      public static List<JobPropertyDescriptor> getJobPropertyDescriptors(Class<? extends Job> clazz)

    • getJobPropertyDescriptors

      public static List<JobPropertyDescriptor> getJobPropertyDescriptors(Job job)

    • getBuildWrapperDescriptors

      public static List<Descriptor<BuildWrapper>> getBuildWrapperDescriptors(AbstractProject<?,?> project)

    • getSecurityRealmDescriptors

      public static List<Descriptor<SecurityRealm>> getSecurityRealmDescriptors()

    • getAuthorizationStrategyDescriptors

      public static List<Descriptor<AuthorizationStrategy>> getAuthorizationStrategyDescriptors()

    • getBuilderDescriptors

      public static List<Descriptor<Builder>> getBuilderDescriptors(AbstractProject<?,?> project)

    • getPublisherDescriptors

      public static List<Descriptor<Publisher>> getPublisherDescriptors(AbstractProject<?,?> project)

    • getSCMDescriptors

      public static List<SCMDescriptor<?>> getSCMDescriptors(AbstractProject<?,?> project)

    • getComputerLauncherDescriptors

      @Deprecated @Restricted(org.kohsuke.accmod.restrictions.DoNotUse.class) @RestrictedSince("2.12") public static List<Descriptor<ComputerLauncher>> getComputerLauncherDescriptors()
      Deprecated.
      replaced by Slave.SlaveDescriptor.computerLauncherDescriptors(Slave)
      Since:
      2.12

    • getRetentionStrategyDescriptors

      @Deprecated @Restricted(org.kohsuke.accmod.restrictions.DoNotUse.class) @RestrictedSince("2.12") public static List<Descriptor<RetentionStrategy<?>>> getRetentionStrategyDescriptors()
      Deprecated.
      replaced by Slave.SlaveDescriptor.retentionStrategyDescriptors(Slave)
      Since:
      2.12

    • getParameterDescriptors

      public static List<ParameterDefinition.ParameterDescriptor> getParameterDescriptors()

    • getCaptchaSupportDescriptors

      public static List<Descriptor<CaptchaSupport>> getCaptchaSupportDescriptors()

    • getViewsTabBarDescriptors

      public static List<Descriptor<ViewsTabBar>> getViewsTabBarDescriptors()

    • getMyViewsTabBarDescriptors

      public static List<Descriptor<MyViewsTabBar>> getMyViewsTabBarDescriptors()

    • getNodePropertyDescriptors

      @Deprecated @Restricted(org.kohsuke.accmod.restrictions.DoNotUse.class) @RestrictedSince("2.12") public static List<NodePropertyDescriptor> getNodePropertyDescriptors(Class<? extends Node> clazz)
      Deprecated.
      replaced by Slave.SlaveDescriptor.nodePropertyDescriptors(Slave)
      Since:
      2.12

    • getGlobalNodePropertyDescriptors

      public static List<NodePropertyDescriptor> getGlobalNodePropertyDescriptors()
      Returns those node properties which can be configured as global node properties.
      Since:
      1.520

    • getSortedDescriptorsForGlobalConfig

      @Deprecated @Restricted(org.kohsuke.accmod.restrictions.NoExternalUse.class) public static Collection<Descriptor> getSortedDescriptorsForGlobalConfig(com.google.common.base.Predicate<GlobalConfigurationCategory> predicate)
      Deprecated.
      use getSortedDescriptorsForGlobalConfigByDescriptor(Predicate)
      Gets all the descriptors sorted by their inheritance tree of Describable so that descriptors of similar types come nearby.

      We sort them by Extension.ordinal() but only for GlobalConfigurations, as the value is normally used to compare similar kinds of extensions, and we needed GlobalConfigurations to be able to position themselves in a layer above. This however creates some asymmetry between regular Descriptors and GlobalConfigurations. Perhaps it is better to introduce another annotation element? But then, extensions shouldn't normally concern themselves about ordering too much, and the only reason we needed this for GlobalConfigurations are for backward compatibility.

      Parameters:
      predicate - Filter the descriptors based on this predicate
      Since:
      1.494

    • getSortedDescriptorsForGlobalConfigByDescriptor

      public static Collection<Descriptor> getSortedDescriptorsForGlobalConfigByDescriptor(Predicate<Descriptor> predicate)
      Gets all the descriptors sorted by their inheritance tree of Describable so that descriptors of similar types come nearby.

      We sort them by Extension.ordinal() but only for GlobalConfigurations, as the value is normally used to compare similar kinds of extensions, and we needed GlobalConfigurations to be able to position themselves in a layer above. This however creates some asymmetry between regular Descriptors and GlobalConfigurations. Perhaps it is better to introduce another annotation element? But then, extensions shouldn't normally concern themselves about ordering too much, and the only reason we needed this for GlobalConfigurations are for backward compatibility.

      Parameters:
      predicate - Filter the descriptors based on this predicate
      Since:
      2.222

    • getSortedDescriptorsForGlobalConfigByDescriptor

      public static Collection<Descriptor> getSortedDescriptorsForGlobalConfigByDescriptor()
      Like getSortedDescriptorsForGlobalConfigByDescriptor(Predicate) but with a constant truth predicate, to include all descriptors.

    • getSortedDescriptorsForGlobalConfigNoSecurity

      @Deprecated public static Collection<Descriptor> getSortedDescriptorsForGlobalConfigNoSecurity()
      Deprecated.
      This is rather meaningless.

    • getSortedDescriptorsForGlobalConfigUnclassified

      public static Collection<Descriptor> getSortedDescriptorsForGlobalConfigUnclassified()
      Descriptors in the global configuration form that users with Jenkins.MANAGE permission can configure.
      Since:
      1.506

    • getSortedDescriptorsForGlobalConfigUnclassifiedReadable

      @Restricted(org.kohsuke.accmod.restrictions.NoExternalUse.class) public static Collection<Descriptor> getSortedDescriptorsForGlobalConfigUnclassifiedReadable()
      Descriptors shown in the global configuration form to users with Jenkins.SYSTEM_READ permission.
      Since:
      2.222

    • hasAnyPermission

      public static boolean hasAnyPermission(AccessControlled ac, Permission[] permissions)
      Checks if the current security principal has one of the supplied permissions.
      Since:
      2.238

    • hasAnyPermission

      public static boolean hasAnyPermission(Object object, Permission[] permissions) throws IOException, jakarta.servlet.ServletException
      This version is so that the 'hasAnyPermission' degrades gracefully if "it" is not an AccessControlled object. Otherwise it will perform no check and that problem is hard to notice.
      Throws:
      IOException
      jakarta.servlet.ServletException
      Since:
      2.238

    • checkAnyPermission

      public static void checkAnyPermission(AccessControlled ac, Permission[] permissions)
      Checks if the current security principal has one of the supplied permissions.
      Throws:
      org.springframework.security.access.AccessDeniedException - if the user doesn't have the permission.
      Since:
      2.222

    • checkAnyPermission

      public static void checkAnyPermission(Object object, Permission[] permissions) throws IOException, jakarta.servlet.ServletException
      This version is so that the 'checkAnyPermission' on layout.jelly degrades gracefully if "it" is not an AccessControlled object. Otherwise it will perform no check and that problem is hard to notice.
      Throws:
      IOException
      jakarta.servlet.ServletException

    • getIconFilePath

      public static String getIconFilePath(Action a)
      Computes the path to the icon of the given action from the context path.

    • size2

      public static int size2(Object o) throws Exception
      Works like JSTL build-in size(x) function, but handle null gracefully.
      Throws:
      Exception

    • getRelativeLinkTo

      public static String getRelativeLinkTo(Item p)
      Computes the relative path from the current page to the given item.

    • getAllTopLevelItems

      public static List<TopLevelItem> getAllTopLevelItems(ItemGroup root)
      Gets all the TopLevelItems recursively in the ItemGroup tree.
      Since:
      1.512

    • getRelativeNameFrom

      @Nullable public static String getRelativeNameFrom(@CheckForNull Item p, @CheckForNull ItemGroup g, boolean useDisplayName)
      Gets the relative name or display name to the given item from the specified group.
      Parameters:
      p - the Item we want the relative display name. If null, a null will be returned by the method
      g - the ItemGroup used as point of reference for the item. If the group is not specified, item's path will be used.
      useDisplayName - if true, returns a display name, otherwise returns a name
      Returns:
      String like "foo » bar". null if item is null or if one of its parents is not an Item.
      Since:
      1.515

    • getRelativeNameFrom

      @Nullable public static String getRelativeNameFrom(@CheckForNull Item p, @CheckForNull ItemGroup g)
      Gets the name to the given item relative to given group.
      Parameters:
      p - the Item we want the relative display name If null, the method will immediately return null.
      g - the ItemGroup used as point of reference for the item
      Returns:
      String like "foo/bar". null if the item is null or if one of its parents is not an Item.
      Since:
      1.515

    • getRelativeDisplayNameFrom

      @Nullable public static String getRelativeDisplayNameFrom(@CheckForNull Item p, @CheckForNull ItemGroup g)
      Gets the relative display name to the given item from the specified group.
      Parameters:
      p - the Item we want the relative display name. If null, the method will immediately return null.
      g - the ItemGroup used as point of reference for the item
      Returns:
      String like "Foo » Bar". null if the item is null or if one of its parents is not an Item.
      Since:
      1.512

    • dumpAllThreads

      public static Map<Thread,StackTraceElement[]> dumpAllThreads()

    • getThreadInfos

      public static ThreadInfo[] getThreadInfos()

    • sortThreadsAndGetGroupMap

      public static Functions.ThreadGroupMap sortThreadsAndGetGroupMap(ThreadInfo[] list)

    • isMustangOrAbove

      @Deprecated public static boolean isMustangOrAbove()
      Deprecated.
      Now always true.

    • dumpThreadInfo

      public static String dumpThreadInfo(ThreadInfo ti, Functions.ThreadGroupMap map)

    • emptyList

      public static <T> Collection<T> emptyList()

    • jsStringEscape

      public static String jsStringEscape(String s)
      Escape a string so variable values can be used in inline JavaScript in views. Note that inline JavaScript and especially passing variables is discouraged, see the documentation for alternatives. 
       Input example : \ \\ ' "
 Output example: \\ \\\\ \' \"
      See Also:

    • capitalize

      public static String capitalize(String s)
      Converts "abc" to "Abc".

    • getVersion

      public static String getVersion()

    • getResourcePath

      public static String getResourcePath()
      Resource path prefix.

    • getViewResource

      public static String getViewResource(Object it, String path)

    • hasView

      public static boolean hasView(Object it, String path) throws IOException
      Throws:
      IOException

    • defaultToTrue

      public static boolean defaultToTrue(Boolean b)
      Can be used to check a checkbox by default. Used from views like h.defaultToTrue(scm.useUpdate). The expression will evaluate to true if scm is null.

    • defaulted

      public static <T> T defaulted(T value, T defaultValue)
      If the value exists, return that value. Otherwise return the default value.

      Starting 1.294, JEXL supports the elvis operator "x?:y" that supersedes this.

      Since:
      1.150

    • printThrowable

      @NonNull public static String printThrowable(@CheckForNull Throwable t)
      Prints a stack trace from an exception into a readable form. Unlike Throwable.printStackTrace(PrintWriter), this implementation follows the suggestion of JDK-6507809 to produce a linear trace even when Throwable.getCause() is used.
      Parameters:
      t - Input Throwable
      Returns:
      If t is not null, generally a multiline string ending in a (platform-specific) newline; otherwise, the method returns a default "No exception details" string.

    • printStackTrace

      public static void printStackTrace(@CheckForNull Throwable t, @NonNull PrintWriter pw)
      Like Throwable.printStackTrace(PrintWriter) but using printThrowable(java.lang.Throwable) format.
      Parameters:
      t - an exception to print
      pw - the log
      Since:
      2.43

    • printStackTrace

      public static void printStackTrace(@CheckForNull Throwable t, @NonNull PrintStream ps)
      Like Throwable.printStackTrace(PrintStream) but using printThrowable(java.lang.Throwable) format.
      Parameters:
      t - an exception to print
      ps - the log
      Since:
      2.43

    • determineRows

      public static int determineRows(String s)
      Counts the number of rows needed for textarea to fit the content. Minimum 5 rows.

    • toCCStatus

      @Deprecated @Restricted(org.kohsuke.accmod.restrictions.DoNotUse.class) @RestrictedSince("2.173") public static String toCCStatus(Item i)
      Deprecated.
      This functionality has been moved to ccxml plugin.
      Converts the Hudson build status to CruiseControl build status, which is either Success, Failure, Exception, or Unknown.

    • isAnonymous

      public static boolean isAnonymous()
      Checks if the current user is anonymous.

    • getCurrentJellyContext

      public static org.apache.commons.jelly.JellyContext getCurrentJellyContext()
      When called from within JEXL expression evaluation, this method returns the current JellyContext used to evaluate the script.
      Since:
      1.164

    • runScript

      public static String runScript(org.apache.commons.jelly.Script script) throws org.apache.commons.jelly.JellyTagException
      Evaluate a Jelly script and return output as a String.
      Throws:
      org.apache.commons.jelly.JellyTagException
      Since:
      1.267

    • subList

      public static <T> List<T> subList(List<T> base, int maxSize)
      Returns a sub-list if the given list is bigger than the specified maxSize. Warning: do not call this with a RunList, or you will break lazy loading!

    • joinPath

      public static String joinPath(String... components)
      Combine path components via '/' while handling leading/trailing '/' to avoid duplicates.

    • getActionUrl

      @CheckForNull public static String getActionUrl(String itUrl, Action action)
      Computes the hyperlink to actions, to handle the situation when the Action.getUrlName() returns absolute URL.
      Returns:
      null in case the action should not be presented to the user.

    • getConsoleUrl

      @CheckForNull public static String getConsoleUrl(WithConsoleUrl withConsoleUrl)
      Computes the link to the console for the run for the specified object, taking ConsoleUrlProvider into account.
      Parameters:
      withConsoleUrl - the object to compute a console url for (can be Run, a PlaceholderExecutable...)
      Returns:
      the absolute URL for accessing the build console for the given object, or null if there is no console URL defined for the object.
      Since:
      2.433

    • toEmailSafeString

      public static String toEmailSafeString(String projectName)
      Escapes the character unsafe for e-mail address. See the Wikipedia page for the details, but here the vocabulary is even more restricted.

    • getServerName

      @Deprecated public String getServerName()
      Deprecated.
      use JNLPLauncher.getInboundAgentUrl()
      Obtains the host name of the Hudson server that clients can use to talk back to.

      This was primarily used in jenkins-agent.jnlp.jelly to specify the destination that the agents talk to.

    • getCheckUrl

      @Deprecated public String getCheckUrl(String userDefined, Object descriptor, String field)
      Deprecated.
      Use calcCheckUrl(java.util.Map, java.lang.String, java.lang.Object, java.lang.String)
      Determines the form validation check URL. See textbox.jelly

    • calcCheckUrl

      public void calcCheckUrl(Map attributes, String userDefined, Object descriptor, String field)
      Determines the parameters that client-side needs for a form validation check. See prepareDatabinding.jelly
      Since:
      1.528

    • hyperlinkMatchesCurrentPage

      public boolean hyperlinkMatchesCurrentPage(String href)
      If the given href link is matching the current page, return true. Used in task.jelly to decide if the page should be highlighted.

    • singletonList

      @Deprecated public <T> List<T> singletonList(T t)
      Deprecated.
      From JEXL expressions (${…}) in *.jelly files you can use [obj] syntax to construct an Object[] (which may be usable where a List is expected) rather than h.singletonList(obj).

    • getPageDecorators

      public static List<PageDecorator> getPageDecorators()
      Gets all the PageDecorators.

    • getSimplePageDecorator

      public static SimplePageDecorator getSimplePageDecorator()
      Gets only one SimplePageDecorator.
      Since:
      2.128

    • getSimplePageDecorators

      public static List<SimplePageDecorator> getSimplePageDecorators()

    • getCloudDescriptors

      public static List<Descriptor<Cloud>> getCloudDescriptors()

    • prepend

      public String prepend(String prefix, String body)
      Prepend a prefix only when there's the specified body.

    • getCrumbIssuerDescriptors

      public static List<Descriptor<CrumbIssuer>> getCrumbIssuerDescriptors()

    • getCrumb

      public static String getCrumb(org.kohsuke.stapler.StaplerRequest2 req)
      Since:
      2.475

    • getCrumb

      @Deprecated public static String getCrumb(org.kohsuke.stapler.StaplerRequest req)
      Deprecated.
      use getCrumb(StaplerRequest2)

    • getCrumbRequestField

      public static String getCrumbRequestField()

    • getCurrentTime

      public static Date getCurrentTime()

    • getCurrentLocale

      public static Locale getCurrentLocale()

    • generateConsoleAnnotationScriptAndStylesheet

      public static String generateConsoleAnnotationScriptAndStylesheet()
      Generate a series of <script> tags to include script.js from ConsoleAnnotatorFactorys and ConsoleAnnotationDescriptors.

    • getLoggerNames

      public List<String> getLoggerNames()
      Work around for bug 6935026.

    • getPasswordValue

      public String getPasswordValue(Object o)
      Used by <f:password/> so that we send an encrypted value to the client.

    • filterDescriptors

      public List filterDescriptors(Object context, Iterable descriptors)

    • getIsUnitTest

      public static boolean getIsUnitTest()
      Returns true if we are running unit tests.

    • isArtifactsPermissionEnabled

      public static boolean isArtifactsPermissionEnabled()
      Returns true if the Run.ARTIFACTS permission is enabled, false otherwise.

      When the Run.ARTIFACTS permission is not turned on using the hudson.security.ArtifactsPermission system property, this permission must not be considered to be set to false for every user. It must rather be like if the permission doesn't exist at all (which means that every user has to have an access to the artifacts but the permission can't be configured in the security screen). Got it?

    • isWipeOutPermissionEnabled

      public static boolean isWipeOutPermissionEnabled()
      Returns true if the Item.WIPEOUT permission is enabled, false otherwise.

      The "Wipe Out Workspace" action available on jobs is controlled by the Item.BUILD permission. For some specific projects, however, it is not acceptable to let users have this possibility, even it they can trigger builds. As such, when enabling the hudson.security.WipeOutPermission system property, a new "WipeOut" permission will allow to have greater control on the "Wipe Out Workspace" action.

    • createRenderOnDemandProxy

      @Deprecated public static String createRenderOnDemandProxy(org.apache.commons.jelly.JellyContext context, String attributesToCapture)
      Deprecated.

    • createRenderOnDemandProxyParameters

      @Restricted(org.kohsuke.accmod.restrictions.NoExternalUse.class) public static org.kohsuke.stapler.StaplerRequest2.RenderOnDemandParameters createRenderOnDemandProxyParameters(org.apache.commons.jelly.JellyContext context, String attributesToCapture)
      Called from renderOnDemand.jelly to generate the parameters for the proxy object generation.
      Since:
      2.475

    • getCurrentDescriptorByNameUrl

      public static String getCurrentDescriptorByNameUrl()

    • setCurrentDescriptorByNameUrl

      public static String setCurrentDescriptorByNameUrl(String value)

    • restoreCurrentDescriptorByNameUrl

      public static void restoreCurrentDescriptorByNameUrl(String old)

    • getRequestHeaders

      public static List<String> getRequestHeaders(String name)

    • rawHtml

      public static Object rawHtml(Object o)
      Used for arguments to internationalized expressions to avoid escape

    • getCLICommands

      public static ArrayList<CLICommand> getCLICommands()

    • getAvatar

      public static String getAvatar(User user, String avatarSize)
      Returns an avatar image URL for the specified user and preferred image size
      Parameters:
      user - the user
      avatarSize - the preferred size of the avatar image
      Returns:
      a URL string
      Since:
      1.433

    • getUserAvatar

      @Deprecated public String getUserAvatar(User user, String avatarSize)
      Deprecated.
      as of 1.451 Use getAvatar(hudson.model.User, java.lang.String)

    • humanReadableByteSize

      public static String humanReadableByteSize(long size)
      Returns human readable information about file size
      Parameters:
      size - file size in bytes
      Returns:
      file size in appropriate unit

    • breakableString

      public static String breakableString(String plain)
      Get a string that can be safely broken to several lines when necessary. This implementation inserts <wbr> tags into string. It allows browsers to wrap line before any sequence of punctuation characters or anywhere in the middle of prolonged sequences of word characters.
      Since:
      1.517

    • advertiseHeaders

      public static void advertiseHeaders(jakarta.servlet.http.HttpServletResponse rsp)
      Advertises the minimum set of HTTP headers that assist programmatic discovery of Jenkins.

    • advertiseHeaders

      @Deprecated public static void advertiseHeaders(javax.servlet.http.HttpServletResponse rsp)
      Deprecated.
      use advertiseHeaders(HttpServletResponse)

    • isContextMenuVisible

      @Restricted(org.kohsuke.accmod.restrictions.NoExternalUse.class) public static boolean isContextMenuVisible(Action a)

    • tryGetIcon

      @Restricted(org.kohsuke.accmod.restrictions.NoExternalUse.class) public static Icon tryGetIcon(String iconGuess)

    • extractPluginNameFromIconSrc

      @Restricted(org.kohsuke.accmod.restrictions.NoExternalUse.class) public static String extractPluginNameFromIconSrc(String iconSrc)

    • tryGetIconPath

      @Restricted(org.kohsuke.accmod.restrictions.NoExternalUse.class) public static String tryGetIconPath(String iconGuess, org.apache.commons.jelly.JellyContext context)

    • generateItemId

      @Restricted(org.kohsuke.accmod.restrictions.NoExternalUse.class) public static String generateItemId()

    • getSearchFactories

      @Restricted(org.kohsuke.accmod.restrictions.NoExternalUse.class) public static ExtensionList<SearchFactory> getSearchFactories()

    • translateModifierKeysForUsersPlatform

      @Restricted(org.kohsuke.accmod.restrictions.NoExternalUse.class) public static String translateModifierKeysForUsersPlatform(String keyboardShortcut)
      Parameters:
      keyboardShortcut - the shortcut to be translated
      Returns:
      the translated shortcut, e.g. CMD+K to ⌘+K for macOS, CTRL+K for Windows

    • formatMessage

      @Restricted(org.kohsuke.accmod.restrictions.NoExternalUse.class) public static String formatMessage(String format, Object args)