Class UserSeedProperty.DescriptorImpl

    • Constructor Detail

      • DescriptorImpl

        public DescriptorImpl()
    • Method Detail

      • getDisplayName

        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.
        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
        null if the implementation choose not to add any property object for such user.
      • isCurrentUser

        public boolean isCurrentUser​(@NonNull
                                     User target)
      • doRenewSessionSeed

        public org.kohsuke.stapler.HttpResponse doRenewSessionSeed​(@AncestorInPath @NonNull
                                                                   User u)
                                                            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.

        isEnabled in class UserPropertyDescriptor