hudson.model
Class UserProperty

java.lang.Object
  extended by hudson.model.UserProperty
All Implemented Interfaces:
ExtensionPoint, Describable<UserProperty>
Direct Known Subclasses:
FederatedLoginServiceUserProperty, HudsonPrivateSecurityRealm.Details, Mailer.UserProperty, MyViewsProperty

@ExportedBean
public abstract class UserProperty
extends Object
implements Describable<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 Mailer.UserProperty's config.jelly for an example.

Author:
Kohsuke Kawaguchi

Nested Class Summary
 
Nested classes/interfaces inherited from interface hudson.ExtensionPoint
ExtensionPoint.LegacyInstancesAreScopedToHudson
 
Constructor Summary
UserProperty()
           
 
Method Summary
static DescriptorExtensionList<UserProperty,UserPropertyDescriptor> all()
          Returns all the registered UserPropertyDescriptors.
 UserPropertyDescriptor getDescriptor()
          Gets the descriptor for this instance.
 UserProperty reconfigure(org.kohsuke.stapler.StaplerRequest req, net.sf.json.JSONObject form)
           
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

UserProperty

public UserProperty()
Method Detail

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 a.getDescriptor()==b.getDescriptor() must hold.

Specified by:
getDescriptor in interface Describable<UserProperty>

all

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


reconfigure

public UserProperty reconfigure(org.kohsuke.stapler.StaplerRequest req,
                                net.sf.json.JSONObject form)
                         throws Descriptor.FormException
Throws:
Descriptor.FormException


Copyright © 2004-2013 Hudson. All Rights Reserved.