Package hudson.model

Class UserProperty

java.lang.Object
hudson.model.UserProperty
All Implemented Interfaces:
ExtensionPoint, Describable<UserProperty>, ReconfigurableDescribable<UserProperty>
Direct Known Subclasses:
ApiTokenProperty, ConsoleUrlProviderUserProperty, FederatedLoginServiceUserProperty, HudsonPrivateSecurityRealm.Details, LastGrantedAuthoritiesProperty, MyViewsProperty, PaneStatusProperties, TimeZoneProperty, UserExperimentalFlagsProperty, UserSearchProperty, UserSeedProperty
@ExportedBean public abstract class UserProperty extends Object implements ReconfigurableDescribable<UserProperty>, ExtensionPoint
Extensible property of User.

Plugins can extend this to define custom properties for Users. UserPropertys show up in the user configuration screen, and they are persisted with the user object.

Configuration screen should be defined in config.jelly. Within this page, the UserProperty instance is available as instance variable (while it refers to User. See UserSearchProperty's config.jelly for an example.

A property may also define a summary.jelly view to show in the main user screen.

Author:
Kohsuke Kawaguchi

  • Field Details

    • user

      protected transient User user
      The user object that owns this property. This value will be set by the Hudson code. Derived classes can expect this value to be always set.

  • Constructor Details

    • UserProperty

      public UserProperty()

  • Method Details

    • setUser

      protected void setUser(User u)
      This method is used to inform the property about its owner. It could be called multiple times, even without change, thus it should be idempotent.

    • getDescriptor

      public UserPropertyDescriptor getDescriptor()
      Description copied from interface: Describable
      Gets the descriptor for this instance.

      Descriptor is a singleton for every concrete Describable implementation, so if a.getClass() == b.getClass() then by default a.getDescriptor() == b.getDescriptor() as well. (In rare cases a single implementation class may be used for instances with distinct descriptors.)

      Specified by:
      getDescriptor in interface Describable<UserProperty>

    • all

      public static DescriptorExtensionList<UserProperty,UserPropertyDescriptor> all()
      Returns all the registered UserPropertyDescriptors.

    • allByCategoryClass

      public static List<UserPropertyDescriptor> allByCategoryClass(@NonNull Class<? extends UserPropertyCategory> categoryClass)
      Returns all the registered UserPropertyCategory descriptors for a given category.
      Since:
      2.468

    • reconfigure

      public UserProperty reconfigure(org.kohsuke.stapler.StaplerRequest req, net.sf.json.JSONObject form) throws Descriptor.FormException
      Description copied from interface: ReconfigurableDescribable
      When a parent/owner object of a Describable gets a config form submission and instances are recreated, this method is invoked on the existing instance (meaning the 'this' reference points to the existing instance) to create a new instance to be added to the parent/owner object.

      The default implementation of this should be the following: 

       return form==null ? null : getDescriptor().newInstance(req, form);
      Specified by:
      reconfigure in interface ReconfigurableDescribable<UserProperty>
      Parameters:
      req - The current HTTP request being processed.
      form - JSON fragment that corresponds to this describable object. If the newly submitted form doesn't include a fragment for this describable (meaning the user has de-selected your descriptor), then this argument is null.
      Returns:
      The new instance. To not to create an instance of a describable, return null.
      Throws:
      Descriptor.FormException