org.sparta.springwebutils.util

Class ExternalEntryPointHelper

java.lang.Object

org.sparta.springwebutils.util.ExternalEntryPointHelper

public final class ExternalEntryPointHelper
extends Object

Author:

Carlos Eduardo Endler Genz – Sparta Java Team History: Mar 5, 2014 - Carlos Eduardo Endler Genz Mar 14, 2014 - Daniel Conde Diehl - Not ignoring list on object scan

Constructor Summary

Constructors

Constructor and Description
ExternalEntryPointHelper()

Method Summary

Modifier and Type	Method and Description
static Set<String>	getConsolidatedNameBlacklist(List<String> predefinedNameBlacklist, Method method, boolean scanEntryPointAnnotation) Based on the input for scanning annotations, look for @ExternalEntryPoint and get the specific name black list elements.
static Set<Class<?>>	getConsolidatedTypeBlacklist(List<Class<?>> predefinedTypeBlacklist, Method method, boolean scanEntryPointAnnotation) Based on the input for scanning annotations, look for @ExternalEntryPoint and get the specific type black list elements.
static String	getEntryPointDecoratedName(Method method, boolean scanEntryPointAnnotation) Based on the input for scanning annotations, look for @ExternalEntryPoint and get the decorated name from it, if any.
static List<EntryPointParameter>	getInternalEntryPointParametersRecursively(Class<?> parameterType, Set<Class<?>> typeBlacklist, Set<String> nameBlacklist, int maxDeepLevel) Deeply finds all the attributes of the supplied class
static boolean	isAnEntryPoint(Method method, boolean scanEntryPointAnnotation) Returns whether the supplied method is an Entry Point or not.
static boolean	isSimpleRequestParameter(Class<?> parameterType) Finds out if the supplied type is a simple element (primitive/wrapper, an primitive/wrapper array or a Collection instance)

Methods inherited from class java.lang.Object

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

Constructor Detail

ExternalEntryPointHelper

public ExternalEntryPointHelper()

Method Detail

isAnEntryPoint

public static boolean isAnEntryPoint(Method method,
                                     boolean scanEntryPointAnnotation)

Returns whether the supplied method is an Entry Point or not. It might be annotated by @ExternalEntryPoint

Parameters:

method - Method to be scanned

scanEntryPointAnnotation - Does it has annotation

Returns:

true = it's an entry point, false = it's not

getInternalEntryPointParametersRecursively

public static List<EntryPointParameter> getInternalEntryPointParametersRecursively(Class<?> parameterType,
                                                                                   Set<Class<?>> typeBlacklist,
                                                                                   Set<String> nameBlacklist,
                                                                                   int maxDeepLevel)

Deeply finds all the attributes of the supplied class

Parameters:

parameterType - Type of parameter

typeBlacklist - blackList by type

nameBlacklist - blackList by name

maxDeepLevel - How deep should algorithm go in the object

Returns:

all the parameters recursively gathered

isSimpleRequestParameter

public static boolean isSimpleRequestParameter(Class<?> parameterType)

Finds out if the supplied type is a simple element (primitive/wrapper, an primitive/wrapper array or a Collection instance)

Parameters:

parameterType - Check if this class is simple parameter

Returns:

boolean

getEntryPointDecoratedName

public static String getEntryPointDecoratedName(Method method,
                                                boolean scanEntryPointAnnotation)

Based on the input for scanning annotations, look for @ExternalEntryPoint and get the decorated name from it, if any.

Parameters:

method - Method to get name from it.

scanEntryPointAnnotation - if should scan annotations

Returns:

String Decorated name

getConsolidatedTypeBlacklist

public static Set<Class<?>> getConsolidatedTypeBlacklist(List<Class<?>> predefinedTypeBlacklist,
                                                         Method method,
                                                         boolean scanEntryPointAnnotation)

Based on the input for scanning annotations, look for @ExternalEntryPoint and get the specific type black list elements.

Parameters:

predefinedTypeBlacklist - predefined black list

method - method to get the black list

scanEntryPointAnnotation - should scan annotations

Returns:

A set of all blacklisted ones

getConsolidatedNameBlacklist

public static Set<String> getConsolidatedNameBlacklist(List<String> predefinedNameBlacklist,
                                                       Method method,
                                                       boolean scanEntryPointAnnotation)

Based on the input for scanning annotations, look for @ExternalEntryPoint and get the specific name black list elements.

Parameters:

predefinedNameBlacklist - predefined black list

method - method to get the black list

scanEntryPointAnnotation - should scan annotations

Returns:

Set of blacklisted names