com.highqsoft.odsx.factory

Class OdsxSessionFactory

java.lang.Object

com.highqsoft.fwk.Fwk

com.highqsoft.fwk.FwkDescription

com.highqsoft.odsx.factory.OdsxSessionFactory

All Implemented Interfaces:

FwkDescriptionInterface, FwkInterface, FwkTransferableInterface, java.awt.datatransfer.ClipboardOwner, java.awt.datatransfer.Transferable, java.io.Serializable, java.lang.Cloneable

public class OdsxSessionFactory
extends FwkDescription

The session factory that caches the ods session objects. sessions.
If the factory type starts with ATF- (case insensitive) the factory asks for a ATF ASCII filename. The property OdsxSessionFactory.ATF.Directory specifies the initial directory.
If the factory type includes the case insensitive string ATF, the factory doesn't ask the user for a password. This doesn't depend on the value of the property Odsx.NewSession.AskForPassword. The property OdsxSessionFactory.XATF.Directory specifies the initial directory.

Property Keyword	Datatype	Default	Description
OdsxSessionFactory.ATF.Directory	String	The user directory (s.a. FwkContainer)	The startup directory for the ATF file selector.
Odsx.Title.ATFFileOpenDialog	String	Odsx.Title.ATFFileOpenDialog	The title of the selection dialog box.
OdsxSessionFactory.XATF.Directory	String	The user directory (s.a. FwkContainer)	The startup directory for the XML-ATF file selector.
Odsx.Title.XATFFileOpenDialog	String	Odsx.Title.XATFFileOpenDialog	The title of the selection dialog box.
Odsx.NewSession.AskForPassword	boolean	true	if true the user will be asked for a password before the system tries to connnect a service.
Odsx.NewSession.Username	String	null	The factory tires to get the the username and password from user dialog. This feature can be disabled by the property keyword Odsx.NewSession.AskForPassword. By using this keyword it is possible to specify username for the batchmode. If the username and password is available via these properties, the factory will not ask the user for authentication.
Odsx.NewSession.Password	String	null	The factory tires to get the the username and password from user dialog. This feature can be disabled by the property keyword Odsx.NewSession.AskForPassword. By using this keyword it is possible to specify password for the batchmode. If the username and password is available via these properties, the factory will not ask the user for authentication.
Odsx.NewSession.OpenMode	String	read	This flag enables the setting of on openmode.
Odsx.NewSession.CreateCoSessionAllowed	String	true	This flag enables the creation of a co session during runtime.
Odsx.NewSession.Authentication	String	null	The complete authentication used for connection. The values of the keywords Odsx.newSession.Username, Odsx.NewSession.Password and Odsx.NewSession.OpenMode will be appended if available.

The session factory uses the java.util.prefs.Preferences class to get and put following preferences:

atfdir	String	user.home or content of OdsxSessionFactory.XATF.Directory property.	This preferece holds the initial directory for the open ATF dialog.
xmlatfdir	String	user.home or content of OdsxSessionFactory.XATF.Directory property.	This preferece holds the initial directory for the open XML-ATF dialog.

Since:

$Date: 2017/04/06 13:29:53 $

Version:

$Revision: 1.44 $

Author:

Andreas Hofmann

See Also:

, Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected static OdsxSessionFactory	instance
protected static java.lang.String	PREFS_LASTATFFILE
protected static java.lang.String	PREFS_LASTXMLATFFILE
static java.lang.String	version

Fields inherited from class com.highqsoft.fwk.FwkDescription

author, buildnr, className, company, copyright, creationDate, dateFormatString, description, eMail, FWK_ICON, FWK_ICON_ARRAY, FWK_ICON_BG, FWK_ICON_BG_ARRAY, FWK_ICON_BG_LARGE, FWK_ICON_BG_LARGE_ARRAY, FWK_ICON_LARGE, FWK_ICON_LARGE_ARRAY, icon, ICON, iconCount, iconKey, internetAddress, name, titleName

Fields inherited from interface com.highqsoft.interfaces.fwk.FwkDescriptionInterface

AUTHOR, BUILDNR, COMPANY, COPYRIGHT, DATE_FORMAT, DEFAULT_ICON, DESCRIPTION, INTERNET, LARGE_ICON, LARGE_KEY_EXT, LARGE_OPAQUE_ICON, LARGE_OPAQUE_KEY_EXT, OPAQUE_ICON, OPAQUE_KEY_EXT, RCS_DATE_FORMAT, SUPPORT_EMAIL, TITLE_NAME

Method Summary

Methods

Modifier and Type	Method and Description
static void	addOdsxChangeListener(AoSession aoSession, OdsxChangeListenerInterface listener) Add an ODS change listener listen to the specified ODS session.
static void	addOdsxChangeListener(OdsxChangeListenerInterface listener) Add an ODS change listener.
protected void	addOdsxChangeListenerImpl(AoSession aoSession, OdsxChangeListenerInterface listener)
protected void	addOdsxChangeListenerImpl(OdsxChangeListenerInterface listener)
protected boolean	askForPassword(java.util.HashMap authMap, OdsxSessionInterface observer, java.lang.String serviceType)
static void	close(OdsxSessionInterface observer) Close the session.
protected void	closeImpl(OdsxSessionInterface observer)
static void	fireOdsxChange(AoSession aoSession, OdsxChangeEvent.OdsxDBEventModifier modifier) Fire a ODS DB change event.
static void	fireOdsxChange(AoSession aoSession, OdsxChangeEvent ev) Fire an ods change event.
static void	fireOdsxChange(ApplicationElement applicationElement, OdsxChangeEvent.OdsxAEEventModifier modifier) Fire a ODS change event.
static void	fireOdsxChange(ApplicationStructure applicationStructure, OdsxChangeEvent.OdsxASEventModifier modifier) Fire a ODS change event.
static void	fireOdsxChange(InstanceElement instElem1, InstanceElement instElem2, OdsxChangeEvent.OdsxRelEventModifier modifier) Fire a ODS change event.
static void	fireOdsxChange(InstanceElement instanceElement, OdsxChangeEvent.OdsxIEEventModifier modifier) Fire a ODS change event.
protected void	fireOdsxChangeImpl(AoSession aoSession, OdsxChangeEvent ev)
protected java.lang.String	getATFFilename(java.awt.Container root)
protected java.util.HashMap<java.lang.String,AoSession>	getAuthMap(AoFactory factory)
static AoSession	getCheckedSession(OdsxSessionInterface observer) Get a checked session for the specified observer.
protected AoSession	getCheckedSessionImpl(OdsxSessionInterface observer)
static java.awt.Container	getDialogParent(AoSession session) Retrieves a dialog parent belongs to the given session.
static java.awt.Container	getDialogParent(OdsxSessionInterface observer) Retrieves a dialog parent belongs to the given observer.
java.awt.Container	getDialogParentImpl(AoSession session)
java.awt.Container	getDialogParentImpl(OdsxSessionInterface observer)
static AoFactory	getFactory(OdsxSessionInterface observer) Get the factory for the specified observer.
protected AoFactory	getFactoryImpl(OdsxSessionInterface observer)
protected static OdsxSessionFactory	getInstance() Get the singleton instance.
static java.lang.String	getObserverIdent(OdsxSessionInterface observer) Determine the observer ident string.
static FwkSortedArray	getOptionMap(java.lang.String options, java.util.HashMap entries) Get the option identification string.
static FwkSortedArray	getOptionMap(java.lang.String options, java.util.HashMap entries, boolean upper) Get the option identification string.
static AoService	getService(OdsxSessionInterface observer) Get the service belongs to the given oberserver.
protected AoService	getServiceImpl(OdsxSessionInterface observer)
static AoSession	getSession(OdsxSessionInterface observer) Get the session for the specified observer.
protected AoSession	getSessionImpl(OdsxSessionInterface observer)
static OdsxSessionInterface	getSessionObserver(AoSession session) Get the session observer of the specified session.
protected OdsxSessionInterface	getSessionObserverImpl(AoSession session)
java.lang.String	getVersion() Return the version string of the FWK component.
protected java.lang.String	getXATFFilename(java.awt.Container root)
static void	main(java.lang.String[] args) The main testing routine.
static java.lang.String	normalizeOptionString(FwkSortedArray arr, java.util.HashMap entries)
static java.lang.String	normalizeOptionString(java.lang.String options) Get the option identification string.
static java.lang.String	normalizeOptionString(java.lang.String options, boolean upper) Get the option identification string.
protected java.lang.String	prepareOption(java.lang.String option)
static void	removeOdsxChangeListener(AoSession aoSession, OdsxChangeListenerInterface listener) Remove an ODS change listener listen to the specified ODS session.
static void	removeOdsxChangeListener(OdsxChangeListenerInterface listener) Remove an ODS change listener.
protected void	removeOdsxChangeListenerImpl(AoSession aoSession, OdsxChangeListenerInterface listener)
protected void	removeOdsxChangeListenerImpl(OdsxChangeListenerInterface listener)
static void	setDialogParent(OdsxSessionInterface observer, java.awt.Container dialogParent) Set a dialog parent belongs to the given observer.
java.awt.Container	setDialogParentImpl(OdsxSessionInterface observer, java.awt.Container dialogParent)

Methods inherited from class com.highqsoft.fwk.FwkDescription

getAuthor, getBuild, getClassName, getCompany, getCompanyInternetAddress, getCopyright, getCreationDate, getCreationDate, getDateFormatString, getDescription, getIcon, getIcon, getIconKey, getIconKey, getName, getPresentationString, getPresentationString, getSupportEMail, getTitle, getTitleName, getTransferData, getTransferDataFlavors, isDataFlavorSupported, lostOwnership, setAuthor, setBuild, setClassName, setCompany, setCompanyInternetAddress, setCopyright, setCreationDate, setCreationDate, setDateFormatString, setDescription, setDescriptor, setIcon, setIcon, setIconKey, setIconKey, setName, setSupportEMail, setTitleName, toString

Methods inherited from class com.highqsoft.fwk.Fwk

getNiceVersion, release

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.highqsoft.interfaces.fwk.FwkInterface

release

Field Detail

PREFS_LASTATFFILE

protected static final java.lang.String PREFS_LASTATFFILE

See Also:

Constant Field Values

PREFS_LASTXMLATFFILE

protected static final java.lang.String PREFS_LASTXMLATFFILE

See Also:

Constant Field Values

version

public static final java.lang.String version

See Also:

Constant Field Values

instance

protected static OdsxSessionFactory instance

Method Detail

getVersion

public java.lang.String getVersion()

Description copied from interface: FwkInterface

Return the version string of the FWK component.

Specified by:

getVersion in interface FwkInterface

Overrides:

getVersion in class FwkDescription

getInstance

protected static OdsxSessionFactory getInstance()

Get the singleton instance.

Returns:

the instance.

getAuthMap

protected java.util.HashMap<java.lang.String,AoSession> getAuthMap(AoFactory factory)

close

public static void close(OdsxSessionInterface observer)
                  throws AoException

Close the session. If there are no more references to the AoSession object, the method will fire an ODSChangeEvent and will cleanup all tables.

Parameters:

observer - The session observer.

Throws:

AoException

closeImpl

protected void closeImpl(OdsxSessionInterface observer)
                  throws AoException

Throws:

AoException

getService

public static AoService getService(OdsxSessionInterface observer)
                            throws AoException

Get the service belongs to the given oberserver.

Parameters:

observer - The session observer.

Returns:

An AoService object.

Throws:

AoException

getServiceImpl

protected AoService getServiceImpl(OdsxSessionInterface observer)
                            throws AoException

Throws:

AoException

getFactory

public static AoFactory getFactory(OdsxSessionInterface observer)
                            throws AoException

Get the factory for the specified observer.

Parameters:

observer - The reference object.

Returns:

The factory.

Throws:

AoException

getFactoryImpl

protected AoFactory getFactoryImpl(OdsxSessionInterface observer)
                            throws AoException

Throws:

AoException

getSessionObserver

public static OdsxSessionInterface getSessionObserver(AoSession session)

Get the session observer of the specified session.

Parameters:

session - the session.

Returns:

The session observer.

getSessionObserverImpl

protected OdsxSessionInterface getSessionObserverImpl(AoSession session)

getCheckedSession

public static AoSession getCheckedSession(OdsxSessionInterface observer)
                                   throws AoException

Get a checked session for the specified observer. The method will check the session and will do a reconnect, if the session is no more valid. An invalid session can be originated by a session time out on the server. This method call need more time and produce more network transfers than the normal getSession() method.

Parameters:

observer - The reference object.

Returns:

The session.

Throws:

AoException

getCheckedSessionImpl

protected AoSession getCheckedSessionImpl(OdsxSessionInterface observer)
                                   throws AoException

Throws:

AoException

getSession

public static AoSession getSession(OdsxSessionInterface observer)
                            throws AoException

Get the session for the specified observer.

Parameters:

observer - The reference object.

Returns:

The session.

Throws:

AoException

getSessionImpl

protected AoSession getSessionImpl(OdsxSessionInterface observer)
                            throws AoException

Throws:

AoException

prepareOption

protected java.lang.String prepareOption(java.lang.String option)

askForPassword

protected boolean askForPassword(java.util.HashMap authMap,
                     OdsxSessionInterface observer,
                     java.lang.String serviceType)

addOdsxChangeListener

public static void addOdsxChangeListener(OdsxChangeListenerInterface listener)

Add an ODS change listener.

Parameters:

listener - The change listener.

addOdsxChangeListenerImpl

protected void addOdsxChangeListenerImpl(OdsxChangeListenerInterface listener)

addOdsxChangeListener

public static void addOdsxChangeListener(AoSession aoSession,
                         OdsxChangeListenerInterface listener)

Add an ODS change listener listen to the specified ODS session.

Parameters:

listener - The change listener.

addOdsxChangeListenerImpl

protected void addOdsxChangeListenerImpl(AoSession aoSession,
                             OdsxChangeListenerInterface listener)

removeOdsxChangeListener

public static void removeOdsxChangeListener(OdsxChangeListenerInterface listener)

Remove an ODS change listener.

Parameters:

listener - The change listener.

removeOdsxChangeListenerImpl

protected void removeOdsxChangeListenerImpl(OdsxChangeListenerInterface listener)

removeOdsxChangeListener

public static void removeOdsxChangeListener(AoSession aoSession,
                            OdsxChangeListenerInterface listener)

Remove an ODS change listener listen to the specified ODS session.

Parameters:

listener - The change listener.

removeOdsxChangeListenerImpl

protected void removeOdsxChangeListenerImpl(AoSession aoSession,
                                OdsxChangeListenerInterface listener)

fireOdsxChange

public static void fireOdsxChange(AoSession aoSession,
                  OdsxChangeEvent ev)

Fire an ods change event.

Parameters:

aoSession - The session to that the event belongs.

ev - The ods change event.

fireOdsxChangeImpl

protected void fireOdsxChangeImpl(AoSession aoSession,
                      OdsxChangeEvent ev)

fireOdsxChange

public static void fireOdsxChange(AoSession aoSession,
                  OdsxChangeEvent.OdsxDBEventModifier modifier)

Fire a ODS DB change event.

Parameters:

aoSession - The session that will be closed.

modifier - The modifier. Use the constants defined in OdsxChangeEvent.

See Also:

OdsxChangeEvent

fireOdsxChange

public static void fireOdsxChange(InstanceElement instanceElement,
                  OdsxChangeEvent.OdsxIEEventModifier modifier)

Fire a ODS change event.

Parameters:

instance - The instance element that was changed.

modifier - The modifier. Use the constants defined in OdsxChangeEvent.

See Also:

OdsxChangeEvent

fireOdsxChange

public static void fireOdsxChange(ApplicationStructure applicationStructure,
                  OdsxChangeEvent.OdsxASEventModifier modifier)

Fire a ODS change event.

Parameters:

applicationStructure - The application structure was changed.

modifier - The modifier. Use the constants defined in OdsxChangeEvent.

See Also:

OdsxChangeEvent

fireOdsxChange

public static void fireOdsxChange(ApplicationElement applicationElement,
                  OdsxChangeEvent.OdsxAEEventModifier modifier)

Fire a ODS change event.

Parameters:

applicationElement - The application element that was changed.

modifier - The modifier. Use the constants defined in OdsxChangeEvent.

See Also:

OdsxChangeEvent

fireOdsxChange

public static void fireOdsxChange(InstanceElement instElem1,
                  InstanceElement instElem2,
                  OdsxChangeEvent.OdsxRelEventModifier modifier)

Fire a ODS change event.

Parameters:

instElem1 - The application element that was changed.

instElem2 - The application element that was changed.

modifier - The modifier. Use the constants defined in OdsxChangeEvent.

See Also:

OdsxChangeEvent

getOptionMap

public static FwkSortedArray getOptionMap(java.lang.String options,
                          java.util.HashMap entries)

Get the option identification string. This string can be used as option for the ODS layer.

Parameters:

options - The option comming from configurator.

Returns:

The option string used for the ODS-layer and for identification.

getOptionMap

public static FwkSortedArray getOptionMap(java.lang.String options,
                          java.util.HashMap entries,
                          boolean upper)

Get the option identification string. This string can be used as option for the ODS layer.

Parameters:

options - The option comming from configurator.

upper - if true the option keywords will converted to upper case letters.

Returns:

The option string used for the ODS-layer and for identification.

normalizeOptionString

public static java.lang.String normalizeOptionString(java.lang.String options)

Get the option identification string. This string can be used as option for the ODS layer.

Parameters:

options - The option comming from configurator.

upper - if true the option keyword will be converted to upper case letter.

Returns:

The option string used for the ODS-layer and for identification.

normalizeOptionString

public static java.lang.String normalizeOptionString(java.lang.String options,
                                     boolean upper)

Get the option identification string. This string can be used as option for the ODS layer.

Parameters:

options - The option comming from configurator.

upper - if true the option keyword will be converted to upper case letter.

Returns:

The option string used for the ODS-layer and for identification.

normalizeOptionString

public static java.lang.String normalizeOptionString(FwkSortedArray arr,
                                     java.util.HashMap entries)

getATFFilename

protected java.lang.String getATFFilename(java.awt.Container root)

getXATFFilename

protected java.lang.String getXATFFilename(java.awt.Container root)

getObserverIdent

public static java.lang.String getObserverIdent(OdsxSessionInterface observer)

Determine the observer ident string.

Parameters:

observer - the observer.

getDialogParent

public static java.awt.Container getDialogParent(AoSession session)

Retrieves a dialog parent belongs to the given session.

Parameters:

session - the ASAM ODS session.

Returns:

the dialog parent or null

getDialogParentImpl

public java.awt.Container getDialogParentImpl(AoSession session)

getDialogParent

public static java.awt.Container getDialogParent(OdsxSessionInterface observer)

Retrieves a dialog parent belongs to the given observer.

Parameters:

observer - the observer.

Returns:

the dialog parent or null

getDialogParentImpl

public java.awt.Container getDialogParentImpl(OdsxSessionInterface observer)

setDialogParent

public static void setDialogParent(OdsxSessionInterface observer,
                   java.awt.Container dialogParent)

Set a dialog parent belongs to the given observer.

Parameters:

observer - the observer.

dialogParent - the dialog parent or null

setDialogParentImpl

public java.awt.Container setDialogParentImpl(OdsxSessionInterface observer,
                                     java.awt.Container dialogParent)

main

public static void main(java.lang.String[] args)

The main testing routine.