com.highqsoft.corbafileserver

Class CORBAFileServer

java.lang.Object

org.omg.PortableServer.Servant

com.highqsoft.corbafileserver.generated.CORBAFileServerIFPOA

com.highqsoft.corbafileserver.AbstractCORBAFileServer

com.highqsoft.corbafileserver.CORBAFileServer

All Implemented Interfaces:

CORBAFileServerIF, CORBAFileServerIFOperations, java.io.Serializable, java.lang.Runnable, org.omg.CORBA.Object, org.omg.CORBA.portable.IDLEntity, org.omg.CORBA.portable.InvokeHandler

public class CORBAFileServer
extends AbstractCORBAFileServer
implements CORBAFileServerIF, java.lang.Runnable

The CORBA File Server.

Property Keyword	Datatype	Default	Description
CORBAFileServer.NameServiceName	String	NameService	The name of the requested CORBA Name Service. This value has more priority than NameServiceName, but is ignored if ORBInitRef is set. This value is an application property.
NameServiceName	String	NameService	The name of the requested CORBA Name Service. This value has less priority than CORBAFileServer.NameServiceName, both are ignored if ORBInitRef is set. This value is an application property.
CORBAFileServer.NameServicePort	String	2809	The port number of the requested CORBA Name Service. This value has more priority than NameServicePort, but is ignored if ORBInitRef is set. This value is an application property.
NameServicePort	String	2809	The port number of the requested CORBA Name Service. This value has less priority than CORBAFileServer.NameServicePort, both are ignored if ORBInitRef is set. This value is an application property.
CORBAFileServer.NameServiceHost	String	localhost	The host name of the requested CORBA Name Service. This value has more priority than NameServiceHost, but is ignored if ORBInitRef is set. This value is an application property.
NameServiceHost	String	localhost	The host name of the requested CORBA Name Service. This value has less priority than CORBAFileServer.NameServiceHost, both are ignored if ORBInitRef is set. This value is an application property.
CORBAProtocol	String	""	The CORBA protocol in the corbaloc (CORBA locator) to find the name service. The default of CORBA is iiop, which is identical with an empty string "". For IIOP over SSL the protocol must be ssliop. This value is ignored if ORBInitRef is set. This value is an application property.
ORBInitRef	String	none	The full CORBA locator. If this value is set, the values of (CORBAFileServer.)NameServiceName, NameServicePort, NameServiceHost and CORBAProtocol are ignored. This value is an application property. Example: Nameservice=corbaloc::1.2@MyServiceHost:MyServicePort/NameService
CORBAFileServer.ServiceName	String	CORBAFileServer	The service to be used by the service. The name of for registration will be build by using the property CORBAFileServer.RegistrationFormat. This value is an application property.
CORBAFileServer.RegistrationFormat	String	"{0}.{1}@{2}"	This is the format string for the name that is used to register this service. There are three optional parameter available: 0 - The value of the property ServiceName 1 - The word FileServer 2 - The uppercase local hostname The default format creates a name like CORBAFileServer/FileServer@HOSTNAME
CORBAFileServer.PrintNameServiceIOR	boolean	false	This flags tells the server to print the NameService IOR to the console. This IOR can be used by the client to find the name service used by service.
CORBAFileServer.PublishInRoot	boolean	true	This flags tells the server to publish the CORBAFileServerIF in the root of the name service. When the CORBAFileServerIF is published in the root, the object will always have the kind ASAM-ODS.
CORBAFileServer.NameServiceContext	string	"com/highqsoft/"	This property set the name service context. The name service context is the context in which servicename will be published. The context must ends with '/' character.
CORBAFileServer.DebugLevel	int	none	To get verbose output set this value. Currently there is no convention at what is printed at what level.
CORBAFileServer.StdOut	File	none	The name of a file that service uses as standard output stream. This value can not set via a property files (parameter Properties), because it will be used directly after startup and before the property file is evaluated.
CORBAFileServer.StdErr	File	none	The name of a file that service uses as standard error stream. This value can not set via a property files (parameter Properties), because it will be used directly after startup and before the property file is evaluated.
CORBAFileServer.RootDir	Directory	$HOME/CORBAFileServer	The root directory for the filehandler.
CORBAFileServer.WasteDir	Directory	$HOME/CORBAFileServer/waste	The root directory for the filehandler where to move the waste.
CORBAFileServer.BufferSize	int	100000	The buffer size in bytes for file transfer.
CORBAFileServer.FilenameHandler	classname	com.highqsoft.corbafileserver.FilenameHandler	The default filename handler. This class must fulfill the FilenameHandlerIF interface defined in this package.
CORBAFileServer.Terminator	classname	null	The terminator that can be called by the client to terminate the transfer action.
CORBAFileServer.SecurityHandler	classname	com.highqsoft.corbafileserver.SecurityHandler	The default security handler. This class must fulfill the SecurityHandlerIF interface defined in this package.
CORBAFileServer.SecurityActive	boolean	true	The boolean decides whether to call the security handler or not. if true it will be called.
CORBAFileServer.SocketTimeout	boolean	2000	The socket timeout in milliseconds.
CORBAFileServer.LicenseLocation	String	path-to-CFS-jar/../etc	The location of the license for the CORBAFileServer. The supported format of the string is either an absolute path to a directory with the license file(s) or a 'host@port' annotation of a machine where the license manager is running.
CORBAFileServer.useSSL	boolean	false	Tells the CORBAFileServer to initialize SSLSockets instead of normal Sockets. The Java SSL stack must be set up correctly by the IT administrator.
CORBAFileServer.IncludePattern	String	none	This property is can be used by the security handler. It is used by the default security handler com.highqsoft.corbafileserver.SecurityHandler and checks the name coming from client against this pattern. If the pattern doesn't matches, a security exception will be thrown.
CORBAFileServer.IncludePatternFlags	String	none	This property is meaningful if the property CORBAFileServer.IncludePattern is also available. It is a list of flags defined by the java.util.regex.Pattern and used by the method compile(String, int). The flags must not be defined by the integer values. It can be defined directly by the field names optionally separated by vertical bar '|'. Example: CASE_INSENSITIVE | MULTILINE
CORBAFileServer.ExcludePattern	String	none	This property is can be used by the security handler. It is used by the default security handler com.highqsoft.corbafileserver.SecurityHandler and checks the name coming from client against this pattern. If the pattern does matches, a security exception will be thrown.
CORBAFileServer.ExcludePatternFlags	String	none	This property is meaningful if the property CORBAFileServer.ExcludePattern is also available. It is a list of flags defined by the java.util.regex.Pattern and used by the method compile(String, int). The flags must not be defined by the integer values. It can be defined directly by the field names optionally separated by vertical bar '|'. Example: CASE_INSENSITIVE | MULTILINE
CORBAFileServer.LogConfig	String	none	This property configures the Java Util Logging system of the CORBAFileServer. It must be the path the configuration file. There is a default configuration which will write to console if this property is not given.
Properties	filename	none	A file that contains the properties. The properties defined directly as parameters have higher priority.

Since:

$Date: 2019/08/13 06:59:10 $

Version:

$Revision: 1.92 $

Author:

Andreas Hofmann

See Also:

, Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	CORBAFileServer.RunningStateListener The service listener to control the state of the command line ver

Field Summary

Fields

Modifier and Type	Field and Description
protected int	licFails
protected java.util.concurrent.atomic.AtomicBoolean	methodHandle

Fields inherited from interface com.highqsoft.corbafileserver.generated.CORBAFileServerIF

INTERFACEVERSION

Constructor Summary

Constructors

Constructor and Description
CORBAFileServer() The constructor.
CORBAFileServer(java.util.Properties properties) Constructor receiving the commandline arguments.

Method Summary

Methods

Modifier and Type	Method and Description
void	addJVMServiceListener(JVMServiceListener l) Add a service state listener.
org.omg.CosNaming.NameComponent[]	checkAndRebind(org.omg.CosNaming.NamingContext nsContext, org.omg.CosNaming.NameComponent[] path, org.omg.CORBA.Object cfsRef, java.lang.String serviceName, boolean orbStarted) Check the object in the name service context if the object is a valid AoFactory object, the there is an implementation of avalon running at the momet with the same name and the service will not start.
protected FilenameHandlerExtIF	createFilenameHandler() Create the filename handler.
protected LicenseListener	createLicenseListener() Creates a new LicenseListener from the Property 'CORBAFileServer.LicenseListener' if it was given.
protected void	createSecurityHandler(java.util.Properties properties) Create the security handler.
protected void	createStreamHandler(java.util.Properties properties)
protected void	createTerminator() Create the terminator.
void	delete(AoSession aoSession, java.lang.String url) Delete the data associated with the given name.
void	deleteForInstance(AoSession aoSession, java.lang.String url, T_LONGLONG aid, T_LONGLONG iid) Delete the data associated with the given name.
boolean	exit() The exit method.
void	fireServiceEvent(int state) Fire a service event.
void	fireServiceEvent(int state, java.lang.String message) Fire a service event.
void	fireServiceEvent(JVMServiceEvent ev) Fire a service event.
void	getBySocket(AoSession aoSession, java.lang.String name, java.lang.String host, int port) Get the data using a socket.
java.lang.String	getContext(AoSession aoSession, java.lang.String key) Get a context variable.
FilenameHandlerExtIF	getFilenameHandler()
void	getForInstanceBySocket(AoSession aoSession, java.lang.String name, T_LONGLONG aid, T_LONGLONG iid, java.lang.String host, int port) Get the data using a socket.
java.lang.String	getHostname(AoSession aoSession) Get the name of the host where the server is running
static CORBAFileServer	getInstance() Get the CORBAFileServer instance.
java.lang.String	getInterfaceVersion() Get the Interface Version (hardcoded string 'version' in this module!)
JVMServiceListener[]	getJVMServiceListeners() Get all service state listeners.
protected static java.lang.String	getLogDate()
SecurityHandlerIF	getSecurityHandler()
long	getSize(AoSession aoSession, java.lang.String url) Get size of the file associated with the given name.
long	getSizeForInstance(AoSession aoSession, java.lang.String url, T_LONGLONG aid, T_LONGLONG iid) Get size of the file associated with the given name.
long[]	getSizes(AoSession aoSess, java.lang.String[] names) Returns an array of long values representing the length of the files that were provided in the String array.
StreamHandlerIF	getStreamHandler() Returns the StreamHandler that was set in the CFS if there is any.
protected int	getTimeout() Get the socket timeout value from configuration.
java.lang.String	getVersion() Returns the current version of the CORBAFileServer.
void	init() Initialize CORBAFileServer.
protected void	initCode()
protected void	initializeTransportPlugin()
protected void	initLog()
boolean	isRunning() Get the running state.
java.lang.String[]	listContext(AoSession aoSession) List all context keywords.
protected void	logErr(java.lang.String s) The output on standard err.
protected void	logOut(java.lang.String s) The output on standard out.
static void	main(java.lang.String[] args) Main module of this application.
void	move(AoSession aoSession, java.lang.String url) Move the data associated with the given name.
void	moveForInstance(AoSession aoSession, java.lang.String url, T_LONGLONG aid, T_LONGLONG iid) Move the data associated with the given name.
static java.util.Properties	parseArguments(java.lang.String[] args)
InputStreamIF	read(AoSession aoSession, java.lang.String url) Read the data associated with the given name.
InputStreamIF	readForInstance(AoSession aoSession, java.lang.String url, T_LONGLONG aid, T_LONGLONG iid) Read the data associated with the given name.
void	removeContext(AoSession aoSession, java.lang.String key) Remove a context variable.
void	removeJVMServiceListener(JVMServiceListener l) Remove a service state listener.
void	restart() Restart CORBAFileServer.
void	run() Run the application.
java.lang.String	save(AoSession aoSession, java.lang.String name, java.lang.String subDir, InputStreamIF stream) Save the data associated with the given intput stream.
java.lang.String	saveBySocket(AoSession aoSession, java.lang.String name, java.lang.String subDir, java.lang.String host, int port) Save the data using a socket.
java.lang.String	saveForInstance(AoSession aoSession, java.lang.String name, java.lang.String subDir, T_LONGLONG aid, T_LONGLONG iid, InputStreamIF stream) Save the data associated with the given intput stream.
java.lang.String	saveForInstanceBySocket(AoSession aoSession, java.lang.String name, java.lang.String subDir, T_LONGLONG aid, T_LONGLONG iid, java.lang.String host, int port) Save the data using a socket.
java.lang.String	saveForInstanceName(AoSession aoSession, java.lang.String name, java.lang.String subDir, java.lang.String aeName, java.lang.String ieName, InputStreamIF stream) Save the data associated with the given intput stream.
java.lang.String	saveForInstanceNameBySocket(AoSession aoSession, java.lang.String name, java.lang.String subDir, java.lang.String aeName, java.lang.String ieName, java.lang.String host, int port) Save the data using a socket.
void	scheduleStop() Schedule a server stop.
void	setContext(AoSession aoSession, java.lang.String key, java.lang.String value) Set a context variable.
static void	setOutputStreams(java.lang.String[] args) Analize the arguments for StdOut and StdErr keywords and set the system out and err stream.
protected static void	setupLogging(java.lang.String[] args)
void	terminate(AoSession aoSession, java.lang.String name, java.lang.String parameter) This method can be called by the client when the server should be start a termination process.
void	terminate(boolean orbStarted) Terminate process.
void	terminateForInstance(AoSession aoSession, java.lang.String name, T_LONGLONG aid, T_LONGLONG iid, java.lang.String parameter) This method can be called by the client when the server should be start a termination process.

Methods inherited from class com.highqsoft.corbafileserver.AbstractCORBAFileServer

_create_request, _create_request, _duplicate, _get_domain_managers, _get_policy, _hash, _is_equivalent, _release, _request, _set_policy_override

Methods inherited from class com.highqsoft.corbafileserver.generated.CORBAFileServerIFPOA

_all_interfaces, _invoke, _this, _this

Methods inherited from class org.omg.PortableServer.Servant

_default_POA, _get_delegate, _get_interface_def, _is_a, _non_existent, _object_id, _orb, _poa, _set_delegate, _this_object, _this_object

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.omg.CORBA.Object

_create_request, _create_request, _duplicate, _get_domain_managers, _get_interface_def, _get_policy, _hash, _is_a, _is_equivalent, _non_existent, _release, _request, _set_policy_override

Field Detail

licFails

protected int licFails

methodHandle

protected java.util.concurrent.atomic.AtomicBoolean methodHandle

Constructor Detail

CORBAFileServer

public CORBAFileServer()

The constructor.

CORBAFileServer

public CORBAFileServer(java.util.Properties properties)

Constructor receiving the commandline arguments.

Parameters:

args - the command line arguments.

Method Detail

getVersion

public java.lang.String getVersion()

Returns the current version of the CORBAFileServer.

Returns:

the version

See Also:

CORBAFileServerVersion

initializeTransportPlugin

protected void initializeTransportPlugin()

addJVMServiceListener

public void addJVMServiceListener(JVMServiceListener l)

Add a service state listener.

Parameters:

l - the service state listener to be added.

removeJVMServiceListener

public void removeJVMServiceListener(JVMServiceListener l)

Remove a service state listener.

Parameters:

l - the service state listener to be removed.

getJVMServiceListeners

public JVMServiceListener[] getJVMServiceListeners()

Get all service state listeners.

Returns:

an array of all registered service state listeners.

fireServiceEvent

public void fireServiceEvent(int state,
                    java.lang.String message)

Fire a service event.

Parameters:

-

fireServiceEvent

public void fireServiceEvent(int state)

Fire a service event.

Parameters:

-

fireServiceEvent

public void fireServiceEvent(JVMServiceEvent ev)

Fire a service event.

Parameters:

-

getInstance

public static CORBAFileServer getInstance()

Get the CORBAFileServer instance.

createStreamHandler

protected void createStreamHandler(java.util.Properties properties)

createSecurityHandler

protected void createSecurityHandler(java.util.Properties properties)

Create the security handler.

getSecurityHandler

public SecurityHandlerIF getSecurityHandler()

createFilenameHandler

protected FilenameHandlerExtIF createFilenameHandler()

Create the filename handler.

Returns:

the FilenameHandler

createLicenseListener

protected LicenseListener createLicenseListener()

Creates a new LicenseListener from the Property 'CORBAFileServer.LicenseListener' if it was given. If not, the method returns null. If the creation fails, a RuntimeException is thrown. Every time the method is called, a new object is created.

Returns:

a LicenseListener if any was specified

createTerminator

protected void createTerminator()

Create the terminator.

terminate

public void terminate(AoSession aoSession,
             java.lang.String name,
             java.lang.String parameter)
               throws CORBAFileServerException

This method can be called by the client when the server should be start a termination process.

Specified by:

terminate in interface CORBAFileServerIFOperations

Parameters:

aoSession - the ASAM ODS session.

name - the name of the file.

parameter - the parameter string. The content depends on the server side terminate implementation.

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

terminateForInstance

public void terminateForInstance(AoSession aoSession,
                        java.lang.String name,
                        T_LONGLONG aid,
                        T_LONGLONG iid,
                        java.lang.String parameter)
                          throws CORBAFileServerException

This method can be called by the client when the server should be start a termination process.

Specified by:

terminateForInstance in interface CORBAFileServerIFOperations

Parameters:

aoSession - the ASAM ODS session.

name - the name of the file.

aid - the application element id.

iid - the instance element id.

parameter - the parameter string. The content depends on the server side terminate implementation.

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

scheduleStop

public void scheduleStop()

Schedule a server stop.

isRunning

public boolean isRunning()

Get the running state.

checkAndRebind

public org.omg.CosNaming.NameComponent[] checkAndRebind(org.omg.CosNaming.NamingContext nsContext,
                                               org.omg.CosNaming.NameComponent[] path,
                                               org.omg.CORBA.Object cfsRef,
                                               java.lang.String serviceName,
                                               boolean orbStarted)
                                                 throws org.omg.CosNaming.NamingContextPackage.CannotProceed,
                                                        org.omg.CosNaming.NamingContextPackage.InvalidName,
                                                        org.omg.CosNaming.NamingContextPackage.NotFound

Check the object in the name service context if the object is a valid AoFactory object, the there is an implementation of avalon running at the momet with the same name and the service will not start. In case the the object is not a valid AoFactory the object will be bind with the current AoFactory.

Parameters:

nsContext - context of the name service where to bind the object.

path - path of the object to bind.

cfsRef - the object to bind.

orbStarted - flags if the orb is started.

Returns:

the path of the bounded object

Throws:

org.omg.CosNaming.NamingContextPackage.CannotProceed - CORBA exception

org.omg.CosNaming.NamingContextPackage.InvalidName - CORBA exception

org.omg.CosNaming.NamingContextPackage.NotFound - CORBA exception

run

public void run()

Run the application. This method is called by the Java Virtual Machine if a start() is requested. User components should never call this method.

Specified by:

run in interface java.lang.Runnable

terminate

public void terminate(boolean orbStarted)

Terminate process.

init

public final void init()

Initialize CORBAFileServer.

initCode

protected final void initCode()
                       throws java.lang.Exception

Throws:

java.lang.Exception

initLog

protected void initLog()
                throws java.lang.Exception

Throws:

java.lang.Exception

exit

public boolean exit()

The exit method.

restart

public void restart()

Restart CORBAFileServer. This method doesn't look for existing sessions.

setOutputStreams

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

Analize the arguments for StdOut and StdErr keywords and set the system out and err stream.

Parameters:

args - The startup arguments.

parseArguments

public static java.util.Properties parseArguments(java.lang.String[] args)

delete

public void delete(AoSession aoSession,
          java.lang.String url)
            throws CORBAFileServerException

Delete the data associated with the given name.

Specified by:

delete in interface CORBAFileServerIFOperations

Parameters:

aoSession - the ASAM ODS session.

url - the name of the file.

stream - the input stream, ready to read by the server.

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

deleteForInstance

public void deleteForInstance(AoSession aoSession,
                     java.lang.String url,
                     T_LONGLONG aid,
                     T_LONGLONG iid)
                       throws CORBAFileServerException

Delete the data associated with the given name. Specify the ApplicationElement id and the InstanceElement id of the component that holds the external reference.

Specified by:

deleteForInstance in interface CORBAFileServerIFOperations

Parameters:

aoSession - the ASAM ODS session.

url - the url of the file.

stream - the input stream, ready to read by the server.

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

save

public java.lang.String save(AoSession aoSession,
                    java.lang.String name,
                    java.lang.String subDir,
                    InputStreamIF stream)
                      throws CORBAFileServerException

Save the data associated with the given intput stream.

Specified by:

save in interface CORBAFileServerIFOperations

Parameters:

name - the name of the file.

subDir - an alternative sub directory, that can be specified, if the filename should not used to determine the destination folder.

stream - the input stream, ready to read by the server.

aoSession - the ASAM ODS session.

Returns:

the rul string of the created 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

saveForInstance

public java.lang.String saveForInstance(AoSession aoSession,
                               java.lang.String name,
                               java.lang.String subDir,
                               T_LONGLONG aid,
                               T_LONGLONG iid,
                               InputStreamIF stream)
                                 throws CORBAFileServerException

Save the data associated with the given intput stream. Specify the ApplicationElement id and the InstanceElement id of the component that holds the external reference.

Specified by:

saveForInstance in interface CORBAFileServerIFOperations

Parameters:

aoSession - the ASAM ODS session.

name - the name of the file.

subDir - an alternative sub directory, that can be specified, if the filename should not used to determine the destination folder.

aid - the application element id.

iid - the instance element id.

stream - the input stream, ready to read by the server.

Returns:

the rul string of the created 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

saveForInstanceName

public java.lang.String saveForInstanceName(AoSession aoSession,
                                   java.lang.String name,
                                   java.lang.String subDir,
                                   java.lang.String aeName,
                                   java.lang.String ieName,
                                   InputStreamIF stream)
                                     throws CORBAFileServerException

Save the data associated with the given intput stream. Specify the name of an applciation element and the name of the instance element that holds the external reference

Specified by:

saveForInstanceName in interface CORBAFileServerIFOperations

Parameters:

aoSession - the ASAM ODS session.

name - the name of the file.

subDir - an alternative sub directory, that can be specified, if the filename should not used to determine the destination folder.

aeName - the application element name.

ieName - the instance element name.

stream - the input stream, ready to read by the server.

Returns:

the url string of the created 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

read

public InputStreamIF read(AoSession aoSession,
                 java.lang.String url)
                   throws CORBAFileServerException

Read the data associated with the given name.

Specified by:

read in interface CORBAFileServerIFOperations

Parameters:

aoSession - the ASAM ODS session.

url - the url of the file.

stream - the input stream, ready to read by the server.

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

readForInstance

public InputStreamIF readForInstance(AoSession aoSession,
                            java.lang.String url,
                            T_LONGLONG aid,
                            T_LONGLONG iid)
                              throws CORBAFileServerException

Read the data associated with the given name.

Specified by:

readForInstance in interface CORBAFileServerIFOperations

Parameters:

aoSession - the ASAM ODS session.

url - the url of the file.

aid - the application element id.

iid - the instance element id.

stream - the input stream, ready to read by the server.

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

getInterfaceVersion

public java.lang.String getInterfaceVersion()
                                     throws CORBAFileServerException

Get the Interface Version (hardcoded string 'version' in this module!)

Specified by:

getInterfaceVersion in interface CORBAFileServerIFOperations

Parameters:

version - the interface version string.

Returns:

The interface version of the CorbaFileServerIF.

Throws:

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

getSize

public long getSize(AoSession aoSession,
           java.lang.String url)
             throws CORBAFileServerException

Description copied from interface: CORBAFileServerIFOperations

Get size of the file associated with the given name.

Specified by:

getSize in interface CORBAFileServerIFOperations

Parameters:

aoSession - the ASAM ODS session.

url - the name of the file.

Returns:

the size of the input stream.

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

getSizeForInstance

public long getSizeForInstance(AoSession aoSession,
                      java.lang.String url,
                      T_LONGLONG aid,
                      T_LONGLONG iid)
                        throws CORBAFileServerException

Get size of the file associated with the given name.

Specified by:

getSizeForInstance in interface CORBAFileServerIFOperations

Parameters:

aoSession - the ASAM ODS session.

url - the url of the file.

aid - the application element id.

iid - the instance element id.

size - the size of the input stream.

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

getHostname

public java.lang.String getHostname(AoSession aoSession)
                             throws CORBAFileServerException

Get the name of the host where the server is running

Specified by:

getHostname in interface CORBAFileServerIFOperations

Parameters:

aoSession - the ASAM ODS session.

Returns:

the hostname

Throws:

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

getContext

public java.lang.String getContext(AoSession aoSession,
                          java.lang.String key)
                            throws CORBAFileServerException

Get a context variable.

Specified by:

getContext in interface CORBAFileServerIFOperations

Parameters:

aoSession - the ASAM ODS session.

key - the keyword of the context value.

Returns:

the context value

Throws:

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

listContext

public java.lang.String[] listContext(AoSession aoSession)
                               throws CORBAFileServerException

List all context keywords.

Specified by:

listContext in interface CORBAFileServerIFOperations

Parameters:

aoSession - the ASAM ODS session.

Returns:

a sequence of strings.

Throws:

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

removeContext

public void removeContext(AoSession aoSession,
                 java.lang.String key)
                   throws CORBAFileServerException

Remove a context variable.

Specified by:

removeContext in interface CORBAFileServerIFOperations

Parameters:

aoSession - the ASAM ODS session.

key - the keyword of the context value.

Throws:

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

setContext

public void setContext(AoSession aoSession,
              java.lang.String key,
              java.lang.String value)
                throws CORBAFileServerException

Set a context variable.

Specified by:

setContext in interface CORBAFileServerIFOperations

Parameters:

aoSession - the ASAM ODS session.

key - the keyword of the context value.

value - the context value.

Throws:

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

logOut

protected void logOut(java.lang.String s)

The output on standard out.

logErr

protected void logErr(java.lang.String s)

The output on standard err.

getLogDate

protected static java.lang.String getLogDate()

move

public void move(AoSession aoSession,
        java.lang.String url)
          throws CORBAFileServerException

Move the data associated with the given name.

Specified by:

move in interface CORBAFileServerIFOperations

Parameters:

aoSession - the ASAM ODS session.

url - the name of the file.

stream - the input stream, ready to read by the server.

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

moveForInstance

public void moveForInstance(AoSession aoSession,
                   java.lang.String url,
                   T_LONGLONG aid,
                   T_LONGLONG iid)
                     throws CORBAFileServerException

Move the data associated with the given name. Specify the ApplicationElement id and the InstanceElement id of the component that holds the external reference.

Specified by:

moveForInstance in interface CORBAFileServerIFOperations

Parameters:

aoSession - the ASAM ODS session.

url - the url of the file.

stream - the input stream, ready to read by the server.

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

getBySocket

public void getBySocket(AoSession aoSession,
               java.lang.String name,
               java.lang.String host,
               int port)
                 throws CORBAFileServerException

Get the data using a socket.

Specified by:

getBySocket in interface CORBAFileServerIFOperations

Parameters:

aoSession - the ASAM ODS session.

name - the name of the file.

host - the hostname for the socket connection.

port - the port for the socket connection.

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

getForInstanceBySocket

public void getForInstanceBySocket(AoSession aoSession,
                          java.lang.String name,
                          T_LONGLONG aid,
                          T_LONGLONG iid,
                          java.lang.String host,
                          int port)
                            throws CORBAFileServerException

Get the data using a socket.

Specified by:

getForInstanceBySocket in interface CORBAFileServerIFOperations

Parameters:

aoSession - the ASAM ODS session.

name - the url specification of the file.

aid - the application element id.

iid - the instance element id.

host - the hostname for the socket connection.

port - the port for the socket connection.

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

saveBySocket

public java.lang.String saveBySocket(AoSession aoSession,
                            java.lang.String name,
                            java.lang.String subDir,
                            java.lang.String host,
                            int port)
                              throws CORBAFileServerException

Save the data using a socket.

Specified by:

saveBySocket in interface CORBAFileServerIFOperations

Parameters:

aoSession - the ASAM ODS session.

name - the name of the file.

subDir - an alternative sub directory, that can be specified, if the filename should not used to determine the destination folder.

host - the hostname for the socket connection.

port - the port for the socket connection.

Returns:

the url string of the created 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

saveForInstanceBySocket

public java.lang.String saveForInstanceBySocket(AoSession aoSession,
                                       java.lang.String name,
                                       java.lang.String subDir,
                                       T_LONGLONG aid,
                                       T_LONGLONG iid,
                                       java.lang.String host,
                                       int port)
                                         throws CORBAFileServerException

Save the data using a socket.

Specified by:

saveForInstanceBySocket in interface CORBAFileServerIFOperations

Parameters:

aoSession - the ASAM ODS session.

name - the name of the file.

subDir - an alternative sub directory, that can be specified, if the filename should not used to determine the destination folder.

aid - the application element id.

iid - the instance element id.

host - the hostname for the socket connection.

port - the port for the socket connection.

Returns:

the url string of the created 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

saveForInstanceNameBySocket

public java.lang.String saveForInstanceNameBySocket(AoSession aoSession,
                                           java.lang.String name,
                                           java.lang.String subDir,
                                           java.lang.String aeName,
                                           java.lang.String ieName,
                                           java.lang.String host,
                                           int port)
                                             throws CORBAFileServerException

Save the data using a socket.

Specified by:

saveForInstanceNameBySocket in interface CORBAFileServerIFOperations

Parameters:

aoSession - the ASAM ODS session.

name - the name of the file.

subDir - an alternative sub directory, that can be specified, if the filename should not used to determine the destination folder.

aeName - the application element name.

ieName - the instance element name.

host - the hostname for the socket connection.

port - the port for the socket connection.

Returns:

the url string of the created 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

getSizes

public long[] getSizes(AoSession aoSess,
              java.lang.String[] names)
                throws CORBAFileServerException

Returns an array of long values representing the length of the files that were provided in the String array. The order of the long values must match with the order of the filenames.

Specified by:

getSizes in interface CORBAFileServerIFOperations

Parameters:

aoSess - the aoSession of the caller

names - the String array of filenames for which to get the sizes

Returns:

an Array of long values containing the file sizes

Throws:

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

getTimeout

protected int getTimeout()

Get the socket timeout value from configuration.

Returns:

the timeout value

main

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

Main module of this application.

setupLogging

protected static void setupLogging(java.lang.String[] args)

getFilenameHandler

public FilenameHandlerExtIF getFilenameHandler()

getStreamHandler

public StreamHandlerIF getStreamHandler()

Returns the StreamHandler that was set in the CFS if there is any. This method returns null if no StreamHandler was set.

Returns:

a StreamHandler if set by configuration of the CFS