• No results found

You use the elements in the client folder to formulate and submit requests to HTTP, FTP, SFTP, e-mail, and LDAP servers.

3 Client Folder

Summary of Elements in this Folder

The following elements are available in this folder:

Element Package and Description

pub.client:ftp WmPublic. Performs a series of FTP actions.

pub.client.ftp:append WmPublic. Appends data to a remote file.

pub.client.ftp:cd WmPublic. Changes the working directory on the FTP server. (This service corresponds to the

standard FTP command cd dirpath.)

pub.client.ftp:cdls WmPublic. Changes the working directory on the FTP server and retrieves a list of file names. (This service corresponds to the standard FTP commands cd dirpath and ls namePattern.)

pub.client.ftp:delete WmPublic. Deletes a file in the current working directory on an FTP server. (This service

corresponds to the standard FTP command delete

somefile.)

pub.client.ftp:dir WmPublic. Retrieves the file list during an FTP session. (This service corresponds to the standard

FTP command dir namepattern.)

pub.client.ftp:get WmPublic. Retrieves a file from a remote FTP server. (This service corresponds to the standard FTP command get.)

pub.client.ftp:getCompletedNotification WmPublic. A publishable document type that represents the document published to notify parties that an FTP get command has completed.

pub.client.ftp:login WmPublic. Connects to a remote FTP server and logs in with a specified user name and password.

pub.client.ftp:logout WmPublic. Logs off of the FTP server and ends the current FTP session.

pub.client.ftp:ls WmPublic. Retrieves the file list during an FTP session. (This service corresponds to the standard

FTP command ls namepattern.)

pub.client.ftp:mdelete WmPublic. Deletes multiple files in the current working directory on an FTP server. (This service

corresponds to the standard FTP command mdelete

pattern.)

pub.client.ftp:mget WmPublic. Transfers multiple files from the remote FTP server. (This service corresponds to the

3 Client Folder

pub.client.ftp:mput WmPublic. Transfers multiple files to a remote FTP server. (This service corresponds to the standard

FTP command input.)

pub.client.ftp:put WmPublic. Transfers a file to a remote FTP server. (This service corresponds to the standard FTP command put.)

pub.client.ftp:putCompletedNotification WmPublic. A publishable document type that represents the document published to notify parties that an FTP put command has completed.

pub.client.ftp:quote WmPublic. Executes a given FTP command.

pub.client.ftp:rename WmPublic. Renames a file on a remote FTP server. (This service corresponds to the standard FTP command rename.)

pub.client.ftp:sessioninfo WmPublic. Returns session information for all of the FTP servers that users are currently logged into.

pub.client:http WmPublic. Issues an HTTP request that you specify and returns the HTTP response.

pub.client.ldap:add WmPublic. Inserts a new entry into the directory.

pub.client.ldap:bind WmPublic. Performs an LDAP bind operation that associates the connection with the specified

principal.

pub.client.ldap:cancelNotification WmPublic. Cancels a previously created notification request.

pub.client.ldap:compare WmPublic. Compares the value of an attribute in the LDAP directory with a value specified by the service.

pub.client.ldap:delete WmPublic. Removes an entry from the directory.

pub.client.ldap:modify WmPublic. Performs an LDAP modify operation that allows you to specify a list of attributes with corresponding lists of values to add to, replace, or remove from the directory entry.

pub.client.ldap:registerNotification WmPublic. Creates a notification (or "persistent search") that causes Integration Server to listen for LDAP events. When the notification gets an event, the specified service is called.

pub.client.ldap:rename WmPublic. Performs an LDAP rename (move) operation allowing you to rename an entry.

3 Client Folder

pub.client.ldap:search WmPublic. Performs an LDAP search operation with the specified parameters and returns the results of the search.

pub.client.oauth:executeRequest WmPublic. Allow clients to access protected resources using an OAuth token.

pub.client.sftp:cd WmPublic. Changes the working directory on the remote SFTP server.

pub.client.sftp:chgrp WmPublic. Changes the group ownership of one or more remote files.

pub.client.sftp:chmod WmPublic. Changes permissions of one or more remote files.

pub.client.sftp:chown WmPublic. Changes the user of one or more remote files.

pub.client.sftp:get WmPublic. Retrieves a file from a remote SFTP server and saves it on the local machine.

pub.client.sftp:login WmPublic. Connects to a remote SFTP server and logs in with the specified SFTP user alias.

pub.client.sftp:logout WmPublic. Logs off the user from the SFTP server and ends the current SFTP session.

pub.client.sftp:ls WmPublic. Retrieves the remote directory listing of the specified path or current remote directory if path is not specified.

pub.client.sftp:mkdir WmPublic. Creates a new remote directory.

pub.client.sftp:put WmPublic. Transfers a file to a remote SFTP server.

pub.client.sftp:pwd WmPublic. Displays the remote working directory on the SFTP server.

pub.client.sftp:rename WmPublic. Renames a file or directory on a remote SFTP server.

pub.client.sftp:rm WmPublic. Deletes one or more remote files on the SFTP server.

pub.client.sftp:rmdir WmPublic. Deletes one or more remote directories on the SFTP server.

pub.client.sftp:symlink WmPublic. Creates a symbolic link between the old path and the new path of a file.

pub.client:smtp WmPublic. Sends a MIME-type e-mail message.

3 Client Folder