com.zanox.hudson.plugins
Class FTPPublisher.DescriptorImpl

java.lang.Object
  hudson.model.Descriptor<T>
      hudson.tasks.BuildStepDescriptor<hudson.tasks.Publisher>
          com.zanox.hudson.plugins.FTPPublisher.DescriptorImpl

All Implemented Interfaces:

hudson.model.Saveable

Enclosing class:

FTPPublisher

public static final class FTPPublisher.DescriptorImpl
extends hudson.tasks.BuildStepDescriptor<hudson.tasks.Publisher>

This class holds the metadata for the FTPPublisher.

Author:

$Author: ZANOX-COM\fit $

See Also:

Descriptor

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

FTPPublisher.DescriptorImpl()
The default constructor.

Method Summary

boolean	configure(org.kohsuke.stapler.StaplerRequest req, net.sf.json.JSONObject formData)
hudson.util.FormValidation	doLoginCheck(org.kohsuke.stapler.StaplerRequest request) This method validates the current entered ftp configuration data.
java.lang.String	getDisplayName() The name of the plugin to display them on the project configuration web page.
java.lang.String	getHelpFile() Return the location of the help document for this publisher.
FTPSite[]	getSites() The getter of the sites field.
boolean	isApplicable(java.lang.Class<? extends hudson.model.AbstractProject> jobType)
boolean	isFlatten(FTPPublisher pub)
boolean	isFlattenFilesSelectedByDefault()
hudson.tasks.Publisher	newInstance(org.kohsuke.stapler.StaplerRequest req, net.sf.json.JSONObject formData) This method is called by hudson if the user has clicked the add button of the FTP repository hosts point in the System Configuration web page.
void	setFlattenFilesSelectedByDefault(boolean flattenFilesSelectedByDefault)

Methods inherited from class hudson.tasks.BuildStepDescriptor

filter

Methods inherited from class hudson.model.Descriptor

configure, 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

FTPPublisher.DescriptorImpl

public FTPPublisher.DescriptorImpl()

The default constructor.

Method Detail

setFlattenFilesSelectedByDefault

public void setFlattenFilesSelectedByDefault(boolean flattenFilesSelectedByDefault)

isFlattenFilesSelectedByDefault

public boolean isFlattenFilesSelectedByDefault()

getDisplayName

public java.lang.String getDisplayName()

The name of the plugin to display them on the project configuration web page.

Specified by:

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

Returns:

See Also:

Descriptor.getDisplayName()

getHelpFile

public java.lang.String getHelpFile()

Return the location of the help document for this publisher.

Overrides:

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

Returns:

See Also:

Descriptor.getHelpFile()

isApplicable

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

Specified by:

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

newInstance

public hudson.tasks.Publisher newInstance(org.kohsuke.stapler.StaplerRequest req,
                                          net.sf.json.JSONObject formData)

This method is called by hudson if the user has clicked the add button of the FTP repository hosts point in the System Configuration web page. It's create a new instance of the FTPPublisher class and added all configured ftp sites to this instance by calling the method FTPPublisher.getEntries() and on it's return value the addAll method is called.

Overrides:

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

Parameters:

req -

Returns:

See Also:

Descriptor.newInstance(org.kohsuke.stapler.StaplerRequest)

isFlatten

public boolean isFlatten(FTPPublisher pub)

getSites

public FTPSite[] getSites()

The getter of the sites field.

Returns:

the value of the sites field.

configure

public boolean configure(org.kohsuke.stapler.StaplerRequest req,
                         net.sf.json.JSONObject formData)

Overrides:

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

Parameters:

req -

Returns:

See Also:

Descriptor.configure(org.kohsuke.stapler.StaplerRequest)

doLoginCheck

public hudson.util.FormValidation doLoginCheck(org.kohsuke.stapler.StaplerRequest request)

This method validates the current entered ftp configuration data. That is made by create a ftp connection.

Parameters:

request - the current HttpServletRequest