hudson.security
Class HudsonPrivateSecurityRealm.Details.DescriptorImpl

java.lang.Object
  hudson.model.Descriptor<UserProperty>
      hudson.model.UserPropertyDescriptor
          hudson.security.HudsonPrivateSecurityRealm.Details.DescriptorImpl

All Implemented Interfaces:

Saveable

Enclosing class:

HudsonPrivateSecurityRealm.Details

@Extension
public static final class HudsonPrivateSecurityRealm.Details.DescriptorImpl
extends UserPropertyDescriptor

Nested Class Summary

Nested classes/interfaces inherited from class hudson.model.Descriptor

Descriptor.FormException, Descriptor.PropertyType, Descriptor.Self

Field Summary

Fields inherited from class hudson.model.Descriptor

clazz

Fields inherited from interface hudson.model.Saveable

NOOP

Constructor Summary

HudsonPrivateSecurityRealm.Details.DescriptorImpl()

Method Summary

String	getDisplayName() Human readable name of this kind of configurable object.
boolean	isEnabled() Whether or not the described property is enabled in the current context.
HudsonPrivateSecurityRealm.Details	newInstance(org.kohsuke.stapler.StaplerRequest req, net.sf.json.JSONObject formData) Creates a configured instance from the submitted form.
UserProperty	newInstance(User user) Creates a default instance of UserProperty to be associated with User object that wasn't created from a persisted XML data.

Methods inherited from class hudson.model.Descriptor

addHelpFileRedirect, calcAutoCompleteSettings, calcFillSettings, configure, configure, doHelp, find, find, getCheckUrl, getConfigFile, getConfigPage, getCurrentDescriptorByNameUrl, getDescriptorFullUrl, getDescriptorUrl, getGlobalConfigPage, getGlobalPropertyType, getHelpFile, getHelpFile, getHelpFile, getId, getJsonSafeClassName, getKlass, getPlugin, getPossibleViewNames, getPropertyType, getPropertyType, getPropertyTypeOrDie, getT, getViewPage, isInstance, isSubTypeOf, load, newInstance, newInstancesFromHeteroList, newInstancesFromHeteroList, save, self, toArray, toList, toMap

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

HudsonPrivateSecurityRealm.Details.DescriptorImpl

public HudsonPrivateSecurityRealm.Details.DescriptorImpl()

Method Detail

getDisplayName

public String getDisplayName()

Description copied from class: Descriptor

Human readable name of this kind of configurable object.

Specified by:

getDisplayName in class Descriptor<UserProperty>

newInstance

public HudsonPrivateSecurityRealm.Details newInstance(org.kohsuke.stapler.StaplerRequest req,
                                                      net.sf.json.JSONObject formData)
                                               throws Descriptor.FormException

Description copied from class: Descriptor

Creates a configured instance from the submitted form.

Hudson only invokes this method when the user wants an instance of T. So there's no need to check that in the implementation.

Starting 1.206, the default implementation of this method does the following:

 req.bindJSON(clazz,formData);
 

... which performs the databinding on the constructor of Descriptor.clazz.

For some types of Describable, such as ListViewColumn, this method can be invoked with null request object for historical reason. Such design is considered broken, but due to the compatibility reasons we cannot fix it. Because of this, the default implementation gracefully handles null request, but the contract of the method still is "request is always non-null." Extension points that need to define the "default instance" semantics should define a descriptor subtype and add the no-arg newInstance method.

Overrides:

newInstance in class Descriptor<UserProperty>

Parameters:

req - Always non-null (see note above.) This object includes represents the entire submission.

formData - The JSON object that captures the configuration data for this Descriptor. See http://wiki.jenkins-ci.org/display/JENKINS/Structured+Form+Submission Always non-null.

Throws:

Descriptor.FormException - Signals a problem in the submitted form.

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

newInstance

public UserProperty 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.