EnsLib.File.OutboundAdapter
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.Property Inventory
Method Inventory
- CreateFilename()
- Delete()
- Exists()
- GetStream()
- NameList()
- OnInit()
- PutLine()
- PutStream()
- PutString()
- Rename()
- close()
- 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;
Inherited description: 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 methods: DeviceDisplayToLogical(), DeviceGet(), DeviceIsValid(), DeviceLogicalToDisplay(), DeviceLogicalToOdbc(), DeviceNormalize(), DeviceSet()
property LineTerminator as %String (MAXLEN = 10) [ InitialExpression = $C(13,10) ];
Property methods: LineTerminatorDisplayToLogical(), LineTerminatorGet(), LineTerminatorIsValid(), LineTerminatorLogicalToDisplay(), LineTerminatorLogicalToOdbc(), LineTerminatorNormalize(), LineTerminatorSet()
property OldIO as %String (MAXLEN = 1000);
Property methods: OldIODisplayToLogical(), OldIOGet(), OldIOIsValid(), OldIOLogicalToDisplay(), OldIOLogicalToOdbc(), OldIONormalize(), OldIOSet()
property OpenTimeout as %Numeric (MINVAL = 0) [ InitialExpression = 5 ];
Number of seconds to wait on each attempt to open the output file.
Property methods: OpenTimeoutDisplayToLogical(), OpenTimeoutGet(), OpenTimeoutIsValid(), OpenTimeoutLogicalToDisplay(), OpenTimeoutNormalize(), OpenTimeoutSet()
property Overwrite as %Boolean [ InitialExpression = 0 ];
Overwrite file if it exists, instead of appending
Property methods: OverwriteDisplayToLogical(), OverwriteGet(), OverwriteIsValid(), OverwriteLogicalToDisplay(), OverwriteNormalize(), OverwriteSet()
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 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
Inherited description: This user callback method is called just after %OnNew()
method close() as %Status
classmethod isTemp(pStream)
Inherited Members
Inherited Properties
- %CredentialsObj
- %WarnedLatest
- %logTransfers
- BusinessHost
- Charset
- Credentials
- FilePath
- KeepaliveInterval
- RegistryID
Inherited 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()
- CreateTimestamp()
- CredentialsSet()
- DeepListClose()
- DeepListExecute()
- DeepListFetch()
- EnumerateSettingsClose()
- EnumerateSettingsExecute()
- EnumerateSettingsFetch()
- FileLikePattern()
- FileListClose()
- FileListExecute()
- FileListFetch()
- GenerateSemaphoreFilename()
- GetSettings()
- LinkFileStream()
- NormalizeDirectory()
- OnKeepalive()
- OnTearDown()
- SemaphoreFileExists()
- fixPath()