SCMProviderHandler (ADOP Pluggable SCM)

pluggable.scm.SCMProviderHandler

The SCMProviderHandler is responsible for dispatching SCM provider requests to the correctSCM provider factory.

Field Summary

Fields
Modifiers	Name	Description
`private static java.lang.String`	`SCM_PROVIDER_FILE_EXTENSION`

Constructor Summary

Constructors
Constructor and description
`SCMProviderHandler ()`

Methods Summary

Methods
Type Params	Return Type	Name and description
	`private static java.util.List<java.lang.Class>`	`findClasses(java.io.File directory, java.lang.String packageName)` Return a collection of all classes in a directory and specified package by recursively searching.
	`private static java.lang.Class`	`findScmProvider(java.lang.String providerType, java.util.List<java.lang.Class> classes)` Return a SCMProvider with the specified provider type.
	`private static java.lang.String`	`getPackageName(java.lang.String pathName)` Utility method which converts file path name to a package name.
	`static SCMProvider`	`getScmProvider(java.lang.String scmProviderId, java.lang.Object variableBindings)` Return an implementation of SCM provider for the provided unique SCM provider id.

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class java.lang.Object`	`java.lang.Object#wait(long, int), java.lang.Object#wait(long), java.lang.Object#wait(), java.lang.Object#equals(java.lang.Object), java.lang.Object#toString(), java.lang.Object#hashCode(), java.lang.Object#getClass(), java.lang.Object#notify(), java.lang.Object#notifyAll()`

- Field Detail
  - private static java.lang.String SCM_PROVIDER_FILE_EXTENSION
- Constructor Detail
  - SCMProviderHandler()
- Method Detail
  - private static java.util.List<java.lang.Class> findClasses(java.io.File directory, java.lang.String packageName)
    
    Return a collection of all classes in a directory and specified package by recursively searching.
    Parameters:
    directory - - directory to recursively search for class files.
    packageName - - Java package name to search.
    Returns:
    a collection of class files in the specified directory. If the directory does not exist an empty collection is returned.
  - private static java.lang.Class findScmProvider(java.lang.String providerType, java.util.List<java.lang.Class> classes)
    
    Return a SCMProvider with the specified provider type. Returns null if the SCM provider is not found. This method assumes there is only one implementation of the SCM type.
    throws:
    IllegalArgumentException If provider type is null or not specified. If collection of classes is null.
    
    Parameters:
    providerName - - SCM provider type.
    Returns:
    SCM provider with the specified provider type. Returns null if the SCM provider is not found.
  - private static java.lang.String getPackageName(java.lang.String pathName)
    
    Utility method which converts file path name to a package name. e.g. pluggable/scm/helpers to pluggable.scm.helpers.
    Parameters:
    pathName - - pathName to convert to package name.
    Returns:
    a package name corresponding to the provided file path name.
  - static SCMProvider getScmProvider(java.lang.String scmProviderId, java.lang.Object variableBindings)
    
    Return an implementation of SCM provider for the provided unique SCM provider id. The method uses the SCM Provider data store to infer the SCM providers configuration.
    Parameters:
    scmProviderId - - the unique id of the SCM provider.
    variableBindings - - map to inject environment variables/SCM provider library configuration
    Returns:
    the inferred SCM provider for the provided unique SCM provider Id.

Summary:
Field
Constructor
Method

| Detail:
Field
Constructor
Method

ADOP Pluggable SCM

[Groovy] Class SCMProviderHandler

Field Summary

Constructor Summary

Methods Summary

Inherited Methods Summary

Field Detail

private static java.lang.String SCM_PROVIDER_FILE_EXTENSION

Constructor Detail

SCMProviderHandler()

Method Detail

private static java.util.List<java.lang.Class> findClasses(java.io.File directory, java.lang.String packageName)

private static java.lang.Class findScmProvider(java.lang.String providerType, java.util.List<java.lang.Class> classes)

private static java.lang.String getPackageName(java.lang.String pathName)

static SCMProvider getScmProvider(java.lang.String scmProviderId, java.lang.Object variableBindings)