Package jenkins.model.identity

Class IdentityRootAction

java.lang.Object
jenkins.model.identity.IdentityRootAction
All Implemented Interfaces:
ExtensionPoint, Action, ModelObject, RootAction, UnprotectedRootAction
@Extension public class IdentityRootAction extends Object implements UnprotectedRootAction
A simple root action that exposes the public key to users so that they do not need to search for the X-Instance-Identity response header, also exposes the fingerprint of the public key so that people can verify a fingerprint of a master before connecting to it.

Do not use this class from plugins. Depend on instance-identity directly instead.

Since:
2.16

  • Constructor Details

    • IdentityRootAction

      public IdentityRootAction()

  • Method Details

    • getIconFileName

      public String getIconFileName()
      Description copied from interface: Action
      Gets the name of the icon.
      Specified by:
      getIconFileName in interface Action
      Returns:
      If the icon name is prefixed with "symbol-", a Jenkins Symbol will be used.

      If just a file name (like "abc.gif") is returned, it will be interpreted as a file name inside /images/24x24. This is useful for using one of the stock images.

      If an absolute file name that starts from '/' is returned (like "/plugin/foo/abc.gif"), then it will be interpreted as a path from the context root of Jenkins. This is useful to pick up image files from a plugin.

      Finally, return null to hide it from the task list. This is normally not very useful, but this can be used for actions that only contribute floatBox.jelly and no task list item. The other case where this is useful is to avoid showing links that require a privilege when the user is anonymous.

      See Also:

    • 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".
      Specified by:
      getDisplayName in interface Action
      Specified by:
      getDisplayName in interface ModelObject
      Returns:
      Can be null in case the action is hidden.

    • getUrlName

      public String getUrlName()
      Description copied from interface: Action
      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.

      Specified by:
      getUrlName in interface Action
      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:

    • getPublicKey

      @CheckForNull public String getPublicKey()
      Returns the PEM encoded public key.
      Returns:
      the PEM encoded public key. Null if the instance-identity plugin is not enabled.

    • getFingerprint

      @NonNull public String getFingerprint()
      Returns the fingerprint of the public key.
      Returns:
      the fingerprint of the public key.