hudson.remoting

Class ClassFilter

java.lang.Object

hudson.remoting.ClassFilter

public abstract class ClassFilter
extends Object

Restricts what classes can be received through remoting.

Since:

2.53

Author:

Kohsuke Kawaguchi

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ClassFilter.ClassFilterException Class for propagating exceptions in ClassFilter.

Field Summary

Fields

Modifier and Type	Field and Description
static ClassFilter	DEFAULT A set of sensible default filtering rules to apply, unless the context guarantees the trust between two channels.
static String	FILE_OVERRIDE_LOCATION_PROPERTY Property to set to override the blacklist used by {DEFAULT with a different set.
static ClassFilter	NONE No filtering whatsoever.

Constructor Summary

Constructors

Constructor and Description
ClassFilter()

Method Summary

Modifier and Type	Method and Description
static void	appendDefaultFilter(Pattern filter) Adds an additional exclusion to DEFAULT.
Class	check(Class c)
String	check(String name)
protected boolean	isBlacklisted(Class c)
protected boolean	isBlacklisted(String name)

Methods inherited from class java.lang.Object

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

Field Detail

FILE_OVERRIDE_LOCATION_PROPERTY

public static final String FILE_OVERRIDE_LOCATION_PROPERTY

Property to set to override the blacklist used by {DEFAULT with a different set. The location should point to a a file containing regular expressions (one per line) of classes to blacklist. If this property is set but the file can not be read the default blacklist will be used.

Since:

2.53.2

See Also:

Constant Field Values

DEFAULT

public static final ClassFilter DEFAULT

A set of sensible default filtering rules to apply, unless the context guarantees the trust between two channels.

NONE

public static final ClassFilter NONE

No filtering whatsoever.

Constructor Detail

ClassFilter

public ClassFilter()

Method Detail

isBlacklisted

protected boolean isBlacklisted(String name)

isBlacklisted

protected boolean isBlacklisted(Class c)

check

public final String check(String name)

check

public final Class check(Class c)

appendDefaultFilter

public static void appendDefaultFilter(Pattern filter)
                                throws ClassFilter.ClassFilterException

Adds an additional exclusion to DEFAULT. Does nothing if the default list has already been customized via FILE_OVERRIDE_LOCATION_PROPERTY. This API is not supposed to be used anywhere outside Jenkins core, calls for other sources may be rejected later.

Parameters:

filter - a regular expression for Class.getName() which, if matched according to Matcher.matches(), will blacklist the class

Throws:

ClassFilter.ClassFilterException - Filter pattern cannot be applied. It means either unexpected processing error or rejection by the internal logic.

Since:

3.11