Class ReloadLink

    • Constructor Detail

      • ReloadLink

        public ReloadLink()
    • Method Detail

      • getDisplayName

        public String getDisplayName()
        Description copied from interface: Action
        Gets the string to be displayed. The convention is to capitalize the first letter of each word, such as "Test Result".
        Returns:
        Can be null in case the action is hidden.
      • getDescription

        public String getDescription()
        Description copied from class: ManagementLink
        Returns a short description of what this link does. This text is the one that's displayed in grey. This can include HTML, although the use of block tags is highly discouraged. Optional.
        Overrides:
        getDescription in class ManagementLink
      • getUrlName

        public String getUrlName()
        Description copied from class: ManagementLink
        Gets the URL path name.

        For example, if this method returns "xyz", and if the parent object (that this action is associated with) is bound to /foo/bar/zot, then this action object will be exposed to /foo/bar/zot/xyz.

        This method should return a string that's unique among other Actions.

        The returned string can be an absolute URL, like "http://www.sun.com/", which is useful for directly connecting to external systems.

        If the returned string starts with '/', like '/foo', then it's assumed to be relative to the context path of the Jenkins webapp.

        In case of ManagementLink, this value is put straight into the href attribute, so relative paths are interpreted against the root Jenkins object.

        Specified by:
        getUrlName in interface Action
        Specified by:
        getUrlName in class ManagementLink
        Returns:
        null if this action object doesn't need to be bound to web (when you do that, be sure to also return null from Action.getIconFileName().
        See Also:
        Functions.getActionUrl(String, Action)
      • getRequiresConfirmation

        public boolean getRequiresConfirmation()
        Description copied from class: ManagementLink
        Allows implementations to request that this link show a confirmation dialog, and use POST if confirmed. Suitable for links which perform an action rather than simply displaying a page.
        Overrides:
        getRequiresConfirmation in class ManagementLink
        Returns:
        true if this link takes an action
        See Also:
        RequirePOST
      • getRequiresPOST

        public boolean getRequiresPOST()
        Description copied from class: ManagementLink
        Define if the rendered link will use the default GET method or POST.
        Overrides:
        getRequiresPOST in class ManagementLink
        Returns:
        true if POST must be used
        See Also:
        RequirePOST
      • getRequiredPermission

        @NonNull
        public Permission getRequiredPermission()
        Description copied from class: ManagementLink
        Returns the permission required for user to see this management link on the "Manage Jenkins" page (ManageJenkinsAction). Historically, this returned null, which amounted to the same behavior, as Jenkins.ADMINISTER was required to access the page.
        Overrides:
        getRequiredPermission in class ManagementLink
        Returns:
        the permission required for the link to be shown on "Manage Jenkins".