Package jenkins.plugins.nodejs.cache

Class CacheLocationLocator

java.lang.Object

hudson.model.AbstractDescribableImpl<CacheLocationLocator>

jenkins.plugins.nodejs.cache.CacheLocationLocator

All Implemented Interfaces:

ExtensionPoint, Describable<CacheLocationLocator>

Direct Known Subclasses:

DefaultCacheLocationLocator, PerExecutorCacheLocationLocator, PerJobCacheLocationLocator

public abstract class CacheLocationLocator
extends AbstractDescribableImpl<CacheLocationLocator>
implements ExtensionPoint

Strategy pattern that decides the location of the NPM cache location for a build.

Nested Class Summary

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

ExtensionPoint.LegacyInstancesAreScopedToHudson

Constructor Summary

Constructors

Constructor	Description
CacheLocationLocator()

Method Summary

Modifier and Type	Method	Description
CacheLocationLocatorDescriptor	getDescriptor()
abstract FilePath	locate(FilePath workspace)	Called during the build on the master to determine the location of the local cache location.

Methods inherited from class java.lang.Object

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

Constructor Details

CacheLocationLocator

public CacheLocationLocator()

Method Details

locate

public abstract FilePath locate(@NonNull
 FilePath workspace)

Called during the build on the master to determine the location of the local cache location.

Parameters:

workspace - the workspace file path locator

Returns:

null to let NPM uses its default location. Otherwise this must be located on the same node as described by this path.

getDescriptor

public CacheLocationLocatorDescriptor getDescriptor()

Specified by:

getDescriptor in interface Describable<CacheLocationLocator>

Overrides:

getDescriptor in class AbstractDescribableImpl<CacheLocationLocator>