org.eclipse.persistence.sdo.helper

Class SDOHelperContext

java.lang.Object

org.eclipse.persistence.sdo.helper.SDOHelperContext

All Implemented Interfaces:

commonj.sdo.helper.HelperContext

Direct Known Subclasses:

JAXBHelperContext

public class SDOHelperContext
extends java.lang.Object
implements commonj.sdo.helper.HelperContext

Purpose:

• This class represents a local HelperContext. The global HelperContext can be accessed as HelperProvider.getDefaultContext().

Responsibilities:

• 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

Modifier and Type	Class and Description
static interface	SDOHelperContext.HelperContextResolver Strategy for HelperContext creation.
static class	SDOHelperContext.MyNotificationFilter INTERNAL: This class will be handed in as a parameter when adding a JBoss notification listener.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	STRICT_TYPE_CHECKING_PROPERTY_NAME Property controls strictness of Type.getInstanceClass() type checking.

Constructor Summary

Constructors

Constructor and Description
SDOHelperContext() Create a local HelperContext.
SDOHelperContext(java.lang.ClassLoader aClassLoader) Create a local HelperContext.
SDOHelperContext(java.lang.String identifier) Create a local HelperContext with the given identifier.
SDOHelperContext(java.lang.String identifier, java.lang.ClassLoader aClassLoader) Create a local HelperContext with the given identifier.

Method Summary

Modifier and Type	Method and Description
static void	addAlias(java.lang.String identifier, java.lang.String alias) Add an alias to identifier pair to the alias Map for the current application.
commonj.sdo.impl.ExternalizableDelegator.Resolvable	createResolvable() Create and return a new ExternalizableDelegator.Resolvable instance based on this helper context.
commonj.sdo.impl.ExternalizableDelegator.Resolvable	createResolvable(java.lang.Object target) Create and return a new ExternalizableDelegator.Resolvable instance based on this helper context and a given target.
commonj.sdo.helper.CopyHelper	getCopyHelper() Return the CopyHelper instance for this helper context.
commonj.sdo.helper.DataFactory	getDataFactory() Return the DataFactory instance for this helper context.
commonj.sdo.helper.DataHelper	getDataHelper() Return the DataHelper instance for this helper context.
commonj.sdo.helper.EqualityHelper	getEqualityHelper() Return the EqualityHelper instance for this helper context.
static commonj.sdo.helper.HelperContext	getHelperContext() INTERNAL: Return the helper context for a given key.
static commonj.sdo.helper.HelperContext	getHelperContext(java.lang.String identifier) Return the local helper context associated with the given identifier, or create one if it does not already exist.
static commonj.sdo.helper.HelperContext	getHelperContext(java.lang.String identifier, java.lang.ClassLoader classLoader) Return the local helper context with the given identifier, or create one if it does not already exist.
static SDOHelperContext.HelperContextResolver	getHelperContextResolver() Getter for HelperContextResolver
java.lang.String	getIdentifier() Return the unique label for this HelperContext.
java.lang.Object	getProperty(java.lang.String name) Return the value stored in the properties Map for a given name, or null if an entry for name does not exist.
commonj.sdo.helper.TypeHelper	getTypeHelper() Return the TypeHelper instance for this helper context.
static java.util.Map<SDOTypeHelperDelegate.SDOWrapperTypeId,SDOWrapperType>	getWrapperTypes() Returns the SDOWrapperType instances for current application
commonj.sdo.helper.XMLHelper	getXMLHelper() Return the XMLHelper instance for this helper context.
commonj.sdo.helper.XSDHelper	getXSDHelper() Return the XSDHelper instance for this helper context.
static boolean	hasHelperContext(java.lang.String identifier) Return true if a HelperContext corresponding to this identifier or alias already exists, else false.
static boolean	isApplicationResolverSet() Indicates if a call to setApplicationResolver has been made.
boolean	isStrictTypeCheckingEnabled() Indicates whether strict type checking is enabled.
void	makeDefaultContext() ADVANCED Promote this helper context to be the default or global one.
static void	putHelperContext(java.lang.ClassLoader key, commonj.sdo.helper.HelperContext value) INTERNAL: Put a ClassLoader/HelperContext key/value pair in the Thread HelperContext map.
static void	putHelperContext(commonj.sdo.helper.HelperContext ctx) 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.
static java.util.Map<SDOTypeHelperDelegate.SDOWrapperTypeId,SDOWrapperType>	putWrapperTypes(java.util.Map<SDOTypeHelperDelegate.SDOWrapperTypeId,SDOWrapperType> wrapperTypes) Replaces the SDOWrapperType instances for current application with the ones passed as an argument
static void	removeHelerContextResolver() Removes HelperContextResolver for the current application.
static void	removeHelperContext(java.lang.ClassLoader key) INTERNAL: Remove a ClassLoader/HelperContext key/value pair from the Thread HelperContext map.
static void	removeHelperContext(java.lang.String identifier, java.lang.ClassLoader key) INTERNAL
void	reset() Reset the Type,XML and XSD helper instances.
static void	setApplicationResolver(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 void	setHelperContextResolver(java.lang.Object helperContextResolver) Method allows dynamically change HelperContext creation strategy.
static void	setHelperContextResolver(SDOHelperContext.HelperContextResolver helperContextResolver) Method allows dynamically change HelperContext creation strategy.
void	setProperty(java.lang.String name, java.lang.Object value) Add a name/value pair to the properties Map.
void	setStrictTypeCheckingEnabled(boolean enabled) Controls type checking strictness.

Methods inherited from class java.lang.Object

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

Field Detail

STRICT_TYPE_CHECKING_PROPERTY_NAME

public static final java.lang.String STRICT_TYPE_CHECKING_PROPERTY_NAME

Property controls strictness of Type.getInstanceClass() type checking.

See isStrictTypeCheckingEnabled() for more details. By this property, the initial value can be changed. Default value is true.

See Also:

Constant Field Values

Constructor Detail

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

public SDOHelperContext(java.lang.String identifier)

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

public SDOHelperContext(java.lang.ClassLoader aClassLoader)

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

public SDOHelperContext(java.lang.String identifier,
                        java.lang.ClassLoader aClassLoader)

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 Detail

setApplicationResolver

public static void setApplicationResolver(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. 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:

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

reset

public void reset()

Reset the Type,XML and XSD helper instances.

getCopyHelper

public commonj.sdo.helper.CopyHelper getCopyHelper()

Return the CopyHelper instance for this helper context.

Specified by:

getCopyHelper in interface commonj.sdo.helper.HelperContext

getDataFactory

public commonj.sdo.helper.DataFactory getDataFactory()

Return the DataFactory instance for this helper context.

Specified by:

getDataFactory in interface commonj.sdo.helper.HelperContext

getDataHelper

public commonj.sdo.helper.DataHelper getDataHelper()

Return the DataHelper instance for this helper context.

Specified by:

getDataHelper in interface commonj.sdo.helper.HelperContext

getEqualityHelper

public commonj.sdo.helper.EqualityHelper getEqualityHelper()

Return the EqualityHelper instance for this helper context.

Specified by:

getEqualityHelper in interface commonj.sdo.helper.HelperContext

getTypeHelper

public commonj.sdo.helper.TypeHelper getTypeHelper()

Return the TypeHelper instance for this helper context.

Specified by:

getTypeHelper in interface commonj.sdo.helper.HelperContext

getXMLHelper

public commonj.sdo.helper.XMLHelper getXMLHelper()

Return the XMLHelper instance for this helper context.

Specified by:

getXMLHelper in interface commonj.sdo.helper.HelperContext

getXSDHelper

public commonj.sdo.helper.XSDHelper getXSDHelper()

Return the XSDHelper instance for this helper context.

Specified by:

getXSDHelper in interface commonj.sdo.helper.HelperContext

createResolvable

public commonj.sdo.impl.ExternalizableDelegator.Resolvable createResolvable()

Create and return a new ExternalizableDelegator.Resolvable instance based on this helper context.

Returns:

createResolvable

public commonj.sdo.impl.ExternalizableDelegator.Resolvable createResolvable(java.lang.Object target)

Create and return a new ExternalizableDelegator.Resolvable instance based on this helper context and a given target.

Parameters:

target -

Returns:

putHelperContext

public static void putHelperContext(java.lang.ClassLoader key,
                                    commonj.sdo.helper.HelperContext value)

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 loader

value - helper context

removeHelperContext

public static void removeHelperContext(java.lang.ClassLoader key)

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

public static void removeHelperContext(java.lang.String identifier,
                                       java.lang.ClassLoader key)

INTERNAL

Parameters:

identifier - the specific identifier of the HelperContext to be removed. "" for a Global helper

key - the ClassLoader associated with the HelperContext to be removed

getHelperContext

public static commonj.sdo.helper.HelperContext 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

public static commonj.sdo.helper.HelperContext getHelperContext(java.lang.String identifier)

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

public static commonj.sdo.helper.HelperContext getHelperContext(java.lang.String identifier,
                                                                java.lang.ClassLoader classLoader)

Return the local helper context with the given identifier, or create one if it does not already exist.

putHelperContext

public static void putHelperContext(commonj.sdo.helper.HelperContext ctx)

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

public static SDOHelperContext.HelperContextResolver getHelperContextResolver()

Getter for HelperContextResolver

Returns:

actual strategy

setHelperContextResolver

public static void setHelperContextResolver(java.lang.Object helperContextResolver)

Method allows dynamically change HelperContext creation strategy.

Parameters:

helperContextResolver - on this object SDOHelperContext.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

public java.lang.String getIdentifier()

Return the unique label for this HelperContext.

Returns:

String representing the unique label for this HelperContext

hasHelperContext

public static boolean hasHelperContext(java.lang.String identifier)

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

public static void addAlias(java.lang.String identifier,
                            java.lang.String alias)

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 Map

alias - the alias to be associated with identifier

setProperty

public void setProperty(java.lang.String name,
                        java.lang.Object value)

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 property

value - the value of the property

getProperty

public java.lang.Object getProperty(java.lang.String name)

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 the Type upon initialization of the Type. If any getter is missing then the interface is ignored and Type.getInstanceClass() will return null.

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. See isStrictTypeCheckingEnabled() for more details.

Parameters:

enabled - new value (true to enable the strict validation)

getWrapperTypes

public static java.util.Map<SDOTypeHelperDelegate.SDOWrapperTypeId,SDOWrapperType> getWrapperTypes()

Returns the SDOWrapperType instances for current application

putWrapperTypes

public static java.util.Map<SDOTypeHelperDelegate.SDOWrapperTypeId,SDOWrapperType> putWrapperTypes(java.util.Map<SDOTypeHelperDelegate.SDOWrapperTypeId,SDOWrapperType> wrapperTypes)

Replaces the SDOWrapperType instances 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