Package jenkins.security.seed

Class UserSeedProperty.DescriptorImpl

java.lang.Object
hudson.model.Descriptor<UserProperty>
hudson.model.UserPropertyDescriptor
jenkins.security.seed.UserSeedProperty.DescriptorImpl
All Implemented Interfaces:
Saveable, Loadable, OnMaster
Enclosing class:
UserSeedProperty
@Extension @Symbol("userSeed") public static final class UserSeedProperty.DescriptorImpl extends UserPropertyDescriptor

  • Constructor Details

    • DescriptorImpl

      public DescriptorImpl()

  • Method Details

    • getDisplayName

      @NonNull public String getDisplayName()
      Description copied from class: Descriptor
      Human readable name of this kind of configurable object. Should be overridden for most descriptors, if the display name is visible somehow. As a fallback it uses Class.getSimpleName() on Descriptor.clazz, so for example MyThing from some.pkg.MyThing.DescriptorImpl. Historically some implementations returned null as a way of hiding the descriptor from the UI, but this is generally managed by an explicit method such as isEnabled or isApplicable.
      Overrides:
      getDisplayName in class Descriptor<UserProperty>

    • newInstance

      public UserSeedProperty newInstance(User user)
      Description copied from class: UserPropertyDescriptor
      Creates a default instance of UserProperty to be associated with User object that wasn't created from a persisted XML data.

      See User class javadoc for more details about the life cycle of User and when this method is invoked.

      Specified by:
      newInstance in class UserPropertyDescriptor
      Returns:
      null if the implementation choose not to add any property object for such user.

    • isCurrentUser

      @Restricted(org.kohsuke.accmod.restrictions.DoNotUse.class) public boolean isCurrentUser(@NonNull User target)

    • doRenewSessionSeed

      public org.kohsuke.stapler.HttpResponse doRenewSessionSeed(@AncestorInPath @NonNull User u) throws IOException
      Throws:
      IOException

    • isEnabled

      public boolean isEnabled()
      Description copied from class: UserPropertyDescriptor
      Whether or not the described property is enabled in the current context. Defaults to true. Over-ride in sub-classes as required.

      Returning false from this method essentially has the same effect of making Hudson behaves as if this UserPropertyDescriptor is not a part of UserProperty.all().

      This mechanism is useful if the availability of the property is contingent of some other settings.

      Overrides:
      isEnabled in class UserPropertyDescriptor

    • getUserPropertyCategory

      @NonNull public UserPropertyCategory getUserPropertyCategory()
      Description copied from class: UserPropertyDescriptor
      Define the category for this user property descriptor.
      Overrides:
      getUserPropertyCategory in class UserPropertyDescriptor
      Returns:
      never null, always the same value for a given instance of Descriptor.