Class Reference
IRIS for UNIX 2019.2
InterSystems: The power behind what matters   
Documentation  Search
  [ENSLIB] >  [EnsLib] >  [File] >  [OutboundAdapter]
Private  Storage   

class EnsLib.File.OutboundAdapter extends Ens.OutboundAdapter, EnsLib.File.Common

An Outbound Adapter class providing methods used to write data to files and do other OS level file manipulations.

Inventory

Parameters Properties Methods Queries Indices ForeignKeys Triggers
1 5 14


Summary

Properties
%CredentialsObj %WarnedLatest %logTransfers BusinessHost
Charset Credentials Device FilePath
KeepaliveInterval LineTerminator OldIO OpenTimeout
Overwrite RegistryID

Methods
%AddToSaveSet %ClassIsLatestVersion %ClassName %ConstructClone
%DispatchClassMethod %DispatchGetModified %DispatchGetProperty %DispatchMethod
%DispatchSetModified %DispatchSetMultidimProperty %DispatchSetProperty %Extends
%GetParameter %IsA %IsModified %New
%NormalizeObject %ObjectModified %OriginalNamespace %PackageName
%RemoveFromSaveSet %SerializeObject %SetModified %ValidateObject
AssignOneSetting ClearAllAppData ClearRuntimeAppData ClearStaticAppData
CorrespondingSemaphoreExists CreateFilename CreateTimestamp CredentialsSet
DeepListClose DeepListExecute DeepListFetch Delete
EnumerateSettingsClose EnumerateSettingsExecute EnumerateSettingsFetch Exists
FileLikePattern FileListClose FileListExecute FileListFetch
GenerateSemaphoreFilename GetSettings GetStream LinkFileStream
NameList NormalizeDirectory OnInit OnKeepalive
OnTearDown PutLine PutStream PutString
Rename SemaphoreFileExists close fixPath
isTemp open openRead


Parameters

• parameter SETTINGS = "RegistryID:Basic:selector?context={Ens.ServiceRegistry.External.ContextSearch/Services?Protocols_1=File},FilePath:Basic:directorySelector,Overwrite,Charset::selector?context={Ens.ContextSearch/CharacterSets},OpenTimeout";
List of properties can be set as settings in the configuration file format is a comma separated list of property names

Properties

• property Device as %String(MAXLEN=1000);
• property LineTerminator as %String(MAXLEN=10) [ InitialExpression = $C(13,10) ];
• property OldIO as %String(MAXLEN=1000);
• property OpenTimeout as %Numeric(MINVAL=0) [ InitialExpression = 5 ];
Number of seconds to wait on each attempt to open the output file.
• property Overwrite as %Boolean [ InitialExpression = 0 ];
Overwrite file if it exists, instead of appending

Methods

• method CreateFilename(pFilename As %String, pSpec As %String, pIsVMS As %Boolean, pDirectory As %String, pLocal As %Boolean) as %String
Combine base Filename with Directory and filename Spec that may contain timestamp and counter templates
• method Delete(pFilename As %String) as %Status
• method Exists(pFilename As %String) as %Boolean
• method GetStream(pFilename As %String, ByRef pStream As %Stream.Object = $$$NULLOREF) as %Status
• method NameList(Output pFileList As %ListOfDataTypes, pWildcards As %String = "*", pIncludeDirs As %Boolean = 0) as %Status
Get a list of files in the directory configured by FilePath. The filenames are returned in a %ListOfDataTypes object. Each entry in the list is a semicolon-separated string containing: Filename;Type;Size;DateCreated;DateModified;FullPathName
• method OnInit() as %Status
This user callback method is called just after %OnNew()
• method PutLine(pFilename As %String, pLine As %String) as %Status
• method PutStream(pFilename As %String, pStream As %Stream, ByRef pLen As %Integer = -1) as %Status
• method PutString(pFilename As %String, pData As %String) as %Status
• method Rename(pFilename As %String, pNewFilename As %String, pNewPath As %String = "") as %Status
• method close() as %Status
• classmethod isTemp(pStream)
• method open(pFilename As %String) as %Status
• method openRead(pFilename As %String) as %Status


Copyright (c) 2019 by InterSystems Corporation. Cambridge, Massachusetts, U.S.A. All rights reserved. Confidential property of InterSystems Corporation.