org.springframework.data.gemfire.function.config

Annotation Type EnableGemfireFunctionExecutions

@Target(value=TYPE)
 @Retention(value=RUNTIME)
 @Documented
 @Inherited
 @Import(value=FunctionExecutionBeanDefinitionRegistrar.class)
public @interface EnableGemfireFunctionExecutions

Enables classpath scanning for interfaces annotated as GemFire function executions (function invocations). These include interfaces annotated with one of {code} @OnRegion, @OnServer, @OnServers, @OnMember, @OnMembers{code}

Author:

David Turanski

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
Class<?>[]	basePackageClasses Type-safe alternative to basePackages() for specifying the packages to scan for annotated components.
String[]	basePackages Base packages to scan for annotated components.
ComponentScan.Filter[]	excludeFilters Specifies which types are not eligible for component scanning.
ComponentScan.Filter[]	includeFilters Specifies which types are eligible for component scanning.
String[]	value Alias for the basePackages() attribute.

Element Detail

value

public abstract String[] value

Alias for the basePackages() attribute. Allows for more concise annotation declarations e.g.: @EnableGemfireRepositories("org.my.pkg") instead of @EnableGemfireRepositories(basePackages="org.my.pkg").

Returns:

an array of Strings indicating the names of packages to scan during component scanning.

See Also:

basePackages()

Default:

{}

basePackages

public abstract String[] basePackages

Base packages to scan for annotated components. value() is an alias for (and mutually exclusive with) this attribute. Use basePackageClasses() for a type-safe alternative to String-based package names.

Returns:

an array of Strings indicating the names of packages to scan during component scanning.

See Also:

basePackageClasses()

Default:

{}

basePackageClasses

public abstract Class<?>[] basePackageClasses

Type-safe alternative to basePackages() for specifying the packages to scan for annotated components. The package of each class specified will be scanned. Consider creating a special no-op marker class or interface in each package that serves no purpose other than being referenced by this attribute.

Returns:

an array of Class types used to get the packages to scan during component scanning.

See Also:

basePackages()

Default:

{}

includeFilters

public abstract ComponentScan.Filter[] includeFilters

Specifies which types are eligible for component scanning. Further narrows the set of candidate components from everything in basePackages() to everything in the base packages that matches the given filter or filters.

Returns:

an array of Filters indicating which types are eligible for component scanning.

See Also:

ComponentScan.Filter

Default:

{}

excludeFilters

public abstract ComponentScan.Filter[] excludeFilters

Specifies which types are not eligible for component scanning.

Returns:

an array of Filters indicating which types are not eligible for component scanning.

See Also:

ComponentScan.Filter

Default:

{}