Package org.apache.uima.fit.factory.locator

Class JndiResourceLocator

java.lang.Object

org.apache.uima.resource.Resource_ImplBase

org.apache.uima.fit.component.Resource_ImplBase

org.apache.uima.fit.factory.locator.JndiResourceLocator

All Implemented Interfaces:

ExternalResourceAware, ExternalResourceLocator, Resource

@Deprecated
public class JndiResourceLocator
extends Resource_ImplBase
implements ExternalResourceLocator

Deprecated.

To be removed without replacement

Locate an object via JNDI.

To be removed in version:

4.0.0

Field Summary

Fields

Modifier and Type	Field	Description
static final String	PARAM_NAME	Deprecated. The name of the JNDI resource to look up.

Fields inherited from interface org.apache.uima.resource.Resource

PARAM_AGGREGATE_SOFA_MAPPINGS, PARAM_CONFIG_MANAGER, PARAM_CONFIG_PARAM_SETTINGS, PARAM_EXTERNAL_OVERRIDE_SETTINGS, PARAM_PERFORMANCE_TUNING_SETTINGS, PARAM_RESOURCE_MANAGER, PARAM_UIMA_CONTEXT

Constructor Summary

Constructors

Constructor	Description
JndiResourceLocator()	Deprecated.

Method Summary

Modifier and Type	Method	Description
Object	getResource()	Deprecated.
boolean	initialize(ResourceSpecifier aSpecifier, Map aAdditionalParams)	Deprecated. Initializes this Resource from a ResourceSpecifier.

Methods inherited from class org.apache.uima.fit.component.Resource_ImplBase

afterResourcesInitialized, getResourceName

Methods inherited from class org.apache.uima.resource.Resource_ImplBase

destroy, getCasManager, getLogger, getMetaData, getRelativePathResolver, getResourceManager, getUimaContext, getUimaContextAdmin, loadUserClass, loadUserClassOrThrow, setContextHolder, setContextHolderX, setLogger, setMetaData, withContextHolder

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.uima.resource.Resource

destroy, getLogger, getMetaData, getResourceManager, getUimaContext, getUimaContextAdmin, setLogger

Field Details

PARAM_NAME

public static final String PARAM_NAME

Deprecated.

The name of the JNDI resource to look up.

See Also:

• Constant Field Values

Constructor Details

JndiResourceLocator

public JndiResourceLocator()

Deprecated.

Method Details

initialize

public boolean initialize(ResourceSpecifier aSpecifier,
 Map aAdditionalParams)
                   throws ResourceInitializationException

Deprecated.

Description copied from interface: Resource

Initializes this Resource from a ResourceSpecifier. Applications do not need to call this method. It is called automatically by the ResourceFactory and cannot be called a second time.

Specified by:

initialize in interface Resource

Overrides:

initialize in class Resource_ImplBase

Parameters:

aSpecifier - specifies how to create a resource or locate an existing resource service.

aAdditionalParams - a Map containing additional parameters. May be null if there are no parameters. Each class that implements this interface can decide what additional parameters it supports.

Returns:

true if and only if initialization completed successfully. Returns false if the given ResourceSpecifier is not of an appropriate type for this Resource. If the ResourceSpecifier is of an appropriate type but is invalid or if some other failure occurs, an exception should be thrown.

Throws:

ResourceInitializationException - if a failure occurs during initialization.

getResource

public Object getResource()

Deprecated.

Specified by:

getResource in interface ExternalResourceLocator

Returns:

the resource