hudson.scm

Class SubversionSCM.DescriptorImpl

java.lang.Object

hudson.model.Descriptor<hudson.scm.SCM>

hudson.scm.SCMDescriptor<SubversionSCM>

hudson.scm.SubversionSCM.DescriptorImpl

All Implemented Interfaces:

hudson.model.ModelObject, hudson.model.Saveable

Enclosing class:

SubversionSCM

@Extension
public static class SubversionSCM.DescriptorImpl
extends hudson.scm.SCMDescriptor<SubversionSCM>
implements hudson.model.ModelObject

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SubversionSCM.DescriptorImpl.Credential Stores SVNAuthentication for a single realm.
static class	SubversionSCM.DescriptorImpl.PasswordCredential Deprecated. left for backward compatibility.
static class	SubversionSCM.DescriptorImpl.SshPublicKeyCredential Deprecated. left for backward compatibility.
static class	SubversionSCM.DescriptorImpl.SslClientCertificateCredential Deprecated. left for backward compatibility.

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

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

Field Summary

Fields inherited from class hudson.scm.SCMDescriptor

generation, repositoryBrowser

Fields inherited from class hudson.model.Descriptor

clazz

Fields inherited from interface hudson.model.Saveable

NOOP

Constructor Summary

Constructors

Modifier	Constructor and Description
	SubversionSCM.DescriptorImpl()
protected	SubversionSCM.DescriptorImpl(Class clazz, Class<? extends hudson.scm.RepositoryBrowser> repositoryBrowser)

Method Summary

Methods

Modifier and Type	Method and Description
org.tmatesoft.svn.core.SVNNodeKind	checkRepositoryPath(hudson.model.AbstractProject context, org.tmatesoft.svn.core.SVNURL repoURL)
boolean	configure(org.kohsuke.stapler.StaplerRequest req, net.sf.json.JSONObject formData)
org.tmatesoft.svn.core.auth.ISVNAuthenticationProvider	createAuthenticationProvider() Deprecated. as of 1.18 Now that Hudson allows different credentials to be given in different jobs, The caller should use createAuthenticationProvider(AbstractProject) to indicate the project in which the subversion operation is performed.
org.tmatesoft.svn.core.auth.ISVNAuthenticationProvider	createAuthenticationProvider(hudson.model.AbstractProject<?,?> inContextOf) Creates ISVNAuthenticationProvider backed by credentials.
hudson.util.FormValidation	doCheckExcludedCommitMessages(String value) Validates the excludeCommitMessages field.
hudson.util.FormValidation	doCheckExcludedRegions(String value) Validates the excludeRegions Regex.
hudson.util.FormValidation	doCheckExcludedUsers(String value) Validates the excludeUsers field.
hudson.util.FormValidation	doCheckIncludedRegions(String value) Validates the includedRegions Regex.
hudson.util.FormValidation	doCheckLocal(String value) Validates the value for a local location (local checkout directory).
hudson.util.FormValidation	doCheckRemote(org.kohsuke.stapler.StaplerRequest req, hudson.model.AbstractProject context, String value) Validates the value for a remote (repository) location.
hudson.util.FormValidation	doCheckRevisionPropertiesSupported(hudson.model.AbstractProject context, String value) Validates the remote server supports custom revision properties.
void	doPostCredential(org.kohsuke.stapler.StaplerRequest req, org.kohsuke.stapler.StaplerResponse rsp) Submits the authentication info.
String	getDisplayName()
String	getGlobalExcludedRevprop()
static String	getRelativePath(org.tmatesoft.svn.core.SVNURL repoURL, org.tmatesoft.svn.core.io.SVNRepository repository)
protected org.tmatesoft.svn.core.io.SVNRepository	getRepository(hudson.model.AbstractProject context, org.tmatesoft.svn.core.SVNURL repoURL)
SubversionSCM.RevisionPolicy[]	getRevisionOptions() Returns available choose for revision policy option.
SubversionSCM.RevisionPolicy	getRevisionPolicy() Returns revision policy.
int	getWorkspaceFormat()
List<WorkspaceUpdaterDescriptor>	getWorkspaceUpdaterDescriptors()
boolean	isBrowserReusable(SubversionSCM x, SubversionSCM y)
boolean	isValidateRemoteUpToVar()
hudson.scm.SCM	newInstance(org.kohsuke.stapler.StaplerRequest staplerRequest, net.sf.json.JSONObject jsonObject)
void	postCredential(hudson.model.AbstractProject inContextOf, String url, String username, String password, File keyFile, PrintWriter logWriter)
void	postCredential(String url, String username, String password, File keyFile, PrintWriter logWriter) Deprecated. as of 1.18 Use postCredential(AbstractProject, String, String, String, File, PrintWriter)
void	postCredential(String url, UserProvidedCredential upc, PrintWriter logWriter) Submits the authentication info.

Methods inherited from class hudson.scm.SCMDescriptor

getBrowserDescriptors, getGeneration, isApplicable, load

Methods inherited from class hudson.model.Descriptor

calcAutoCompleteSettings, calcFillSettings, configure, doHelp, find, find, getCheckUrl, getConfigFile, getConfigPage, getDescriptorUrl, getGlobalConfigPage, getGlobalPropertyType, getHelpFile, getHelpFile, getId, getJsonSafeClassName, getPropertyType, getPropertyType, getViewPage, isInstance, isSubTypeOf, newInstance, newInstancesFromHeteroList, 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

SubversionSCM.DescriptorImpl

public SubversionSCM.DescriptorImpl()

SubversionSCM.DescriptorImpl

protected SubversionSCM.DescriptorImpl(Class clazz,
                            Class<? extends hudson.scm.RepositoryBrowser> repositoryBrowser)

Method Detail

newInstance

public hudson.scm.SCM newInstance(org.kohsuke.stapler.StaplerRequest staplerRequest,
                         net.sf.json.JSONObject jsonObject)
                           throws hudson.model.Descriptor.FormException

Overrides:

newInstance in class hudson.model.Descriptor<hudson.scm.SCM>

Throws:

hudson.model.Descriptor.FormException

getDisplayName

public String getDisplayName()

Specified by:

getDisplayName in interface hudson.model.ModelObject

Specified by:

getDisplayName in class hudson.model.Descriptor<hudson.scm.SCM>

getGlobalExcludedRevprop

public String getGlobalExcludedRevprop()

getWorkspaceFormat

public int getWorkspaceFormat()

isValidateRemoteUpToVar

public boolean isValidateRemoteUpToVar()

getRevisionOptions

@Exported
public SubversionSCM.RevisionPolicy[] getRevisionOptions()

Returns available choose for revision policy option.

Returns:

available choose for revision policy option.

getRevisionPolicy

public SubversionSCM.RevisionPolicy getRevisionPolicy()

Returns revision policy.

Returns:

revision policy.

configure

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

Overrides:

configure in class hudson.model.Descriptor<hudson.scm.SCM>

Throws:

hudson.model.Descriptor.FormException

isBrowserReusable

public boolean isBrowserReusable(SubversionSCM x,
                        SubversionSCM y)

Overrides:

isBrowserReusable in class hudson.scm.SCMDescriptor<SubversionSCM>

createAuthenticationProvider

public org.tmatesoft.svn.core.auth.ISVNAuthenticationProvider createAuthenticationProvider(hudson.model.AbstractProject<?,?> inContextOf)

Creates ISVNAuthenticationProvider backed by credentials. This method must be invoked on the master, but the returned object is remotable.

Therefore, to access ISVNAuthenticationProvider, you need to call this method on the master, then pass the object to the slave side, then call SubversionSCM.createSvnClientManager(ISVNAuthenticationProvider) on the slave.

See Also:

SubversionSCM.createSvnClientManager(ISVNAuthenticationProvider)

createAuthenticationProvider

public org.tmatesoft.svn.core.auth.ISVNAuthenticationProvider createAuthenticationProvider()

Deprecated. as of 1.18 Now that Hudson allows different credentials to be given in different jobs, The caller should use createAuthenticationProvider(AbstractProject) to indicate the project in which the subversion operation is performed.

doPostCredential

public void doPostCredential(org.kohsuke.stapler.StaplerRequest req,
                    org.kohsuke.stapler.StaplerResponse rsp)
                      throws IOException,
                             javax.servlet.ServletException

Submits the authentication info.

Throws:

IOException

javax.servlet.ServletException

postCredential

public void postCredential(String url,
                  String username,
                  String password,
                  File keyFile,
                  PrintWriter logWriter)
                    throws org.tmatesoft.svn.core.SVNException,
                           IOException

Deprecated. as of 1.18 Use postCredential(AbstractProject, String, String, String, File, PrintWriter)

Throws:

org.tmatesoft.svn.core.SVNException

IOException

postCredential

public void postCredential(hudson.model.AbstractProject inContextOf,
                  String url,
                  String username,
                  String password,
                  File keyFile,
                  PrintWriter logWriter)
                    throws org.tmatesoft.svn.core.SVNException,
                           IOException

Throws:

org.tmatesoft.svn.core.SVNException

IOException

postCredential

public void postCredential(String url,
                  UserProvidedCredential upc,
                  PrintWriter logWriter)
                    throws org.tmatesoft.svn.core.SVNException,
                           IOException

Submits the authentication info.

This code is fairly ugly because of the way SVNKit handles credentials.

Throws:

org.tmatesoft.svn.core.SVNException

IOException

doCheckRemote

public hudson.util.FormValidation doCheckRemote(org.kohsuke.stapler.StaplerRequest req,
                                       @AncestorInPath
                                       hudson.model.AbstractProject context,
                                       @QueryParameter
                                       String value)

Validates the value for a remote (repository) location.

Parameters:

req - StaplerRequest.

context - AbstractProject.

value - value to validate.

Returns:

FormValidation.

checkRepositoryPath

public org.tmatesoft.svn.core.SVNNodeKind checkRepositoryPath(hudson.model.AbstractProject context,
                                                     org.tmatesoft.svn.core.SVNURL repoURL)
                                                       throws org.tmatesoft.svn.core.SVNException

Throws:

org.tmatesoft.svn.core.SVNException

getRepository

protected org.tmatesoft.svn.core.io.SVNRepository getRepository(hudson.model.AbstractProject context,
                                                    org.tmatesoft.svn.core.SVNURL repoURL)
                                                         throws org.tmatesoft.svn.core.SVNException

Throws:

org.tmatesoft.svn.core.SVNException

getRelativePath

public static String getRelativePath(org.tmatesoft.svn.core.SVNURL repoURL,
                     org.tmatesoft.svn.core.io.SVNRepository repository)
                              throws org.tmatesoft.svn.core.SVNException

Throws:

org.tmatesoft.svn.core.SVNException

doCheckLocal

public hudson.util.FormValidation doCheckLocal(@QueryParameter
                                      String value)
                                        throws IOException,
                                               javax.servlet.ServletException

Validates the value for a local location (local checkout directory).

Parameters:

value - value to validate.

Returns:

FormValidation.

Throws:

IOException - IOException.

javax.servlet.ServletException - ServletException.

doCheckExcludedRegions

public hudson.util.FormValidation doCheckExcludedRegions(@QueryParameter
                                                String value)
                                                  throws IOException,
                                                         javax.servlet.ServletException

Validates the excludeRegions Regex.

Parameters:

value - value to validate.

Returns:

FormValidation.

Throws:

IOException - IOException.

javax.servlet.ServletException - ServletException.

doCheckIncludedRegions

public hudson.util.FormValidation doCheckIncludedRegions(@QueryParameter
                                                String value)
                                                  throws IOException,
                                                         javax.servlet.ServletException

Validates the includedRegions Regex.

Parameters:

value - value to validate.

Returns:

FormValidation.

Throws:

IOException - IOException.

javax.servlet.ServletException - ServletException.

doCheckExcludedUsers

public hudson.util.FormValidation doCheckExcludedUsers(@QueryParameter
                                              String value)
                                                throws IOException,
                                                       javax.servlet.ServletException

Validates the excludeUsers field.

Parameters:

value - value to validate.

Returns:

FormValidation.

Throws:

IOException - IOException.

javax.servlet.ServletException - ServletException.

getWorkspaceUpdaterDescriptors

public List<WorkspaceUpdaterDescriptor> getWorkspaceUpdaterDescriptors()

doCheckExcludedCommitMessages

public hudson.util.FormValidation doCheckExcludedCommitMessages(@QueryParameter
                                                       String value)
                                                         throws IOException,
                                                                javax.servlet.ServletException

Validates the excludeCommitMessages field.

Parameters:

value - value to validate.

Returns:

FormValidation.

Throws:

IOException - IOException.

javax.servlet.ServletException - ServletException.

doCheckRevisionPropertiesSupported

public hudson.util.FormValidation doCheckRevisionPropertiesSupported(@AncestorInPath
                                                            hudson.model.AbstractProject context,
                                                            @QueryParameter
                                                            String value)
                                                              throws IOException,
                                                                     javax.servlet.ServletException

Validates the remote server supports custom revision properties.

Parameters:

context - AbstractProject.

value - value to validate.

Returns:

FormValidation.

Throws:

IOException - IOException.

javax.servlet.ServletException - ServletException.