diff options
| author | Lars Thorsen <[email protected]> | 2018-04-25 15:09:14 +0200 |
|---|---|---|
| committer | Lars Thorsen <[email protected]> | 2018-04-27 12:05:30 +0200 |
| commit | 6bcdad20c24457393c0d9eeb385d0ff5aa872cd0 (patch) | |
| tree | 63162ddfa38d92eaff2193b73277aba18160308c /lib/cosFileTransfer/doc | |
| parent | 87b06e4ab91729f7415578c8ac0aacec28720ad9 (diff) | |
| download | otp-6bcdad20c24457393c0d9eeb385d0ff5aa872cd0.tar.gz otp-6bcdad20c24457393c0d9eeb385d0ff5aa872cd0.tar.bz2 otp-6bcdad20c24457393c0d9eeb385d0ff5aa872cd0.zip | |
Move the corba applcations to separate repository
All corba applications are moved to a separate repository.
E.g. orber, ic, cosEvent, cosEventDomain, cosNotifications
cosTime, cosTransactions, cosProperty and cosFileTransfer.
Diffstat (limited to 'lib/cosFileTransfer/doc')
21 files changed, 0 insertions, 1773 deletions
diff --git a/lib/cosFileTransfer/doc/html/.gitignore b/lib/cosFileTransfer/doc/html/.gitignore deleted file mode 100644 index e69de29bb2..0000000000 --- a/lib/cosFileTransfer/doc/html/.gitignore +++ /dev/null diff --git a/lib/cosFileTransfer/doc/man3/.gitignore b/lib/cosFileTransfer/doc/man3/.gitignore deleted file mode 100644 index e69de29bb2..0000000000 --- a/lib/cosFileTransfer/doc/man3/.gitignore +++ /dev/null diff --git a/lib/cosFileTransfer/doc/man6/.gitignore b/lib/cosFileTransfer/doc/man6/.gitignore deleted file mode 100644 index e69de29bb2..0000000000 --- a/lib/cosFileTransfer/doc/man6/.gitignore +++ /dev/null diff --git a/lib/cosFileTransfer/doc/pdf/.gitignore b/lib/cosFileTransfer/doc/pdf/.gitignore deleted file mode 100644 index e69de29bb2..0000000000 --- a/lib/cosFileTransfer/doc/pdf/.gitignore +++ /dev/null diff --git a/lib/cosFileTransfer/doc/src/CosFileTransfer.gif b/lib/cosFileTransfer/doc/src/CosFileTransfer.gif Binary files differdeleted file mode 100644 index 16970ad5ad..0000000000 --- a/lib/cosFileTransfer/doc/src/CosFileTransfer.gif +++ /dev/null diff --git a/lib/cosFileTransfer/doc/src/CosFileTransfer_Directory.xml b/lib/cosFileTransfer/doc/src/CosFileTransfer_Directory.xml deleted file mode 100644 index da5810521a..0000000000 --- a/lib/cosFileTransfer/doc/src/CosFileTransfer_Directory.xml +++ /dev/null @@ -1,69 +0,0 @@ -<?xml version="1.0" encoding="utf-8" ?> -<!DOCTYPE erlref SYSTEM "erlref.dtd"> - -<erlref> - <header> - <copyright> - <year>2000</year> - <year>2016</year> - <holder>Ericsson AB, All Rights Reserved</holder> - </copyright> - <legalnotice> - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. - - The Initial Developer of the Original Code is Ericsson AB. - </legalnotice> - - <title>CosFileTransfer_Directory</title> - <prepared></prepared> - <docno></docno> - <checked></checked> - <date>2000-11-09</date> - <rev>PA1</rev> - </header> - <module>CosFileTransfer_Directory</module> - <modulesummary>This module implements the OMG CosFileTransfer::Directory interface.</modulesummary> - <description> - <p>To get access to the record definitions for the structures use: <br></br> -<c>-include_lib("cosFileTransfer/include/*.hrl").</c></p> - <p>This module also exports the functions described in:</p> - <list type="bulleted"> - <item> - <p><seealso marker="CosFileTransfer_File">CosFileTransfer_File</seealso></p> - </item> - <item> - <p>CosPropertyService_PropertySetDef in the cosProperty application.</p> - </item> - </list> - </description> - <funcs> - <func> - <name>list(Directory, Max) -> Return</name> - <fsummary>Return a list, of length <c>Max</c>or less, containing Object References representing files or directories contained within the target Directory and a <c>FileIterator</c>or a <c>NIL</c>object</fsummary> - <type> - <v>Directory = #objref</v> - <v>Return = {ok, FileList, FileIterator}</v> - <v>FileList = [File]</v> - <v>File = FileIterator = #objref</v> - </type> - <desc> - <p>This operation returns a list, of length <c>Max</c> or less, containing - Object References representing files or directories contained within - the target Directory. If the amount of objects found is less than <c>Max</c> - the returned Iterator will be a <c>NIL</c> object.</p> - </desc> - </func> - </funcs> - -</erlref> - diff --git a/lib/cosFileTransfer/doc/src/CosFileTransfer_File.xml b/lib/cosFileTransfer/doc/src/CosFileTransfer_File.xml deleted file mode 100644 index 373c14d1f1..0000000000 --- a/lib/cosFileTransfer/doc/src/CosFileTransfer_File.xml +++ /dev/null @@ -1,94 +0,0 @@ -<?xml version="1.0" encoding="utf-8" ?> -<!DOCTYPE erlref SYSTEM "erlref.dtd"> - -<erlref> - <header> - <copyright> - <year>2000</year> - <year>2016</year> - <holder>Ericsson AB, All Rights Reserved</holder> - </copyright> - <legalnotice> - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. - - The Initial Developer of the Original Code is Ericsson AB. - </legalnotice> - - <title>CosFileTransfer_File</title> - <prepared></prepared> - <docno></docno> - <approved></approved> - <checked></checked> - <date>2000-11-09</date> - <rev>PA1</rev> - </header> - <module>CosFileTransfer_File</module> - <modulesummary>This module implements the OMG CosFileTransfer::File interface.</modulesummary> - <description> - <p>To get access to the record definitions for the structures use: <br></br> -<c>-include_lib("cosFileTransfer/include/*.hrl").</c></p> - <p>This module also exports the functions described in:</p> - <list type="bulleted"> - <item> - <p>CosPropertyService_PropertySetDef in the cosProperty application.</p> - </item> - </list> - </description> - <funcs> - <func> - <name>'_get_name'(File) -> string()</name> - <fsummary>Return the target object's associated name</fsummary> - <type> - <v>File = #objref</v> - </type> - <desc> - <p>This read only attribute represents the target object's associated name.</p> - </desc> - </func> - <func> - <name>'_get_complete_file_name'(File) -> string()</name> - <fsummary>Return the target object's associated absolute name.</fsummary> - <type> - <v>File = #objref</v> - </type> - <desc> - <p>This read only attribute represents the target object's associated - absolute name.</p> - </desc> - </func> - <func> - <name>'_get_parent'(File) -> Directory</name> - <fsummary>Return the target object's container.</fsummary> - <type> - <v>File = Directory = #objref</v> - </type> - <desc> - <p>This read only attribute represents the target object's container. - In some cases a <c>NIL</c> object will be returned.</p> - </desc> - </func> - <func> - <name>'_get_associated_session'(File) -> FileTransferSession</name> - <fsummary>Return the target object's associated <c>FileTransferSession</c></fsummary> - <type> - <v>File = FileTransferSession = #objref</v> - </type> - <desc> - <p>This read only attribute represents the target object's associated - <c>FileTransferSession</c>.</p> - </desc> - </func> - </funcs> - -</erlref> - diff --git a/lib/cosFileTransfer/doc/src/CosFileTransfer_FileIterator.xml b/lib/cosFileTransfer/doc/src/CosFileTransfer_FileIterator.xml deleted file mode 100644 index f5c219b9c1..0000000000 --- a/lib/cosFileTransfer/doc/src/CosFileTransfer_FileIterator.xml +++ /dev/null @@ -1,86 +0,0 @@ -<?xml version="1.0" encoding="utf-8" ?> -<!DOCTYPE erlref SYSTEM "erlref.dtd"> - -<erlref> - <header> - <copyright> - <year>2000</year><year>2016</year> - <holder>Ericsson AB. All Rights Reserved.</holder> - </copyright> - <legalnotice> - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. - - </legalnotice> - - <title>CosFileTransfer_FileIterator</title> - <prepared></prepared> - <docno></docno> - <checked></checked> - <date>2000-11-09</date> - <rev>PA1</rev> - </header> - <module>CosFileTransfer_FileIterator</module> - <modulesummary>This module implements the OMG CosFileTransfer::FileIterator interface.</modulesummary> - <description> - <p>To get access to the record definitions for the structures use: <br></br> -<c>-include_lib("cosFileTransfer/include/*.hrl").</c></p> - </description> - <funcs> - <func> - <name>next_one(Iterator) -> Return</name> - <fsummary>Return the next <c>FileWrapper</c>and a boolean which indicate whether the <c>FileWrapper</c>is valid or not.</fsummary> - <type> - <v>Iterator = #objref</v> - <v>Return = {boolean(), #'CosFileTransfer_FileWrapper'{the_file = File file_type = Type}}</v> - <v>File = #objref</v> - <v>Type = nfile | ndirectory</v> - </type> - <desc> - <p>This operation returns true if a <c>FileWrapper</c> exists at the - current position and the out parameter contains a valid <c>File</c> - reference. If false is returned the out parameter is a non-valid - <c>FileWrapper</c>.</p> - </desc> - </func> - <func> - <name>next_n(Iterator, Max) -> Return</name> - <fsummary>Return a list, of length <c>Max</c>or less, containing <c>FileWrappers</c>and a boolean which indicates if more <c>FileWrappers</c>exists</fsummary> - <type> - <v>Iterator = #objref</v> - <v>Max = unsigned long()</v> - <v>Return = {boolean(), FileList}</v> - <v>FileList = [#'CosFileTransfer_FileWrapper'{the_file = File file_type = Type}]</v> - <v>File = #objref</v> - <v>Type = nfile | ndirectory</v> - </type> - <desc> - <p>This operation returns true if the requested number of <c>FileWrappers</c> - can be delivered and there are additional <c>FileWrappers</c>. If false is - returned a list, of length <c>Max</c> or less, containing the last valid - <c>FileWrappers</c> associated with the target object.</p> - </desc> - </func> - <func> - <name>destroy(Iterator) -> ok</name> - <fsummary>Terminate the target object</fsummary> - <type> - <v>Iterator = #objref</v> - </type> - <desc> - <p>This operation terminates the target object.</p> - </desc> - </func> - </funcs> - -</erlref> - diff --git a/lib/cosFileTransfer/doc/src/CosFileTransfer_FileTransferSession.xml b/lib/cosFileTransfer/doc/src/CosFileTransfer_FileTransferSession.xml deleted file mode 100644 index 312af3b8c2..0000000000 --- a/lib/cosFileTransfer/doc/src/CosFileTransfer_FileTransferSession.xml +++ /dev/null @@ -1,191 +0,0 @@ -<?xml version="1.0" encoding="utf-8" ?> -<!DOCTYPE erlref SYSTEM "erlref.dtd"> - -<erlref> - <header> - <copyright> - <year>2000</year><year>2016</year> - <holder>Ericsson AB. All Rights Reserved.</holder> - </copyright> - <legalnotice> - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. - - </legalnotice> - - <title>CosFileTransfer_FileTransferSession</title> - <prepared></prepared> - <docno></docno> - <checked></checked> - <date>2000-11-09</date> - <rev>PA1</rev> - </header> - <module>CosFileTransfer_FileTransferSession</module> - <modulesummary>This module implements the OMG CosFileTransfer::FileTransferSession interface.</modulesummary> - <description> - <p>To get access to the record definitions for the structures use: <br></br> -<c>-include_lib("cosFileTransfer/include/*.hrl").</c></p> - </description> - <funcs> - <func> - <name>'_get_protocols_supported'(FTS) -> Return</name> - <fsummary>Return the protocols supported by the target object</fsummary> - <type> - <v>FTS = #objref</v> - <v>Return = [#'CosFileTransfer_ProtocolSupport'{protocol_name=Type, addresses=[Address]}]</v> - <v>Type = Address = string()</v> - </type> - <desc> - <p>This read only attribute returns the protocols supported by the - target object.</p> - </desc> - </func> - <func> - <name>set_directory(FTS, Directory) -> Return</name> - <fsummary>Change the current working directory of the target object's associated file system</fsummary> - <type> - <v>FTS = Directory = #objref</v> - <v>Return = ok | {'EXCEPTION, E}</v> - </type> - <desc> - <p>Invoking this operation will change the current working directory of - the target object's associated file system. If fail to do so the - appropriate exception is raised. </p> - </desc> - </func> - <func> - <name>create_file(FTS, FileNameList) -> Return</name> - <fsummary>Create a <c>File</c>Object representing a file which may or may not exist</fsummary> - <type> - <v>FTS = #objref</v> - <v>FileNameList = [string()]</v> - <v>Return = File | {'EXCEPTION, E}</v> - <v>File = #objref</v> - </type> - <desc> - <p>This operation creates a <c>File</c> Object representing a file which - may or may not exist. - For this operation to be independent of the working directory the - supplied <c>FileNameList</c> must represent the absolute name.</p> - </desc> - </func> - <func> - <name>create_directory(FTS, FileNameList) -> Return</name> - <fsummary>Create a new directory in the target objects associated file systems domain</fsummary> - <type> - <v>FTS = #objref</v> - <v>FileNameList = [string()]</v> - <v>Return = Directory | {'EXCEPTION, E}</v> - <v>Directory = #objref</v> - </type> - <desc> - <p>This operation creates a new directory in the target objects associated - file systems domain. If fail to do so an exception is raised but, - if successful, a <c>Directory</c> object representing the new - directory is returned.</p> - </desc> - </func> - <func> - <name>get_file(FTS, FileNameList) -> Return</name> - <fsummary>Create a <c>FileWrapper</c>which represents a file or directory</fsummary> - <type> - <v>FTS = #objref</v> - <v>FileNameList = [string()]</v> - <v>Return = FileWrapper | {'EXCEPTION, E}</v> - <v>FileWrapper = #'CosFileTransfer_FileWrapper'{the_file = File file_type = Type}</v> - <v>File = #objref</v> - <v>Type = nfile | ndirectory</v> - </type> - <desc> - <p>This operation, creates a <c>FileWrapper</c> which represents a file or directory, and - should be independent of the working Directory, - i.e., a full path name must be supplied. Furthermore, the file or - directory represented by the <c>FileNameList</c> must exist.</p> - </desc> - </func> - <func> - <name>delete(FTS, File) -> Return</name> - <fsummary>Delete the file or directory, represented by the <c>File</c>object, from the target objects associated file system</fsummary> - <type> - <v>FTS = File = #objref</v> - <v>Return = ok | {'EXCEPTION', E}</v> - </type> - <desc> - <p>This operation removes the file or directory, represented by the <c>File</c> - object, from the target objects associated file system. If it is a non-empty - directory or non-existing file or directory an exception is raised.</p> - </desc> - </func> - <func> - <name>transfer(FTS, SourceFile, DestinationFile) -> Return</name> - <fsummary>Copy the file represented by the <c>SourceFile</c>from the target object's file system to a file in the destination <c>FileTransferSession's</c>file system</fsummary> - <type> - <v>FTS = SourceFile = DestinationFile = #objref</v> - <v>Return = ok | {'EXCEPTION', E}</v> - </type> - <desc> - <p>If the target object's and the <c>DestinationFile's</c> associated - <c>FileTransferSession's</c> support the same protocol(s) this operation - will copy the file represented by the <c>SourceFile</c> from the target - object's file system to a file in the destination - <c>FileTransferSession's</c> file system. The file is represented by the - <c>DestinationFile</c> object and may not exist. - This operation must be invoked on the <c>FileTransferSession</c> - associated with the <c>SourceFile</c> object.</p> - </desc> - </func> - <func> - <name>append(FTS, SourceFile, DestinationFile) -> Return</name> - <fsummary>Append the file represented by the <c>SourceFile</c>from the target object's file system to a file in the destination <c>FileTransferSession's</c>file system</fsummary> - <type> - <v>FTS = SourceFile = DestinationFile = #objref</v> - <v>Return = ok | {'EXCEPTION', E}</v> - </type> - <desc> - <p>This operation behaves almost like the <c>transfer/3</c> operation. The - difference is that the <c>DestinationFile</c> must exist since the - <c>SourceFile</c> will be appended to the <c>DestinationFile</c>.</p> - <p>Currently, it is not possible to use this operation when the target - object represents FTP.</p> - </desc> - </func> - <func> - <name>insert(FTS, SourceFile, DestinationFile, Offset) -> Return</name> - <fsummary>Insert the <c>SourceFile</c>into the <c>DestinationFile</c> <c>Offset</c>bytes from the start of the file</fsummary> - <type> - <v>FTS = SourceFile = DestinationFile = #objref</v> - <v>Offset = long()</v> - <v>Return = ok | {'EXCEPTION', E}</v> - </type> - <desc> - <p>This operation behaves almost like the <c>append/3</c> operation. The - difference is that the <c>SourceFile</c> will be inserted into the - <c>DestinationFile</c> <c>Offset</c> bytes from the start of the file.</p> - <p>Currently, it is not possible to use this operation when the target - object represents FTP.</p> - </desc> - </func> - <func> - <name>logout(FTS) -> ok</name> - <fsummary>Terminate the target object and close the connection to the file system it represents</fsummary> - <type> - <v>FTS = #objref</v> - </type> - <desc> - <p>This operation terminates the target object and closes the connection - to the file system it represents.</p> - </desc> - </func> - </funcs> - -</erlref> - diff --git a/lib/cosFileTransfer/doc/src/CosFileTransfer_VirtualFileSystem.xml b/lib/cosFileTransfer/doc/src/CosFileTransfer_VirtualFileSystem.xml deleted file mode 100644 index 701e56e660..0000000000 --- a/lib/cosFileTransfer/doc/src/CosFileTransfer_VirtualFileSystem.xml +++ /dev/null @@ -1,83 +0,0 @@ -<?xml version="1.0" encoding="utf-8" ?> -<!DOCTYPE erlref SYSTEM "erlref.dtd"> - -<erlref> - <header> - <copyright> - <year>2000</year> - <year>2016</year> - <holder>Ericsson AB, All Rights Reserved</holder> - </copyright> - <legalnotice> - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. - - The Initial Developer of the Original Code is Ericsson AB. - </legalnotice> - - <title>CosFileTransfer_VirtualFileSystem</title> - <prepared></prepared> - <docno></docno> - <checked></checked> - <date>2000-11-09</date> - <rev>PA1</rev> - </header> - <module>CosFileTransfer_VirtualFileSystem</module> - <modulesummary>This module implements the OMG CosFileTransfer::VirtualFileSystem interface.</modulesummary> - <description> - <p>To get access to the record definitions for the structures use: <br></br> -<c>-include_lib("cosFileTransfer/include/*.hrl").</c></p> - </description> - <funcs> - <func> - <name>'_get_file_system_type'(VFS) -> Return</name> - <fsummary>Return the target object's associated file system</fsummary> - <type> - <v>VFS = #objref</v> - <v>Return = 'FTP' | 'NATIVE'</v> - </type> - <desc> - <p>This read only attribute represents the target object's associated - file system.</p> - </desc> - </func> - <func> - <name>'_get_supported_content_types'(VFS) -> Return</name> - <fsummary>Return the target object's supported content types.</fsummary> - <type> - <v>VFS = #objref</v> - <v>Return = </v> - </type> - <desc> - <p>This read only attribute represents the target object's supported - content types.</p> - </desc> - </func> - <func> - <name>login(VFS, User, Password, Account) -> Return</name> - <fsummary>Create a new instance of a <c>FileTransferSession</c>and a <c>Directory</c></fsummary> - <type> - <v>VFS = #objref</v> - <v>User = Password = Account = string()</v> - <v>Return = {FileTransferSession, Directory} | {'EXCEPTION', E}</v> - <v>FileTransferSession = Directory = #objref</v> - </type> - <desc> - <p>This operation creates a new instance of a <c>FileTransferSession</c> - and a <c>Directory</c>. The later represents the current working - directory of the returned <c>FileTransferSession</c>.</p> - </desc> - </func> - </funcs> - -</erlref> - diff --git a/lib/cosFileTransfer/doc/src/Makefile b/lib/cosFileTransfer/doc/src/Makefile deleted file mode 100644 index fcaa88c1e2..0000000000 --- a/lib/cosFileTransfer/doc/src/Makefile +++ /dev/null @@ -1,142 +0,0 @@ -# -# %CopyrightBegin% -# -# Copyright Ericsson AB 2000-2017. All Rights Reserved. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -# -# %CopyrightEnd% -# -# -include $(ERL_TOP)/make/target.mk -include $(ERL_TOP)/make/$(TARGET)/otp.mk - -# ---------------------------------------------------- -# Application version -# ---------------------------------------------------- -include ../../vsn.mk -VSN=$(COSFILETRANSFER_VSN) -APPLICATION=cosFileTransfer - -# ---------------------------------------------------- -# Release directory specification -# ---------------------------------------------------- -RELSYSDIR = $(RELEASE_PATH)/lib/$(APPLICATION)-$(VSN) - -# ---------------------------------------------------- -# Target Specs -# ---------------------------------------------------- -XML_APPLICATION_FILES = ref_man.xml -XML_REF3_FILES = \ - cosFileTransferApp.xml \ - CosFileTransfer_Directory.xml \ - CosFileTransfer_File.xml \ - CosFileTransfer_VirtualFileSystem.xml \ - CosFileTransfer_FileTransferSession.xml \ - CosFileTransfer_FileIterator.xml - -XML_PART_FILES = \ - part.xml -XML_CHAPTER_FILES = \ - ch_contents.xml \ - ch_introduction.xml \ - ch_install.xml \ - ch_system.xml \ - ch_example.xml \ - notes.xml - -BOOK_FILES = book.xml - -XML_FILES = $(BOOK_FILES) $(XML_APPLICATION_FILES) $(XML_REF3_FILES) \ - $(XML_PART_FILES) $(XML_CHAPTER_FILES) - -TECHNICAL_DESCR_FILES = - -GIF_FILES = \ - CosFileTransfer.gif - -PS_FILES = - -# ---------------------------------------------------- - -INTERNAL_HTML_FILES = $(TECHNICAL_DESCR_FILES:%.xml=$(HTMLDIR)/%.html) - -HTML_FILES = $(XML_APPLICATION_FILES:%.xml=$(HTMLDIR)/%.html) \ - $(XML_CHAPTER_FILES:%.xml=$(HTMLDIR)/%.html) \ - $(XML_PART_FILES:%.xml=$(HTMLDIR)/%.html) - - -INFO_FILE = ../../info - -EXTRA_FILES = \ - $(DEFAULT_GIF_FILES) \ - $(DEFAULT_HTML_FILES) \ - $(XML_REF3_FILES:%.xml=$(HTMLDIR)/%.html) - -MAN3_FILES = $(XML_REF3_FILES:%.xml=$(MAN3DIR)/%.3) - -HTML_REF_MAN_FILE = $(HTMLDIR)/index.html - -TOP_PDF_FILE = $(PDFDIR)/$(APPLICATION)-$(VSN).pdf - -# ---------------------------------------------------- -# FLAGS -# ---------------------------------------------------- -XML_FLAGS += -DVIPS_FLAGS += - -# ---------------------------------------------------- -# Targets -# ---------------------------------------------------- -$(HTMLDIR)/%.gif: %.gif - $(INSTALL_DATA) $< $@ - -docs: pdf html man - -$(TOP_PDF_FILE): $(XML_FILES) - -pdf: $(TOP_PDF_FILE) - -html: gifs $(HTML_REF_MAN_FILE) - -clean clean_docs: - rm -rf $(HTMLDIR)/* - rm -f $(MAN3DIR)/* - rm -f $(TOP_PDF_FILE) $(TOP_PDF_FILE:%.pdf=%.fo) - rm -f errs core *~ - -man: $(MAN3_FILES) - -gifs: $(GIF_FILES:%=$(HTMLDIR)/%) - -$(INDEX_TARGET): $(INDEX_SRC) - sed -e 's;%VSN%;$(VSN);' $(INDEX_SRC) > $(INDEX_TARGET) - -debug opt: - -# ---------------------------------------------------- -# Release Target -# ---------------------------------------------------- -include $(ERL_TOP)/make/otp_release_targets.mk - -release_docs_spec: docs - $(INSTALL_DIR) "$(RELSYSDIR)/doc/pdf" - $(INSTALL_DATA) $(TOP_PDF_FILE) "$(RELSYSDIR)/doc/pdf" - $(INSTALL_DIR) "$(RELSYSDIR)/doc/html" - $(INSTALL_DATA) $(HTMLDIR)/* \ - "$(RELSYSDIR)/doc/html" - $(INSTALL_DATA) $(INFO_FILE) "$(RELSYSDIR)" - $(INSTALL_DIR) "$(RELEASE_PATH)/man/man3" - $(INSTALL_DATA) $(MAN3DIR)/* "$(RELEASE_PATH)/man/man3" - -release_spec: diff --git a/lib/cosFileTransfer/doc/src/book.xml b/lib/cosFileTransfer/doc/src/book.xml deleted file mode 100644 index 9a9ec3d0a2..0000000000 --- a/lib/cosFileTransfer/doc/src/book.xml +++ /dev/null @@ -1,49 +0,0 @@ -<?xml version="1.0" encoding="utf-8" ?> -<!DOCTYPE book SYSTEM "book.dtd"> - -<book xmlns:xi="http://www.w3.org/2001/XInclude"> - <header titlestyle="normal"> - <copyright> - <year>2000</year><year>2016</year> - <holder>Ericsson AB. All Rights Reserved.</holder> - </copyright> - <legalnotice> - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. - - </legalnotice> - - <title>cosFileTransfer</title> - <prepared></prepared> - <docno></docno> - <date>2000-08-24</date> - <rev>1.0</rev> - </header> - <insidecover> - </insidecover> - <pagetext>cosFileTransfer</pagetext> - <preamble> - <contents level="2"></contents> - </preamble> - <parts lift="no"> - <xi:include href="part.xml"/> - </parts> - <applications> - <xi:include href="ref_man.xml"/> - </applications> - <releasenotes> - <xi:include href="notes.xml"/> - </releasenotes> - <listofterms></listofterms> - <index></index> -</book> - diff --git a/lib/cosFileTransfer/doc/src/ch_contents.xml b/lib/cosFileTransfer/doc/src/ch_contents.xml deleted file mode 100644 index bd4ed5116f..0000000000 --- a/lib/cosFileTransfer/doc/src/ch_contents.xml +++ /dev/null @@ -1,75 +0,0 @@ -<?xml version="1.0" encoding="utf-8" ?> -<!DOCTYPE chapter SYSTEM "chapter.dtd"> - -<chapter> - <header> - <copyright> - <year>2000</year><year>2016</year> - <holder>Ericsson AB. All Rights Reserved.</holder> - </copyright> - <legalnotice> - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. - - </legalnotice> - - <title>The cosFileTransfer Application</title> - <prepared></prepared> - <docno></docno> - <date>2000-08-24</date> - <rev>1.0</rev> - <file>ch_contents.xml</file> - </header> - - <section> - <title>Content Overview</title> - <p>The cosFileTransfer documentation is divided into three sections: - </p> - <list type="bulleted"> - <item> - <p>PART ONE - The User's Guide - <br></br> -Description of the cosFileTransfer Application including - services and a small tutorial demonstrating - the development of a simple service.</p> - </item> - <item> - <p>PART TWO - Release Notes - <br></br> -A concise history of cosFileTransfer.</p> - </item> - <item> - <p>PART THREE - The Reference Manual - <br></br> - A quick reference guide, including a - brief description, to all the functions available in cosFileTransfer.</p> - </item> - </list> - </section> - - <section> - <title>Brief description of the User's Guide</title> - <p>The User's Guide contains the following parts:</p> - <list type="bulleted"> - <item> - <p>cosFileTransfer overview</p> - </item> - <item> - <p>cosFileTransfer installation</p> - </item> - <item> - <p>A tutorial example</p> - </item> - </list> - </section> -</chapter> - diff --git a/lib/cosFileTransfer/doc/src/ch_example.xml b/lib/cosFileTransfer/doc/src/ch_example.xml deleted file mode 100644 index 7e3c65eedd..0000000000 --- a/lib/cosFileTransfer/doc/src/ch_example.xml +++ /dev/null @@ -1,96 +0,0 @@ -<?xml version="1.0" encoding="utf-8" ?> -<!DOCTYPE chapter SYSTEM "chapter.dtd"> - -<chapter> - <header> - <copyright> - <year>2000</year><year>2016</year> - <holder>Ericsson AB. All Rights Reserved.</holder> - </copyright> - <legalnotice> - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. - - </legalnotice> - - <title>cosFileTransfer Examples</title> - <prepared></prepared> - <docno></docno> - <date>2000-08-24</date> - <rev>A</rev> - <file>ch_example.xml</file> - </header> - - <section> - <title>A tutorial on how to create a simple service</title> - - <section> - <title>Initiate the application</title> - <p>To use the complete cosFileTransfer application cosProperty - must be installed.</p> - </section> - - <section> - <title>How to run everything</title> - <p>Below is a short transcript on how to run cosFileTransfer. </p> - <code type="none"> - -%% Start Mnesia and Orber -mnesia:delete_schema([node()]), -mnesia:create_schema([node()]), -orber:install([node()]), -mnesia:start(), -orber:start(), - -%% The File Transfer Service depends on the cosProperty -%% application. Hence, we must install cosProperty first. -%% It's NOT necessary to invoke cosProperty:install_db(). -cosProperty:install(), - -%% Install File Transfer Service in the IFR. -cosFileTransfer:install(), - -%% Now start the application and necessary services. -cosFileTransfer:start(), - -%% Create two Virtual File Systems respectively representing an FTP- -%% and the local NFS file system. -VFSFTP = cosFileTransferApp:create_VFS('FTP', [], FTPHost, 21), -VFSNATIVE = cosFileTransferApp: - create_VFS({'NATIVE', 'cosFileTransferNATIVE_file'}, - [], MyLocalHost, 0), - -%% Login to each system. -{FSFTP, DirFTP} = 'CosFileTransfer_VirtualFileSystem': - login(VFSFTP, "myId", "myPwd", "myAccount"), -{FSNATIVE, DirNATIVE} = 'CosFileTransfer_VirtualFileSystem': - login(VFSNATIVE, "myId", "myPwd", "myAccount"), - -%% If we want to copy a file from the NFS to the FTP we must first -%% create a File object which contains its attributes. -Target = 'CosFileTransfer_FileTransferSession':create_file(FSFTP, - ["/", "ftp", "incoming", "targetFile"])), - - #'CosFileTransfer_FileWrapper'{the_file = Dir} = -%% Lookup the file we want to copy. -FileWrapper = 'CosFileTransfer_FileTransferSession':get_file(FSNATIVE, - ["/", "home", "myId", "sourceFile"]), -Source = FileWrapper#'CosFileTransfer_FileWrapper'.the_file, - -%% Now we are ready to transfer the file. Please note that we most -%% call the source Session object. -'CosFileTransfer_FileTransferSession':transfer(FSNATIVE, Source, Target), - </code> - </section> - </section> -</chapter> - diff --git a/lib/cosFileTransfer/doc/src/ch_install.xml b/lib/cosFileTransfer/doc/src/ch_install.xml deleted file mode 100644 index 9681f98b45..0000000000 --- a/lib/cosFileTransfer/doc/src/ch_install.xml +++ /dev/null @@ -1,58 +0,0 @@ -<?xml version="1.0" encoding="utf-8" ?> -<!DOCTYPE chapter SYSTEM "chapter.dtd"> - -<chapter> - <header> - <copyright> - <year>2000</year><year>2016</year> - <holder>Ericsson AB. All Rights Reserved.</holder> - </copyright> - <legalnotice> - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. - - </legalnotice> - - <title>Installing cosFileTransfer</title> - <prepared></prepared> - <docno></docno> - <date>2000-08-24</date> - <rev></rev> - <file>ch_install.xml</file> - </header> - - <section> - <title>Installation Process </title> - <p>This chapter describes how to install - <seealso marker="cosFileTransferApp">cosFileTransferApp</seealso> in an Erlang Environment. - </p> - - <section> - <title>Preparation</title> - <p>Before starting the installation process for cosFileTransfer, - the application <c>Orber</c> must be running and <c>cosProperty</c> installed by - using <c>cosProperty:install()</c>. Please note that it is <em>NOT</em> necessary - to use <c>cosProperty:install_db()</c> for running the cosFileTransfer application.</p> - </section> - - <section> - <title>Configuration</title> - <p>When starting the cosFileTransfer application the following configuration parameters - can be used:</p> - <list type="bulleted"> - <item><em>buffert_size</em> - default is 64000. This option determine - how many bytes will be read at a time when transferring files.</item> - </list> - </section> - </section> -</chapter> - diff --git a/lib/cosFileTransfer/doc/src/ch_introduction.xml b/lib/cosFileTransfer/doc/src/ch_introduction.xml deleted file mode 100644 index 67616b0a39..0000000000 --- a/lib/cosFileTransfer/doc/src/ch_introduction.xml +++ /dev/null @@ -1,57 +0,0 @@ -<?xml version="1.0" encoding="utf-8" ?> -<!DOCTYPE chapter SYSTEM "chapter.dtd"> - -<chapter> - <header> - <copyright> - <year>2000</year><year>2016</year> - <holder>Ericsson AB. All Rights Reserved.</holder> - </copyright> - <legalnotice> - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. - - </legalnotice> - - <title>Introduction to cosFileTransfer</title> - <prepared></prepared> - <docno></docno> - <date>2000-08-24</date> - <rev></rev> - <file>ch_introduction.xml</file> - </header> - - <section> - <title>Overview</title> - <p>The cosFileTransfer application is a FileTransfer Service compliant with the - <url href="http://www.omg.org">OMG</url> Service CosFileTransfer. - </p> - - <section> - <title>Purpose and Dependencies</title> - <p>If a Virtual File System is started as 'FTP', the inets-2.5.4 application, - or later, must be installed.</p> - <p><em>cosFileTransfer</em> is dependent on <em>Orber</em>, which provides CORBA functionality in an Erlang environment, - and <em>cosProperty</em>.</p> - </section> - - <section> - <title>Prerequisites</title> - <p>To fully understand the concepts presented in the - documentation, it is recommended that the user is familiar - with distributed programming, CORBA, the Orber and cosProperty applications. - </p> - <p>Recommended reading includes <em>CORBA, Fundamentals and Programming - Jon Siegel</em> and <em>Open Telecom Platform Documentation Set</em>. It is also helpful to have read <em>Concurrent Programming in Erlang</em>.</p> - </section> - </section> -</chapter> - diff --git a/lib/cosFileTransfer/doc/src/ch_system.xml b/lib/cosFileTransfer/doc/src/ch_system.xml deleted file mode 100644 index 377ec1fa49..0000000000 --- a/lib/cosFileTransfer/doc/src/ch_system.xml +++ /dev/null @@ -1,138 +0,0 @@ -<?xml version="1.0" encoding="utf-8" ?> -<!DOCTYPE chapter SYSTEM "chapter.dtd"> - -<chapter> - <header> - <copyright> - <year>2001</year><year>2016</year> - <holder>Ericsson AB. All Rights Reserved.</holder> - </copyright> - <legalnotice> - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. - - </legalnotice> - - <title>Using the File Transfer Service</title> - <prepared></prepared> - <docno></docno> - <date>2001-08-07</date> - <rev></rev> - <file>ch_system.xml</file> - </header> - - <section> - <title>Overview</title> - <p>This chapter describes how two File Transfer Service applications interact.</p> - - <section> - <title>Components</title> - <p>There are several ways the OMG File Transfer Service can be used. - Below one scenario is visualized: </p> - <marker id="CosFileTransfer"></marker> - <image file="CosFileTransfer.gif"> - <icaption>Figure 1: The File Transfer Service Components.</icaption> - </image> - <list type="bulleted"> - <item><em>Source ORB:</em> this is the ORB we want to transfer a file from/via and it holds - an object reference to a - <seealso marker="CosFileTransfer_VirtualFileSystem">Virtual File System (VFS)</seealso> which, - in this example, represents an FTP server.</item> - <item><em>Target ORB:</em> the goal may be, for example, to transfer a new file or append to an - existing file placed at the location that this ORB's <c>VFS</c> represents. - In this scenario it is the local disk or the NFS.</item> - <item><em>Transport Protocol:</em> initially the ORB's, i.e., target and source, communicate via - normal <c>CORBA</c> requests to determine whether or not they can communicate. If the - File Transfer Service's have one, or more, <c>Transport Protocol</c> in common the data - will be streamed using this protocol. The cosFileTransfer application currently supports - <c>TCP/IP</c> and <c>SSL</c>.</item> - </list> - <p>Which type of file system the <c>VFS</c> is supposed to represent is determined - by the options given when creating it, which is also how one determine which - <c>Transport Protocol</c> to use. Hence, the source and target <c>VFS</c> described above - can be started by invoking, respectively, the following operations:</p> - <code type="none"> -1> SVFS = cosFileTransferApp:create_VFS('FTP', [], Host, 21, [{protocol, tcp}]), -2> TVFS = cosFileTransferApp:create_VFS({'NATIVE', 'cosFileTransferNATIVE_file'}, - [], OtherHost, 0, [{protocol, tcp}]), - </code> - <p>Naturally can any combination of <c>VFS</c>-types be used and it is also possible - to use own drivers, i.e., <c>{'NATIVE', 'MyDriver'}</c>.</p> - <p>After creating necessary <c>VFS's</c> we can login in and perform operations - on files and directories residing on each file system.</p> - </section> - - <section> - <title>How To Use SSL</title> - <p>To be able to use <c>SSL</c> as transport protocol a few configuration - parameters must be set. The required parameters depend on if Orber is - the target or/and the source ORB. However, the SSL_CERT_FILE variable - must be defined in both cases.</p> - <p>Setting of a CA certificate file with an option does not work due to - weaknesses in the SSLeay package. A work-around in the ssl application is - to set the OS environment variable SSL_CERT_FILE before SSL is started. - However, then the CA certificate file will be global for all connections - (both incoming and outgoing calls).</p> - - <section> - <title>Configurations when cosFileTransfer is Used as Target</title> - <p>The following three configuration variables can be used to configure - cosFileTransfer's SSL target behavior.</p> - <list type="bulleted"> - <item><em>ssl_server_certfile</em> which is a path to a file containing a - chain of PEM encoded certificates for cosFileTransfer as target.</item> - <item><em>ssl_server_verify</em> which specifies type of verification: - 0 = do not verify peer; 1 = verify peer, verify client once, 2 = - verify peer, verify client once, fail if no peer certificate. - The default value is 0.</item> - <item><em>ssl_server_depth</em> which specifies verification depth, i.e. - how far in a chain of certificates the verification process shall - proceed before the verification is considered successful. The - default value is 1. </item> - </list> - <p>There also exist a number of API functions for accessing the values of - these variables:</p> - <list type="bulleted"> - <item>cosFileTransferApp:ssl_server_certfile/0</item> - <item>cosFileTransferApp:ssl_server_verify/0</item> - <item>cosFileTransferApp:ssl_server_depth/0</item> - </list> - </section> - - <section> - <title>Configurations when cosFileTransfer is used as Source</title> - <p>Below is the list of configuration variables used when cosFileTransfer - act as the source application.</p> - <list type="bulleted"> - <item><em>ssl_client_certfile</em> which is a path to a file containing a - chain of PEM encoded certificates used in outgoing calls.</item> - <item><em>ssl_client_verify</em> which specifies type of verification: - 0 = do not verify peer; 1 = verify peer, verify client once, 2 = - verify peer, verify client once, fail if no peer certificate. - The default value is 0.</item> - <item><em>ssl_client_depth</em> which specifies verification depth, i.e. - how far in a chain of certificates the verification process shall - proceed before the verification is considered successful. The - default value is 1. </item> - </list> - <p>There also exist a number of API functions for accessing the values of - these variables in the client processes:</p> - <list type="bulleted"> - <item>cosFileTransferApp:ssl_client_certfile/0</item> - <item>cosFileTransferApp:ssl_client_verify/0</item> - <item>cosFileTransferApp:ssl_client_depth/0</item> - </list> - </section> - </section> - </section> -</chapter> - diff --git a/lib/cosFileTransfer/doc/src/cosFileTransferApp.xml b/lib/cosFileTransfer/doc/src/cosFileTransferApp.xml deleted file mode 100644 index ae7b4f1ec5..0000000000 --- a/lib/cosFileTransfer/doc/src/cosFileTransferApp.xml +++ /dev/null @@ -1,173 +0,0 @@ -<?xml version="1.0" encoding="utf-8" ?> -<!DOCTYPE erlref SYSTEM "erlref.dtd"> - -<erlref> - <header> - <copyright> - <year>2000</year><year>2016</year> - <holder>Ericsson AB. All Rights Reserved.</holder> - </copyright> - <legalnotice> - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. - - </legalnotice> - - <title>cosFileTransferApp</title> - <prepared></prepared> - <docno></docno> - <checked></checked> - <date>2000-08-24</date> - <rev>PA1</rev> - </header> - <module>cosFileTransferApp</module> - <modulesummary>The main module of the cosFileTransfer application.</modulesummary> - <description> - <p>To get access to the record definitions for the structures use: <br></br> -<c>-include_lib("cosFileTransfer/include/*.hrl").</c></p> - <p>This module contains the functions for starting and stopping the application.</p> - </description> - <funcs> - <func> - <name>install() -> Return</name> - <fsummary>Install the cosFileTransfer application</fsummary> - <type> - <v>Return = ok | {'EXIT', Reason}</v> - </type> - <desc> - <p>This operation installs the cosFileTransfer application. Note, the - <c>cosProperty</c> application must be installed prior to invoking this - operation.</p> - </desc> - </func> - <func> - <name>uninstall() -> Return</name> - <fsummary>Uninstall the cosFileTransfer application</fsummary> - <type> - <v>Return = ok | {'EXIT', Reason}</v> - </type> - <desc> - <p>This operation uninstalls the cosFileTransfer application.</p> - </desc> - </func> - <func> - <name>start() -> Return</name> - <fsummary>Start the cosFileTransfer application</fsummary> - <type> - <v>Return = ok | {error, Reason}</v> - </type> - <desc> - <p>This operation starts the cosFileTransfer application.</p> - </desc> - </func> - <func> - <name>stop() -> Return</name> - <fsummary>Stop the cosFileTransfer application</fsummary> - <type> - <v>Return = ok | {error, Reason}</v> - </type> - <desc> - <p>This operation stops the cosFileTransfer application.</p> - </desc> - </func> - <func> - <name>create_VFS(Type, Content, Host, Port [,Options]) -> Return</name> - <fsummary>Create a new instance of a Virtual File System</fsummary> - <type> - <v>Type = 'FTP' | {'NATIVE', 'cosFileTransferNATIVE_file'} | {'NATIVE', MyModule}</v> - <v>Content = []</v> - <v>Host = string(), e.g. "myHost@myServer" or "012.345.678.910"</v> - <v>Port = integer()</v> - <v>Options = [Option]</v> - <v>Option = {protocol, Protocol} | {connect_timeout, Seconds}</v> - <v>Protocol = tcp | ssl</v> - <v>Return = VFS | {'EXCEPTION, E}</v> - <v>VFS = #objref</v> - </type> - <desc> - <p>This operation creates a new instance of a Virtual File System. The - <c>Type</c> parameter determines which type we want the VFS to represent. - 'FTP' maps to the <c>INETS</c> ftp implementation, while - {'NATIVE', 'cosFileTransferNATIVE_file'} uses the <c>file</c> module. - It is also possible to implement own mappings which are activated by - supplying {'NATIVE', MyModule}. The MyModule module must export the same - functions and behave in the same way as the INETS ftp module, and - an operation named <c>open(Host, Port)</c>, which shall return - <c>{ok, Pid}</c> or <c>{error, Reason}</c>.</p> - <p>If no <c>Options</c> are supplied the default setting will be - used, i.e., tcp and 60 seconds.</p> - <p>The <c>Content</c> parameter is currently ignored by must be supplied - as an empty list.</p> - </desc> - </func> - <func> - <name>ssl_server_certfile() -> string()</name> - <fsummary>Display the path to the target certificate</fsummary> - <desc> - <p>This function returns a path to a file containing a chain of PEM encoded - certificates for the cosFileTransfer as target. - This is configured by setting the application variable - <em>ssl_server_certfile</em>.</p> - </desc> - </func> - <func> - <name>ssl_client_certfile() -> string()</name> - <fsummary>Display the path to the client certificate</fsummary> - <desc> - <p>This function returns a path to a file containing a chain of PEM encoded - certificates used in outgoing calls. - The default value is configured by setting the application variable - <em>ssl_client_certfile</em>.</p> - </desc> - </func> - <func> - <name>ssl_server_verify() -> 0 | 1 | 2</name> - <fsummary>Display the SSL verification type for incoming calls</fsummary> - <desc> - <p>This function returns the type of verification used by SSL during authentication of the other - peer for incoming calls. - It is configured by setting the application variable - <em>ssl_server_verify</em>.</p> - </desc> - </func> - <func> - <name>ssl_client_verify() -> 0 | 1 | 2</name> - <fsummary>Display the SSL verification type for outgoing calls</fsummary> - <desc> - <p>This function returns the type of verification used by SSL during authentication of the other - peer for outgoing calls. - The default value is configured by setting the application variable - <em>ssl_client_verify</em>.</p> - </desc> - </func> - <func> - <name>ssl_server_depth() -> int()</name> - <fsummary>Display the SSL verification depth for incoming calls</fsummary> - <desc> - <p>This function returns the SSL verification depth for incoming calls. - It is configured by setting the application variable - <em>ssl_server_depth</em>.</p> - </desc> - </func> - <func> - <name>ssl_client_depth() -> int()</name> - <fsummary>Display the SSL verification depth for outgoing calls</fsummary> - <desc> - <p>This function returns the SSL verification depth for outgoing calls. - The default value is configured by setting the application variable - <em>ssl_client_depth</em>.</p> - </desc> - </func> - </funcs> - -</erlref> - diff --git a/lib/cosFileTransfer/doc/src/notes.xml b/lib/cosFileTransfer/doc/src/notes.xml deleted file mode 100644 index e0b4bdf64b..0000000000 --- a/lib/cosFileTransfer/doc/src/notes.xml +++ /dev/null @@ -1,379 +0,0 @@ -<?xml version="1.0" encoding="utf-8" ?> -<!DOCTYPE chapter SYSTEM "chapter.dtd"> - -<chapter> - <header> - <copyright> - <year>2000</year><year>2016</year> - <holder>Ericsson AB. All Rights Reserved.</holder> - </copyright> - <legalnotice> - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. - - </legalnotice> - - <title>cosFileTransfer Release Notes</title> - <prepared></prepared> - <docno></docno> - <checked></checked> - <date>2000-08-24</date> - <rev>A</rev> - <file>notes.xml</file> - </header> - - <section><title>cosFileTransfer 1.2.2</title> - - <section><title>Fixed Bugs and Malfunctions</title> - <list> - <item> - <p> Removed all old unused files in the documentation. - </p> - <p> - Own Id: OTP-14475 Aux Id: ERL-409, PR-1493 </p> - </item> - </list> - </section> - -</section> - -<section><title>cosFileTransfer 1.2.1</title> - - <section><title>Improvements and New Features</title> - <list> - <item> - <p> - Internal changes</p> - <p> - Own Id: OTP-13551</p> - </item> - </list> - </section> - -</section> - -<section><title>cosFileTransfer 1.2</title> - - <section><title>Improvements and New Features</title> - <list> - <item> - <p> Remove the usage of erlang:now() from all Corba - applications and use the new rand module instead of - random. </p> - <p> - Own Id: OTP-12687</p> - </item> - </list> - </section> - -</section> - -<section><title>cosFileTransfer 1.1.16</title> - - <section><title>Improvements and New Features</title> - <list> - <item> - <p> The default encoding of Erlang files has been changed - from ISO-8859-1 to UTF-8. </p> <p> The encoding of XML - files has also been changed to UTF-8. </p> - <p> - Own Id: OTP-10907</p> - </item> - </list> - </section> - -</section> - -<section><title>cosFileTransfer 1.1.15</title> - - <section><title>Improvements and New Features</title> - <list> - <item> - <p> Postscript files no longer needed for the generation - of PDF files have been removed. </p> - <p> - Own Id: OTP-11016</p> - </item> - </list> - </section> - -</section> - -<section><title>cosFileTransfer 1.1.14</title> - - <section><title>Improvements and New Features</title> - <list> - <item> - <p> - Misc build updates</p> - <p> - Own Id: OTP-10784</p> - </item> - </list> - </section> - -</section> - -<section><title>cosFileTransfer 1.1.13</title> - - <section><title>Improvements and New Features</title> - <list> - <item> - <p>Erlang/OTP can now be built using parallel make if you - limit the number of jobs, for instance using '<c>make - -j6</c>' or '<c>make -j10</c>'. '<c>make -j</c>' does not - work at the moment because of some missing - dependencies.</p> - <p> - Own Id: OTP-9451</p> - </item> - </list> - </section> - -</section> - -<section><title>cosFileTransfer 1.1.12</title> - - <section><title>Fixed Bugs and Malfunctions</title> - <list> - <item> - <p> XML files have been corrected. </p> - <p> - Own Id: OTP-9550 Aux Id: OTP-9541 </p> - </item> - </list> - </section> - -</section> - -<section> - <title>cosFileTransfer 1.1.11</title> - - <section> - <title>Improvements and New Features</title> - <list type="bulleted"> - <item> - <p> - Removed superfluous usage of shy in the documentation since it can cause problem if - a buggy tool is used.</p> - <p> - Own Id: OTP-9319 Aux Id:</p> - </item> - </list> - </section> - </section> - - <section> - <title>cosFileTransfer 1.1.10</title> - - <section> - <title>Improvements and New Features</title> - <list type="bulleted"> - <item> - <p> - Removed obsolete SSL dependency.</p> - <p> - Own Id: OTP-8374 Aux Id:</p> - </item> - </list> - </section> - - <section> - <title>Fixed Bugs and Malfunctions</title> - <list type="bulleted"> - <item> - <p>The documentation EIX file was not generated.</p> - <p>Own id: OTP-8355 Aux Id:</p> - </item> - </list> - </section> - </section> - - <section> - <title>cosFileTransfer 1.1.9</title> - - <section> - <title>Improvements and New Features</title> - <list type="bulleted"> - <item> - <p> - The documentation is now built with open source tools (xsltproc and fop) - that exists on most platforms. One visible change is that the frames are removed.</p> - <p> - Own Id: OTP-8201 Aux Id:</p> - </item> - </list> - </section> - </section> - - <section> - <title>cosFileTransfer 1.1.8</title> - - <section> - <title>Improvements and New Features</title> - <list type="bulleted"> - <item> - <p>Obsolete guards, e.g. record vs is_record, has been changed - to avoid compiler warnings.</p> - <p>Own id: OTP-7987</p> - </item> - </list> - </section> - </section> - - <section> - <title>cosFileTransfer 1.1.7</title> - - <section> - <title>Improvements and New Features</title> - <list type="bulleted"> - <item> - <p>Updated file headers.</p> - <p>Own id: OTP-7837</p> - </item> - </list> - </section> - </section> - - <section> - <title>cosFileTransfer 1.1.6</title> - - <section> - <title>Improvements and New Features</title> - <list type="bulleted"> - <item> - <p>Documentation source included in open source releases.</p> - <p>Own id: OTP-7595</p> - </item> - </list> - </section> - <section> - <title>Fixed Bugs and Malfunctions</title> - <list type="bulleted"> - <item> - <p>When using predefined native file copy the return values from - file operation was not handled correctly.</p> - <p>Own id: OTP-7599</p> - </item> - </list> - </section> - </section> - - <section> - <title>cosFileTransfer 1.1.5</title> - - <section> - <title>Improvements and New Features</title> - <list type="bulleted"> - <item> - <p>CosFileTransfer now uses the changed Inets API.</p> - <p>Own id: OTP-7020</p> - </item> - </list> - </section> - </section> - - <section> - <title>cosFileTransfer 1.1.4</title> - - <section> - <title>Improvements and New Features</title> - <list type="bulleted"> - <item> - <p>The documentation source has been converted from SGML to XML.</p> - <p>Own id: OTP-6754</p> - </item> - </list> - </section> - </section> - - <section> - <title>cosFileTransfer 1.1.3</title> - - <section> - <title>Improvements and New Features</title> - <list type="bulleted"> - <item> - <p>Minor Makefile changes.</p> - <p>Own id: OTP-6701</p> - </item> - </list> - </section> - </section> - - <section> - <title>cosFileTransfer 1.1.2</title> - - <section> - <title>Improvements and New Features</title> - <list type="bulleted"> - <item> - <p>Due to changed behavior of the ftp client a few changes - has been made.</p> - <p>Own id: OTP-5135</p> - </item> - </list> - </section> - </section> - - <section> - <title>cosFileTransfer 1.1.1</title> - - <section> - <title>Fixed Bugs and Malfunctions</title> - <list type="bulleted"> - <item> - <p>Depending on which ftp server is used, the operation - CosFileTransfer::Directory::list could fail.</p> - <p>Own id: OTP-4954</p> - </item> - </list> - </section> - </section> - - <section> - <title>cosFileTransfer 1.1</title> - - <section> - <title>Improvements and New Features</title> - <list type="bulleted"> - <item> - <p>The stub/skeleton-files generated by IC have been improved, - i.e., depending on the IDL-files, reduced the size of the - erl- and beam-files and decreased dependencies off Orber's - Interface Repository. It is necessary to re-compile all IDL-files - and use COS-applications, including Orber, compiled with - IC-4.2.</p> - <p>Own id: OTP-4576</p> - </item> - </list> - </section> - </section> - - <section> - <title>cosFileTransfer 1.0.2</title> - - <section> - <title>Improvements and New Features</title> - <list type="bulleted"> - <item> - <p>First release of the cosFileTransfer application. Please note that - the OMG specification was not finalized when this version - was released. Hence, the API may be changed in way which is not - compatible with this version. Contact support if you are in doubt.</p> - <p>Own Id: -</p> - </item> - </list> - </section> - </section> -</chapter> - diff --git a/lib/cosFileTransfer/doc/src/part.xml b/lib/cosFileTransfer/doc/src/part.xml deleted file mode 100644 index b4e6f573dd..0000000000 --- a/lib/cosFileTransfer/doc/src/part.xml +++ /dev/null @@ -1,41 +0,0 @@ -<?xml version="1.0" encoding="utf-8" ?> -<!DOCTYPE part SYSTEM "part.dtd"> - -<part xmlns:xi="http://www.w3.org/2001/XInclude"> - <header> - <copyright> - <year>2000</year><year>2016</year> - <holder>Ericsson AB. All Rights Reserved.</holder> - </copyright> - <legalnotice> - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. - - </legalnotice> - - <title>cosFileTransfer User's Guide</title> - <prepared></prepared> - <docno></docno> - <date>2000-08-24</date> - <rev>1.0</rev> - </header> - <description> - <p>The cosFileTransfer Application is an Erlang implementation of the OMG - CORBA FileTransfer Service.</p> - </description> - <xi:include href="ch_contents.xml"/> - <xi:include href="ch_introduction.xml"/> - <xi:include href="ch_install.xml"/> - <xi:include href="ch_system.xml"/> - <xi:include href="ch_example.xml"/> -</part> - diff --git a/lib/cosFileTransfer/doc/src/ref_man.xml b/lib/cosFileTransfer/doc/src/ref_man.xml deleted file mode 100644 index ce050128e6..0000000000 --- a/lib/cosFileTransfer/doc/src/ref_man.xml +++ /dev/null @@ -1,42 +0,0 @@ -<?xml version="1.0" encoding="utf-8" ?> -<!DOCTYPE application SYSTEM "application.dtd"> - -<application xmlns:xi="http://www.w3.org/2001/XInclude"> - <header> - <copyright> - <year>2000</year><year>2016</year> - <holder>Ericsson AB. All Rights Reserved.</holder> - </copyright> - <legalnotice> - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. - - </legalnotice> - - <title>cosFileTransfer Reference Manual</title> - <prepared></prepared> - <docno></docno> - <date>2000-08-24</date> - <rev>1.0</rev> - </header> - <description> - <p>The cosFileTransfer Application is an Erlang implementation of the OMG - CORBA File Transfer Service.</p> - </description> - <xi:include href="cosFileTransferApp.xml"/>> - <xi:include href="CosFileTransfer_File.xml"/>> - <xi:include href="CosFileTransfer_Directory.xml"/>> - <xi:include href="CosFileTransfer_FileIterator.xml"/>> - <xi:include href="CosFileTransfer_VirtualFileSystem.xml"/>> - <xi:include href="CosFileTransfer_FileTransferSession.xml"/>> -</application> - |
