com.highqsoft.corbafileserver

Class FileNameHandlerExtWrapper

java.lang.Object

com.highqsoft.corbafileserver.FileNameHandlerExtWrapper

All Implemented Interfaces:

FilenameHandlerExtIF, FilenameHandlerIF

public class FileNameHandlerExtWrapper
extends java.lang.Object
implements FilenameHandlerExtIF

Adapter class that implements the FilenameHandlerExtIF interface. When the CFS tries to instanciate the FileNameHandler class that is configured in the runtime properties, it will use a wrapper when the class does not implement the FilenameHandlerExtIF interface itself. This is to support the new functionality with older FileNameHandler classes.

Since:

2011-12-02

Version:

$Revision: 1.6 $

Author:

Alexander Ziller, HighQSoft GmbH

Constructor Summary

Constructors

Constructor and Description
FileNameHandlerExtWrapper(FilenameHandlerIF handler) Default constructor.

Method Summary

Methods

Modifier and Type	Method and Description
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 local file from given URL string.
java.io.File	getFileFromURL(java.lang.String url) Get the local file from given URL string.
java.lang.String	getURLFromFile(AoSession aoSession, java.io.File file) Create a URL string used by the ASAM ODS client to store into the AoExternalReference url value.
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.
java.io.File	move(java.io.File file) Move an unused file.

Methods inherited from class java.lang.Object

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

Constructor Detail

FileNameHandlerExtWrapper

public FileNameHandlerExtWrapper(FilenameHandlerIF handler)

Default constructor. Requires a FilenameHandlerIF implementation as parameter. This object will be wrapped by this Wrapper.

Parameters:

handler - the actual FilenameHandler implementation

Method Detail

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 FILESERVER_ASAMODS_EXCEPTION

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:

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.

aid - the application element id.

iid - the instance element id.

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

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:

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.

aeName - the application element name.

ieName - the instance element name.

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

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 url)
                            throws java.io.IOException,
                                   CORBAFileServerException

Get the local file from given URL string.

Specified by:

getFileFromURL in interface FilenameHandlerIF

Parameters:

url - the url string

Returns:

the local file

Throws:

java.io.IOException

CORBAFileServerException

delete

public void delete(java.io.File file)
            throws java.io.IOException,
                   CORBAFileServerException

Delete an unused file.

Specified by:

delete in interface FilenameHandlerIF

Parameters:

file - the file that may be deleted.

Throws:

java.io.IOException

CORBAFileServerException

move

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

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

CORBAFileServerException

getURLFromFile

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

Create a URL string used by the ASAM ODS client to store into the AoExternalReference url value.
This implementation ignores the session and calls the wrapped FileNameHandler's getURLFromFile(File) method.

Specified by:

getURLFromFile in interface FilenameHandlerExtIF

Parameters:

aoSession - an AoSession object, may also be null because this method does not use this parameter

file - the local file

Returns:

the url string

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 local file from given URL string.
This implementation ignores the session and calls the wrapped FileNameHandler's {@link #getFileFromURL(String) method.

Specified by:

getFileFromURL in interface FilenameHandlerExtIF

Parameters:

aoSession - an AoSession object, may also be null because this method does not use this parameter

url - the url string

Returns:

the local 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