Module org.eclipse.persistence.sdo
Class SDOHelperContext
java.lang.Object
org.eclipse.persistence.sdo.helper.SDOHelperContext
- All Implemented Interfaces:
HelperContext
- Direct Known Subclasses:
JAXBHelperContext
Purpose:
- This class represents a local HelperContext. The global HelperContext can be accessed as HelperProvider.getDefaultContext().
- Provide access to instances of helper objects.
- Provide an OSGi compatible HelperContext (when the constructor that takes a ClassLoader is used).
- Since:
- Oracle TopLink 11.1.1.0.0
-
Nested Class Summary
Nested Classes -
Field Summary
FieldsModifier and TypeFieldDescriptionprotected CopyHelperprotected DataFactoryprotected DataHelperprotected EqualityHelperstatic final StringDeprecated, for removal: This API element is subject to removal in a future version.protected TypeHelperprotected XMLHelperprotected XSDHelper -
Constructor Summary
ConstructorsConstructorDescriptionCreate a local HelperContext.SDOHelperContext(ClassLoader aClassLoader) Create a local HelperContext.SDOHelperContext(String identifier) Create a local HelperContext with the given identifier.SDOHelperContext(String identifier, ClassLoader aClassLoader) Create a local HelperContext with the given identifier. -
Method Summary
Modifier and TypeMethodDescriptionstatic voidAdd an alias to identifier pair to the alias Map for the current application.Create and return a new ExternalizableDelegator.Resolvable instance based on this helper context.createResolvable(Object target) Create and return a new ExternalizableDelegator.Resolvable instance based on this helper context and a given target.Return the CopyHelper instance for this helper context.Return the DataFactory instance for this helper context.Return the DataHelper instance for this helper context.Return the EqualityHelper instance for this helper context.static HelperContextINTERNAL: Return the helper context for a given key.static HelperContextgetHelperContext(String identifier) Return the local helper context associated with the given identifier, or create one if it does not already exist.static HelperContextgetHelperContext(String identifier, ClassLoader classLoader) Return the local helper context with the given identifier, or create one if it does not already exist.Getter for HelperContextResolverReturn the unique label for this HelperContext.getProperty(String name) Return the value stored in the properties Map for a given name, or null if an entry for name does not exist.Return the TypeHelper instance for this helper context.Returns theSDOWrapperTypeinstances for current applicationReturn the XMLHelper instance for this helper context.Return the XSDHelper instance for this helper context.static booleanhasHelperContext(String identifier) Return true if a HelperContext corresponding to this identifier or alias already exists, else false.protected voidinitialize(ClassLoader aClassLoader) The underlying helpers for this instance will be instantiated in this method.static booleanIndicates if a call to setApplicationResolver has been made.booleanIndicates whether strict type checking is enabled.voidADVANCED Promote this helper context to be the default or global one.static voidReplaces the provided helper context in the map of identifiers to helper contexts for this application.static voidputHelperContext(ClassLoader key, HelperContext value) INTERNAL: Put a ClassLoader/HelperContext key/value pair in the Thread HelperContext map.putWrapperTypes(Map<SDOTypeHelperDelegate.SDOWrapperTypeId, SDOWrapperType> wrapperTypes) Replaces theSDOWrapperTypeinstances for current application with the ones passed as an argumentstatic voidRemoves HelperContextResolver for the current application.static voidINTERNAL: Remove a ClassLoader/HelperContext key/value pair from the Thread HelperContext map.static voidremoveHelperContext(String identifier, ClassLoader key) INTERNALvoidreset()Reset the Type,XML and XSD helper instances.static voidsetApplicationResolver(ApplicationResolver aResolver) ADVANCED: Used to set an ApplicationResolver instance that will be used to retrieve info pertaining to a given application, such as the application name, in the case where our logic fails.static voidsetHelperContextResolver(Object helperContextResolver) Method allows dynamically change HelperContext creation strategy.static voidsetHelperContextResolver(SDOHelperContext.HelperContextResolver helperContextResolver) Method allows dynamically change HelperContext creation strategy.voidsetProperty(String name, Object value) Add a name/value pair to the properties Map.voidsetStrictTypeCheckingEnabled(boolean enabled) Controls type checking strictness.
-
Field Details
-
copyHelper
-
dataFactory
-
dataHelper
-
equalityHelper
-
xmlHelper
-
typeHelper
-
xsdHelper
-
STRICT_TYPE_CHECKING_PROPERTY_NAME
@Deprecated(since="4.0", forRemoval=true) public static final String STRICT_TYPE_CHECKING_PROPERTY_NAMEDeprecated, for removal: This API element is subject to removal in a future version.Property controls strictness ofType.getInstanceClass()type checking.See
isStrictTypeCheckingEnabled()for more details. By this property, the initial value can be changed. Default value istrue.- See Also:
-
-
Constructor Details
-
SDOHelperContext
public SDOHelperContext()Create a local HelperContext. The current thread's context ClassLoader will be used to find static instance classes. In OSGi environments the construct that takes a ClassLoader parameter should be used instead. -
SDOHelperContext
Create a local HelperContext with the given identifier. The current thread's context ClassLoader will be used to find static instance classes. In OSGi environments the construct that takes a ClassLoader parameter should be used instead.- Parameters:
identifier- The unique label for this HelperContext.
-
SDOHelperContext
Create a local HelperContext. This constructor should be used in OSGi environments.- Parameters:
aClassLoader- This class loader will be used to find static instance classes.
-
SDOHelperContext
Create a local HelperContext with the given identifier. This constructor should be used in OSGi environments.- Parameters:
identifier- The unique label for this HelperContext.aClassLoader- This class loader will be used to find static instance classes.
-
-
Method Details
-
setApplicationResolver
ADVANCED: Used to set an ApplicationResolver instance that will be used to retrieve info pertaining to a given application, such as the application name, in the case where our logic fails. This method can be called once and only once per active server instance.- Parameters:
aResolver- the ApplicationResolver instance that will be used to retrieve info pertaining to a given application. Note that null is considered a valid set operation.- Throws:
org.eclipse.persistence.exceptions.SDOException- if more than one call is made to this method in an active server instance.
-
isApplicationResolverSet
public static boolean isApplicationResolverSet()Indicates if a call to setApplicationResolver has been made.- Returns:
- true if a prior call to setApplicationResolver has been made, false otherwise
-
initialize
The underlying helpers for this instance will be instantiated in this method.- Parameters:
aClassLoader-
-
reset
public void reset()Reset the Type,XML and XSD helper instances. -
getCopyHelper
Return the CopyHelper instance for this helper context.- Specified by:
getCopyHelperin interfaceHelperContext- Returns:
- a CopyHelper object
-
getDataFactory
Return the DataFactory instance for this helper context.- Specified by:
getDataFactoryin interfaceHelperContext- Returns:
- a DataFactory object
-
getDataHelper
Return the DataHelper instance for this helper context.- Specified by:
getDataHelperin interfaceHelperContext- Returns:
- a DataHelper object
-
getEqualityHelper
Return the EqualityHelper instance for this helper context.- Specified by:
getEqualityHelperin interfaceHelperContext- Returns:
- an EqualityHelper object
-
getTypeHelper
Return the TypeHelper instance for this helper context.- Specified by:
getTypeHelperin interfaceHelperContext- Returns:
- a TypeHelper object
-
getXMLHelper
Return the XMLHelper instance for this helper context.- Specified by:
getXMLHelperin interfaceHelperContext- Returns:
- an XMLHelper object
-
getXSDHelper
Return the XSDHelper instance for this helper context.- Specified by:
getXSDHelperin interfaceHelperContext- Returns:
- an XSDHelper object
-
createResolvable
Create and return a new ExternalizableDelegator.Resolvable instance based on this helper context.- Returns:
-
createResolvable
Create and return a new ExternalizableDelegator.Resolvable instance based on this helper context and a given target.- Parameters:
target-- Returns:
-
putHelperContext
INTERNAL: Put a ClassLoader/HelperContext key/value pair in the Thread HelperContext map. If Thread.currentThread().getContextClassLoader() == key during getHelperContext() call then the HelperContext (value) will be returned. This method will overwrite an existing entry in the map with the same ClassLoader key.- Parameters:
key- class loadervalue- helper context
-
removeHelperContext
INTERNAL: Remove a ClassLoader/HelperContext key/value pair from the Thread HelperContext map. If there are multiple local helper contexts associated with this ClassLoader, they will all be removed from the map.- Parameters:
key- class loader
-
removeHelperContext
INTERNAL- Parameters:
identifier- the specific identifier of the HelperContext to be removed. "" for a Global helperkey- the ClassLoader associated with the HelperContext to be removed
-
getHelperContext
INTERNAL: Return the helper context for a given key. The key will either be a ClassLoader or a String (representing an application name). A new context will be created and put in the map if none exists for the given key. The key is assumed to be non-null - getDelegateKey should always return either a string representing the application name (for WLS, WAS and JBoss if available) or a class loader. This is relevant since 'putIfAbsent' will throw a null pointer exception if the key is null. -
getHelperContext
Return the local helper context associated with the given identifier, or create one if it does not already exist. If identifier is an alias, the value associated with it in the alias Map will be used as the identifier value.- Parameters:
identifier- the identifier or alias to use for lookup/creation- Returns:
- HelperContext associated with identifier, or a new HelperContext keyed on identifier if none eixsts
-
getHelperContext
Return the local helper context with the given identifier, or create one if it does not already exist. -
putHelperContext
Replaces the provided helper context in the map of identifiers to helper contexts for this application. ctx.getIdentifier() will be used to obtain the identifier value. If identifier is a key in the the alias Map, i.e. was previously set as alias, the corresponding entry will be removed from the alias Map.- Parameters:
ctx- the HelperContext to be added to the context Map for the current application
-
getHelperContextResolver
Getter for HelperContextResolver- Returns:
- actual strategy
-
setHelperContextResolver
Method allows dynamically change HelperContext creation strategy.- Parameters:
helperContextResolver- on this objectSDOHelperContext.HelperContextResolver.getHelperContext(String, ClassLoader)will be called. If it is null - then default strategy will be set.
-
setHelperContextResolver
public static void setHelperContextResolver(SDOHelperContext.HelperContextResolver helperContextResolver) Method allows dynamically change HelperContext creation strategy.- Parameters:
helperContextResolver- strategy to be used. If it is null - then default strategy will be set.
-
removeHelerContextResolver
public static void removeHelerContextResolver()Removes HelperContextResolver for the current application. Application is resolved based on applicationName or classLoader. -
makeDefaultContext
public void makeDefaultContext()ADVANCED Promote this helper context to be the default or global one. This will completely replace the existing default context including all types and properties defined. -
getIdentifier
Return the unique label for this HelperContext.- Returns:
- String representing the unique label for this HelperContext
-
hasHelperContext
Return true if a HelperContext corresponding to this identifier or alias already exists, else false. If identifer is an alias, the corresponding value in the alias Map will be used as the identifier for the lookup.- Parameters:
identifier- the alias or identifier used to lookup a helper context- Returns:
- true if an entry exists in the helper context map for identifier (or the associated identifier value if identifier is an alias), false otherwise.
-
addAlias
Add an alias to identifier pair to the alias Map for the current application.- Parameters:
identifier- assumed to be a key in the helper context Mapalias- the alias to be associated with identifier
-
setProperty
Add a name/value pair to the properties Map. If name is null, nothing will be done. If value is null, the entry in the Map will be removed (if an entry exists for name).- Parameters:
name- the name of the propertyvalue- the value of the property
-
getProperty
Return the value stored in the properties Map for a given name, or null if an entry for name does not exist.- Parameters:
name- the name of the property to be returned- Returns:
- the value associated with name, or null
-
isStrictTypeCheckingEnabled
public boolean isStrictTypeCheckingEnabled()Indicates whether strict type checking is enabled.If strict type checking is enabled then
Type.getInstanceClass()interface is checked whether it contains getters for all the properties of theTypeupon initialization of theType. If any getter is missing then the interface is ignored andType.getInstanceClass()will returnnull.The getters are not checked if the strict type checking is disabled.
- Returns:
- boolean value
-
setStrictTypeCheckingEnabled
public void setStrictTypeCheckingEnabled(boolean enabled) Controls type checking strictness. SeeisStrictTypeCheckingEnabled()for more details.- Parameters:
enabled- new value (trueto enable the strict validation)
-
getWrapperTypes
Returns theSDOWrapperTypeinstances for current application -
putWrapperTypes
public static Map<SDOTypeHelperDelegate.SDOWrapperTypeId,SDOWrapperType> putWrapperTypes(Map<SDOTypeHelperDelegate.SDOWrapperTypeId, SDOWrapperType> wrapperTypes) Replaces theSDOWrapperTypeinstances for current application with the ones passed as an argument- Parameters:
wrapperTypes- the SDOWrapperType instances to use for current application- Returns:
- SDOWrapperType instances configured for current application
-
SDOSystemProperties.SDO_STRICT_TYPE_CHECKING_PROPERTY_NAME.