Package name.matthewgreet.strutscommons.util

Class DefaultPolicyLookup

java.lang.Object

name.matthewgreet.strutscommons.util.DefaultPolicyLookup

All Implemented Interfaces:

PolicyLookup

public class DefaultPolicyLookup
extends Object
implements PolicyLookup

Standard implementation of PolicyLookup that creates a Singleton instance from an initial configuration that returns the built-in form field policies and, if classpath scanning is enabled, automatically finds and adds bespoke ones. Once created, policies can be added and removed but scanning cannot be re-run. Uses ClassGraph for classpath scanning. If scanning enabled, scanning the entire classpath can impose a noticeable, three second delay, so it's recommended to set the known policy packages in configuration.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	DefaultPolicyLookup.Configuration
static class	DefaultPolicyLookup.GenericTypeDeclarationClassGraph	Class that describes the actual type parameters and generic types of superclass extracted using ClassGraph.
static class	DefaultPolicyLookup.GenericTypeDeclarationReflection	Class that describes the actual type parameters and generic types of superclass extracted using reflection.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	BASE_POLICY_PACKAGES
protected Set<Class<?>>	builtInDefaultConverterClasses
protected Map<Class<?>,InterceptorCommonLibrary.DefaultConverterEntry<?,?>>	builtInDefaultConverterMap
protected Set<Class<?>>	builtInDefaultListConverterClasses
protected Set<Class<?>>	builtInPolicyClasses
protected Map<Class<? extends Annotation>,InterceptorCommonLibrary.PolicyEntry<?,?,?>>	builtInPolicyMap
protected Map<Class<?>,InterceptorCommonLibrary.DefaultConverterEntry<?,?>>	dynamicDefaultConverterMap
protected Map<Class<? extends Annotation>,InterceptorCommonLibrary.PolicyEntry<?,?,?>>	dynamicPolicyMap

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	DefaultPolicyLookup()
protected	DefaultPolicyLookup(DefaultPolicyLookup.Configuration configuration)

Method Summary

Modifier and Type	Method	Description
protected Class<?>	actualTypeFromClassForInterface(Class<?> candidateClass, Class<?> interfaceClass, int genericTypeIndex)	Returns actual type declared by class implementing a parameterised interface for a specific generic type.
protected String	actualTypeFromClassInfoForInterface(io.github.classgraph.ClassInfo candidateClassInfo, Class<?> interfaceClass, int genericTypeIndex)	Returns name of actual type declared by class implementing a parameterised interface for a specific generic type, according to ClassGraph into.
protected <A extends Annotation, P extends Policy<A>, T> void	addDynamicPolicyInternalAutomatic(InterceptorCommonLibrary.PolicyEntry<A,P,T> policyEntry)	Adds policy found by class scanning.
protected <A extends Annotation, P extends Policy<A>, T> InterceptorCommonLibrary.PolicyEntry<A,?,?>	addDynamicPolicyInternalManual(InterceptorCommonLibrary.PolicyEntry<A,P,T> policyEntry)	Adds policy set by client code and returns previous policy found by configuring annotation.
protected boolean	defaultPolicyFromClass(Class<?> candidateClass)	Returns whether policy class means it can be a default for a field type, meaning it implements DefaultPolicy.
protected boolean	defaultPolicyFromClassInfo(io.github.classgraph.ClassInfo candidateClassInfo)	Returns whether policy class info (found by class scanning) means it can be a default for a field type, meaning it implements DefaultPolicy.
static void	deleteInstance()	Removes Singleton instance.
Collection<String>	getAcceptClasses()
Collection<String>	getAcceptPackages()
boolean	getClasspathScanningReplaceBuiltIn()	Returns whether instance was created allowing classpath scanning, if run, to replace built-in default converters and collection converters with bespoke one.
Collection<InterceptorCommonLibrary.DefaultConverterEntry<?,?>>	getDefaultConverterEntries()	Returns all default converters in use and related metadata.
<C extends Converter<?, T>, T> InterceptorCommonLibrary.DefaultConverterEntry<T,C>	getDefaultConverterEntry(Class<? extends T> fieldClass)	Returns default converter configuration for the form field type, or null if none set.
boolean	getEnableClasspathScanning()	Returns whether instance was created with classpath scanning.
static DefaultPolicyLookup	getInstance()	Returns Singleton instance with default initialisation options, or existing one if already initialised.
static DefaultPolicyLookup	getInstance(DefaultPolicyLookup.Configuration configuration)	Returns Singleton instance with initialisation options.
Collection<InterceptorCommonLibrary.PolicyEntry<?,?,?>>	getPolicyEntries()	Returns all policy classes and related metadata.
<A extends Annotation, P extends Policy<A>, T> InterceptorCommonLibrary.PolicyEntry<A,P,T>	getPolicyEntry(Class<? extends A> annotationClass)	Returns policy implementation configuration for a form field annotation, or null if not set.
Collection<String>	getRejectClasses()
Collection<String>	getRejectPackages()
protected List<InterceptorCommonLibrary.PolicyEntry<?,?,?>>	getScannedPoliciesByType(io.github.classgraph.ScanResult scanResult, Class<?> interfaceClass, Class<?> supportClass, InterceptorCommonLibrary.AnnotationUsage annotationUsage)	Returns info about all policies found by class scanning matching policy type.
protected void	initBuiltInDefaultConverterMap()	Returns unmodifiable map of all built-in default converters.
protected void	initBuiltInPolicyMap()	Creates unmodifiable map of all built-in policies.
protected void	initDynamicDefaultConverterMap()	Creates modifiable map of default converters from policies already found by class scanning.
protected void	initDynamicPolicyMap()	Creates modifiable map of policies found by class scanning.
static <A extends Annotation, P extends Policy<A>, T> InterceptorCommonLibrary.PolicyEntry<?,?,?>	makePolicyEntryFromClassNames(String annotationClassName, String policyClassName, String recipientTypeName, InterceptorCommonLibrary.AnnotationUsage annotationUsage, boolean builtIn, boolean defaultPolicy)
<C extends Converter<?, T>, T> InterceptorCommonLibrary.DefaultConverterEntry<T,?>	putDefaultConverter(Class<C> converterClass)	Sets form field converter as the default converter for its recipient type, replacing any existing converter.
<A extends Annotation, P extends Policy<A>, T> InterceptorCommonLibrary.PolicyEntry<A,?,?>	putPolicy(Class<P> policyClass)	Adds a form field policy not found by classpath scanning, so it can be found from the annotation that configures it, replacing any existing using the same annotation.
protected DefaultPolicyLookup.Configuration	readConfiguration()	Returns configuration read from stuts.xml.
<C extends Converter<?, T>, T> InterceptorCommonLibrary.DefaultConverterEntry<T,C>	removeDefaultConverter(Class<? extends T> fieldClass)	Removes default converter for a form field type and returns it, or null if not found.
<A extends Annotation, P extends Policy<A>, T> InterceptorCommonLibrary.PolicyEntry<A,P,T>	removePolicy(Class<? extends A> annotationClass)	Removes form field policy found from the class of annotation that configures it and returns policy config, or null if not found.
protected void	setConfiguration(DefaultPolicyLookup.Configuration configuration)	Sets configuration.
protected Class<?>	translateDefaultConverterRecipientClass(Class<?> recipientClass)	Translates form field class or item type of collection form field into a class used by default converter and collection converter lookups.

Methods inherited from class java.lang.Object

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

Field Details

BASE_POLICY_PACKAGES

public static final String BASE_POLICY_PACKAGES

See Also:

• Constant Field Values

builtInPolicyMap

protected Map<Class<? extends Annotation>,InterceptorCommonLibrary.PolicyEntry<?,?,?>> builtInPolicyMap

dynamicPolicyMap

protected Map<Class<? extends Annotation>,InterceptorCommonLibrary.PolicyEntry<?,?,?>> dynamicPolicyMap

builtInDefaultConverterMap

protected Map<Class<?>,InterceptorCommonLibrary.DefaultConverterEntry<?,?>> builtInDefaultConverterMap

dynamicDefaultConverterMap

protected Map<Class<?>,InterceptorCommonLibrary.DefaultConverterEntry<?,?>> dynamicDefaultConverterMap

builtInPolicyClasses

protected Set<Class<?>> builtInPolicyClasses

builtInDefaultConverterClasses

protected Set<Class<?>> builtInDefaultConverterClasses

builtInDefaultListConverterClasses

protected Set<Class<?>> builtInDefaultListConverterClasses

Constructor Details

DefaultPolicyLookup

protected DefaultPolicyLookup()

DefaultPolicyLookup

protected DefaultPolicyLookup(DefaultPolicyLookup.Configuration configuration)

Method Details

deleteInstance

public static void deleteInstance()

Removes Singleton instance. This only exists for testing.

getInstance

public static DefaultPolicyLookup getInstance()

Returns Singleton instance with default initialisation options, or existing one if already initialised.

getInstance

public static DefaultPolicyLookup getInstance(DefaultPolicyLookup.Configuration configuration)

Returns Singleton instance with initialisation options. Initialisation options have no effect if the instance is already initialised.

makePolicyEntryFromClassNames

public static <A extends Annotation,
P extends Policy<A>,
T>
InterceptorCommonLibrary.PolicyEntry<?,?,?> makePolicyEntryFromClassNames(String annotationClassName,
 String policyClassName,
 String recipientTypeName,
 InterceptorCommonLibrary.AnnotationUsage annotationUsage,
 boolean builtIn,
 boolean defaultPolicy)
                                                                   throws ClassNotFoundException

Throws:

ClassNotFoundException

actualTypeFromClassForInterface

protected Class<?> actualTypeFromClassForInterface(Class<?> candidateClass,
 Class<?> interfaceClass,
 int genericTypeIndex)

Returns actual type declared by class implementing a parameterised interface for a specific generic type. genericTypeIndex starts at 0.

actualTypeFromClassInfoForInterface

protected String actualTypeFromClassInfoForInterface(io.github.classgraph.ClassInfo candidateClassInfo,
 Class<?> interfaceClass,
 int genericTypeIndex)

Returns name of actual type declared by class implementing a parameterised interface for a specific generic type, according to ClassGraph into. genericTypeIndex starts at 0.

addDynamicPolicyInternalAutomatic

protected <A extends Annotation,
P extends Policy<A>,
T>
void addDynamicPolicyInternalAutomatic(InterceptorCommonLibrary.PolicyEntry<A,P,T> policyEntry)

Adds policy found by class scanning. Blocks policies configured by a built-in or custom annotation.

addDynamicPolicyInternalManual

protected <A extends Annotation,
P extends Policy<A>,
T>
InterceptorCommonLibrary.PolicyEntry<A,?,?> addDynamicPolicyInternalManual(InterceptorCommonLibrary.PolicyEntry<A,P,T> policyEntry)
                                                                    throws PolicyLookupRejectionException

Adds policy set by client code and returns previous policy found by configuring annotation. Can replace policies configured by a built-in annotation but not custom ones.

Throws:

PolicyLookupRejectionException

defaultPolicyFromClass

protected boolean defaultPolicyFromClass(Class<?> candidateClass)

Returns whether policy class means it can be a default for a field type, meaning it implements DefaultPolicy.

defaultPolicyFromClassInfo

protected boolean defaultPolicyFromClassInfo(io.github.classgraph.ClassInfo candidateClassInfo)

Returns whether policy class info (found by class scanning) means it can be a default for a field type, meaning it implements DefaultPolicy.

getScannedPoliciesByType

protected List<InterceptorCommonLibrary.PolicyEntry<?,?,?>> getScannedPoliciesByType(io.github.classgraph.ScanResult scanResult,
 Class<?> interfaceClass,
 Class<?> supportClass,
 InterceptorCommonLibrary.AnnotationUsage annotationUsage)

Returns info about all policies found by class scanning matching policy type.

initBuiltInDefaultConverterMap

protected void initBuiltInDefaultConverterMap()

Returns unmodifiable map of all built-in default converters.

initBuiltInPolicyMap

protected void initBuiltInPolicyMap()

Creates unmodifiable map of all built-in policies.

initDynamicDefaultConverterMap

protected void initDynamicDefaultConverterMap()

Creates modifiable map of default converters from policies already found by class scanning. Ignores default converters that would replace a built-in one unless classpathScanningReplaceBuiltIn is true.

initDynamicPolicyMap

protected void initDynamicPolicyMap()

Creates modifiable map of policies found by class scanning.

readConfiguration

protected DefaultPolicyLookup.Configuration readConfiguration()

Returns configuration read from stuts.xml.

setConfiguration

protected void setConfiguration(DefaultPolicyLookup.Configuration configuration)

Sets configuration.

translateDefaultConverterRecipientClass

protected Class<?> translateDefaultConverterRecipientClass(Class<?> recipientClass)

Translates form field class or item type of collection form field into a class used by default converter and collection converter lookups.

getAcceptClasses

public Collection<String> getAcceptClasses()

getAcceptPackages

public Collection<String> getAcceptPackages()

getClasspathScanningReplaceBuiltIn

public boolean getClasspathScanningReplaceBuiltIn()

Returns whether instance was created allowing classpath scanning, if run, to replace built-in default converters and collection converters with bespoke one.

getDefaultConverterEntries

public Collection<InterceptorCommonLibrary.DefaultConverterEntry<?,?>> getDefaultConverterEntries()

Description copied from interface: PolicyLookup

Returns all default converters in use and related metadata.

Specified by:

getDefaultConverterEntries in interface PolicyLookup

getDefaultConverterEntry

public <C extends Converter<?,
T>,
T>
InterceptorCommonLibrary.DefaultConverterEntry<T,C> getDefaultConverterEntry(Class<? extends T> fieldClass)

Returns default converter configuration for the form field type, or null if none set.

Specified by:

getDefaultConverterEntry in interface PolicyLookup

getEnableClasspathScanning

public boolean getEnableClasspathScanning()

Returns whether instance was created with classpath scanning.

getPolicyEntries

public Collection<InterceptorCommonLibrary.PolicyEntry<?,?,?>> getPolicyEntries()

Description copied from interface: PolicyLookup

Returns all policy classes and related metadata.

Specified by:

getPolicyEntries in interface PolicyLookup

getPolicyEntry

public <A extends Annotation,
P extends Policy<A>,
T>
InterceptorCommonLibrary.PolicyEntry<A,P,T> getPolicyEntry(Class<? extends A> annotationClass)

Returns policy implementation configuration for a form field annotation, or null if not set.

Specified by:

getPolicyEntry in interface PolicyLookup

getRejectClasses

public Collection<String> getRejectClasses()

getRejectPackages

public Collection<String> getRejectPackages()

putDefaultConverter

public <C extends Converter<?,
T>,
T>
InterceptorCommonLibrary.DefaultConverterEntry<T,?> putDefaultConverter(Class<C> converterClass)
                                                                 throws PolicyLookupRejectionException

Sets form field converter as the default converter for its recipient type, replacing any existing converter. Class must directly implement Converter or inherit AbstractConverterSupport. Ignores any attempt to replace a built-in or custom converter.

Specified by:

putDefaultConverter in interface PolicyLookup

Throws:

PolicyLookupRejectionException

putPolicy

public <A extends Annotation,
P extends Policy<A>,
T>
InterceptorCommonLibrary.PolicyEntry<A,?,?> putPolicy(Class<P> policyClass)
                                               throws PolicyLookupRejectionException

Adds a form field policy not found by classpath scanning, so it can be found from the annotation that configures it, replacing any existing using the same annotation. Ignores polices referring to custom annotations (CustomAdjuster, CustomConversion, CustomValidation etc.).

Specified by:

putPolicy in interface PolicyLookup

Throws:

PolicyLookupRejectionException

removeDefaultConverter

public <C extends Converter<?,
T>,
T>
InterceptorCommonLibrary.DefaultConverterEntry<T,C> removeDefaultConverter(Class<? extends T> fieldClass)
                                                                    throws IllegalArgumentException

Removes default converter for a form field type and returns it, or null if not found. Cannot remove a built-in converter.

Specified by:

removeDefaultConverter in interface PolicyLookup

Throws:

IllegalArgumentException

removePolicy

public <A extends Annotation,
P extends Policy<A>,
T>
InterceptorCommonLibrary.PolicyEntry<A,P,T> removePolicy(Class<? extends A> annotationClass)
                                                  throws IllegalArgumentException

Removes form field policy found from the class of annotation that configures it and returns policy config, or null if not found. Cannot remove for built-in annotations.

Specified by:

removePolicy in interface PolicyLookup

Throws:

IllegalArgumentException