net.ontopia.topicmaps.nav2.impl.basic
Class NavigatorApplication

java.lang.Object
  net.ontopia.topicmaps.nav2.impl.basic.NavigatorApplication

All Implemented Interfaces:

NavigatorApplicationIF

public final class NavigatorApplication
extends java.lang.Object
implements NavigatorApplicationIF

INTERNAL: Basic Implementation of interface NavigatorApplicationIF to store all handles to application-wide configuration holders needed by the navigator framework.

Note: The default behaviour if no plug-ins dir is specified (in web.xml) that there will be no plug-ins available.

Field Summary

Fields inherited from interface net.ontopia.topicmaps.nav2.core.NavigatorApplicationIF

APP_CONFIG_DEFAULT_VALUE, APP_CONFIG_KEY, CONTEXT_KEY, FOREACH_SEQ_FIRST_KEY, FOREACH_SEQ_INDEX_KEY, FOREACH_SEQ_LAST_KEY, JNDI_REPOSITORY_KEY, LOG4J_CONFIG_DEFAULT_VALUE, LOG4J_CONFIG_KEY, NAV_APP_KEY, PLUGINS_ROOTDIR_KEY, SOURCE_CONFIG_DEFAULT_VALUE, SOURCE_CONFIG_KEY, TOPICMAPS_REPOSITORY_ID, USER_KEY

Constructor Summary

NavigatorApplication(javax.servlet.ServletContext context)
INTERNAL: Default Constructor.

Method Summary

void	close() INTERNAL: Close navigator application and free all resources connected to it.
NavigatorConfigurationIF	getConfiguration() INTERNAL: Get NavigatorConfigurationIF object which allows access to all application relevant configuration information.
java.lang.Object	getInstanceOf(java.lang.String classname) INTERNAL: Get an object instance of specified class name centralized managed by this instance (application).
ModuleIF	getModule(java.net.URL location) Gets module from internal cache, if it is not in or should be refreshed the module resource is loaded in again.
java.lang.String	getName() INTERNAL: Gets the name of this application.
TopicMapIF	getTopicMapById(java.lang.String topicmapId) INTERNAL: Get TopicMapIF object for specified TopicMap String Identifier which is in accordance to the identifiers used by the TopicMapRepositoryIF.
TopicMapIF	getTopicMapById(java.lang.String topicmapId, boolean readonly) INTERNAL: Get TopicMapIF object for specified TopicMap String Identifier which is in accordance to the identifiers used by the TopicMapRepositoryIF.
TopicMapIF	getTopicMapById(java.lang.String topicmapId, boolean readonly, java.lang.String repositoryId)
java.lang.String	getTopicMapRefId(TopicMapIF topicmap) INTERNAL: Get the reference ID of the topic map within the application's store registry.
TopicMapRepositoryIF	getTopicMapRepository() INTERNAL: Returns the topic map repository used by the navigator application.
UserStoreRegistry	getUserStoreRegistry() INTERNAL: Get UserStoreRegistry object which allows access to all available topicmap sources, whether they are already loaded or have to be loaded (managed automatically).
static SharedStoreRegistry	lookupSharedStoreRegistry(java.lang.String jndi_name) INTERNAL: Looks up the SharedStoreRegistry in JNDI.
void	refreshAppConfig() Deprecated.
void	refreshTopicMapRegistry() Deprecated.
void	returnTopicMap(TopicMapIF topicmap) INTERNAL: Returns the TopicMapIF object to the navigator application.

Methods inherited from class java.lang.Object

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

Constructor Detail

NavigatorApplication

public NavigatorApplication(javax.servlet.ServletContext context)

INTERNAL: Default Constructor.

Parameters:

context - - The ServletContext object, which is needed to retrieve the context and configuration information about this web application.

Method Detail

getName

public java.lang.String getName()

Description copied from interface: NavigatorApplicationIF

INTERNAL: Gets the name of this application.

Specified by:

getName in interface NavigatorApplicationIF

Returns:

Display name of the web application ServletContext.getServletContextName().

getConfiguration

public NavigatorConfigurationIF getConfiguration()

Description copied from interface: NavigatorApplicationIF

INTERNAL: Get NavigatorConfigurationIF object which allows access to all application relevant configuration information.

Specified by:

getConfiguration in interface NavigatorApplicationIF

getTopicMapRepository

public TopicMapRepositoryIF getTopicMapRepository()

Description copied from interface: NavigatorApplicationIF

INTERNAL: Returns the topic map repository used by the navigator application.

Specified by:

getTopicMapRepository in interface NavigatorApplicationIF

getUserStoreRegistry

public UserStoreRegistry getUserStoreRegistry()

Description copied from interface: NavigatorApplicationIF

INTERNAL: Get UserStoreRegistry object which allows access to all available topicmap sources, whether they are already loaded or have to be loaded (managed automatically). The transaction user is bound internally by the navigator application.

Specified by:

getUserStoreRegistry in interface NavigatorApplicationIF

refreshAppConfig

public void refreshAppConfig()

Deprecated.

INTERNAL: Reloads application.xml and plug-in configurations.

Specified by:

refreshAppConfig in interface NavigatorApplicationIF

getTopicMapById

public TopicMapIF getTopicMapById(java.lang.String topicmapId)
                           throws NavigatorRuntimeException

Description copied from interface: NavigatorApplicationIF

INTERNAL: Get TopicMapIF object for specified TopicMap String Identifier which is in accordance to the identifiers used by the TopicMapRepositoryIF.

Specified by:

getTopicMapById in interface NavigatorApplicationIF

Throws:

NavigatorRuntimeException

getTopicMapById

public TopicMapIF getTopicMapById(java.lang.String topicmapId,
                                  boolean readonly)
                           throws NavigatorRuntimeException

Description copied from interface: NavigatorApplicationIF

INTERNAL: Get TopicMapIF object for specified TopicMap String Identifier which is in accordance to the identifiers used by the TopicMapRepositoryIF.

Specified by:

getTopicMapById in interface NavigatorApplicationIF

Throws:

NavigatorRuntimeException

getTopicMapById

public TopicMapIF getTopicMapById(java.lang.String topicmapId,
                                  boolean readonly,
                                  java.lang.String repositoryId)
                           throws NavigatorRuntimeException

Throws:

NavigatorRuntimeException

returnTopicMap

public void returnTopicMap(TopicMapIF topicmap)

Description copied from interface: NavigatorApplicationIF

INTERNAL: Returns the TopicMapIF object to the navigator application. Note that the topic map object must have been retrieved from the navigator application for this to work properly.

Specified by:

returnTopicMap in interface NavigatorApplicationIF

getTopicMapRefId

public java.lang.String getTopicMapRefId(TopicMapIF topicmap)

Description copied from interface: NavigatorApplicationIF

INTERNAL: Get the reference ID of the topic map within the application's store registry.

Specified by:

getTopicMapRefId in interface NavigatorApplicationIF

getInstanceOf

public java.lang.Object getInstanceOf(java.lang.String classname)
                               throws NavigatorRuntimeException

Description copied from interface: NavigatorApplicationIF

INTERNAL: Get an object instance of specified class name centralized managed by this instance (application).

Specified by:

getInstanceOf in interface NavigatorApplicationIF

Parameters:

classname - String which can be a shortcut for a full qualified class name (FQCN) specified in the classmap of NavigatorConfigurationIF If no entry is found the classname is interpreted as FQCN.

Returns:

An object instance of given class.

Throws:

NavigatorRuntimeException

See Also:

NavigatorConfigurationIF

getModule

public ModuleIF getModule(java.net.URL location)
                   throws NavigatorRuntimeException

Gets module from internal cache, if it is not in or should be refreshed the module resource is loaded in again.

Specified by:

getModule in interface NavigatorApplicationIF

Throws:

NavigatorRuntimeException

close

public void close()

Description copied from interface: NavigatorApplicationIF

INTERNAL: Close navigator application and free all resources connected to it.

Specified by:

close in interface NavigatorApplicationIF

refreshTopicMapRegistry

public void refreshTopicMapRegistry()

Deprecated.

INTERNAL: Reloads the topic map repository, which stores information about which topicmaps should be made available to the web application.

Specified by:

refreshTopicMapRegistry in interface NavigatorApplicationIF

lookupSharedStoreRegistry

public static SharedStoreRegistry lookupSharedStoreRegistry(java.lang.String jndi_name)

INTERNAL: Looks up the SharedStoreRegistry in JNDI.