com.highqsoft.corbafileserver

Class ODSFilenameHandler

java.lang.Object

com.highqsoft.corbafileserver.ODSFilenameHandler

All Implemented Interfaces:

FilenameHandlerExtIF, FilenameHandlerIF

public class ODSFilenameHandler
extends java.lang.Object
implements FilenameHandlerExtIF

This is the filename handler for the CORBAFileServer using the definition of ASAM ODS for the filename and the URL or storage location. The filename handler reads the FILE_NOTATION, FILE_MODE and required symbols from the ODS Session and depending on the settings of these variables, the local file and the URL are created. When The FILE_MODE of the ODS Session is ABSOLUTE the files will be location in the PINPATH given in the INI-File of the avalon.

Property Keyword	Datatype	Default	Description
ODSFilenameHandler.URLPrefix	String	file://	This is the prefix that the file handler uses to create the URL of the file.
ODSFilenameHandler.FileRoot	String	FILE_ROOT_EXTREF	This is the symbol of the ODS Server where the files will be stored.
ODSFilenameHandler.UseSessionCache	boolean	true	Use a cache for the ODSFilenameURL, the cache will reduce the requests from FilenameHandler to the ODS Server. Without a cache for each file, handled in the same session, the symbols are loaded from the ODS server. With the cache the symbols are loaded only once. When the symbols changes during the session , you can not use the cache. This property is obsolete, because caching leads to synchronization issues.
ODSFilenameHandler.CheckPath	boolean	false	Check the path of the resulting file is a (sub)directory of one of the given symbols. This check can only be done in case the FILE_MODE is MULTI_VOLUME or SINGLE_VOLUME. An exception will be thrown when the files are not part of the symbols.

\note In case an error occurs in the URI, the way ZEUSAGGR used the location of the external reference will be used to get the file. This is required at ZEUSAGGR there is mixture between old location and new locations.

Since:

$Date: 2019/02/07 12:58:24 $

Version:

$Revision: 1.17 $

Author:

Karst Schaap

See Also:

Field Summary

Fields

Modifier and Type	Field and Description
protected static java.lang.String	BinPath
protected static java.lang.String	BinSubDir
protected static java.lang.String	FileRootExtRefName
protected static java.lang.String	FileRootName
protected static java.lang.String	FileSymbols
protected OdsFilenameURL	odsFilename

Constructor Summary

Constructors

Constructor and Description
ODSFilenameHandler() The filename handler

Method Summary

Methods

Modifier and Type	Method and Description
protected java.lang.String	aoExceptionToString(AoException aoException) String formatter for AoException.
void	delete(java.io.File file) Delete an unused file.
java.io.File	getFile(AoSession aoSession, java.lang.String name, java.lang.String subdir) Get a file for the given initial name.
java.io.File	getFileForInstance(AoSession aoSession, java.lang.String name, java.lang.String subDir, T_LONGLONG aid, T_LONGLONG iid) Create a file for the given initial name and depending on the given ids.
java.io.File	getFileForInstanceName(AoSession aoSession, java.lang.String name, java.lang.String subDir, java.lang.String aeName, java.lang.String ieName) Create a file for the given initial name and depending on the given names.
java.io.File	getFileFromURL(AoSession aoSession, java.lang.String url) Get the file from the storage location
java.io.File	getFileFromURL(java.lang.String urlStr) Get the local file from given URL string.
protected OdsFilenameURL	getOdsFilenameURL(AoSession aoSession, java.lang.String fileRoot) Get the ODSFilenameURL to get the URL and the File.
static java.lang.String	getRootDirectory() Get the root directory according to the defined properties.
java.lang.String	getURLFromFile(AoSession aoSession, java.io.File file) Get the URL from the file.
java.lang.String	getURLFromFile(java.io.File file) Create a URL string used by the ASAM ODS client to store into the AoExternalReference url value.
static java.lang.String	getWasteDirectory() Get the waste directory according to the defined properties.
static void	main(java.lang.String[] arg)
java.io.File	move(java.io.File file) Move an unused file.
protected java.lang.String	severityFlagToString(SeverityFlag sevFlag) String formatter for the severity flags

Methods inherited from class java.lang.Object

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

Field Detail

FileRootName

protected static java.lang.String FileRootName

FileRootExtRefName

protected static java.lang.String FileRootExtRefName

FileSymbols

protected static java.lang.String FileSymbols

BinPath

protected static java.lang.String BinPath

BinSubDir

protected static java.lang.String BinSubDir

odsFilename

protected OdsFilenameURL odsFilename

Constructor Detail

ODSFilenameHandler

public ODSFilenameHandler()

The filename handler

Method Detail

aoExceptionToString

protected java.lang.String aoExceptionToString(AoException aoException)

String formatter for AoException.

Parameters:

aoException - the exception

Returns:

the formatted string.

severityFlagToString

protected java.lang.String severityFlagToString(SeverityFlag sevFlag)

String formatter for the severity flags

Parameters:

sevFlag - the severity flag

Returns:

the formatted string

getFile

public java.io.File getFile(AoSession aoSession,
                   java.lang.String name,
                   java.lang.String subdir)
                     throws CORBAFileServerException

Get a file for the given initial name.

Specified by:

getFile in interface FilenameHandlerIF

Parameters:

aoSession - the ASAM ODS session.

name - the name of the file.

subdir - the subdirectory, if the filename should not be used to get the subfolder.

Throws:

CORBAFileServerException - with the following possible error codes: FILESERVER_CONNECT_FAILED FILESERVER_BAD_PARAMETER FILESERVER_CONNECTION_LOST FILESERVER_IMPLEMENTATION_PROBLEM FILESERVER_NOT_IMPLEMENTED FILESERVER_NO_MEMORY

getFileForInstance

public java.io.File getFileForInstance(AoSession aoSession,
                              java.lang.String name,
                              java.lang.String subDir,
                              T_LONGLONG aid,
                              T_LONGLONG iid)
                                throws CORBAFileServerException

Create a file for the given initial name and depending on the given ids.

Specified by:

getFileForInstance in interface FilenameHandlerIF

Parameters:

name - the name of the file.

subDir - the subdirectory, if the filename should not be used to get the subfolder.

aid - the application element id.

iid - the instance element id.

aoSession - the ASAM ODS Session

Returns:

the file.

Throws:

CORBAFileServerException - with the following possible error codes: FILESERVER_CONNECT_FAILED FILESERVER_BAD_PARAMETER FILESERVER_CONNECTION_LOST FILESERVER_IMPLEMENTATION_PROBLEM FILESERVER_NOT_IMPLEMENTED FILESERVER_NO_MEMORY

getFileForInstanceName

public java.io.File getFileForInstanceName(AoSession aoSession,
                                  java.lang.String name,
                                  java.lang.String subDir,
                                  java.lang.String aeName,
                                  java.lang.String ieName)
                                    throws CORBAFileServerException

Create a file for the given initial name and depending on the given names.

Specified by:

getFileForInstanceName in interface FilenameHandlerIF

Parameters:

name - the name of the file.

subDir - the subdirectory, if the filename should not be used to get the subfolder.

aeName - the application element name.

ieName - the instance element name.

aoSession - the ASAM ODS Session

Returns:

the file.

Throws:

CORBAFileServerException - with the following possible error codes: FILESERVER_CONNECT_FAILED FILESERVER_BAD_PARAMETER FILESERVER_CONNECTION_LOST FILESERVER_IMPLEMENTATION_PROBLEM FILESERVER_NOT_IMPLEMENTED FILESERVER_NO_MEMORY

getURLFromFile

public java.lang.String getURLFromFile(java.io.File file)
                                throws java.io.IOException,
                                       CORBAFileServerException

Create a URL string used by the ASAM ODS client to store into the AoExternalReference url value.

Specified by:

getURLFromFile in interface FilenameHandlerIF

Parameters:

file - the local file

Returns:

the url string

Throws:

java.io.IOException

CORBAFileServerException

getFileFromURL

public java.io.File getFileFromURL(java.lang.String urlStr)
                            throws java.io.IOException,
                                   java.net.UnknownHostException,
                                   CORBAFileServerException

Get the local file from given URL string.

Specified by:

getFileFromURL in interface FilenameHandlerIF

Parameters:

urlStr - the url string

Returns:

the local file

Throws:

java.io.IOException

java.net.UnknownHostException

CORBAFileServerException

delete

public void delete(java.io.File file)

Delete an unused file.

Specified by:

delete in interface FilenameHandlerIF

Parameters:

file - the file that may be deleted.

getRootDirectory

public static java.lang.String getRootDirectory()

Get the root directory according to the defined properties. If the directory doesn't exist, this routine will newly create it.

Returns:

The name of the root directory.

getWasteDirectory

public static java.lang.String getWasteDirectory()

Get the waste directory according to the defined properties. If the directory doesn't exist, this routine will newly create it.

Returns:

The name of the waste directory.

move

public java.io.File move(java.io.File file)
                  throws java.io.IOException

Move an unused file. The result may be a waste basket or a parking area for unused files.

Specified by:

move in interface FilenameHandlerIF

Parameters:

file - the result file.

Throws:

java.io.IOException

main

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

getOdsFilenameURL

protected OdsFilenameURL getOdsFilenameURL(AoSession aoSession,
                               java.lang.String fileRoot)

Get the ODSFilenameURL to get the URL and the File.

Parameters:

aoSession - the current asam ods session.

fileRoot - the file root variable.

Returns:

the odsFilename

getURLFromFile

public java.lang.String getURLFromFile(AoSession aoSession,
                              java.io.File file)
                                throws CORBAFileServerException

Get the URL from the file.

Specified by:

getURLFromFile in interface FilenameHandlerExtIF

Parameters:

aoSession - the ASAM ODS session

the - file

Returns:

the URL or storage location

Throws:

CORBAFileServerException - with the following possible error codes: FILESERVER_CONNECT_FAILED FILESERVER_BAD_PARAMETER FILESERVER_CONNECTION_LOST FILESERVER_IMPLEMENTATION_PROBLEM FILESERVER_NOT_IMPLEMENTED FILESERVER_NO_MEMORY FILESERVER_ASAMODS_EXCEPTION

getFileFromURL

public java.io.File getFileFromURL(AoSession aoSession,
                          java.lang.String url)
                            throws CORBAFileServerException

Get the file from the storage location

Specified by:

getFileFromURL in interface FilenameHandlerExtIF

Parameters:

aoSession - the ASAM ODS session

url - the URL or storage location

Returns:

the file.

Throws:

CORBAFileServerException - with the following possible error codes: FILESERVER_CONNECT_FAILED FILESERVER_BAD_PARAMETER FILESERVER_CONNECTION_LOST FILESERVER_IMPLEMENTATION_PROBLEM FILESERVER_NOT_IMPLEMENTED FILESERVER_NO_MEMORY FILESERVER_ASAMODS_EXCEPTION