com.highqsoft.corbafileserver

Interface FilenameHandlerIF

All Known Subinterfaces:

FilenameHandlerExtIF

All Known Implementing Classes:

FilenameHandler, FileNameHandlerExtWrapper, ODSFilenameHandler

public interface FilenameHandlerIF

This interface must be fullfilled by all classes that should be a filename handler for the CORBAFileServer.

Since:

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

Version:

$Revision: 1.15 $

Author:

Andreas Hofmann

See Also:

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(java.lang.String url) Get the local file from given URL string.
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.

Method Detail

getFile

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

Get a file for the given initial name.

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

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.

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

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.

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

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.

Parameters:

file - the local file

Returns:

the url string

Throws:

java.io.IOException

CORBAFileServerException

getFileFromURL

java.io.File getFileFromURL(java.lang.String url)
                            throws java.io.IOException,
                                   CORBAFileServerException

Get the local file from given URL string.

Parameters:

url - the url string

Returns:

the local file

Throws:

java.io.IOException

CORBAFileServerException

delete

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

Delete an unused file.

Parameters:

file - the file that may be deleted.

Throws:

java.io.IOException

CORBAFileServerException

move

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.

Parameters:

file - the result file.

Throws:

java.io.IOException

CORBAFileServerException