com.devexperts.io

Class SerialClassContext

java.lang.Object

com.devexperts.io.SerialClassContext

public class SerialClassContext
extends Object

Defines context of deserialization operation. Class contains whitelist, blacklist and classLoader. Whitelist and blacklist can be set in different ways:

• Specified in code using createSerialClassContext
• Read from class path resources DEFAULT_BLACK_LIST_NAME and DEFAULT_BLACK_LIST_NAME using getDefaultSerialContext

Note, this class retains weak reference to the class loader.

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_BLACK_LIST_NAME Path for resource with classes for blacklist.
static String	DEFAULT_WHITE_LIST_NAME Path to the resource with classes for whitelist.

Method Summary

Modifier and Type	Method and Description
boolean	accept(String className) Returns true, if class name contained in whitelist and not contained in blacklist.
void	check(String className) Throws an ClassNotFoundException if the class not contained in whitelist or contained in blacklist.
static SerialClassContext	createSerialClassContext(ClassLoader loader, Collection<String> whiteClasses, Collection<String> blackClasses) Creates serial class context with a specified class loader, whitelist, and blacklist.
boolean	equals(Object o)
List<String>	getBlacklist()
ClassLoader	getClassLoader() Returns class loader.
static SerialClassContext	getDefaultSerialContext(ClassLoader loader) Returns default serial class context for the specified class loader.
List<String>	getWhitelist()
int	hashCode()

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_WHITE_LIST_NAME

public static final String DEFAULT_WHITE_LIST_NAME

Path to the resource with classes for whitelist.

See Also:

Constant Field Values

DEFAULT_BLACK_LIST_NAME

public static final String DEFAULT_BLACK_LIST_NAME

Path for resource with classes for blacklist.

See Also:

Constant Field Values

Method Detail

createSerialClassContext

public static SerialClassContext createSerialClassContext(ClassLoader loader,
                                                          Collection<String> whiteClasses,
                                                          Collection<String> blackClasses)

Creates serial class context with a specified class loader, whitelist, and blacklist. Note, the resulting class retains weak reference to the class loader.

Parameters:

whiteClasses - classes for whitelist.

blackClasses - classes for blacklist.

loader - Class loader, when null uses Thread.currentThread().getContextClassLoader().

Returns:

serial class context.

See Also:

getDefaultSerialContext(ClassLoader)

getDefaultSerialContext

public static SerialClassContext getDefaultSerialContext(ClassLoader loader)

Returns default serial class context for the specified class loader. This method reads whitelist and blacklist from resources using ClassLoader.getResources(String). Note, the resulting class retains weak reference to the class loader.

Parameters:

loader - Class loader, when null uses Thread.currentThread().getContextClassLoader().

Returns:

serial class context.

getWhitelist

public List<String> getWhitelist()

getBlacklist

public List<String> getBlacklist()

getClassLoader

public ClassLoader getClassLoader()

Returns class loader. Note, this method retains weak reference to the class loader. This method may return null if all strong references to the class loader are lost and it was garbage collected.

Returns:

class loader.

accept

public boolean accept(String className)

Returns true, if class name contained in whitelist and not contained in blacklist.

Parameters:

className - class name.

Returns:

true, if class name contained in whitelist and not contained in blacklist.

Throws:

NullPointerException - if className is null.

check

public void check(String className)
           throws ClassNotFoundException

Throws an ClassNotFoundException if the class not contained in whitelist or contained in blacklist.

Parameters:

className - class name.

Throws:

ClassNotFoundException - if the class not contained in whitelist or contained in blacklist.

NullPointerException - if className is null.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object