Package hudson.scm

Class SubversionSCM.DescriptorImpl

java.lang.Object

hudson.model.Descriptor<SCM>

hudson.scm.SCMDescriptor<SubversionSCM>

hudson.scm.SubversionSCM.DescriptorImpl

All Implemented Interfaces:

ModelObject, Saveable, Loadable, OnMaster

Enclosing class:

SubversionSCM

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SubversionSCM.DescriptorImpl.Credential	Stores SVNAuthentication for a single realm.
static final class	SubversionSCM.DescriptorImpl.PasswordCredential	Username/password based authentication.
static final class	SubversionSCM.DescriptorImpl.SshPublicKeyCredential	Public key authentication for Subversion over SSH.
static final class	SubversionSCM.DescriptorImpl.SslClientCertificateCredential	SSL client certificate based authentication.

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

Descriptor.FormException, Descriptor.PropertyType, Descriptor.Self

Field Summary

Fields inherited from class hudson.scm.SCMDescriptor

repositoryBrowser

Fields inherited from class hudson.model.Descriptor

clazz

Fields inherited from interface hudson.model.Saveable

NOOP

Constructor Summary

Constructors

Modifier	Constructor	Description
	DescriptorImpl()
protected	DescriptorImpl(Class clazz, Class<? extends RepositoryBrowser> repositoryBrowser)

Method Summary

Modifier and Type	Method	Description
org.tmatesoft.svn.core.SVNNodeKind	checkRepositoryPath(AbstractProject context, org.tmatesoft.svn.core.SVNURL repoURL)	Deprecated. use checkRepositoryPath(hudson.model.Job, org.tmatesoft.svn.core.SVNURL, com.cloudbees.plugins.credentials.common.StandardCredentials)
org.tmatesoft.svn.core.SVNNodeKind	checkRepositoryPath(Item context, org.tmatesoft.svn.core.SVNURL repoURL, com.cloudbees.plugins.credentials.common.StandardCredentials credentials)
org.tmatesoft.svn.core.SVNNodeKind	checkRepositoryPath(Job context, org.tmatesoft.svn.core.SVNURL repoURL, com.cloudbees.plugins.credentials.common.StandardCredentials credentials)	Deprecated.
boolean	configure(org.kohsuke.stapler.StaplerRequest2 req, net.sf.json.JSONObject formData)
org.tmatesoft.svn.core.auth.ISVNAuthenticationProvider	createAuthenticationProvider()	Deprecated. as of 1.18 Now that Jenkins 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(AbstractProject<?,?> inContextOf)	Deprecated. as of 2.0
FormValidation	doCheckExcludedCommitMessages(String value)	Validates the excludeCommitMessages field
FormValidation	doCheckExcludedRegions(String value)	Validates the excludeRegions Regex
FormValidation	doCheckExcludedRevprop(Item context, String value, String remoteLocation, String remoteCredentialsId)	Validates the remote server supports custom revision properties
FormValidation	doCheckExcludedUsers(String value)	Validates the excludeUsers field
FormValidation	doCheckIncludedRegions(String value)	Validates the includedRegions Regex
FormValidation	doCheckRemote(org.kohsuke.stapler.StaplerRequest2 req, AbstractProject context, String value, String credentialsId)	Deprecated. retained for API compatibility only
void	doPostCredential(org.kohsuke.stapler.StaplerRequest2 req, org.kohsuke.stapler.StaplerResponse2 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(AbstractProject context, org.tmatesoft.svn.core.SVNURL repoURL)	Deprecated. Use getRepository(hudson.model.Job, org.tmatesoft.svn.core.SVNURL, com.cloudbees.plugins.credentials.common.StandardCredentials, java.util.Map, org.tmatesoft.svn.core.io.ISVNSession)
protected org.tmatesoft.svn.core.io.SVNRepository	getRepository(AbstractProject context, org.tmatesoft.svn.core.SVNURL repoURL, com.cloudbees.plugins.credentials.common.StandardCredentials credentials, Map<String,com.cloudbees.plugins.credentials.Credentials> additionalCredentials)	Deprecated. Use getRepository(hudson.model.Job, org.tmatesoft.svn.core.SVNURL, com.cloudbees.plugins.credentials.common.StandardCredentials, java.util.Map, org.tmatesoft.svn.core.io.ISVNSession)
protected org.tmatesoft.svn.core.io.SVNRepository	getRepository(AbstractProject context, org.tmatesoft.svn.core.SVNURL repoURL, org.tmatesoft.svn.core.io.ISVNSession session)	Deprecated. Use getRepository(hudson.model.Job, org.tmatesoft.svn.core.SVNURL, com.cloudbees.plugins.credentials.common.StandardCredentials, java.util.Map, org.tmatesoft.svn.core.io.ISVNSession)
protected org.tmatesoft.svn.core.io.SVNRepository	getRepository(Item context, org.tmatesoft.svn.core.SVNURL repoURL, com.cloudbees.plugins.credentials.common.StandardCredentials credentials, Map<String,com.cloudbees.plugins.credentials.Credentials> additionalCredentials, org.tmatesoft.svn.core.io.ISVNSession session)
protected org.tmatesoft.svn.core.io.SVNRepository	getRepository(Job context, org.tmatesoft.svn.core.SVNURL repoURL, com.cloudbees.plugins.credentials.common.StandardCredentials credentials, Map<String,com.cloudbees.plugins.credentials.Credentials> additionalCredentials, org.tmatesoft.svn.core.io.ISVNSession session)	Deprecated.
Permission	getRequiredGlobalConfigPagePermission()
int	getWorkspaceFormat()
List<WorkspaceUpdaterDescriptor>	getWorkspaceUpdaterDescriptors()
boolean	isApplicable(Job project)
boolean	isBrowserReusable(SubversionSCM x, SubversionSCM y)
boolean	isStoreAuthToDisk()
boolean	isValidateRemoteUpToVar()
void	load()
SCM	newInstance(org.kohsuke.stapler.StaplerRequest2 staplerRequest, net.sf.json.JSONObject jsonObject)
void	postCredential(AbstractProject inContextOf, String url, String username, String password, File keyFile, PrintWriter logWriter)
void	postCredential(String url, UserProvidedCredential upc, PrintWriter logWriter)	Submits the authentication info.
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	setGlobalExcludedRevprop(String globalExcludedRevprop)
void	setWorkspaceFormat(int workspaceFormat)

Methods inherited from class hudson.scm.SCMDescriptor

getBrowserDescriptors, getGeneration, incrementGeneration, isApplicable

Methods inherited from class hudson.model.Descriptor

addHelpFileRedirect, bindJSON, bindJSON, calcAutoCompleteSettings, calcFillSettings, configure, configure, doHelp, doHelp, find, find, findByDescribableClassName, findById, getCategory, getCheckMethod, getCheckUrl, getConfigFile, getConfigPage, getCurrentDescriptorByNameUrl, getDescriptorFullUrl, getDescriptorUrl, getGlobalConfigPage, getGlobalPropertyType, getHelpFile, getHelpFile, getHelpFile, getId, getJsonSafeClassName, getKlass, getPlugin, getPossibleViewNames, getPropertyType, getPropertyType, getPropertyTypeOrDie, getStaticHelpUrl, getStaticHelpUrl, getT, getViewPage, isInstance, isSubTypeOf, newInstance, newInstance, newInstancesFromHeteroList, newInstancesFromHeteroList, 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 Details

DescriptorImpl

public DescriptorImpl()

DescriptorImpl

protected DescriptorImpl(Class clazz,
 Class<? extends RepositoryBrowser> repositoryBrowser)

Method Details

load

public void load()

Specified by:

load in interface Loadable

Overrides:

load in class SCMDescriptor<SubversionSCM>

newInstance

public SCM newInstance(org.kohsuke.stapler.StaplerRequest2 staplerRequest,
 net.sf.json.JSONObject jsonObject)
                throws Descriptor.FormException

Overrides:

newInstance in class Descriptor<SCM>

Throws:

Descriptor.FormException

isApplicable

public boolean isApplicable(Job project)

Overrides:

isApplicable in class SCMDescriptor<SubversionSCM>

getDisplayName

public String getDisplayName()

Specified by:

getDisplayName in interface ModelObject

Overrides:

getDisplayName in class Descriptor<SCM>

setGlobalExcludedRevprop

public void setGlobalExcludedRevprop(String globalExcludedRevprop)

getGlobalExcludedRevprop

public String getGlobalExcludedRevprop()

getWorkspaceFormat

public int getWorkspaceFormat()

setWorkspaceFormat

public void setWorkspaceFormat(int workspaceFormat)

isValidateRemoteUpToVar

public boolean isValidateRemoteUpToVar()

isStoreAuthToDisk

public boolean isStoreAuthToDisk()

configure

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

Overrides:

configure in class Descriptor<SCM>

Throws:

Descriptor.FormException

isBrowserReusable

public boolean isBrowserReusable(SubversionSCM x,
 SubversionSCM y)

Overrides:

isBrowserReusable in class SCMDescriptor<SubversionSCM>

getRequiredGlobalConfigPagePermission

@NonNull
public Permission getRequiredGlobalConfigPagePermission()

Overrides:

getRequiredGlobalConfigPagePermission in class Descriptor<SCM>

createAuthenticationProvider

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

Deprecated.

as of 2.0

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

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

Deprecated.

as of 1.18 Now that Jenkins 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

@POST
public void doPostCredential(org.kohsuke.stapler.StaplerRequest2 req,
 org.kohsuke.stapler.StaplerResponse2 rsp)
                      throws IOException,
jakarta.servlet.ServletException

Submits the authentication info.

Throws:

IOException

jakarta.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(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

@CheckForNull
@Deprecated
public FormValidation doCheckRemote(org.kohsuke.stapler.StaplerRequest2 req,
 @AncestorInPath
 AbstractProject context,
 @QueryParameter
 String value,
 @QueryParameter
 String credentialsId)

Deprecated.

retained for API compatibility only

checkRepositoryPath

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

Deprecated.

use checkRepositoryPath(hudson.model.Job, org.tmatesoft.svn.core.SVNURL, com.cloudbees.plugins.credentials.common.StandardCredentials)

Throws:

org.tmatesoft.svn.core.SVNException

checkRepositoryPath

@Deprecated
public org.tmatesoft.svn.core.SVNNodeKind checkRepositoryPath(Job context,
 org.tmatesoft.svn.core.SVNURL repoURL,
 com.cloudbees.plugins.credentials.common.StandardCredentials credentials)
                                                       throws org.tmatesoft.svn.core.SVNException

Deprecated.

Throws:

org.tmatesoft.svn.core.SVNException

checkRepositoryPath

public org.tmatesoft.svn.core.SVNNodeKind checkRepositoryPath(Item context,
 org.tmatesoft.svn.core.SVNURL repoURL,
 com.cloudbees.plugins.credentials.common.StandardCredentials credentials)
                                                       throws org.tmatesoft.svn.core.SVNException

Throws:

org.tmatesoft.svn.core.SVNException

getRepository

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

Deprecated.

Use getRepository(hudson.model.Job, org.tmatesoft.svn.core.SVNURL, com.cloudbees.plugins.credentials.common.StandardCredentials, java.util.Map, org.tmatesoft.svn.core.io.ISVNSession)

Throws:

org.tmatesoft.svn.core.SVNException

getRepository

@Deprecated
protected org.tmatesoft.svn.core.io.SVNRepository getRepository(AbstractProject context,
 org.tmatesoft.svn.core.SVNURL repoURL,
 org.tmatesoft.svn.core.io.ISVNSession session)
                                                         throws org.tmatesoft.svn.core.SVNException

Deprecated.

Use getRepository(hudson.model.Job, org.tmatesoft.svn.core.SVNURL, com.cloudbees.plugins.credentials.common.StandardCredentials, java.util.Map, org.tmatesoft.svn.core.io.ISVNSession)

Throws:

org.tmatesoft.svn.core.SVNException

getRepository

@Deprecated
protected org.tmatesoft.svn.core.io.SVNRepository getRepository(AbstractProject context,
 org.tmatesoft.svn.core.SVNURL repoURL,
 com.cloudbees.plugins.credentials.common.StandardCredentials credentials,
 Map<String,com.cloudbees.plugins.credentials.Credentials> additionalCredentials)
                                                         throws org.tmatesoft.svn.core.SVNException

Deprecated.

Use getRepository(hudson.model.Job, org.tmatesoft.svn.core.SVNURL, com.cloudbees.plugins.credentials.common.StandardCredentials, java.util.Map, org.tmatesoft.svn.core.io.ISVNSession)

Throws:

org.tmatesoft.svn.core.SVNException

getRepository

@Deprecated
protected org.tmatesoft.svn.core.io.SVNRepository getRepository(Job context,
 org.tmatesoft.svn.core.SVNURL repoURL,
 com.cloudbees.plugins.credentials.common.StandardCredentials credentials,
 Map<String,com.cloudbees.plugins.credentials.Credentials> additionalCredentials,
 org.tmatesoft.svn.core.io.ISVNSession session)
                                                         throws org.tmatesoft.svn.core.SVNException

Deprecated.

Throws:

org.tmatesoft.svn.core.SVNException

getRepository

protected org.tmatesoft.svn.core.io.SVNRepository getRepository(Item context,
 org.tmatesoft.svn.core.SVNURL repoURL,
 com.cloudbees.plugins.credentials.common.StandardCredentials credentials,
 Map<String,com.cloudbees.plugins.credentials.Credentials> additionalCredentials,
 org.tmatesoft.svn.core.io.ISVNSession session)
                                                         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

doCheckExcludedRegions

public FormValidation doCheckExcludedRegions(@QueryParameter
 String value)
                                      throws IOException,
jakarta.servlet.ServletException

Validates the excludeRegions Regex

Throws:

IOException

jakarta.servlet.ServletException

doCheckIncludedRegions

public FormValidation doCheckIncludedRegions(@QueryParameter
 String value)
                                      throws IOException,
jakarta.servlet.ServletException

Validates the includedRegions Regex

Throws:

IOException

jakarta.servlet.ServletException

doCheckExcludedUsers

public FormValidation doCheckExcludedUsers(@QueryParameter
 String value)
                                    throws IOException,
jakarta.servlet.ServletException

Validates the excludeUsers field

Throws:

IOException

jakarta.servlet.ServletException

getWorkspaceUpdaterDescriptors

public List<WorkspaceUpdaterDescriptor> getWorkspaceUpdaterDescriptors()

doCheckExcludedCommitMessages

public FormValidation doCheckExcludedCommitMessages(@QueryParameter
 String value)
                                             throws IOException,
jakarta.servlet.ServletException

Validates the excludeCommitMessages field

Throws:

IOException

jakarta.servlet.ServletException

doCheckExcludedRevprop

public FormValidation doCheckExcludedRevprop(@AncestorInPath
 Item context,
 @QueryParameter
 String value,
 @QueryParameter
 String remoteLocation,
 @QueryParameter
 String remoteCredentialsId)
                                      throws IOException,
jakarta.servlet.ServletException

Validates the remote server supports custom revision properties

Throws:

IOException

jakarta.servlet.ServletException