org.apache.qpid.jms.policy

Class JmsDefaultDeserializationPolicy

java.lang.Object

org.apache.qpid.jms.policy.JmsDefaultDeserializationPolicy

All Implemented Interfaces:

JmsDeserializationPolicy

public class JmsDefaultDeserializationPolicy
extends Object
implements JmsDeserializationPolicy

Default implementation of the deserialization policy that can read white and black list of classes/packages from the environment, and be updated by the connection uri options. The policy reads a default blackList string value (comma separated) from the system property "org.apache.qpid.jms.deserialization.black_list" which defaults to null which indicates an empty blacklist. The policy reads a default whitelist string value (comma separated) from the system property "org.apache.qpid.jms.deserialization.white_list" which defaults to a "*" which indicates that all classes are whitelisted. The blacklist overrides the whitelist, entries that could match both are counted as blacklisted. If the policy should treat all classes as untrusted the blacklist should be set to "*"".

Field Summary

Fields

Modifier and Type	Field and Description
static String	BLACKLIST_PROPERTY
static String	CATCH_ALL_WILDCARD Value used to indicate that all classes should be white or black listed,
static String	WHITELIST_PROPERTY

Constructor Summary

Constructors

Constructor and Description
JmsDefaultDeserializationPolicy() Creates an instance of this policy with default configuration.
JmsDefaultDeserializationPolicy(JmsDefaultDeserializationPolicy source)

Method Summary

Modifier and Type	Method and Description
JmsDeserializationPolicy	copy()
boolean	equals(Object obj)
String	getBlackList()
String	getWhiteList()
int	hashCode()
boolean	isTrustedType(JmsDestination destination, Class<?> clazz) Returns whether the given class is a trusted type and can be deserialized by the client when calls to ObjectMessage.getObject() are made.
void	setBlackList(String blackList) Replaces the currently configured blackList with a comma separated string containing the new blackList.
void	setWhiteList(String whiteList) Replaces the currently configured whiteList with a comma separated string containing the new whiteList.

Methods inherited from class java.lang.Object

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

Field Detail

CATCH_ALL_WILDCARD

public static final String CATCH_ALL_WILDCARD

Value used to indicate that all classes should be white or black listed,

See Also:

Constant Field Values

WHITELIST_PROPERTY

public static final String WHITELIST_PROPERTY

See Also:

Constant Field Values

BLACKLIST_PROPERTY

public static final String BLACKLIST_PROPERTY

See Also:

Constant Field Values

Constructor Detail

JmsDefaultDeserializationPolicy

public JmsDefaultDeserializationPolicy()

Creates an instance of this policy with default configuration.

JmsDefaultDeserializationPolicy

public JmsDefaultDeserializationPolicy(JmsDefaultDeserializationPolicy source)

Parameters:

source - The instance whose configuration should be copied from.

Method Detail

copy

public JmsDeserializationPolicy copy()

Specified by:

copy in interface JmsDeserializationPolicy

isTrustedType

public boolean isTrustedType(JmsDestination destination,
                             Class<?> clazz)

Description copied from interface: JmsDeserializationPolicy

Returns whether the given class is a trusted type and can be deserialized by the client when calls to ObjectMessage.getObject() are made.

Specified by:

isTrustedType in interface JmsDeserializationPolicy

Parameters:

destination - the Destination for the message containing the type to be deserialized.

clazz - the Type of the object that is about to be read.

Returns:

true if the type is trusted or false if not.

getWhiteList

public String getWhiteList()

Returns:

the whiteList configured on this policy instance.

getBlackList

public String getBlackList()

Returns:

the blackList configured on this policy instance.

setWhiteList

public void setWhiteList(String whiteList)

Replaces the currently configured whiteList with a comma separated string containing the new whiteList. Null or empty string denotes no whiteList entries, "*" indicates that all classes are whiteListed.

Parameters:

whiteList - the whiteList that this policy is configured to recognize.

setBlackList

public void setBlackList(String blackList)

Replaces the currently configured blackList with a comma separated string containing the new blackList. Null or empty string denotes no blacklist entries, "*" indicates that all classes are blacklisted.

Parameters:

blackList - the blackList that this policy is configured to recognize.

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object