Package jenkins.scm.api

Class SCMProbe

java.lang.Object

jenkins.scm.api.SCMSourceCriteria.Probe

jenkins.scm.api.SCMProbe

All Implemented Interfaces:

Closeable, Serializable, AutoCloseable

public abstract class SCMProbe
extends SCMSourceCriteria.Probe
implements Closeable

An unmanaged SCMSourceCriteria.Probe that has its lifecycle managed outside of SCMSource.fetch(TaskListener). A SCMProbe is used to check and recheck SCMSourceCriteria so implementations are strongly recommended to provide caching of results from stat(String) and SCMSourceCriteria.Probe.lastModified().

Since:

2.0

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
SCMProbe()

Method Summary

Modifier and Type	Method	Description
boolean	exists(String path)	Deprecated. use stat(String)
abstract SCMProbeStat	stat(String path)	Checks if the path, relative to the head candidate root, exists or not.

Methods inherited from class jenkins.scm.api.SCMSourceCriteria.Probe

getRoot, lastModified, name

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.io.Closeable

close

Constructor Detail

SCMProbe

public SCMProbe()

Method Detail

exists

@Deprecated
public final boolean exists(@NonNull
                            String path)
                     throws IOException

Deprecated.

use stat(String)

Checks if the path, relative to the head candidate root, exists or not. The results of this method should be cached where possible but can involve a remote network call.

Specified by:

exists in class SCMSourceCriteria.Probe

Parameters:

path - the path.

Returns:

true iff the path exists (may be a file or a directory or a symlink or whatever).

Throws:

IOException - if a remote network call failed and the result is therefore indeterminate.

stat

@NonNull
public abstract SCMProbeStat stat(@NonNull
                                  String path)
                           throws IOException

Checks if the path, relative to the head candidate root, exists or not. The results of this method should be cached where possible but can involve a remote network call.

Overrides:

stat in class SCMSourceCriteria.Probe

Parameters:

path - the path.

Returns:

The results of the check.

Throws:

IOException - if a remote network call failed and the result is therefore indeterminate.