com.anaptecs.jeaf.xfun.annotations

Annotation Type XFunConfig

@Retention(value=RUNTIME)
 @Target(value=TYPE)
 @Documented
public @interface XFunConfig

Annotation is used to configure the implementation of X-Fun services that should be used. In order to make configuration even simpler JEAF's Maven Plugin can be used. The plugin analysis the projects classpath for classes with annotations and generates the required configuration files. There should be only one interface or class with this annotation in your classpath. If multiple usages are detected then the first one will be used according to the order of the classpath. If you do not use this annotation at all then the default implementations will be used. These default implementations should be sufficient for most cases.

Field Summary

Fields

Modifier and Type	Fields and Description
static String	X_FUN_CONFIG_RESOURCE_NAME Name of the resource that contains the name of the class with the @XFunConfig annotation.
static String	XFUN_CONFIG_PATH Path under which the configuration file is stored.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
Class<? extends ConfigurationProviderFactory>	configurationProviderFactory Property defines the factory that should be used to create a configuration provider.
Class<? extends DatatypeConverterRegistryFactory>	datatypeConverterRegistryFactory Class defines the factory that should be used to create the datatype converter registry.
Class<? extends InfoProviderFactory>	infoProviderFactory Class defines the factory that should be used to create the info provider of the application. the info provider is responsible to provide information about the application itself as well as the runtime environment and the operating system.
Class<? extends LocaleProviderFactory>	localeProviderFactory Property defines the factory that should be used to create the locale provider of the application.
Class<? extends MessageRepositoryFactory>	messageRepositoryFactory Property defines the factory that should be used to create a message repository.
String	messageResourcePath Property defines the path of the file where all the message resources are be listed.
Class<? extends PrincipalProviderFactory>	principalProviderFactory Property defines the factory that should be used to create the principal provider of the application.
Class<? extends TraceProviderFactory>	traceProviderFactory Trace factory class that should be used.
Class<? extends VerifierFactory>	verifierFactory Property defines the factory that should be used to created a so called verifier.

Field Detail

X_FUN_CONFIG_RESOURCE_NAME

public static final String X_FUN_CONFIG_RESOURCE_NAME

Name of the resource that contains the name of the class with the @XFunConfig annotation.

XFUN_CONFIG_PATH

public static final String XFUN_CONFIG_PATH

Path under which the configuration file is stored.

Element Detail

messageRepositoryFactory

public abstract Class<? extends MessageRepositoryFactory> messageRepositoryFactory

Property defines the factory that should be used to create a message repository. By switching factories it can be configured which implementation of a message repository should be used. MessageRepository, XFun.getMessageRepository()

Default:

com.anaptecs.jeaf.xfun.api.messages.MessageRepositoryFactory.class

verifierFactory

public abstract Class<? extends VerifierFactory> verifierFactory

Property defines the factory that should be used to created a so called verifier. Verifiers provide check implementations. There are only very rare cases when you will need to use your custom verifier implementation, however it is possible. Verifier, Check, Assert, XFun.getVerifier()

Default:

com.anaptecs.jeaf.xfun.api.checks.VerifierFactory.class

configurationProviderFactory

public abstract Class<? extends ConfigurationProviderFactory> configurationProviderFactory

Property defines the factory that should be used to create a configuration provider. Configuration providers can be used to access configuration values from different resources like files, resource bundles etc. ConfigurationProviderFactory, ConfigurationProvider, ConfigurationProviderConfig

Default:

com.anaptecs.jeaf.xfun.api.config.ConfigurationProviderFactory.class

localeProviderFactory

public abstract Class<? extends LocaleProviderFactory> localeProviderFactory

Property defines the factory that should be used to create the locale provider of the application. Locale providers are required to find out the locale (e.g. language) of the current context. Depending on the application this can simply be the language of the operating systems or something like the language of the current user in an web application. LocaleProvider, XFun.getLocaleProvider()

Default:

com.anaptecs.jeaf.xfun.api.locale.LocaleProviderFactory.class

principalProviderFactory

public abstract Class<? extends PrincipalProviderFactory> principalProviderFactory

Property defines the factory that should be used to create the principal provider of the application. The principal provider is responsible to provide information about the current user. Depending on the application this can simply be the current user of the operating systems or something like the current user in an web application. PrincipalProvider, XFun.getPrincipalProvider()

Default:

com.anaptecs.jeaf.xfun.api.principal.PrincipalProviderFactory.class

infoProviderFactory

public abstract Class<? extends InfoProviderFactory> infoProviderFactory

Class defines the factory that should be used to create the info provider of the application. the info provider is responsible to provide information about the application itself as well as the runtime environment and the operating system. There are only very rare cases when you will need to use your custom verifier implementation, however it is possible. InfoProvider, XFun.getInfoProvider()

Default:

com.anaptecs.jeaf.xfun.api.info.InfoProviderFactory.class

datatypeConverterRegistryFactory

public abstract Class<? extends DatatypeConverterRegistryFactory> datatypeConverterRegistryFactory

Class defines the factory that should be used to create the datatype converter registry. The registry is responsible to provide converters for several types of conversions. There are only very rare cases when you will need to use your custom implementation, however it is possible. However there may be the need to provider your own converters. Therefore you have to implement interface DatatypeConverter. For further details please refer to the documentation of the interface. DatatypeConverterRegistry, DatatypeConverter, XFun.getInfoProvider()

Default:

com.anaptecs.jeaf.xfun.api.datatypeconverter.DatatypeConverterRegistryFactory.class

traceProviderFactory

public abstract Class<? extends TraceProviderFactory> traceProviderFactory

Trace factory class that should be used. If it is not set then the default factory will be used.s

Default:

com.anaptecs.jeaf.xfun.api.trace.TraceProviderFactory.class

messageResourcePath

public abstract String messageResourcePath

Property defines the path of the file where all the message resources are be listed.

Default:

"META-INF/JEAF/XFun/MessageResources"