Package io.jenkins.plugins.prism

Class SourceDirectoryFilter

java.lang.Object

io.jenkins.plugins.prism.SourceDirectoryFilter

public class SourceDirectoryFilter
extends Object

Filters source code directories that are not approved in Jenkins' global configuration. A directory is considered safe if it is a sub-folder in the agent workspace. Directories outside the workspace need to be approved by an administrator in Jenkins global configuration page.

Author:

Ullrich Hafner

See Also:

• PrismConfiguration

Constructor Summary

Constructors

Constructor	Description
SourceDirectoryFilter()

Method Summary

Modifier and Type	Method	Description
Set<String>	getPermittedSourceDirectories(String workspacePath, Set<String> allowedSourceDirectories, Set<String> requestedSourceDirectories, edu.hm.hafner.util.FilteredLog log)	Filters the specified collection of additional source code directories so that only permitted source directories will be returned.

Methods inherited from class java.lang.Object

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

Constructor Details

SourceDirectoryFilter

public SourceDirectoryFilter()

Method Details

getPermittedSourceDirectories

public Set<String> getPermittedSourceDirectories(String workspacePath,
 Set<String> allowedSourceDirectories,
 Set<String> requestedSourceDirectories,
 edu.hm.hafner.util.FilteredLog log)

Filters the specified collection of additional source code directories so that only permitted source directories will be returned. Permitted source directories are absolute paths that have been registered using PrismConfiguration.setSourceDirectories(java.util.List) or relative paths in the workspace.

Parameters:

workspacePath - the path to the workspace containing the affected files

allowedSourceDirectories - the approved source directories from the system configuration section

requestedSourceDirectories - source directories either as a relative path in the agent workspace or as an absolute path on the agent

log - logger

Returns:

the permitted source directories