hudson.plugins.collabnet.documentuploader
Class CNDocumentUploader.DescriptorImpl

java.lang.Object
  hudson.model.Descriptor<T>
      hudson.tasks.BuildStepDescriptor<hudson.tasks.Publisher>
          hudson.plugins.collabnet.documentuploader.CNDocumentUploader.DescriptorImpl

All Implemented Interfaces:

hudson.model.Saveable

Enclosing class:

CNDocumentUploader

@Extension
public static final class CNDocumentUploader.DescriptorImpl
extends hudson.tasks.BuildStepDescriptor<hudson.tasks.Publisher>

The CNDocumentUploader Descriptor class.

Nested Class Summary

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

hudson.model.Descriptor.FormException, hudson.model.Descriptor.PropertyType

Field Summary

Fields inherited from class hudson.model.Descriptor

clazz

Fields inherited from interface hudson.model.Saveable

NOOP

Constructor Summary

CNDocumentUploader.DescriptorImpl()

Method Summary

boolean	canInheritAuth()
hudson.util.FormValidation	doCollabNetUrlCheck(java.lang.String value) Form validation for the CollabNet URL.
void	doGetProjects(org.kohsuke.stapler.StaplerRequest req, org.kohsuke.stapler.StaplerResponse rsp) Updates the list of projects in the combo box.
hudson.util.FormValidation	doPasswordCheck(org.kohsuke.stapler.StaplerRequest req) Check that a password is present and allows login.
hudson.util.FormValidation	doPathCheck(org.kohsuke.stapler.StaplerRequest req) Form validation for upload path.
hudson.util.FormValidation	doProjectCheck(org.kohsuke.stapler.StaplerRequest req) Form validation for the project field.
hudson.util.FormValidation	doRequiredCheck(java.lang.String value, java.lang.String name) Form validation for username.
hudson.util.FormValidation	doUnRequiredInterpretedCheck(java.lang.String value, java.lang.String name) Form validation for the file patterns.
java.lang.String	getDisplayName()
java.lang.String	getHelpFile()
static java.lang.String	getHelpUrl()
int	getUniqueId()
boolean	isApplicable(java.lang.Class<? extends hudson.model.AbstractProject> jobType)
CNDocumentUploader	newInstance(org.kohsuke.stapler.StaplerRequest req, net.sf.json.JSONObject formData) Creates a new instance of CNDocumentUploader from a submitted form.

Methods inherited from class hudson.tasks.BuildStepDescriptor

filter

Methods inherited from class hudson.model.Descriptor

configure, configure, configure, convert, doHelp, find, find, getCheckUrl, getConfigPage, getGlobalConfigPage, getHelpFile, getJsonSafeClassName, getPropertyType, getViewPage, isInstance, isSubTypeOf, load, newInstance, newInstancesFromHeteroList, save, toArray, toList, toMap

Methods inherited from class java.lang.Object

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

Constructor Detail

CNDocumentUploader.DescriptorImpl

public CNDocumentUploader.DescriptorImpl()

Method Detail

getUniqueId

public int getUniqueId()

Returns:

a unique integer, used to uniquely identify an instance of this plugin on a page.

isApplicable

public boolean isApplicable(java.lang.Class<? extends hudson.model.AbstractProject> jobType)

Specified by:

isApplicable in class hudson.tasks.BuildStepDescriptor<hudson.tasks.Publisher>

getDisplayName

public java.lang.String getDisplayName()

Specified by:

getDisplayName in class hudson.model.Descriptor<hudson.tasks.Publisher>

Returns:

string to display for configuration screen.

getHelpUrl

public static java.lang.String getHelpUrl()

Returns:

the root for the document uploader's resources.

getHelpFile

public java.lang.String getHelpFile()

Overrides:

getHelpFile in class hudson.model.Descriptor<hudson.tasks.Publisher>

Returns:

a relative url to the main help file.

canInheritAuth

public boolean canInheritAuth()

Returns:

true if there is auth data that can be inherited.

newInstance

public CNDocumentUploader newInstance(org.kohsuke.stapler.StaplerRequest req,
                                      net.sf.json.JSONObject formData)
                               throws hudson.model.Descriptor.FormException

Creates a new instance of CNDocumentUploader from a submitted form.

Overrides:

newInstance in class hudson.model.Descriptor<hudson.tasks.Publisher>

Parameters:

req - config page parameters.

Returns:

new CNDocumentUploader object, instantiated from the configuration form vars.

Throws:

FormException

hudson.model.Descriptor.FormException

doCollabNetUrlCheck

public hudson.util.FormValidation doCollabNetUrlCheck(@QueryParameter
                                                      java.lang.String value)

Form validation for the CollabNet URL.

Parameters:

value - url

doRequiredCheck

public hudson.util.FormValidation doRequiredCheck(@QueryParameter
                                                  java.lang.String value,
                                                  @QueryParameter
                                                  java.lang.String name)

Form validation for username.

Parameters:

value - to check

name - of field

doPasswordCheck

public hudson.util.FormValidation doPasswordCheck(org.kohsuke.stapler.StaplerRequest req)

Check that a password is present and allows login.

Parameters:

password -

doProjectCheck

public hudson.util.FormValidation doProjectCheck(org.kohsuke.stapler.StaplerRequest req)

Form validation for the project field.

Parameters:

req - contains parameters from the config.jelly.

rsp - contains http response data (unused).

Throws:

java.io.IOException

javax.servlet.ServletException

doPathCheck

public hudson.util.FormValidation doPathCheck(org.kohsuke.stapler.StaplerRequest req)
                                       throws java.io.IOException

Form validation for upload path.

Parameters:

req - StaplerRequest which contains parameters from the config.jelly.

rsp - contains http response data (unused).

Throws:

java.io.IOException

javax.servlet.ServletException

doUnRequiredInterpretedCheck

public hudson.util.FormValidation doUnRequiredInterpretedCheck(@QueryParameter
                                                               java.lang.String value,
                                                               @QueryParameter
                                                               java.lang.String name)

Form validation for the file patterns.

Parameters:

req - StaplerRequest which contains parameters from the config.jelly.

rsp - contains http response data (unused).

Throws:

java.io.IOException

javax.servlet.ServletException

doGetProjects

public void doGetProjects(org.kohsuke.stapler.StaplerRequest req,
                          org.kohsuke.stapler.StaplerResponse rsp)
                   throws java.io.IOException

Updates the list of projects in the combo box. Expects the StaplerRequest to contain url, username, and password.

Parameters:

req - contains parameters from the config.jelly.

rsp - http response data.

Throws:

java.io.IOException