com.stdnet.moveit.api

Class Client

java.lang.Object

com.stdnet.moveit.api.ClientBase

com.stdnet.moveit.api.Client

public class Client
extends com.stdnet.moveit.api.ClientBase

Main class used for accessing a MOVEit Transfer server. Contains the methods and properties necessary for signing on, transferring files, and adding, editing, and deleting users, files, and folders on a MOVEit Transfer system.

Before any methods can be called, the host parameters must be configured and the SignOn method called to log on to the MOVEit Transfer host. Once signed on, any of the methods can be called. Many operations are not available based on the permission level of the user used to sign on to the MOVEit Transfer; in cases where the user's permission is not sufficient for the operation, the method will fail and a permission error will be returned from the StatusDescription method.

A note on using HTTP and HTTPS proxies

By default, MOVEit Transfer API Java will not use a proxy server. If you wish to use a proxy, do not use calls to the standard Java method System.setProperty(). Instead, call MOVEit Transfer API Java's useProxy(true) and set the proxy parameters via httpProxyHost(hostname), httpProxyPort(port), etc. There are separate methods for HTTP vs. HTTPS proxies.

Nested Class Summary

Nested classes/interfaces inherited from class com.stdnet.moveit.api.ClientBase

com.stdnet.moveit.api.ClientBase.RelativePathCache, com.stdnet.moveit.api.ClientBase.SNICookies

Field Summary

Fields inherited from class com.stdnet.moveit.api.ClientBase

cnSleepMS, ERR_EXPIRED_SESSION, ERR_LICENSING, ERR_RESUME_DOWNLOAD, FormatCSV, FormatXML

Constructor Summary

Constructors

Constructor and Description
Client()
Client(java.lang.String AuthCode)

Method Summary

Modifier and Type	Method and Description
java.lang.String	actAsIP() Returns the ActAs IP address specified during the signon process.
int	addFolder(java.lang.String MOVEitFolder) Makes a new MOVEit Transfer folder with the given path.
int	addFolder(java.lang.String MOVEitFolder, int InheritPerms) Makes a new MOVEit Transfer folder with the given path and assigns initial permissions based on the given method.
boolean	addGroup(java.lang.String GroupName) Adds a new group with the provided name.
boolean	addGroup(java.lang.String GroupName, java.lang.String Description) Adds a new group with the provided name and description.
boolean	addGroupFolderAccess(java.lang.String MOVEitFolder, java.lang.String GroupName, java.lang.String PermString) Grants the specified group access to this folder.
boolean	addGroupToGroupAddressBook(java.lang.String OwnerGroup, java.lang.String GroupName, boolean AllowExpansion) Adds a group to the specified owner group's address book.
boolean	addGroupToUserAddressBook(java.lang.String Owner, java.lang.String GroupName) Adds a group to the specified owner's address book.
boolean	addGroupToUserAddressBook(java.lang.String Owner, java.lang.String GroupName, boolean AllowExpansion) Adds a group to the specified owner's address book.
int	addMailbox(java.lang.String MOVEitMailbox) Makes a new MOVEit Transfer mailbox with the given path for the current user.
boolean	addTemporaryUser(java.lang.String Email, java.lang.String Password, java.lang.String RealName) Adds a new temporary user with the provided attributes.
boolean	addTemporaryUser(java.lang.String Email, java.lang.String Password, java.lang.String RealName, boolean ForceChangePassword) Adds a new temporary user with the provided attributes.
boolean	addUser(java.lang.String Username, java.lang.String Password, java.lang.String RealName, java.lang.String Email, int Permission) Adds a new user with the provided attributes.
boolean	addUser(java.lang.String Username, java.lang.String Password, java.lang.String RealName, java.lang.String Email, int Permission, java.lang.String Notes) Adds a new user with the provided attributes.
boolean	addUser(java.lang.String Username, java.lang.String Password, java.lang.String RealName, java.lang.String Email, int Permission, java.lang.String Notes, boolean ForceChangePassword) Adds a new user with the provided attributes.
boolean	addUser(java.lang.String Username, java.lang.String Password, java.lang.String RealName, java.lang.String Email, int Permission, java.lang.String Notes, boolean ForceChangePassword, java.lang.String OrgID) Adds a new user with the provided attributes.
boolean	addUserCertKey(java.lang.String Username, int DataType, java.lang.String Data) Adds an SSL certificate or SSH key to a user's store using provided data.
boolean	addUserFolderAccess(java.lang.String MOVEitFolder, java.lang.String Username, java.lang.String PermString) Grants the specified user access to this folder.
boolean	addUserToGroup(java.lang.String Username, java.lang.String GroupName) Adds the specified user to the specified group.
boolean	addUserToGroupAddressBook(java.lang.String OwnerGroup, java.lang.String Username) Adds a user to the specified owner group's address book.
boolean	addUserToUserAddressBook(java.lang.String Owner, java.lang.String Username) Adds a user to the specified owner's address book.
int	addVirtualFolder(java.lang.String MOVEitFolder, java.lang.String TargetMOVEitFolder) Makes a new MOVEit Transfer virtual folder with the given path targeting the given folder.
int	addVirtualFolder(java.lang.String MOVEitFolder, java.lang.String TargetMOVEitFolder, int InheritPerms) Makes a new MOVEit Transfer virtual folder with the given path targeting the given folder and assigns initial permissions based on the given method.
java.lang.String	asAgent() Gets the current agent string to be logged and displayed on the MOVEit Transfer server.
java.lang.String	asAgent(java.lang.String sAgent) Sets an agent string to be logged and displayed on the MOVEit Transfer server.
boolean	changeFolderSetting(java.lang.String MOVEitFolder, java.lang.String SettingName, java.lang.String NewValue) Attempts to change a setting on the specified folder.
boolean	changeGroupSetting(java.lang.String GroupName, java.lang.String SettingName, java.lang.String NewValue) Attempts to change a setting on the specified group.
boolean	changeUserGroupMembership(java.lang.String GroupName, java.lang.String Username, java.lang.String Relationship) Changes the relationship of the given user to the given group.
boolean	changeUserPassword(java.lang.String Username, java.lang.String NewPass) Changes the password of existing user Username to NewPass.
boolean	changeUserSetting(java.lang.String Username, java.lang.String SettingName, java.lang.String NewValue) Attempts to change a setting on the specified user.
boolean	changeUserStatus(java.lang.String Username, java.lang.String Status) Changes the status of existing user Username to Status.
boolean	changeUserStatus(java.lang.String Username, java.lang.String Status, java.lang.String StatusNote) Changes the status of existing user Username to Status.
java.util.HashMap	checkMessageRecipients(MOVEitMessageInfo oMsg) Given a MOVEitMessageInfo object defining a package to send, checks whether the assigned recipients are valid for the currently configured "From" user.
java.lang.String	clientCertFilePath() Returns the filename used to provide a client certificates when connecting to MOVEit Transfer.
java.lang.String	clientCertFilePath(java.lang.String path) Tells MOVEit Transfer API to use a client certificate from the given file when connecting to MOVEit Transfer.
java.lang.String	clientCertPassword() Returns the to the client certificate file.
java.lang.String	clientCertPassword(java.lang.String pw) Tells MOVEit Transfer API the password to the client certificate file set in clientCertFilePath.
java.lang.String	clientCertType() Returns the client certificate file type.
java.lang.String	clientCertType(java.lang.String fileType) Tells MOVEit Transfer API the type of the client certificate file set in clientCertFilePath.
boolean	cloneUser(java.lang.String OrigUsername, java.lang.String NewUsername, java.lang.String Password, java.lang.String RealName, java.lang.String Email) Adds a new user with the provided attributes by cloning the user with the username provided in OrigUsername.
boolean	cloneUser(java.lang.String OrigUsername, java.lang.String NewUsername, java.lang.String Password, java.lang.String RealName, java.lang.String Email, java.lang.String Notes) Adds a new user with the provided attributes by cloning the user with the username provided in OrigUsername.
boolean	cloneUser(java.lang.String OrigUsername, java.lang.String NewUsername, java.lang.String Password, java.lang.String RealName, java.lang.String Email, java.lang.String Notes, boolean ForceChangePassword) Adds a new user with the provided attributes by cloning the user with the username provided in OrigUsername.
MOVEitMessageInfo	composeNewMessage() Returns a new MOVEitMessageInfo object with a state of "Pending".
MOVEitMessageInfo	composeNewMessage(java.lang.String Recipient) Returns a new MOVEitMessageInfo object with a state of "Pending".
MOVEitMessageInfo	composeNewMessage(java.lang.String Recipient, java.lang.String Subject) Returns a new MOVEitMessageInfo object with a state of "Pending".
MOVEitMessageInfo	composeNewMessage(java.lang.String Recipient, java.lang.String Subject, java.lang.String Body) Returns a new MOVEitMessageInfo object with a state of "Pending".
java.lang.String	copyFile(java.lang.String MOVEitPathFrom, java.lang.String MOVEitFolderTo) Copies a file from the specified path to the specified folder.
java.lang.String	copyFileAndConvert(java.lang.String MOVEitPathFrom, java.lang.String MOVEitFolderTo, int MOVEitFormat) Copies a webpost converted into either a CSV file or an XML file from the specified path to the specified folder.
boolean	deleteFile(java.lang.String MOVEitPath) Deletes the file with the provided path from MOVEit Transfer.
boolean	deleteFileById(java.lang.String fileId) Deletes the file with the provided file ID from MOVEit Transfer.
boolean	deleteFolder(java.lang.String MOVEitFolder) Deletes an existing MOVEit Transfer folder with the given path.
boolean	deleteGroup(java.lang.String GroupName) Deletes the group specified by GroupName.
boolean	deleteGroupFolderAccess(java.lang.String MOVEitFolder, java.lang.String GroupName) Denies the specified group access to this folder.
boolean	deleteGroupFromGroupAddressBook(java.lang.String OwnerGroup, java.lang.String GroupName) Deletes a group from the specified owner group's address book.
boolean	deleteGroupFromUserAddressBook(java.lang.String Owner, java.lang.String GroupName) Deletes a group from the specified owner's address book.
boolean	deleteMailbox(java.lang.String MOVEitMailbox) Deletes an existing MOVEit Transfer mailbox with the given path for the current user.
boolean	deleteMessage(java.lang.String MessageID) Deletes the message from all mailboxes owned by the current user.
boolean	deleteMessage(java.lang.String MessageID, java.lang.String MOVEitMailbox) Deletes the message from the specified mailbox.
boolean	deleteMessage(java.lang.String MessageID, java.lang.String MOVEitMailbox, java.lang.String MailboxOwner) Deletes the message from the specified mailbox.
boolean	deleteUser(java.lang.String Username) Deletes the user specified by Username.
boolean	deleteUserFolderAccess(java.lang.String MOVEitFolder, java.lang.String Username)
boolean	deleteUserFromGroupAddressBook(java.lang.String OwnerGroup, java.lang.String Username) Deletes a user from the specified owner group's address book.
boolean	deleteUserFromUserAddressBook(java.lang.String Owner, java.lang.String Username) Deletes a user from the specified owner's address book.
boolean	downloadFile(java.lang.String MOVEitPath, java.lang.String LocalFolder) Downloads the selected file from the MOVEit Transfer system into the specified local folder.
boolean	downloadFile(java.lang.String MOVEitPath, java.lang.String LocalFolder, java.lang.String MailboxOwner) Downloads the selected file from the MOVEit Transfer system into the specified local folder.
boolean	downloadFileAs(java.lang.String MOVEitPath, java.lang.String LocalPath) Downloads the selected file from the MOVEit Transfer system into a file with the specified full path.
boolean	downloadFileAs(java.lang.String MOVEitPath, java.lang.String LocalPath, java.lang.String MailboxOwner) Downloads the selected file from the MOVEit Transfer system into a file with the specified full path.
byte[]	downloadFileToBuffer(java.lang.String MOVEitPath) Downloads the selected file from the MOVEit Transfer system and returns the contents.
byte[]	downloadFileToBuffer(java.lang.String MOVEitPath, java.lang.String MailboxOwner) Downloads the selected file from the MOVEit Transfer system and returns the contents.
boolean	downloadFileToStream(java.lang.String MOVEitPath, java.io.OutputStream out, boolean Trusted) Downloads the selected file from the MOVEit Transfer system to the provided OutputStream object.
boolean	downloadFileToStream(java.lang.String MOVEitPath, java.io.OutputStream out, boolean Trusted, java.lang.String MailboxOwner) Downloads the selected file from the MOVEit Transfer system to the provided OutputStream object.
int	errorCode() Returns the status code of the last action performed.
java.lang.String	errorDescription() Returns a description of the last action performed.
boolean	fileExists(java.lang.String MOVEitPath) Returns TRUE if the specified file exists and the currently authorized user may access it; FALSE otherwise.
java.util.HashMap	findFiles(java.lang.String Mask) Returns a HashMap object made up of MOVEitFileInfo objects which contain information about files in any available folder whose names match the specified mask.
java.util.HashMap	findFilesInFolder(java.lang.String Mask, java.lang.String MOVEitFolder) Returns a HashMap object made up of MOVEitFileInfo objects which contain information about files whose names match the specified mask, and which are located in folders whose MOVEitFolder path is or begins with the provided MOVEitFolder.
java.util.HashMap	findNewFiles(java.lang.String Mask) Returns a HashMap object made up of MOVEitFileInfo objects which contain information about NEW files in any available folder whose names match the specified mask.
java.util.HashMap	findNewFilesInFolder(java.lang.String Mask, java.lang.String MOVEitFolder) Returns a HashMap object made up of MOVEitFileInfo objects which contain information about NEW files whose names match the specified mask, and which are located in folders whose MOVEitFolder path is or begins with the provided MOVEitFolder.
java.lang.String	folderAccessForUser(java.lang.String MOVEitFolder) Returns a string containing a PermissionString describing the permissions the current authorized user enjoys on this folder.
MOVEitFileInfo	getFileDetails(java.lang.String MOVEitPath) Returns a MOVEitFileInfo object containing information about the specified file.
MOVEitFolderInfo	getFolderDetails(java.lang.String MOVEitFolder) Returns a MOVEitFolderInfo object containing information about the specified folder.
MOVEitUserGroupInfo	getGroupDetails(java.lang.String GroupName) Returns a MOVEitUserGroupInfo object containing information about the specified group.
MOVEitFolderInfo	getHomeFolder(java.lang.String Username) Returns a MOVEitFolderInfo object which corresponds to the named user's home folder.
com.stdnet.moveit.api.MOVEitSAMLInfo	getOrgSAMLInfo() Gets SAML signon information for the default organization of the MOVEit Transfer host.
com.stdnet.moveit.api.MOVEitSAMLInfo	getOrgSAMLInfo(java.lang.String OrgID) Gets SAML signon information for the specified organization of the MOVEit Transfer host.
MOVEitUserInfo	getSendAsUserInfo(java.lang.String userid) Returns a MOVEitUserInfo object describing the specified user whom the current user is able to send messages on behalf of.
MOVEitFolderInfo	getTargetFolder(java.lang.String MOVEitFolder) Returns a MOVEitFolderInfo object which corresponds to the target folder of the specified virtual folder.
MOVEitUserInfo	getUserDetails(java.lang.String Username) Returns a MOVEitUserInfo object containing information about the specified user.
java.lang.String	homeFolder() The full path of this user's home folder.
int	homeFolderID() The ID of this user's home folder.
java.lang.String	host() The hostname or IP address of the remote MOVEit Transfer server.
java.lang.String	host(java.lang.String sHost) The hostname or IP address of the remote MOVEit Transfer server.
java.lang.String	httpProxyHost() The proxy hostname to use for HTTP requests.
void	httpProxyHost(java.lang.String host) The proxy hostname to use for HTTP requests.
java.lang.String	httpProxyPassword() The proxy password to use for HTTP requests.
void	httpProxyPassword(java.lang.String password) The proxy password to use for HTTP requests.
int	httpProxyPort() The proxy port to use for HTTP requests.
void	httpProxyPort(int port) The proxy port to use for HTTP requests.
java.lang.String	httpProxyUser() The proxy username to use for HTTP requests.
void	httpProxyUser(java.lang.String user) The proxy username to use for HTTP requests.
java.lang.String	httpsProxyHost() The proxy hostname to use for HTTPS requests.
void	httpsProxyHost(java.lang.String host) The proxy hostname to use for HTTPS requests.
java.lang.String	httpsProxyPassword() The proxy password to use for HTTPS requests.
void	httpsProxyPassword(java.lang.String password) The proxy password to use for HTTPS requests.
int	httpsProxyPort() The proxy port to use for HTTPS requests.
void	httpsProxyPort(int port) The proxy port to use for HTTPS requests.
java.lang.String	httpsProxyUser() The proxy username to use for HTTPS requests.
void	httpsProxyUser(java.lang.String user) The proxy username to use for HTTPS requests.
boolean	ignoreCertProbs() Tells MOVEit Transfer API to ignore certificate problems such as those caused by "test certificates" (bad CA) and connections by IP address rather than by host (name mismatch).
boolean	ignoreCertProbs(boolean bIgnoreCertProbs) Tells MOVEit Transfer API to ignore certificate problems such as those caused by "test certificates" (bad CA) and connections by IP address rather than by host (name mismatch).
boolean	importUserCertFromBuffer(java.lang.String Username, java.lang.String Buffer) Imports an SSL public certificate to a user's certificate store.
boolean	importUserCertFromFile(java.lang.String Username, java.lang.String Filepath) Imports an SSL public certificate to a user's certificate store from a file.
boolean	importUserKeyFromBuffer(java.lang.String Username, java.lang.String Buffer) Imports an SSH public key to a user's certificate store.
boolean	importUserKeyFromFile(java.lang.String Username, java.lang.String Filepath) Imports an SSH public key to a user's certificate store from a file.
java.util.HashMap	listFilesInFolder(java.lang.String MOVEitFolder) Returns a HashMap object made up of MOVEitFileInfo objects which contain information about files in the specified folder.
java.util.HashMap	listFilesInFolderWithMask(java.lang.String MOVEitFolder, java.lang.String Mask) Returns a HashMap object made up of MOVEitFileInfo objects which contain information about files in the specified folder whose names match the specified mask.
java.util.HashMap	listFolderAccess(java.lang.String MOVEitFolder) Returns a HashMap object containing string pairs of users and groups with access to this folder.
java.util.HashMap	listFolders() Returns a HashMap object made up of MOVEitFolderInfo objects which contain information about all folders the currently authorized user can access.
java.util.HashMap	listFolders(java.lang.String OrgID) Returns a HashMap object made up of MOVEitFolderInfo objects which contain information about all folders the currently authorized user can access.
java.util.HashMap	listFoldersInFolder(java.lang.String MOVEitFolder) Returns a HashMap object made up of MOVEitFolderInfo objects which contain information about subfolders of the specified folder.
java.util.HashMap	listGroupMembers(java.lang.String GroupName) Returns a HashMap object containing a list of all users in the given group.
java.util.HashMap	listGroups() Returns a HashMap object containing a list of all group names in this organization.
java.util.HashMap	listGroups(java.lang.String OrgID) Returns a HashMap object containing a list of all group names in the specified organization.
java.util.HashMap	listMailboxes() Returns a HashMap object made up of MOVEitFolderInfo objects which contain information about all mailboxes owned by the current user.
java.util.List<java.util.HashMap>	listMailboxesAndShared() Returns a List of HashMap objects that contain information about all mailboxes owned by the current user AND all mailboxes owned by users whom the current user has Shared Mailbox access to.
java.util.HashMap	listMessages(java.lang.String MOVEitMailbox) Returns as HashMap object whose KEYS contain a list of Message IDs of all messages available to the current user in the provided MOVEit Transfer mailbox and whose VALUES contain MOVEitMessageInfo objects describing those messages.
java.util.HashMap	listMessages(java.lang.String MOVEitMailbox, java.lang.String MailboxOwner) Returns as HashMap object whose KEYS contain a list of Message IDs of all messages available to the current user in the provided MOVEit Transfer mailbox and whose VALUES contain MOVEitMessageInfo objects describing those messages.
java.util.HashMap	listNewMessages() Returns a HashMap object whose KEYS contain a list of Message IDs of all new (unread) messages available to the current user, but only those messages that exist in mailboxes owned by the current user.
java.util.List<java.util.HashMap>	listNewMessagesAndShared() Returns a List of HashMap objects that contain information about all new (unread) messages available to the current user, including messages that are new for users that the current user has Shared Mailbox access to.
java.util.List<MOVEitUserInfo>	listSendAsUsers() Returns a list of MOVEitUserInfo objects describing all the users that the current user is able to send messages on behalf of, including the current user themselves.
java.util.HashMap	listUserAddressBook(java.lang.String Username) Returns a HashMap object containing the contents of the listed user's address book.
java.util.HashMap	listUserCertsKeys(java.lang.String Username) Lists the SSL certificates and SSH keys in a user's store.
java.util.HashMap	listUserGroups(java.lang.String Username) Returns a HashMap object containing a list of group names to which this user belongs.
java.util.HashMap	listUserGroupsNot(java.lang.String Username) Returns a HashMap object containing a list of group names to which this user DOES NOT belong.
java.util.HashMap	listUsers() Returns a HashMap object containing a list of users in this organization.
java.util.HashMap	listUsers(java.lang.String OrgID) Returns a HashMap object containing a list of users in this organization.
java.util.HashMap	listUsersAdvanced(java.lang.String page, int entriesPerPage) Returns a HashMap object containing a list of users in this organization.
java.util.HashMap	listUsersAdvanced(java.lang.String page, int entriesPerPage, java.lang.String permissionFilter, java.lang.String statusFilter, java.lang.String groupFilter, java.lang.String searchFilter, java.lang.String searchString) Returns a HashMap object containing a list of users in this organization.
java.util.HashMap	listUsersAdvanced(java.lang.String page, int entriesPerPage, java.lang.String permissionFilter, java.lang.String statusFilter, java.lang.String groupFilter, java.lang.String searchFilter, java.lang.String searchString, java.lang.String orgID) Returns a HashMap object containing a list of users in this organization.
java.util.HashMap	lookupUserAddressBook(java.lang.String Value, java.lang.String Type) Given a piece of identifying information, determines whether any users or groups matching the search string are members of the current user's address book.
java.util.HashMap	lookupUserAddressBook(java.lang.String Value, java.lang.String Type, java.lang.String Owner) Given a piece of identifying information, determines whether any users or groups matching the search string are members of the specified user's address book MOVEit Transfer will attempt to match the search string against the Username, RealName EmailAddress, and UserID fields for a "user" lookup, or the GroupName and GroupID fields for a "group" lookup.
java.lang.String	makeRandomUserPassword(java.lang.String Username) Returns a randomly generated password that is acceptable by the password length and strength standards of the currently signed on user's organization.
boolean	moveFile(java.lang.String MOVEitPathFrom, java.lang.String MOVEitFolderTo) Moves a file from the specified path to the specified folder.
boolean	moveFileAndConvert(java.lang.String MOVEitPathFrom, java.lang.String MOVEitFolderTo, int MOVEitFormat) Moves a webpost converted into either a CSV file or an XML file from the specified path to the specified folder.
boolean	moveMessage(java.lang.String MessageID, java.lang.String ToMailbox) Moves the message to the provided destination mailbox.
boolean	moveMessage(java.lang.String MessageID, java.lang.String FromMailbox, java.lang.String ToMailbox) Moves the message from the provided source mailbox to the provided destination mailbox.
boolean	moveMessage(java.lang.String MessageID, java.lang.String FromMailbox, java.lang.String ToMailbox, java.lang.String MailboxOwner) Moves the message from the provided source mailbox to the provided destination mailbox.
int	orgID() The Organization ID of the current user.
java.lang.String	orgName() The Organization Name of the current user.
org.w3c.dom.Node	payload() The raw XML payload returned by the MOVEit Transfer server for the last transaction.
int	port() The port used by the HTTP or HTTPS service on the remote MOVEit Transfer server.
int	port(int iPort) The port used by the HTTP or HTTPS service on the remote MOVEit Transfer server.
java.lang.String	rawResponse() Returns the raw data returned from the MOVEit Transfer host in response to the most recent transaction.
MOVEitMessageInfo	readMessage(java.lang.String MessageID) Returns a MOVEitMessageInfo object describing the message identified by the given ID.
MOVEitMessageInfo	readMessage(java.lang.String MessageID, java.lang.String MOVEitMailbox) Returns a MOVEitMessageInfo object describing the message identified by the given ID.
MOVEitMessageInfo	readMessage(java.lang.String MessageID, java.lang.String MOVEitMailbox, java.lang.String MailboxOwner) Returns a MOVEitMessageInfo object describing the message identified by the given ID.
boolean	removeUserCertKey(java.lang.String Username, int CertKeyID) Removes an SSL certificate or SSH key from a user's store.
boolean	removeUserFromGroup(java.lang.String Username, java.lang.String GroupName) Removes the specified user from the specified group.
boolean	renameFile(java.lang.String MOVEitPath, java.lang.String NewName) Renames an existing MOVEit Transfer file with the given path.
boolean	renameFolder(java.lang.String MOVEitFolder, java.lang.String NewName) Renames an existing MOVEit Transfer folder with the given path.
boolean	renameMailbox(java.lang.String MOVEitMailbox, java.lang.String NewName) Renames an existing MOVEit Transfer mailbox with the given path for the current user.
boolean	runCustomReport(java.lang.String fields, java.lang.String tables, java.lang.String criteria, java.lang.String grouping, java.lang.String order, java.lang.String limit, java.lang.String OutputFormat, java.lang.String LocalPath) Runs a custom report with the specified custom options and output format and saves it to the path specified by LocalPath.
boolean	runReport(java.lang.String ReportName, java.lang.String LocalPath) Runs the report specified by ReportName and saves it to the path specified by LocalPath.
java.lang.String	scriptPath() Used only when MOVEit Transfer has been installed into a subdirectory of an existing webserver, this property indicates what that subdirectory is.
java.lang.String	scriptPath(java.lang.String sScriptPath) Used only when MOVEit Transfer has been installed into a subdirectory of an existing webserver, this property indicates what that subdirectory is.
boolean	secure() Indicates whether to use unencrypted HTTP (if FALSE) or encrypted HTTPS (if TRUE) for all communications to MOVEit Transfer.
boolean	secure(boolean bSecure) Indicates whether to use unencrypted HTTP (if FALSE) or encrypted HTTPS (if TRUE) for all communications to MOVEit Transfer.
boolean	sendMessage(MOVEitMessageInfo oMsg) Given a MOVEitMessageInfo object describing a message to be sent, sends the message to the MOVEit Transfer server on behalf of the configured "From" user.
boolean	sendMessage(MOVEitMessageInfo oMsg, boolean bSendToUnregRecip) Given a MOVEitMessageInfo object describing a message to be sent, sends the message to the MOVEit Transfer server on behalf of the configured "From" user.
java.lang.String	sessionCookie() Returns the session cookie of the current session, if the API instance is signed on to a MOVEit Transfer server.
java.lang.String	sessionID() Returns the session ID of the current session, if the API instance is signed on to a MOVEit Transfer server.
boolean	signoff() Signs off the current user.
boolean	signon(java.lang.String Username, java.lang.String Password) Given a username and password, returns TRUE if signon is successful, FALSE otherwise.
boolean	signon(java.lang.String Username, java.lang.String Password, java.lang.String ActAsIP) Given a username and password, returns TRUE if signon is successful, FALSE otherwise.
boolean	signonWithSAMLAssertion(org.w3c.dom.Document SAMLAssertion) Signs on to a MOVEit Transfer host using a SAML assertion document, rather than a username and password.
boolean	signonWithSAMLAssertion(org.w3c.dom.Document SAMLAssertion, java.lang.String ActAsIP) Signs on to a MOVEit Transfer host using a SAML assertion document, rather than a username and password.
int	statusCode() Returns the status code of the last action performed.
java.lang.String	statusDescription() Returns a description of the last action performed.
boolean	technicalDebug() Returns current debug flag.
boolean	technicalDebug(boolean bDebug) Sets and returns debug flag.
java.lang.String	uploadFile(java.lang.String LocalPath, java.lang.String MOVEitFolder) Uploads the selected file into the specified MOVEit Transfer folder.
java.lang.String	uploadFile(java.lang.String LocalPath, java.lang.String MOVEitFolder, java.lang.String Notes) Uploads the selected file into the specified MOVEit Transfer folder.
java.lang.String	uploadFileAs(java.lang.String LocalPath, java.lang.String MOVEitPath) Uploads the selected file into the specified MOVEit Transfer folder.
java.lang.String	uploadFileAs(java.lang.String LocalPath, java.lang.String MOVEitPath, java.lang.String Notes) Uploads the selected file into the specified MOVEit Transfer folder.
java.lang.String	uploadFileFromBuffer(byte[] Buffer, java.lang.String MOVEitPath) Uploads the selected file to MOVEit Transfer from the specified buffer.
java.lang.String	uploadFileFromBuffer(byte[] Buffer, java.lang.String MOVEitPath, java.lang.String Notes) Uploads the selected file to MOVEit Transfer from the specified buffer.
java.lang.String	uploadFileFromStream(java.io.InputStream in, long inLen, java.lang.String MOVEitPath, boolean Trusted) Uploads data from the specified stream to the selected file on MOVEit Transfer.
java.lang.String	uploadFileFromStream(java.io.InputStream in, long inLen, java.lang.String MOVEitPath, java.lang.String Notes, boolean Trusted) Uploads data from the specified stream to the selected file on MOVEit Transfer.
java.lang.String	uploadFileFromStream(java.io.InputStream in, java.lang.String MOVEitPath, boolean Trusted) Uploads data from the specified stream to the selected file on MOVEit Transfer.
java.lang.String	uploadFileFromStream(java.io.InputStream in, java.lang.String MOVEitPath, java.lang.String Notes, boolean Trusted) Uploads data from the specified stream to the selected file on MOVEit Transfer.
boolean	useProxy() Indicates whether proxy settings should be used.
void	useProxy(boolean bUseProxy) Indicates whether proxy settings should be used.
java.lang.String	userID() Returns the ID of the currently signed on user.
int	userListCount() Returns the total number of users available via the most recent listUsers or listUsersAdvanced function call.
java.lang.String	username() Returns the Username of the currently signed on user.
java.lang.String	userRealname() Returns the Realname of the currently signed on user.
java.lang.String	version() Returns the version of MOVEit Transfer API Java.
java.lang.String	welcomeMessage()

Methods inherited from class com.stdnet.moveit.api.ClientBase

actualDestFolderID, certNotTrusted, csrfToken, dlpCheckedLast, dlpViolation, do_file_download_fh, do_file_download_fh, do_file_download_stream, do_file_download_stream, do_file_upload_fh, do_file_upload_fh, do_file_upload_stream, do_upload_zipfile, downloadFileByID, downloadFileByID, folder_add_by_path, get_header_value, get_header_value, getFinalCompressionRatio, getSkippedBytesSoFar, getTransferredAndSkippedBytesSoFar, incTotalBytesSkippedAllFiles, javaEnvironment, javaEnvironment, setAgent, setCookie, setMachineURL, setProxySettings, totalBytesSoFar, totalBytesSoFar, totalBytesToXfer, totalBytesToXfer, totalRawBytes, useCompressionDownload, useCompressionDownload, useCompressionUpload, useCompressionUpload, useNonLumpHashMode, useNonLumpHashMode, virusCheckedLast

Methods inherited from class java.lang.Object

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

Constructor Detail

Client

public Client()

Client

public Client(java.lang.String AuthCode)

Method Detail

version

public java.lang.String version()

Returns the version of MOVEit Transfer API Java.

Returns:

the version as a string; e.g., "3.1.5"

copyFile

public java.lang.String copyFile(java.lang.String MOVEitPathFrom,
                                 java.lang.String MOVEitFolderTo)

Copies a file from the specified path to the specified folder. Returns the File ID of the new file if successful, 0 otherwise.

Parameters:

MOVEitPathFrom - path or ID of the original file on the MOVEit Transfer host

MOVEitFolderTo - path or ID of the folder on the MOVEit Transfer host to copy the original file to

Returns:

if successful, the ID of the newly created file, otherwise "0"

copyFileAndConvert

public java.lang.String copyFileAndConvert(java.lang.String MOVEitPathFrom,
                                           java.lang.String MOVEitFolderTo,
                                           int MOVEitFormat)

Copies a webpost converted into either a CSV file or an XML file from the specified path to the specified folder. Returns the File ID of the new file if successful, 0 otherwise.

Parameters:

MOVEitPathFrom - path or ID of the original file on the MOVEit Transfer host

MOVEitFolderTo - path or ID of the folder on the MOVEit Transfer host to copy the original file to

MOVEitFormat - format code of the format to convert the original file to. Should be FormatCSV or FormatXML

Returns:

if successful, the ID of the newly created file, otherwise "0"

deleteFile

public boolean deleteFile(java.lang.String MOVEitPath)

Deletes the file with the provided path from MOVEit Transfer. Returns TRUE if successful; FALSE otherwise.

Parameters:

MOVEitPath - path or ID of the file on the MOVEit Transfer host to delete

Returns:

true if successful, false otherwise

deleteFileById

public boolean deleteFileById(java.lang.String fileId)

Deletes the file with the provided file ID from MOVEit Transfer. Returns TRUE if successful; FALSE otherwise.

Parameters:

fileId - ID of the file on the MOVEit Transfer host to delete

Returns:

true if successful, false otherwise

downloadFile

public boolean downloadFile(java.lang.String MOVEitPath,
                            java.lang.String LocalFolder,
                            java.lang.String MailboxOwner)

Downloads the selected file from the MOVEit Transfer system into the specified local folder. If a file of the same name already exists in the local folder, it will be overwritten. (Use this function if you want to download files from MOVEit Transfer without renaming them.) If MOVEitPath is message attachment ID, the attachment is downloaded on behalf of the specific mailbox owner. Returns TRUE if successful; FALSE otherwise.

NOTE: During the file download process, the file data is stored to a temporary file (the file name with .tmp appended). When the download is complete, the temporary file is renamed to the correct filename. If the download is interrupted, the temporary file will remain. If this function finds a temporary copy of the downloaded file, it will automatically resume the download, copying only the data needed to complete the transfer from the MOVEit Transfer server. This keeps API from having to start large dowloads again from the beginning if a download is interrupted.

NOTE: Webpost files do not have names, so if this method is used to download a webpost (by using the webpost file ID as the MOVEitPath argument), the file will be downloaded with the constructed name "webpost_[TrackingID]".

Parameters:

MOVEitPath - path or ID of the file on the MOVEit Transfer host to download

LocalFolder - path of the folder on the local filesystem to save the file to

MailboxOwner - user ID of the mailbox owner whom we are downloading the attachment on behalf of

Returns:

true if successful, false otherwise

downloadFile

public boolean downloadFile(java.lang.String MOVEitPath,
                            java.lang.String LocalFolder)

Downloads the selected file from the MOVEit Transfer system into the specified local folder. If a file of the same name already exists in the local folder, it will be overwritten. (Use this function if you want to download files from MOVEit Transfer without renaming them.) If MOVEitPath is message attachment ID, the attachment is downloaded on behalf of the current user. Returns TRUE if successful; FALSE otherwise.

NOTE: During the file download process, the file data is stored to a temporary file (the file name with .tmp appended). When the download is complete, the temporary file is renamed to the correct filename. If the download is interrupted, the temporary file will remain. If this function finds a temporary copy of the downloaded file, it will automatically resume the download, copying only the data needed to complete the transfer from the MOVEit Transfer server. This keeps API from having to start large dowloads again from the beginning if a download is interrupted.

NOTE: Webpost files do not have names, so if this method is used to download a webpost (by using the webpost file ID as the MOVEitPath argument), the file will be downloaded with the constructed name "webpost_[TrackingID]".

Parameters:

MOVEitPath - path or ID of the file on the MOVEit Transfer host to download

LocalFolder - path of the folder on the local filesystem to save the file to

Returns:

true if successful, false otherwise

downloadFileAs

public boolean downloadFileAs(java.lang.String MOVEitPath,
                              java.lang.String LocalPath,
                              java.lang.String MailboxOwner)

Downloads the selected file from the MOVEit Transfer system into a file with the specified full path. If a file with the same local path already exists, it will be overwritten. (Use this function if you want to download files from MOVEit Transfer and rename them.) If MOVEitPath is message attachment ID, the attachment is downloaded on behalf of the specified mailbox owner. Returns TRUE if successful; FALSE otherwise.

NOTE: During the file download process, the file data is stored to a temporary file (the file name with .tmp appended). When the download is complete, the temporary file is renamed to the correct filename. If the download is interrupted, the temporary file will remain. If this function finds a temporary copy of the downloaded file, it will automatically resume the download, copying only the data needed to complete the transfer from the MOVEit Transfer server. This keeps API from having to start large downloads again from the beginning if a download is interrupted.

Parameters:

MOVEitPath - path or ID of the file on the MOVEit Transfer host to download

LocalPath - path of the file on the local filesystem to save the file to

MailboxOwner - user ID of the mailbox owner whom we are downloading the attachment on behalf of

Returns:

true if successful, false otherwise

downloadFileAs

public boolean downloadFileAs(java.lang.String MOVEitPath,
                              java.lang.String LocalPath)

Downloads the selected file from the MOVEit Transfer system into a file with the specified full path. If a file with the same local path already exists, it will be overwritten. (Use this function if you want to download files from MOVEit Transfer and rename them.) If MOVEitPath is message attachment ID, the attachment is downloaded on behalf of the current user. Returns TRUE if successful; FALSE otherwise.

NOTE: During the file download process, the file data is stored to a temporary file (the file name with .tmp appended). When the download is complete, the temporary file is renamed to the correct filename. If the download is interrupted, the temporary file will remain. If this function finds a temporary copy of the downloaded file, it will automatically resume the download, copying only the data needed to complete the transfer from the MOVEit Transfer server. This keeps API from having to start large downloads again from the beginning if a download is interrupted.

Parameters:

MOVEitPath - path or ID of the file on the MOVEit Transfer host to download

LocalPath - path of the file on the local filesystem to save the file to

Returns:

true if successful, false otherwise

downloadFileToBuffer

public byte[] downloadFileToBuffer(java.lang.String MOVEitPath,
                                   java.lang.String MailboxOwner)

Downloads the selected file from the MOVEit Transfer system and returns the contents. If MOVEitPath is message attachment ID, the attachment is downloaded on behalf of the specified mailbox owner.

Parameters:

MOVEitPath - path or ID of the file on the MOVEit Transfer host to download

MailboxOwner - user ID of the mailbox owner whom we are downloading the attachment on behalf of

Returns:

byte array containing the contents of the downloaded file if successful, null otherwise

downloadFileToBuffer

public byte[] downloadFileToBuffer(java.lang.String MOVEitPath)

Downloads the selected file from the MOVEit Transfer system and returns the contents. If MOVEitPath is message attachment ID, the attachment is downloaded on behalf of the current user.

Parameters:

MOVEitPath - path or ID of the file on the MOVEit Transfer host to download

Returns:

byte array containing the contents of the downloaded file if successful, null otherwise

downloadFileToStream

public boolean downloadFileToStream(java.lang.String MOVEitPath,
                                    java.io.OutputStream out,
                                    boolean Trusted,
                                    java.lang.String MailboxOwner)

Downloads the selected file from the MOVEit Transfer system to the provided OutputStream object. If MOVEitPath is message attachment ID, the attachment is downloaded on behalf of the specified mailbox owner.

Set the Trusted argument to true if the stream being written to is a trusted destination, in which case MOVEit Transfer will log the transfer as integrity checked if successful. Otherwise, if the stream is not a trusted destination, the transfer will not be logged as integrity checked.

Parameters:

MOVEitPath - path or ID of the file on the MOVEit Transfer host to download

out - OutputStream object to write downloaded data to

Trusted - whether the stream being downloaded to is trusted

MailboxOwner - user ID of the mailbox owner whom we are downloading the attachment on behalf of

Returns:

true if successful, false otherwise

downloadFileToStream

public boolean downloadFileToStream(java.lang.String MOVEitPath,
                                    java.io.OutputStream out,
                                    boolean Trusted)

Downloads the selected file from the MOVEit Transfer system to the provided OutputStream object. If MOVEitPath is message attachment ID, the attachment is downloaded on behalf of the current user.

Set the Trusted argument to true if the stream being written to is a trusted destination, in which case MOVEit Transfer will log the transfer as integrity checked if successful. Otherwise, if the stream is not a trusted destination, the transfer will not be logged as integrity checked.

Parameters:

MOVEitPath - path or ID of the file on the MOVEit Transfer host to download

out - OutputStream object to write downloaded data to

Trusted - whether the stream being downloaded to is trusted

Returns:

true if successful, false otherwise

fileExists

public boolean fileExists(java.lang.String MOVEitPath)

Returns TRUE if the specified file exists and the currently authorized user may access it; FALSE otherwise.

Parameters:

MOVEitPath - path or ID of the file on the MOVEit Transfer host

Returns:

true if the file exists, false otherwise

getFileDetails

public MOVEitFileInfo getFileDetails(java.lang.String MOVEitPath)

Returns a MOVEitFileInfo object containing information about the specified file. If the file does not exist or the currently authorized user is not permitted to access it, then null is returned instead.

Parameters:

MOVEitPath - path or ID of the file on the MOVEit Transfer host

Returns:

MOVEitFileInfo object containing information about the file if successful, null otherwise

See Also:

MOVEitFileInfo

moveFile

public boolean moveFile(java.lang.String MOVEitPathFrom,
                        java.lang.String MOVEitFolderTo)

Moves a file from the specified path to the specified folder. Returns TRUE if successful; FALSE otherwise.

Parameters:

MOVEitPathFrom - path or ID of the original file on the MOVEit Transfer host

MOVEitFolderTo - path or ID of the folder on the MOVEit Transfer host to move the original file to

Returns:

true if successful, false otherwise

moveFileAndConvert

public boolean moveFileAndConvert(java.lang.String MOVEitPathFrom,
                                  java.lang.String MOVEitFolderTo,
                                  int MOVEitFormat)

Moves a webpost converted into either a CSV file or an XML file from the specified path to the specified folder. Returns TRUE if successful; FALSE otherwise.

Parameters:

MOVEitPathFrom - path or ID of the original file on the MOVEit Transfer host

MOVEitFolderTo - path or ID of the folder on the MOVEit Transfer host to move the original file to

MOVEitFormat - format code of the format to convert the original file to. Should be FormatCSV or FormatXML

Returns:

true if successful, false otherwise

renameFile

public boolean renameFile(java.lang.String MOVEitPath,
                          java.lang.String NewName)

Renames an existing MOVEit Transfer file with the given path. Returns TRUE if successful; FALSE otherwise.

Parameters:

MOVEitPath - path or ID of the file on the MOVEit Transfer host to rename

NewName - new name to apply to the file

Returns:

true if successful, false otherwise

uploadFile

public java.lang.String uploadFile(java.lang.String LocalPath,
                                   java.lang.String MOVEitFolder,
                                   java.lang.String Notes)

Uploads the selected file into the specified MOVEit Transfer folder. If a file of the same name already exists in the MOVEit Transfer folder, it may not be overwritten; the exact behavior of this function depends on the value of the "Allow Overwrite" flag set on that particular folder. (Use this function if you want to upload files to MOVEit Transfer without renaming them.) Returns the FileID of the new file if successful; 0 otherwise.

If a Partial file of the same name exists in the MOVEit Transfer folder, this function will automatically execute a resumed upload, copying only the file data required to complete the upload. This keeps API from having to start large uploads again from the beginning if an upload is interrupted.

Parameters:

LocalPath - path of the file on the local filesystem to upload to the MOVEit Transfer host

MOVEitFolder - path or ID of the folder on the MOVEit Transfer host to upload the file to

Notes - any notes to be included with the file

Returns:

ID of the newly uploaded file if successful, "0" otherwise

uploadFile

public java.lang.String uploadFile(java.lang.String LocalPath,
                                   java.lang.String MOVEitFolder)

Uploads the selected file into the specified MOVEit Transfer folder. If a file of the same name already exists in the MOVEit Transfer folder, it may not be overwritten; the exact behavior of this function depends on the value of the "Allow Overwrite" flag set on that particular folder. (Use this function if you want to upload files to MOVEit Transfer without renaming them.) Returns the FileID of the new file if successful; 0 otherwise.

If a Partial file of the same name exists in the MOVEit Transfer folder, this function will automatically execute a resumed upload, copying only the file data required to complete the upload. This keeps API from having to start large uploads again from the beginning if an upload is interrupted.

Parameters:

LocalPath - path of the file on the local filesystem to upload to the MOVEit Transfer host

MOVEitFolder - path or ID of the folder on the MOVEit Transfer host to upload the file to

Returns:

ID of the newly uploaded file if successful, "0" otherwise

uploadFileAs

public java.lang.String uploadFileAs(java.lang.String LocalPath,
                                     java.lang.String MOVEitPath,
                                     java.lang.String Notes)

Uploads the selected file into the specified MOVEit Transfer folder. If a file of the same name already exists in the MOVEit Transfer folder, it may not be overwritten; the exact behavior of this function depends on the value of the "Allow Overwrite" flag set on that particular folder. (Use this function if you want to upload files to MOVEit Transfer and rename them.) Returns the FileID of the new file if successful; 0 otherwise.

If a Partial file of the same name exists in the MOVEit Transfer folder, this function will automatically execute a resumed upload, copying only the file data required to complete the upload. This keeps API from having to start large uploads again from the beginning if an upload is interrupted.

Parameters:

LocalPath - path of the file on the local filesystem to upload to the MOVEit Transfer host

MOVEitPath - path or ID of the file on the MOVEit Transfer host to upload to

Notes - any notes to be included with the file

Returns:

ID of the newly uploaded file if successful, "0" otherwise

uploadFileAs

public java.lang.String uploadFileAs(java.lang.String LocalPath,
                                     java.lang.String MOVEitPath)

Uploads the selected file into the specified MOVEit Transfer folder. If a file of the same name already exists in the MOVEit Transfer folder, it may not be overwritten; the exact behavior of this function depends on the value of the "Allow Overwrite" flag set on that particular folder. (Use this function if you want to upload files to MOVEit Transfer and rename them.) Returns the FileID of the new file if successful; 0 otherwise.

If a Partial file of the same name exists in the MOVEit Transfer folder, this function will automatically execute a resumed upload, copying only the file data required to complete the upload. This keeps API from having to start large uploads again from the beginning if an upload is interrupted.

Parameters:

LocalPath - path of the file on the local filesystem to upload to the MOVEit Transfer host

MOVEitPath - path or ID of the file on the MOVEit Transfer host to upload to

Returns:

ID of the newly uploaded file if successful, "0" otherwise

uploadFileFromBuffer

public java.lang.String uploadFileFromBuffer(byte[] Buffer,
                                             java.lang.String MOVEitPath,
                                             java.lang.String Notes)

Uploads the selected file to MOVEit Transfer from the specified buffer. Returns the FileID of the new file if successful; 0 otherwise.

Parameters:

Buffer - byte array containing data to be uploaded to the MOVEit Transfer host

MOVEitPath - path or ID of the file on the MOVEit Transfer host to upload to

Notes - any notes to be included with the file

Returns:

ID of the newly uploaded file if successful, "0" otherwise

uploadFileFromBuffer

public java.lang.String uploadFileFromBuffer(byte[] Buffer,
                                             java.lang.String MOVEitPath)

Uploads the selected file to MOVEit Transfer from the specified buffer. Returns the FileID of the new file if successful; 0 otherwise.

Parameters:

Buffer - byte array containing data to be uploaded to the MOVEit Transfer host

MOVEitPath - path or ID of the file on the MOVEit Transfer host to upload to

Returns:

ID of the newly uploaded file if successful, "0" otherwise

uploadFileFromStream

public java.lang.String uploadFileFromStream(java.io.InputStream in,
                                             long inLen,
                                             java.lang.String MOVEitPath,
                                             java.lang.String Notes,
                                             boolean Trusted)

Uploads data from the specified stream to the selected file on MOVEit Transfer.

If length of data to transfer is not known, use uploadFileFromStream(InputStream, String, String, boolean).

Set the Trusted argument to true if the content in the stream is from a trusted source, in which case MOVEit Transfer will log the transfer as integrity checked if successful. Otherwise, if the content in the stream is not from a trusted source, the transfer will not be logged as integrity checked.

Parameters:

in - InputStream to read upload data from

inLen - Length of the data in the InputStream

MOVEitPath - path or ID of the file on the MOVEit Transfer host to upload to

Notes - any notes to be included with the file

Trusted - whether the stream being uploaded from is trusted

Returns:

ID of the newly uploaded file if successful, "0" otherwise

See Also:

uploadFileFromStream(InputStream, String, String, boolean)

uploadFileFromStream

public java.lang.String uploadFileFromStream(java.io.InputStream in,
                                             java.lang.String MOVEitPath,
                                             java.lang.String Notes,
                                             boolean Trusted)

Uploads data from the specified stream to the selected file on MOVEit Transfer.

If length of data to transfer is known, use uploadFileFromStream(InputStream, long, String, String, boolean).

Set the Trusted argument to true if the content in the stream is from a trusted source, in which case MOVEit Transfer will log the transfer as integrity checked if successful. Otherwise, if the content in the stream is not from a trusted source, the transfer will not be logged as integrity checked.

Parameters:

in - InputStream to read upload data from

MOVEitPath - path or ID of the file on the MOVEit Transfer host to upload to

Notes - any notes to be included with the file

Trusted - whether the stream being uploaded from is trusted

Returns:

ID of the newly uploaded file if successful, "0" otherwise

See Also:

uploadFileFromStream(InputStream, long, String, String, boolean)

uploadFileFromStream

public java.lang.String uploadFileFromStream(java.io.InputStream in,
                                             long inLen,
                                             java.lang.String MOVEitPath,
                                             boolean Trusted)

Uploads data from the specified stream to the selected file on MOVEit Transfer.

If length of data to transfer is not known, use uploadFileFromStream(InputStream, String, boolean).

Set the Trusted argument to true if the content in the stream is from a trusted source, in which case MOVEit Transfer will log the transfer as integrity checked if successful. Otherwise, if the content in the stream is not from a trusted source, the transfer will not be logged as integrity checked.

Parameters:

in - InputStream to read upload data from

inLen - Length of the data in the InputStream

MOVEitPath - path or ID of the file on the MOVEit Transfer host to upload to

Trusted - whether the stream being uploaded from is trusted

Returns:

ID of the newly uploaded file if successful, "0" otherwise

See Also:

uploadFileFromStream(InputStream, String, boolean)

uploadFileFromStream

public java.lang.String uploadFileFromStream(java.io.InputStream in,
                                             java.lang.String MOVEitPath,
                                             boolean Trusted)

Uploads data from the specified stream to the selected file on MOVEit Transfer.

If length of data to transfer is known, use uploadFileFromStream(InputStream, long, String, boolean).

Set the Trusted argument to true if the content in the stream is from a trusted source, in which case MOVEit Transfer will log the transfer as integrity checked if successful. Otherwise, if the content in the stream is not from a trusted source, the transfer will not be logged as integrity checked.

Parameters:

in - InputStream to read upload data from

MOVEitPath - path or ID of the file on the MOVEit Transfer host to upload to

Trusted - whether the stream being uploaded from is trusted

Returns:

ID of the newly uploaded file if successful, "0" otherwise

See Also:

uploadFileFromStream(InputStream, long, String, boolean)

addGroupFolderAccess

public boolean addGroupFolderAccess(java.lang.String MOVEitFolder,
                                    java.lang.String GroupName,
                                    java.lang.String PermString)

Grants the specified group access to this folder. Returns TRUE if successful, otherwise returns FALSE.

The PermString parameter should consist of one or more of the following letters:

• A = Admin
• E = Subfolders
• D = Delete
• L = List
• N = Notify
• R = Read
• W = Write

Parameters:

MOVEitFolder - path or ID of the folder on the MOVEit Transfer host to add a group permission to

GroupName - name or ID of group to add a permission for

PermString - permission string to apply to the folder

Returns:

true if successful, false otherwise

addUserFolderAccess

public boolean addUserFolderAccess(java.lang.String MOVEitFolder,
                                   java.lang.String Username,
                                   java.lang.String PermString)

Grants the specified user access to this folder. Returns TRUE if successful, otherwise returns FALSE.

The PermString parameter should consist of one or more of the following letters:

• A = Admin
• E = Subfolders
• D = Delete
• L = List
• N = Notify
• R = Read
• W = Write

Parameters:

MOVEitFolder - path or ID of the folder on the MOVEit Transfer host to add a user permission to

Username - username or ID of user to add a permission for

PermString - permission string to apply to the folder

Returns:

true if successful, false otherwise

deleteGroupFolderAccess

public boolean deleteGroupFolderAccess(java.lang.String MOVEitFolder,
                                       java.lang.String GroupName)

Denies the specified group access to this folder. Returns TRUE if successful, otherwise returns FALSE.

Parameters:

MOVEitFolder - path or ID of the folder on the MOVEit Transfer host to remove permissions to

GroupName - name or ID of the group to remove permissions of

Returns:

true if successful, false otherwise

deleteUserFolderAccess

public boolean deleteUserFolderAccess(java.lang.String MOVEitFolder,
                                      java.lang.String Username)

listFolderAccess

public java.util.HashMap listFolderAccess(java.lang.String MOVEitFolder)

Returns a HashMap object containing string pairs of users and groups with access to this folder. The KEY will be either a username or a group name (group names will be prefixed with the phrase "GROUP:"). The VALUE will be a PermissionString describing the permissions this user or group currently enjoys on this folder. Returns an empty HashMap if no access items are found or null if the currently authorized user is not permitted to get this information.

The permission strings will contain one or more of the following letters:

• A = Admin
• E = Subfolders
• D = Delete
• L = List
• N = Notify
• R = Read
• W = Write

Parameters:

MOVEitFolder - path or ID of the folder on the MOVEit Transfer host to list access rights for

Returns:

HashMap containing access rights list if allowed, null otherwise

folderAccessForUser

public java.lang.String folderAccessForUser(java.lang.String MOVEitFolder)

Returns a string containing a PermissionString describing the permissions the current authorized user enjoys on this folder. Returns an empty string if no access items are found, if the directory does not exist or if the currently authorized user is not permitted to get this information.

The permission string may contain zero or more of the following letters:

• A = Admin
• E = Subfolders
• D = Delete
• L = List
• N = Notify
• R = Read
• W = Write

Parameters:

MOVEitFolder - path or ID of the folder on the MOVEit Transfer host to list access rights for

Returns:

String containing PermissionString

addFolder

public int addFolder(java.lang.String MOVEitFolder,
                     int InheritPerms)

Makes a new MOVEit Transfer folder with the given path and assigns initial permissions based on the given method. The InheritPerms argument defines how permissions should initially be assigned on the new folder. The possible values are:

• 0 = Do not inherit permissions from parent, and do not copy current permissions from parent.
• 1 = Do not inherit permissions from parent, but copy current permissions from parent.
• 2 = Inherit permissions from parent. (Default)

Parameters:

MOVEitFolder - path of the folder to be added

InheritPerms - how to assign initial folder permissions

Returns:

ID of the newly created folder if successful, 0 otherwise

addFolder

public int addFolder(java.lang.String MOVEitFolder)

Makes a new MOVEit Transfer folder with the given path.

Parameters:

MOVEitFolder - path of the folder to be added

Returns:

ID of the newly created folder if successful, 0 otherwise

addVirtualFolder

public int addVirtualFolder(java.lang.String MOVEitFolder,
                            java.lang.String TargetMOVEitFolder,
                            int InheritPerms)

Makes a new MOVEit Transfer virtual folder with the given path targeting the given folder and assigns initial permissions based on the given method. The InheritPerms argument defines how permissions should initially be assigned on the new folder. The possible values are:

• 0 = Do not inherit permissions from parent, and do not copy current permissions from parent.
• 1 = Do not inherit permissions from parent, but copy current permissions from parent.
• 2 = Inherit permissions from parent. (Default)

Parameters:

MOVEitFolder - path of the virtual folder to be added

TargetMOVEitFolder - path of the virtual folder target

InheritPerms - how to assign initial folder permissions

Returns:

ID of the newly created virtual folder if successful, 0 otherwise

addVirtualFolder

public int addVirtualFolder(java.lang.String MOVEitFolder,
                            java.lang.String TargetMOVEitFolder)

Makes a new MOVEit Transfer virtual folder with the given path targeting the given folder.

Parameters:

MOVEitFolder - path of the virtual folder to be added

TargetMOVEitFolder - path of the virtual folder target

Returns:

ID of the newly created virtual folder if successful, 0 otherwise

changeFolderSetting

public boolean changeFolderSetting(java.lang.String MOVEitFolder,
                                   java.lang.String SettingName,
                                   java.lang.String NewValue)

Attempts to change a setting on the specified folder. Possible values for SettingName are listed below. Returns TRUE if successful; FALSE otherwise.

Setting Name	Allowed New Value
allowoverwrite	0 = no 1 = yes
cleantype	0 = never 2 = every cleantime days
cleantime	0-16000 (days)
filemaskrule	0 = allow all files except masks 1 = deny all files except masks
filemasks	comma-delimited list of filemasks (eg, *.txt,frog.*,sni???.ach)
newtime	0-16000 (days)
notedelrcptype	0 = none 16 = immediate
notenewfiletype	0 = none 3 = in a batch every notenewfiletime minutes 16 = immediate
notenewfiletime	0-16000 (minutes)
notenodownloadtype	0 = none 1 = every notenodownloadtime hours 2 = every notenodownloadtime days 3 = every notenodownloadtime minutes
noteupconfirmtype	0 = none 3 = in a batch every noteupconfirmtime minutes 16 = immediate
noteupconfirmtime	0-16000 (minutes)
parentinheritrights	0 = no 1 = yes
quota	0 = none 1-9,223,372,036,854,775,807 = quota size (in bytes)
subfoldercleantime	0-16000 (days)
targetfolder	MOVEitFolder (only used by virtual folders)
useuniquenames	0 = no 1 = yes

NOTE: Several of the above settings cannot be changed on a virtual folder. If attempted, an error will be returned. Instead, such settings should be changed on the virtual folder's target folder.

Parameters:

MOVEitFolder - path or ID of the folder on the MOVEit Transfer host to change a setting of

SettingName - name of the setting to change

NewValue - value to apply to the setting

Returns:

true if successful, false otherwise

deleteFolder

public boolean deleteFolder(java.lang.String MOVEitFolder)

Deletes an existing MOVEit Transfer folder with the given path. Returns TRUE if successful; FALSE otherwise.

Parameters:

MOVEitFolder - path or ID of the folder on the MOVEit Transfer host to delete

Returns:

true if successful, false otherwise

findFiles

public java.util.HashMap findFiles(java.lang.String Mask)

Returns a HashMap object made up of MOVEitFileInfo objects which contain information about files in any available folder whose names match the specified mask. (The KEYS will contain full file paths.) Returns an empty HashMap if no files are found.

Parameters:

Mask - file search mask

Returns:

HashMap containing search results

findFilesInFolder

public java.util.HashMap findFilesInFolder(java.lang.String Mask,
                                           java.lang.String MOVEitFolder)

Returns a HashMap object made up of MOVEitFileInfo objects which contain information about files whose names match the specified mask, and which are located in folders whose MOVEitFolder path is or begins with the provided MOVEitFolder. (This method can be used to search a tree of directories for files of a certain name.) (The KEYS will contain full file paths.) Returns an empty HashMap if no files are found.

For example, given the following file/folder tree:
- Home/Adam Smith/file.dat
- Home/Adam Smith/report.txt
- Home/Adam Smith/archive/info.dat
- Home/Adam Smith/archive/names.txt

A call of findFilesInFolder("*.dat","Home/Adam Smith") would return:
- Home/Adam Smith/file.dat
- Home/Adam Smith/archive/info.dat

Parameters:

Mask - file search mask

MOVEitFolder - path or ID of the folder to limit searches to

Returns:

HashMap containing search results

findNewFiles

public java.util.HashMap findNewFiles(java.lang.String Mask)

Returns a HashMap object made up of MOVEitFileInfo objects which contain information about NEW files in any available folder whose names match the specified mask. (New files listed here would be the same new files normally listed on a user's home page.) (The KEYS will contain full file paths.) Returns an empty HashMap if no files are found.

Parameters:

Mask - file search mask

Returns:

HashMap containing search results

findNewFilesInFolder

public java.util.HashMap findNewFilesInFolder(java.lang.String Mask,
                                              java.lang.String MOVEitFolder)

Returns a HashMap object made up of MOVEitFileInfo objects which contain information about NEW files whose names match the specified mask, and which are located in folders whose MOVEitFolder path is or begins with the provided MOVEitFolder. (This method can be used to search a tree of directories for files of a certain name.) (The KEYS will contain full file paths.) Returns an empty HashMap if no files are found.

Parameters:

Mask - file search mask

MOVEitFolder - path or ID of the folder to limit searches to

Returns:

HashMap containing search results

getFolderDetails

public MOVEitFolderInfo getFolderDetails(java.lang.String MOVEitFolder)

Returns a MOVEitFolderInfo object containing information about the specified folder. If the folder does not exist or the currently authorized user is not permitted to access it, then null is returned instead.

NOTE: When executing this method against a virtual folder, the effective value will be returned for several of the MOVEitFolderInfo properties, rather than the actual value. The effective value is that of the virtual folder's target folder rather than the virtual folder itself, and applies to properties like AllowOverwrite and UseUniqueNames, which have no meaning for virtual folders.

Parameters:

MOVEitFolder - path or ID of the folder on the MOVEit Transfer host to get information about

Returns:

MOVEitFolderInfo object containing information about the folder

getHomeFolder

public MOVEitFolderInfo getHomeFolder(java.lang.String Username)

Returns a MOVEitFolderInfo object which corresponds to the named user's home folder. If the user does not exist, does not have a home folder, or the currently authorized user is not an administrator, then null is returned instead. Note that only the user's actual home folder is returned. If you need to determine a user's default folder (which may or may not be the same as the user's home folder), use the getUserDetails method and examine the defaultFolderPath property of the resulting MOVEitUserInfo object.

Parameters:

Username - username or ID of user to get the home folder of

Returns:

MOVEitFolderInfo object containing information about the user's home folder

getTargetFolder

public MOVEitFolderInfo getTargetFolder(java.lang.String MOVEitFolder)

Returns a MOVEitFolderInfo object which corresponds to the target folder of the specified virtual folder. If the specified folder is not a virtual folder, or the currently authorized user does not have permissions to see the virtual folder's target folder, then null is returned instead.

Parameters:

MOVEitFolder - path or ID of the virtual folder on the MOVEit Transfer host to get the target folder of

Returns:

MOVEitFolderInfo object containing information about the folder's target folder

listFilesInFolder

public java.util.HashMap listFilesInFolder(java.lang.String MOVEitFolder)

Returns a HashMap object made up of MOVEitFileInfo objects which contain information about files in the specified folder. (The KEYS will contain full file paths.) Returns an empty HashMap if no files are found.

Parameters:

MOVEitFolder - path or ID of the folder on the MOVEit Transfer host to list files of

Returns:

HashMap containing list results

listFilesInFolderWithMask

public java.util.HashMap listFilesInFolderWithMask(java.lang.String MOVEitFolder,
                                                   java.lang.String Mask)

Returns a HashMap object made up of MOVEitFileInfo objects which contain information about files in the specified folder whose names match the specified mask. (The KEYS will contain full file paths.) Returns an empty HashMap if no files are found.

Parameters:

MOVEitFolder - path or ID of the folder on the MOVEit Transfer host to list files of

Mask - mask to apply against file list

Returns:

HashMap containing list results

listFoldersInFolder

public java.util.HashMap listFoldersInFolder(java.lang.String MOVEitFolder)

Returns a HashMap object made up of MOVEitFolderInfo objects which contain information about subfolders of the specified folder. (The KEYS will contain full folder paths.) Returns an empty HashMap if no subfolders are found.

Parameters:

MOVEitFolder - path or ID of the folder on the MOVEit Transfer host to list subfolders of

Returns:

HashMap containing list results

listFolders

public java.util.HashMap listFolders()

Returns a HashMap object made up of MOVEitFolderInfo objects which contain information about all folders the currently authorized user can access. (The KEYS will contain full folder paths.) Returns an empty HashMap if no folders are found.

Returns:

HashMap containing list results

listFolders

public java.util.HashMap listFolders(java.lang.String OrgID)

Returns a HashMap object made up of MOVEitFolderInfo objects which contain information about all folders the currently authorized user can access. (The KEYS will contain full folder paths.) Returns an empty HashMap if no folders are found. The "OrgID" argument only applies if the currently authorized user is a SysAdmin; by default this value is the same as the currently authorized user's OrgID.

Parameters:

OrgID - ID of the organization to list the folders of

Returns:

HashMap containing list results

renameFolder

public boolean renameFolder(java.lang.String MOVEitFolder,
                            java.lang.String NewName)

Renames an existing MOVEit Transfer folder with the given path.

Parameters:

MOVEitFolder - path or ID of the folder on the MOVEit Transfer host to rename

NewName - new name to apply to the folder

Returns:

true if successful, false otherwise

addMailbox

public int addMailbox(java.lang.String MOVEitMailbox)

Makes a new MOVEit Transfer mailbox with the given path for the current user.

Parameters:

MOVEitMailbox - path of the mailbox to be added

Returns:

ID of the newly created folder if successful, 0 otherwise

deleteMailbox

public boolean deleteMailbox(java.lang.String MOVEitMailbox)

Deletes an existing MOVEit Transfer mailbox with the given path for the current user. Returns TRUE if successful; FALSE otherwise.

Parameters:

MOVEitMailbox - path or ID of the mailbox to be deleted

Returns:

true if successful, false otherwise

listMailboxes

public java.util.HashMap listMailboxes()

Returns a HashMap object made up of MOVEitFolderInfo objects which contain information about all mailboxes owned by the current user. The KEYS will contain full mailbox paths.) To include mailboxes that the current user has Shared Mailbox access to, use the listMailboxesAndShared method. Returns an empty HashMap if no mailboxes are found.

Returns:

HashMap containing results if successful, null otherwise

listMailboxesAndShared

public java.util.List<java.util.HashMap> listMailboxesAndShared()

Returns a List of HashMap objects that contain information about all mailboxes owned by the current user AND all mailboxes owned by users whom the current user has Shared Mailbox access to. Each HashMap in the list corresponds to a particular user's set of mailboxes and the list is ordered by the user RealName property. (The current user's mailboxes are always listed first.) Each HashMap is made up of MOVEitFolderInfo objects which contain information about all mailboxes owned by that particular user. (The KEYS will contin full mailbox paths.) Returns an empty List if no mailboxes are found.

Returns:

List of HashMap objects containing results if successful, null otherwise

renameMailbox

public boolean renameMailbox(java.lang.String MOVEitMailbox,
                             java.lang.String NewName)

Renames an existing MOVEit Transfer mailbox with the given path for the current user.

Parameters:

MOVEitMailbox - path or ID of the mailbox to be renamed

NewName - new name to apply to the mailbox

Returns:

true if successful, false otherwise

listMessages

public java.util.HashMap listMessages(java.lang.String MOVEitMailbox,
                                      java.lang.String MailboxOwner)

Returns as HashMap object whose KEYS contain a list of Message IDs of all messages available to the current user in the provided MOVEit Transfer mailbox and whose VALUES contain MOVEitMessageInfo objects describing those messages. If MOVEitMailbox is a path and MailboxOwner is an empty string, then the current user is assumed to be the mailbox owner. Returns an empty HashMap if no messages are found. Returns null if the current user does not have permission to know if any messages are found.

Note: The MOVEitMessageInfo objects returned by this method will NOT contain complete information about the given message. Only "header" information about the message will be included (ID, sendStamp, from, fromRealname, subject, parentID). To get the body and attachment list of a message, use the readMessage method.

Parameters:

MOVEitMailbox - path or ID of the mailbox to be listed

MailboxOwner - username or user ID of the mailbox owner

Returns:

HashMap containing list results if successful, null otherwise

listMessages

public java.util.HashMap listMessages(java.lang.String MOVEitMailbox)

Returns as HashMap object whose KEYS contain a list of Message IDs of all messages available to the current user in the provided MOVEit Transfer mailbox and whose VALUES contain MOVEitMessageInfo objects describing those messages. If MOVEitMailbox is a path, then the current user is assumed to be the mailbox owner. Returns as empty HashMap if no messages are found. Returns null if the current user does not have permission to know if any messages are found.

Note: The MOVEitMessageInfo objects returned by this method will NOT contain complete information about the given message. Only "header" information about the message will be included (ID, sendStamp, from, fromRealname, subject, parentID). To get the body and attachment list of a message, use the readMessage method.

Parameters:

MOVEitMailbox - path or ID of the mailbox to be listed

Returns:

HashMap containing list results if successful, null otherwise

listNewMessages

public java.util.HashMap listNewMessages()

Returns a HashMap object whose KEYS contain a list of Message IDs of all new (unread) messages available to the current user, but only those messages that exist in mailboxes owned by the current user. To include new messages in mailboxes that the current user has Shared Mailbox access to, use the listNewMessagesAndShared method. The HashMap VALUES will contain MOVEitMessageInfo objects describing the new messages. Returns An empty HashMap if no new messages are found. Returns null if the current user does not have permission to know if any new messages are found.

Note: The MOVEitMessageInfo objects returned by this method will NOT contain complete information about the given message. Only "header" information about the message will be included (ID, sendStamp, from, fromRealname, subject, parentID). To get the body and attachment list of a message, use the readMessage method.

Returns:

HashMap containing results if successful, null otherwise

listNewMessagesAndShared

public java.util.List<java.util.HashMap> listNewMessagesAndShared()

Returns a List of HashMap objects that contain information about all new (unread) messages available to the current user, including messages that are new for users that the current user has Shared Mailbox access to. Each HashMap in the list corresponds to a particular user's set of new messages and the list is ordered by the user RealName property. (The current user's new messages, if any, are always listed first.) For each HashMap, the VALUES will contain MOVEitMessageInfo objects describing those the new messages for that particular user. Returns an empty List if no new messages are found. Returns null if the current user does not have permission to know if any new messages are found.

Note: The MOVEitMessageInfo objects returned by this method will NOT contain complete information about the given message. Only "header" information about the message will be included (ID, sendStamp, from, fromRealname, subject, parentID). To get the body and attachment list of a message, use the readMessage method.

Returns:

List of HashMap objects containing results if successful, null otherwise

composeNewMessage

public MOVEitMessageInfo composeNewMessage(java.lang.String Recipient,
                                           java.lang.String Subject,
                                           java.lang.String Body)

Returns a new MOVEitMessageInfo object with a state of "Pending". This object can be used to define a new secure message to be sent through the MOVEit Transfer system. The arguments are used to pre-fill their associated properties in the new MOVEitMessageInfo object.

When composing a new message, the Body argument can accept HTML. The message content should not be a complete HTML document (containing html, head, and body tags), but should instead simply contain any HTML formatting the message requires (for example: bold tags, span tags with style attributes, list tags, etc). Certain tags will be stripped from the message for security reasons, once received by MOVEit Transfer. These include script tags and embed tags. Also, any instances of the text "Javascript:" will be removed, to prevent inclusion of javascript operations in the message content.

Parameters:

Recipient - username to add as a recipient to the new message

Subject - subject of the new message

Body - body of the new message

Returns:

new MOVEitMessageInfo object with status set to Pending

See Also:

MOVEitMessageInfo

composeNewMessage

public MOVEitMessageInfo composeNewMessage(java.lang.String Recipient,
                                           java.lang.String Subject)

Returns a new MOVEitMessageInfo object with a state of "Pending". This object can be used to define a new secure message to be sent through the MOVEit Transfer system. The arguments are used to pre-fill their associated properties in the new MOVEitMessageInfo object.

Parameters:

Recipient - username to add as a recipient to the new message

Subject - subject of the new message

Returns:

new MOVEitMessageInfo object with status set to Pending

See Also:

MOVEitMessageInfo

composeNewMessage

public MOVEitMessageInfo composeNewMessage(java.lang.String Recipient)

Returns a new MOVEitMessageInfo object with a state of "Pending". This object can be used to define a new secure message to be sent through the MOVEit Transfer system. The arguments are used to pre-fill their associated properties in the new MOVEitMessageInfo object.

Parameters:

Recipient - username to add as a recipient to the new message

Returns:

new MOVEitMessageInfo object with status set to Pending

See Also:

MOVEitMessageInfo

composeNewMessage

public MOVEitMessageInfo composeNewMessage()

Returns a new MOVEitMessageInfo object with a state of "Pending". This object can be used to define a new secure message to be sent through the MOVEit Transfer system.

Returns:

new MOVEitMessageInfo object with status set to Pending

See Also:

MOVEitMessageInfo

deleteMessage

public boolean deleteMessage(java.lang.String MessageID,
                             java.lang.String MOVEitMailbox,
                             java.lang.String MailboxOwner)

Deletes the message from the specified mailbox. For Shared Mailbox access, only messages in the Drafts mailbox may be deleted. If MOVEitMailbox is a path and MailboxOwner is an empty string, then the current user is assumed to be the mailbox owner. Returns TRUE if successful, FALSE otherwise.

Parameters:

MessageID - ID of the message to be deleted

MOVEitMailbox - path or ID of the mailbox containing the message to be deleted

MailboxOwner - username or user ID of the mailbox owner

Returns:

true if successful, false otherwise

Specifying the mailbox to delete the message from is not strictly necessary, but improves MOVEit Transfer's ability to more accurately handle the situation where a message resides in more than one mailbox accessible to the current user.

See Also:

deleteMessage(String,String)

deleteMessage

public boolean deleteMessage(java.lang.String MessageID,
                             java.lang.String MOVEitMailbox)

Deletes the message from the specified mailbox. For Shared Mailbox access, only messages in the Drafts mailbox may be deleted. If MOVEitMailbox is a path, then the mailbox owner is assumed to be the current user. If MOVEitMailbox is an empty string, the message will be deleted from all mailboxes owned by the current user. Returns TRUE if successful, FALSE otherwise.

Parameters:

MessageID - ID of the message to be deleted

MOVEitMailbox - path or ID of the mailbox containing the message to be deleted

Returns:

true if successful, false otherwise

Specifying the mailbox to delete the message from is not strictly necessary, but improves MOVEit Transfer's ability to more accurately handle the situation where a message resides in more than one mailbox accessible to the current user.

See Also:

deleteMessage(String,String,String)

deleteMessage

public boolean deleteMessage(java.lang.String MessageID)

Deletes the message from all mailboxes owned by the current user. Returns TRUE if successful, FALSE otherwise.

Parameters:

MessageID - ID of the message to be deleted

Returns:

true if successful, false otherwise

Use deleteMessage(String,String) or deleteMessage(String,String,String) to delete a message from a specific mailbox.

See Also:

deleteMessage(String,String), deleteMessage(String,String,String)

moveMessage

public boolean moveMessage(java.lang.String MessageID,
                           java.lang.String FromMailbox,
                           java.lang.String ToMailbox,
                           java.lang.String MailboxOwner)

Moves the message from the provided source mailbox to the provided destination mailbox. If either FromMailbox or ToMailbox is a path and MailboxOwner is an empty string, then the mailbox owner is assumed to be the current user. Returns TRUE if successful, FALSE otherwise.

Parameters:

MessageID - ID of the message to be moved

FromMailbox - path or ID of the mailbox to move message from

ToMailbox - path or ID of the mailbox to move message to

MailboxOwner - username or user ID of the mailbox owner

Returns:

true if successful, false otherwise

Specifying the mailbox to move the message from is not strictly necessary, but improves MOVEit Transfer's ability to more accurately handle the situation where a message resides in more than one mailbox accessible to the current user.

See Also:

moveMessage(String,String,String)

moveMessage

public boolean moveMessage(java.lang.String MessageID,
                           java.lang.String FromMailbox,
                           java.lang.String ToMailbox)

Moves the message from the provided source mailbox to the provided destination mailbox. If either FromMailbox or ToMailbox is a path, then the mailbox owner is assumed to be the current user. Returns TRUE if successful, FALSE otherwise.

Parameters:

MessageID - ID of the message to be moved

FromMailbox - path or ID of the mailbox to move message from

ToMailbox - path or ID of the mailbox to move message to

Returns:

true if successful, false otherwise

Specifying the mailbox to move the message from is not strictly necessary, but improves MOVEit Transfer's ability to more accurately handle the situation where a message resides in more than one mailbox accessible to the current user.

See Also:

moveMessage(String,String,String,String)

moveMessage

public boolean moveMessage(java.lang.String MessageID,
                           java.lang.String ToMailbox)

Moves the message to the provided destination mailbox. If ToMailbox is a path, then the mailbox owner is assumed to be the current user. Returns TRUE if successful, FALSE otherwise.

Parameters:

MessageID - ID of the message to be moved

ToMailbox - path or ID of the mailbox to move message to

Returns:

true if successful, false otherwise

Use moveMessage(String,String,String) or moveMessage(String,String,String,String) to move a message from a specific mailbox.

See Also:

moveMessage(String,String,String), moveMessage(String,String,String,String)

readMessage

public MOVEitMessageInfo readMessage(java.lang.String MessageID,
                                     java.lang.String MOVEitMailbox,
                                     java.lang.String MailboxOwner)

Returns a MOVEitMessageInfo object describing the message identified by the given ID. If MOVEitMailbox is a path and MailboxOwner is an empty string, then the current user is assumed to be the mailbox owner. If MOVEitMailbox is an empty string, a copy of the message will be searched for in mailboxes owned by MailboxOwner.

Parameters:

MessageID - ID of the message to download

MOVEitMailbox - path or ID of the mailbox to download the message from

MailboxOwner - username or user ID of the mailbox owner

Returns:

MOVEitMessageInfo object containing information for the downloaded message if download was successful, null otherwise

Specifying the mailbox to download the message from is not strictly necessary, but improves MOVEit Transfer's ability to more accurately handle the situation where a message resides in more than one mailbox accessible to the current user.

See Also:

readMessage(String,String)

readMessage

public MOVEitMessageInfo readMessage(java.lang.String MessageID,
                                     java.lang.String MOVEitMailbox)

Returns a MOVEitMessageInfo object describing the message identified by the given ID. If MOVEitMailbox is a path, then the current user is assumed to be the mailbox owner. If MOVEitMailbox is an empty string, a copy of the message will be searched for in mailboxes accessible to the current user.

Parameters:

MessageID - ID of the message to download

MOVEitMailbox - path or ID of the mailbox to download the message from

Returns:

MOVEitMessageInfo object containing information for the downloaded message if download was successful, null otherwise

Specifying the mailbox to download the message from is not strictly necessary, but improves MOVEit Transfer's ability to more accurately handle the situation where a message resides in more than one mailbox accessible to the current user.

See Also:

readMessage(String,String,String)

readMessage

public MOVEitMessageInfo readMessage(java.lang.String MessageID)

Returns a MOVEitMessageInfo object describing the message identified by the given ID.

Parameters:

MessageID - ID of the message to download

Returns:

MOVEitMessageInfo object containing information for the downloaded message if download was successful, null otherwise

Use readMessage(String,String) or readMessage(String,String,String) to download a message from a specific mailbox.

See Also:

readMessage(String,String), readMessage(String,String,String)

checkMessageRecipients

public java.util.HashMap checkMessageRecipients(MOVEitMessageInfo oMsg)

Given a MOVEitMessageInfo object defining a package to send, checks whether the assigned recipients are valid for the currently configured "From" user. (If the "From" property is an empty string, then recipients are checked for the current user.) Returns a HashMap whose KEYS contain a list of invalid recipients (group recipients are prefaced by "GROUP:"). For recipients that are invalid because MOVEit Transfer matched more than one user or group, the HashMap VALUES contain strings that are comma-delimited lists of all matching user or group IDs. For recipients that are invalid for other reasons, the HashMap VALUES contain empty strings. Returns an empty dictionary if all recipients checked OK. Returns null if an error occurred.

Parameters:

oMsg - MOVEitMessageInfo object containing recipients to be checked

Returns:

empty HashMap if successful, null if there were errors, otherwise a HashMap containing invalid recipients

sendMessage

public boolean sendMessage(MOVEitMessageInfo oMsg,
                           boolean bSendToUnregRecip)

Given a MOVEitMessageInfo object describing a message to be sent, sends the message to the MOVEit Transfer server on behalf of the configured "From" user. (If the "From" property is an empty string, then sends the message on behalf of the current user.) Returns TRUE if successful, FALSE otherwise. Also sets oMsg to reflect the secure message now stored on MOVEit Transfer. (Local paths are replaced with MOVEit Transfer paths, etc.)

Parameters:

oMsg - MOVEitMessageInfo object containing message information to be posted to the MOVEit Transfer host

bSendToUnregRecip - NO LONGER USED. MOVEit Transfer now handles sending to unregistered recipients based on the server's Ad Hoc Transfer settings

Returns:

true if successful, false otherwise

sendMessage

public boolean sendMessage(MOVEitMessageInfo oMsg)

Given a MOVEitMessageInfo object describing a message to be sent, sends the message to the MOVEit Transfer server on behalf of the configured "From" user. (If the "From" property is an empty string, then sends the message on behalf of the current user.) Returns TRUE if successful, FALSE otherwise. Also sets oMsg to reflect the secure message now stored on MOVEit Transfer. (Local paths are replaced with MOVEit Transfer paths, etc.)

Parameters:

oMsg - MOVEitMessageInfo object containing message information to be posted to the MOVEit Transfer host

Returns:

true if successful, false otherwise

listSendAsUsers

public java.util.List<MOVEitUserInfo> listSendAsUsers()

Returns a list of MOVEitUserInfo objects describing all the users that the current user is able to send messages on behalf of, including the current user themselves. The MOVEitUserInfo objects will contain limited information about each user account (i.e. ID, username, realname, etc.), as well as various Ad Hoc related settings and defaults specific to that user.

Returns:

List of MOVEitUserInfo objects describing all user accounts that the current user is able to send as if successful, null otherwise

getSendAsUserInfo

public MOVEitUserInfo getSendAsUserInfo(java.lang.String userid)

Returns a MOVEitUserInfo object describing the specified user whom the current user is able to send messages on behalf of. The MOVEitUserInfo object will contain limited information about the user account (i.e. ID, username, realname, etc.), as well as various Ad Hoc related settings and defaults specific to that user.

Parameters:

userid - ID of the MOVEit Transfer user

Returns:

MOVEitUserInfo object describing the specified user whom the current user is able to send as if successful, null otherwise

addUser

public boolean addUser(java.lang.String Username,
                       java.lang.String Password,
                       java.lang.String RealName,
                       java.lang.String Email,
                       int Permission,
                       java.lang.String Notes,
                       boolean ForceChangePassword,
                       java.lang.String OrgID)

Adds a new user with the provided attributes. The "Permission" argument may be any of the permission values listed below. The "ForceChangePassword" argument is set to FALSE by default; if set to TRUE this argument will force this user to change his or her password the first time the user signs on. The OrgID field is only used if the currently authenticated user is a SysAdmin. Returns TRUE if successful; FALSE otherwise. Permission values:

• 6 = TempUser
• 10 = User
• 20 = FileAdmin
• 30 = Admin
• 40 = SysAdmin

Parameters:

Username - username of the new user

Password - password of the new user

RealName - display name of the new user

Email - email address of the new user

Permission - permission code of the new user

Notes - any notes to be added with the new user

ForceChangePassword - when true, the user will be required to change their password on their first login

OrgID - ID of the organization to add the user to

Returns:

true if successful, false otherwise

addUser

public boolean addUser(java.lang.String Username,
                       java.lang.String Password,
                       java.lang.String RealName,
                       java.lang.String Email,
                       int Permission,
                       java.lang.String Notes,
                       boolean ForceChangePassword)

Adds a new user with the provided attributes. The "Permission" argument may be any of the permission values listed below. The "ForceChangePassword" argument is set to FALSE by default; if set to TRUE this argument will force this user to change his or her password the first time the user signs on. Returns TRUE if successful; FALSE otherwise. Permission values:

• 6 = TempUser
• 10 = User
• 20 = FileAdmin
• 30 = Admin
• 40 = SysAdmin

Parameters:

Username - username of the new user

Password - password of the new user

RealName - display name of the new user

Email - email address of the new user

Permission - permission code of the new user

Notes - any notes to be added with the new user

ForceChangePassword - when true, the user will be required to change their password on their first login

Returns:

true if successful, false otherwise

addUser

public boolean addUser(java.lang.String Username,
                       java.lang.String Password,
                       java.lang.String RealName,
                       java.lang.String Email,
                       int Permission,
                       java.lang.String Notes)

Adds a new user with the provided attributes. The "Permission" argument may be any of the permission values listed below. Returns TRUE if successful; FALSE otherwise. Permission values:

• 6 = TempUser
• 10 = User
• 20 = FileAdmin
• 30 = Admin
• 40 = SysAdmin

Parameters:

Username - username of the new user

Password - password of the new user

RealName - display name of the new user

Email - email address of the new user

Permission - permission code of the new user

Notes - any notes to be added with the new user

Returns:

true if successful, false otherwise

addUser

public boolean addUser(java.lang.String Username,
                       java.lang.String Password,
                       java.lang.String RealName,
                       java.lang.String Email,
                       int Permission)

Adds a new user with the provided attributes. The "Permission" argument may be any of the permission values listed below. Returns TRUE if successful; FALSE otherwise. Permission values:

• 6 = TempUser
• 10 = User
• 20 = FileAdmin
• 30 = Admin
• 40 = SysAdmin

Parameters:

Username - username of the new user

Password - password of the new user

RealName - display name of the new user

Email - email address of the new user

Permission - permission code of the new user

Returns:

true if successful, false otherwise

cloneUser

public boolean cloneUser(java.lang.String OrigUsername,
                         java.lang.String NewUsername,
                         java.lang.String Password,
                         java.lang.String RealName,
                         java.lang.String Email,
                         java.lang.String Notes,
                         boolean ForceChangePassword)

Adds a new user with the provided attributes by cloning the user with the username provided in OrigUsername.

Parameters:

OrigUsername - username or ID of user to clone

NewUsername - username of the new user

Password - password of the new user

RealName - display name of the new user

Email - email address of the new user

Notes - any notes to be added with the new user

ForceChangePassword - when true, the user will be required to change their password on their first login

Returns:

true if successful, false otherwise

cloneUser

public boolean cloneUser(java.lang.String OrigUsername,
                         java.lang.String NewUsername,
                         java.lang.String Password,
                         java.lang.String RealName,
                         java.lang.String Email,
                         java.lang.String Notes)

Adds a new user with the provided attributes by cloning the user with the username provided in OrigUsername.

Parameters:

OrigUsername - username or ID of user to clone

NewUsername - username of the new user

Password - password of the new user

RealName - display name of the new user

Email - email address of the new user

Notes - any notes to be added with the new user

Returns:

true if successful, false otherwise

cloneUser

public boolean cloneUser(java.lang.String OrigUsername,
                         java.lang.String NewUsername,
                         java.lang.String Password,
                         java.lang.String RealName,
                         java.lang.String Email)

Adds a new user with the provided attributes by cloning the user with the username provided in OrigUsername.

Parameters:

OrigUsername - username or ID of user to clone

NewUsername - username of the new user

Password - password of the new user

RealName - display name of the new user

Email - email address of the new user

Returns:

true if successful, false otherwise

addTemporaryUser

public boolean addTemporaryUser(java.lang.String Email,
                                java.lang.String Password,
                                java.lang.String RealName,
                                boolean ForceChangePassword)

Adds a new temporary user with the provided attributes. *NOTE* Typically the MOVEit Transfer server will handle creating Temp Users based on its Ad Hoc Transfer settings, making this function obsolete. However, MOVEit Transfer does still support manually adding Temp Users, if desired. The "ForceChangePassword" argument is set to FALSE by default; if set to TRUE this argument will force this user to change his or her password the first time the user signs on. Returns TRUE if successful; FALSE otherwise.

Parameters:

Email - email address of the new user

Password - password of the new user

RealName - display name of the new user

ForceChangePassword - when true, the user will be required to change their password on their first login

Returns:

true if successful, false otherwise

addTemporaryUser

public boolean addTemporaryUser(java.lang.String Email,
                                java.lang.String Password,
                                java.lang.String RealName)

Adds a new temporary user with the provided attributes. *NOTE* Typically the MOVEit Transfer server will handle creating Temp Users based on its Ad Hoc Transfer settings, making this function obsolete. However, MOVEit Transfer does still support manually adding Temp Users, if desired. Returns TRUE if successful; FALSE otherwise.

Parameters:

Email - email address of the new user

Password - password of the new user

RealName - display name of the new user

Returns:

true if successful, false otherwise

addGroupToUserAddressBook

public boolean addGroupToUserAddressBook(java.lang.String Owner,
                                         java.lang.String GroupName,
                                         boolean AllowExpansion)

Adds a group to the specified owner's address book. AllowExpansion, when set to "1", makes it so that all members of the added group will appear in the specified owner's recipient list, along with the group itself. Returns TRUE/FALSE.

Parameters:

Owner - address book owner username or ID

GroupName - name or ID of group to add to address book

AllowExpansion - if set to true, address book owner will see all members of the group in their address book as well as the group itself

Returns:

true if successful, false otherwise

addGroupToUserAddressBook

public boolean addGroupToUserAddressBook(java.lang.String Owner,
                                         java.lang.String GroupName)

Adds a group to the specified owner's address book. Returns TRUE/FALSE.

Parameters:

Owner - address book owner username or ID

GroupName - name or ID of group to add to address book

Returns:

true if successful, false otherwise

addUserToUserAddressBook

public boolean addUserToUserAddressBook(java.lang.String Owner,
                                        java.lang.String Username)

Adds a user to the specified owner's address book. Returns TRUE/FALSE.

Parameters:

Owner - address book owner username or ID

Username - username or ID to add to address book

Returns:

true if successful, false otherwise

deleteGroupFromUserAddressBook

public boolean deleteGroupFromUserAddressBook(java.lang.String Owner,
                                              java.lang.String GroupName)

Deletes a group from the specified owner's address book. Returns TRUE/FALSE.

Parameters:

Owner - address book owner username or ID

GroupName - name or ID of group to remove from address book

Returns:

true if successful, false otherwise

deleteUserFromUserAddressBook

public boolean deleteUserFromUserAddressBook(java.lang.String Owner,
                                             java.lang.String Username)

Deletes a user from the specified owner's address book. Returns TRUE/FALSE.

Parameters:

Owner - address book owner username or ID

Username - username or ID of user to remove from address book

Returns:

true if successful, false otherwise

listUserAddressBook

public java.util.HashMap listUserAddressBook(java.lang.String Username)

Returns a HashMap object containing the contents of the listed user's address book. Usernames and group names (prefaced by "GROUP:") will appear in the KEYS. User real names OR group IDs will appear in the VALUES.

Parameters:

Username - username or ID of user to list the address book of

Returns:

HashMap containing list results if successful, null otherwise

lookupUserAddressBook

public java.util.HashMap lookupUserAddressBook(java.lang.String Value,
                                               java.lang.String Type,
                                               java.lang.String Owner)

Given a piece of identifying information, determines whether any users or groups matching the search string are members of the specified user's address book MOVEit Transfer will attempt to match the search string against the Username, RealName EmailAddress, and UserID fields for a "user" lookup, or the GroupName and GroupID fields for a "group" lookup. The search string can contain "*" and "?" wild cards for enhanced searching. If Owner is an empty string, the current user's address book will be searched. Returns a Dictionary whose KEYS contain one or more usernames or group names if there were matching entities found in the specified user's address book (the dictionary VALUES will contain user real names or group IDs, respectively). If no matches were found in the address book, also returns information indicating whether any matching entities can be added to the address book (i.e. are valid package recipients for the specified user). Returns Nothing if there were no matching entities, or if none of the matching entities can be added to the specified user's address book. Returns an empty Dictionary if one or more matching entities can be added to the address book, or if the search string is an email address that doesn't exist on the MOVEit Transfer server and the currently authorized user is allowed to send to unregistered recipients.

Parameters:

Value - a username, real name, email address, user ID, group name, or group ID to search the specified user's address book for

Type - one of the strings "User" or "Group" specifying the nature of the Value argument

Owner - username or user ID of the user who's address book is to be searched

Returns:

HashMap containing search results if successful, null otherwise

lookupUserAddressBook

public java.util.HashMap lookupUserAddressBook(java.lang.String Value,
                                               java.lang.String Type)

Given a piece of identifying information, determines whether any users or groups matching the search string are members of the current user's address book. MOVEit MOVEit Transfer will attempt to match the search string against the Username, RealName, EmailAddress, and UserID fields for a "user" lookup, or the GroupName and GroupID fields for a "group" lookup. The search string can contain "*" and "?" wild cards for enhanced searching. Returns a Dictionary whose KEYS contain one or more usernames or group names if there were matching entities found in the current user's address book (the dictionary VALUES will contain user real names or group IDs, respectively). If no matches were found in the address book, also returns information indicating whether any matching entities can be added to the address book (i.e. are valid package recipients for the current user). Returns Nothing if there were no matching entities, or if none of the matching entities can be added to the current user's address book. Returns an empty Dictionary if one or more matching entities can be added to the address book, or if the search string is an email address that doesn't exist on the MOVEit Transfer server and the current user is allowed to send to unregistered recipients.

Parameters:

Value - a username, real name, email address, user ID, group name, or group ID to search the current user's address book for

Type - one of the strings "User" or "Group" specifying the nature of the Value argument

Returns:

HashMap containing search results if successful, null otherwise

See Also:

lookupUserAddressBook(String,String,String)

importUserCertFromBuffer

public boolean importUserCertFromBuffer(java.lang.String Username,
                                        java.lang.String Buffer)

Imports an SSL public certificate to a user's certificate store. The contents of the certificate should be placed in the Buffer argument, and must be a Base-64 encoded public-only certificate. Do not use DER or other encodings.

Parameters:

Username - username or ID of user to add cert for

Buffer - string containing Base-64 encoded SSL public certificate data

Returns:

true if successful; otherwise, false

importUserCertFromFile

public boolean importUserCertFromFile(java.lang.String Username,
                                      java.lang.String Filepath)

Imports an SSL public certificate to a user's certificate store from a file. The certificate file must contain a Base-64 encoded public-only certificate. Do not use DER or other encodings.

Parameters:

Username - username or ID of user to add cert for

Filepath - local path of certificate file to import

Returns:

true if successful; otherwise, false

importUserKeyFromBuffer

public boolean importUserKeyFromBuffer(java.lang.String Username,
                                       java.lang.String Buffer)

Imports an SSH public key to a user's certificate store. The contents of the key should be placed in the Buffer argument and must contain only the public portion of the key.

Parameters:

Username - username or ID of user to add key for

Buffer - string containing SSH public key data

Returns:

true if successful; otherwise, false

importUserKeyFromFile

public boolean importUserKeyFromFile(java.lang.String Username,
                                     java.lang.String Filepath)

Imports an SSH public key to a user's certificate store from a file. The certificate file must contain only the public portion of the key.

Parameters:

Username - username or ID of user to add key for

Filepath - local path of key file to import

Returns:

true if successful; otherwise, false

addUserCertKey

public boolean addUserCertKey(java.lang.String Username,
                              int DataType,
                              java.lang.String Data)

Adds an SSL certificate or SSH key to a user's store using provided data.

Parameters:

Username - username or ID of user to add cert/key for

DataType - type of cert/key data being added. See MOVEitCertKeyInfo.dataType() for valid data types

Data - cert/key data being added

Returns:

true if successful; otherwise, false

listUserCertsKeys

public java.util.HashMap listUserCertsKeys(java.lang.String Username)

Lists the SSL certificates and SSH keys in a user's store. Returns a HashMap containing cert/key IDs as keys, and MOVEitCertKeyInfo objects as values. Returns an empty HashMap if no certs or keys are found, or null if an error occurs.

Parameters:

Username - username or ID of user to list certs and keys of

Returns:

HashMap containing list results if successful; otherwise, null

removeUserCertKey

public boolean removeUserCertKey(java.lang.String Username,
                                 int CertKeyID)

Removes an SSL certificate or SSH key from a user's store.

Parameters:

Username - username or ID of user to remove cert/key for

CertKeyID - ID of cert or key to remove

Returns:

true if successful; otherwise, false

changeUserGroupMembership

public boolean changeUserGroupMembership(java.lang.String GroupName,
                                         java.lang.String Username,
                                         java.lang.String Relationship)

Changes the relationship of the given user to the given group. Possible values for the Relationship argument are listed below. Returns TRUE if successful, FALSE if not.

Value	Description
1	Regular Member
2	Group Admin

Parameters:

GroupName - name or ID of group

Username - username or ID of user to change relationship of

Relationship - relationship code to apply

Returns:

true if successful, false otherwise

changeUserPassword

public boolean changeUserPassword(java.lang.String Username,
                                  java.lang.String NewPass)

Changes the password of existing user Username to NewPass. Returns TRUE if successful, FALSE if not.

Parameters:

Username - username or ID of user to change password of

NewPass - new password to apply to user

Returns:

true if successful, false otherwise

changeUserSetting

public boolean changeUserSetting(java.lang.String Username,
                                 java.lang.String SettingName,
                                 java.lang.String NewValue)

Attempts to change a setting on the specified user. Possible values for SettingName are listed below. Returns TRUE if successful, FALSE if not.

For more details about these settings, see the MOVEitUserInfo documentation.

Setting Name	Allowed New Value
allowftps	1 = Allowed 0 = Not Allowed
allowhttpsclient	1 = Allowed 0 = Not Allowed
allowhttpsweb	1 = Allowed 0 = Not Allowed
allowinsecureftp	1 = Allowed 0 = Not Allowed
allowssh	1 = Allowed 0 = Not Allowed
authmethod	20 = MOVEit Only 10 = External Only 0 = Both
chrootdefaultfolder	1 = Enabled 0 = Disabled
defaultfolder	Any Valid MOVEit Transfer Folder Path or "0" to reset to user's home folder.
email	Any Valid Email Address
emailformat	1 = HTML 2 = Text
exemptfromexpiration	0 = No 1 = Yes
forcepasswordchange	0 = No 1 = Yes
homefolder	Any Valid MOVEit Transfer Folder Path or "0" to assign no home folder.
language	Any Valid International Language Code
notes	Any String
notification	0 = No 1 = Yes 2 = Yes+Admin
permission	30 = Admin 20 = FileAdmin 10 = User 6 = TempUser
quota	0 = None 1-9,223,372,036,854,775,807 = quota size (in bytes)
realname	Any String
requireftpscert	1 = Required 0 = Not Required
requireftpscertpassword	1 = Required 0 = Not Required
requirehttpscert	1 = Required 0 = Not Required
requirehttpscertpassword	1 = Required 0 = Not Required
requiresshkey	1 = Required 0 = Not Required
requiresshkeypassword	1 = Required 0 = Not Required

Parameters:

Username - username or ID of user to change setting for

SettingName - name of setting to change

NewValue - value to apply to setting

Returns:

true if successful, false otherwise

See Also:

MOVEitUserInfo

changeUserStatus

public boolean changeUserStatus(java.lang.String Username,
                                java.lang.String Status,
                                java.lang.String StatusNote)

Changes the status of existing user Username to Status. (The value of Status must be either "active" or "suspended".) The "StatusNote" argument allows the user to provide a reason why the user was locked or unlocked. Returns TRUE if successful, FALSE if not.

Parameters:

Username - username or ID of user to change status of

Status - either "active" or "suspended"

StatusNote - any notes to be added to the user's status

Returns:

true if successful, false otherwise

changeUserStatus

public boolean changeUserStatus(java.lang.String Username,
                                java.lang.String Status)

Changes the status of existing user Username to Status. (The value of Status must be either "active" or "suspended".) Returns TRUE if successful, FALSE if not.

Parameters:

Username - username or ID of user to change status of

Status - either "active" or "suspended"

Returns:

true if successful, false otherwise

deleteUser

public boolean deleteUser(java.lang.String Username)

Deletes the user specified by Username. Returns TRUE if successful, FALSE if not.

Parameters:

Username - username or ID of user to remove

Returns:

true if successful, false otherwise

getUserDetails

public MOVEitUserInfo getUserDetails(java.lang.String Username)

Returns a MOVEitUserInfo object containing information about the specified user. If the user does not exist or the currently authorized user is not permitted to access it, then null is returned instead.

Parameters:

Username - username or ID of user to return information about

Returns:

MOVEitUserInfo object containing information about the given user if successful, null otherwise

See Also:

MOVEitUserInfo

addUserToGroup

public boolean addUserToGroup(java.lang.String Username,
                              java.lang.String GroupName)

Adds the specified user to the specified group. Returns TRUE if successful, FALSE if not.

Parameters:

Username - username or ID of user to add

GroupName - name or ID of group to add user to

Returns:

true if successful, false otherwise

removeUserFromGroup

public boolean removeUserFromGroup(java.lang.String Username,
                                   java.lang.String GroupName)

Removes the specified user from the specified group. Returns TRUE if successful, FALSE if not.

Parameters:

Username - username or ID of user to remove

GroupName - name or ID of group to remove user from

Returns:

true if successful, false otherwise

listUserGroups

public java.util.HashMap listUserGroups(java.lang.String Username)

Returns a HashMap object containing a list of group names to which this user belongs. (The KEYS will contain group names the VALUES will contain MOVEitUserGroupInfo objects.) Returns an empty HashMap if no groups are found or null if the currently authorized user is not permitted to get this information.

Parameters:

Username - username or ID of user to list group membership of

Returns:

HashMap containing list results if successful, null otherwise

listGroups

public java.util.HashMap listGroups(java.lang.String OrgID)

Returns a HashMap object containing a list of all group names in the specified organization. (The KEYS will contain group names, the VALUES will contain MOVEitUserGroupInfo objects.) The "OrgID" argument only applies if the currently authorized user is a SysAdmin; by default this value is the same as the currently authorized user's OrgID. Returns an empty HashMap if no groups are found or null if the currently authorized user is not permitted to get this information.

Parameters:

OrgID - ID of the organization to list the groups of

Returns:

HashMap containing list results if successful, null otherwise

listGroups

public java.util.HashMap listGroups()

Returns a HashMap object containing a list of all group names in this organization. (The KEYS will contain group names, the VALUES will contain MOVEitUserGroupInfo objects.) Returns an empty HashMap if no groups are found or null if the currently authorized user is not permitted to get this information.

Returns:

HashMap containing list results if successful, null otherwise

listGroupMembers

public java.util.HashMap listGroupMembers(java.lang.String GroupName)

Returns a HashMap object containing a list of all users in the given group. (The KEYS will contain usernames, the VALUES will contain MOVEitUserInfo objects.) Returns an empty HashMap if no members are found or null if the currently authorized user is not permitted to get this information.

Parameters:

GroupName - name or ID of group to return membership information about

Returns:

HashMap containing list results if successful, null otherwise

listUserGroupsNot

public java.util.HashMap listUserGroupsNot(java.lang.String Username)

Returns a HashMap object containing a list of group names to which this user DOES NOT belong. (The KEYS will contain group names.) Returns an empty HashMap if no groups are found or null if the currently authorized user is not permitted to get this information.

Parameters:

Username - username of ID of user to list non-member groups for

Returns:

HashMap containing list results if successful, null otherwise

addUserToGroupAddressBook

public boolean addUserToGroupAddressBook(java.lang.String OwnerGroup,
                                         java.lang.String Username)

Adds a user to the specified owner group's address book. Returns TRUE/FALSE.

Parameters:

OwnerGroup - address book owner group name or ID

Username - username or ID of user to add to address book

Returns:

true if successful, false otherwise

addGroupToGroupAddressBook

public boolean addGroupToGroupAddressBook(java.lang.String OwnerGroup,
                                          java.lang.String GroupName,
                                          boolean AllowExpansion)

Adds a group to the specified owner group's address book. AllowExpansion, when set to "1", makes it so that all members of the added group will appear in the specified owner group members' recipient lists, along with the group itself. Returns TRUE/FALSE.

Parameters:

OwnerGroup - address book owner group name or ID

GroupName - name or ID of group to add to address book

AllowExpansion - if set to true, address book owner group members will see all members of the group in their address book as well as the group itself

Returns:

true if successful, false otherwise

deleteUserFromGroupAddressBook

public boolean deleteUserFromGroupAddressBook(java.lang.String OwnerGroup,
                                              java.lang.String Username)

Deletes a user from the specified owner group's address book. Returns TRUE/FALSE.

Parameters:

OwnerGroup - address book owner group name or ID

Username - username or ID of user to remove from address book

Returns:

true if successful, false otherwise

deleteGroupFromGroupAddressBook

public boolean deleteGroupFromGroupAddressBook(java.lang.String OwnerGroup,
                                               java.lang.String GroupName)

Deletes a group from the specified owner group's address book. Returns TRUE/FALSE.

Parameters:

OwnerGroup - address book owner group name or ID

GroupName - name or ID of group to remove from address book

Returns:

true if successful, false otherwise

getGroupDetails

public MOVEitUserGroupInfo getGroupDetails(java.lang.String GroupName)

Returns a MOVEitUserGroupInfo object containing information about the specified group. If the group does not exist or the currently authorized user is not permitted to access it, then null is returned instead.

Parameters:

GroupName - name or ID of group to return information about

Returns:

MOVEitUserGroupInfo object containing information about the given group if successful, null otherwise

See Also:

MOVEitUserGroupInfo

listUsers

public java.util.HashMap listUsers(java.lang.String OrgID)

Returns a HashMap object containing a list of users in this organization. (The KEYS will contain usernames, the VALUES will contain MOVEitUserInfo objects.) Returns an empty HashMap if no users are found or null if the currently authorized user is not permitted to get this information. The "OrgID" argument only applies if the currently authorized user is a SysAdmin; by default this value is the same as the currently authorized user's OrgID.

NOTE: MOVEit Transfer enforces a 1000 entry limit on the number of users that can be returned from a single listing, for performance reasons. If you need to list more than 1000 users, please use the listUsersAdvanced function.

To determine if there are more than 1000 users on the system, check the userListCount value after this function returns. It will contain the total number of users available to the current user.

Parameters:

OrgID - ID of the organization to list the users of

Returns:

HashMap containing list results if successful, null otherwise

listUsers

public java.util.HashMap listUsers()

Returns a HashMap object containing a list of users in this organization. (The KEYS will contain usernames, the VALUES will contain MOVEitUserInfo objects.) Returns an empty HashMap if no users are found or null if the currently authorized user is not permitted to get this information.

NOTE: MOVEit Transfer enforces a 1000 entry limit on the number of users that can be returned from a single listing, for performance reasons. If you need to list more than 1000 users, please use the listUsersAdvanced function.

To determine if there are more than 1000 users on the system, check the userListCount value after this function returns. It will contain the total number of users available to the current user.

Returns:

HashMap containing list results if successful, null otherwise

listUsersAdvanced

public java.util.HashMap listUsersAdvanced(java.lang.String page,
                                           int entriesPerPage,
                                           java.lang.String permissionFilter,
                                           java.lang.String statusFilter,
                                           java.lang.String groupFilter,
                                           java.lang.String searchFilter,
                                           java.lang.String searchString,
                                           java.lang.String orgID)

Returns a HashMap object containing a list of users in this organization. (The KEYS will contain usernames, the VALUES will contain MOVEitUserInfo objects.) Returns an empty HashMap if no users are found or null if the currently authorized user is not permitted to get this information. The "OrgID" argument only applies if the currently authorized user is a SysAdmin; by default this value is the same as the currently authorized user's OrgID.

This function allows more customization in which users are returned then the listUsers function. Most importantly, this function supports "paging", which allows programs to separate user lists into more manageable "pages", which contain only some of the results of the list. This is necessary when trying to list a large number of users, as MOVEit Transfer enforces a 1000 entry limit on the number of users that can be returned from a single listing, for performance reasons. The page argument specifies the page number to return (starting with 1). The entriesPerPage argument determines the number of entries that will be returned in each page (minimum 5, maximum 1000). Once the first page of the list has returned, the class-level userListCount value will contain the total number of users available via the provided filters. The number of pages of users that can be retrieved can then be calculated using that value and the entriesPerPage argument via the following algorithm:

if ((objAPI.userListCount mod entriesPerPage) > 0) {<br> &nbsp;&nbsp;&nbsp;&nbsp;number_of_pages = (objAPI.userListCount div entriesPerPage) + 1<br> } else {<br> &nbsp;&nbsp;&nbsp;&nbsp;number_of_pages = objAPI.userListCount div entriesPerPage<br> }

If the page argument is set to a value higher than the total number of pages available, the first page of results will be returned.

Other capabilities of this function beyond listUsers include the ability to specify various filters and search strings to narrow down the list of returned users. (Use a blank-string argument to skip a filter.) These options are described below:

permissionFilter - causes only users that match the specified permission filter to be returned
Values:

Filter Code	Meaning
Blank String	All Users
1	End Users
2	Administrators
3	FileAdmins
4	GroupAdmins
5	Temporary Users
6	SysAdmins

statusFilter - causes only users that match the specified status filter to be returned
Values:

Filter Code	Meaning
Blank String	All Users
1	Active Users
2	Inactive Users
3	Users who have never signed on

groupFilter - causes only users who are members of the specified group to be returned
Values: any MOVEit Transfer group name, or blank string to skip filter

searchFilter - used with the searchString argument; causes only users whose property specified by the searchFilter code matches the searchString value to be returned
Values:

Filter Code	Meaning
Blank String	All Users
1	Username
2	Real Name
4	Email Address

searchString - used with the searchFilter argument; search string to match the user property specified by the searchFilter code against
Values: any search string, or blank string to skip filter - multiple character matching can be done with the "*" wildcard character; single character matching can be done with the "?" wildcard character

Parameters:

page - page number to return (starting with 1). If the value provided is larger than the number of pages in the current list, the first page of results will be returned

entriesPerPage - number of entries to return in each page of results (minimum 5, maximum 200)

permissionFilter - filter-by-permission code

statusFilter - filter-by-status code

groupFilter - filter-by-group-membership group name

searchFilter - filter-by-search-string code

searchString - search string to match users against

orgID - ID of the organization to list the users of

Returns:

HashMap containing list results if successful, null otherwise

listUsersAdvanced

public java.util.HashMap listUsersAdvanced(java.lang.String page,
                                           int entriesPerPage,
                                           java.lang.String permissionFilter,
                                           java.lang.String statusFilter,
                                           java.lang.String groupFilter,
                                           java.lang.String searchFilter,
                                           java.lang.String searchString)

Returns a HashMap object containing a list of users in this organization. (The KEYS will contain usernames, the VALUES will contain MOVEitUserInfo objects.) Returns an empty HashMap if no users are found or null if the currently authorized user is not permitted to get this information.

Parameters:

page - page number to return (starting with 1). If the value provided is larger than the number of pages in the current list, the first page of results will be returned

entriesPerPage - number of entries to return in each page of results

permissionFilter - filter-by-permission code

statusFilter - filter-by-status code

groupFilter - filter-by-group-membership code

searchFilter - filter-by-search-string code

searchString - search string to match users against

Returns:

HashMap containing list results if successful, null otherwise

listUsersAdvanced

public java.util.HashMap listUsersAdvanced(java.lang.String page,
                                           int entriesPerPage)

Returns a HashMap object containing a list of users in this organization. (The KEYS will contain usernames, the VALUES will contain MOVEitUserInfo objects.) Returns an empty HashMap if no users are found or null if the currently authorized user is not permitted to get this information.

Parameters:

page - page number to return (starting with 1). If the value provided is larger than the number of pages in the current list, the first page of results will be returned

entriesPerPage - number of entries to return in each page of results

Returns:

HashMap containing list results if successful, null otherwise

makeRandomUserPassword

public java.lang.String makeRandomUserPassword(java.lang.String Username)

Returns a randomly generated password that is acceptable by the password length and strength standards of the currently signed on user's organization. The new password will be tested against the provided username to make sure the two do not match. Use this method to generate an acceptable password when creating a new user.

Parameters:

Username - username or ID of user to generate password for. Used to make sure that the generated password does not contain the username

Returns:

randomly generated password if successful, blank string otherwise

addGroup

public boolean addGroup(java.lang.String GroupName,
                        java.lang.String Description)

Adds a new group with the provided name and description. Returns TRUE if successful; FALSE otherwise.

Parameters:

GroupName - name of the new group

Description - description of the new group

Returns:

true if successful, false otherwise

addGroup

public boolean addGroup(java.lang.String GroupName)

Adds a new group with the provided name. Returns TRUE if successful; FALSE otherwise.

Parameters:

GroupName - name of the new group

Returns:

true if successful, false otherwise

changeGroupSetting

public boolean changeGroupSetting(java.lang.String GroupName,
                                  java.lang.String SettingName,
                                  java.lang.String NewValue)

Attempts to change a setting on the specified group. Possible values for SettingName are listed below. Returns TRUE if successful, FALSE if not.

Setting Name	Allowed New Value
adminfolderaccess	0 = No 1 = Yes
adminfolderrelationship	Permission String
admintempuseraccess	0 = No 1 = Yes
allowattachments	0 = No 1 = Yes
cancreatetempusers	0 = No 1 = Yes
description	Any String
displayprofile	Name of a valid display profile to apply, or a blank string to apply none.
maxmaxattchsize	0 = None 1-9,223,372,036,854,775,807 = max max attachment size (in bytes)
maxmemberquota	0 = None 1-9,223,372,036,854,775,807 = max member quota size (in bytes)
tempusersinaddrbookexpansion	0 = No 1 = Yes

The Permission String value should consist of one or more of the following letters:

• A = Admin
• E = Subfolders
• D = Delete
• L = List
• N = Notify
• R = Read
• W = Write

Parameters:

GroupName - name of group to change setting for

SettingName - name of setting to change

NewValue - value to apply to setting

Returns:

true if successful, false otherwise

deleteGroup

public boolean deleteGroup(java.lang.String GroupName)

Deletes the group specified by GroupName. Returns TRUE if successful, FALSE if not.

Parameters:

GroupName - name or ID of group to remove

Returns:

true if successful, false otherwise

runReport

public boolean runReport(java.lang.String ReportName,
                         java.lang.String LocalPath)

Runs the report specified by ReportName and saves it to the path specified by LocalPath. Returns TRUE if successful, FALSE if not.

Parameters:

ReportName - name of report to run

LocalPath - path of the file on the local filesystem to save the report contents to

Returns:

true if successful, false otherwise

runCustomReport

public boolean runCustomReport(java.lang.String fields,
                               java.lang.String tables,
                               java.lang.String criteria,
                               java.lang.String grouping,
                               java.lang.String order,
                               java.lang.String limit,
                               java.lang.String OutputFormat,
                               java.lang.String LocalPath)

Runs a custom report with the specified custom options and output format and saves it to the path specified by LocalPath. Returns TRUE if successful, FALSE if not.

These are the valid output format values:

Value	Description
CSV	Comma-seperated values
XML	XML
HTMLNAKED	Basic, unstyled HTML
HTMLSTYLED	Styled HTML

Parameters:

fields - SQL fields to query

tables - SQL tables to query

criteria - SQL criteria to apply

grouping - SQL groupings to apply

order - SQL order to apply

limit - SQL limit to apply

OutputFormat - output format to return the report in

LocalPath - path of the file on the local filesystem to save the report contents to

Returns:

true if successful, false otherwise

signon

public boolean signon(java.lang.String Username,
                      java.lang.String Password)

Given a username and password, returns TRUE if signon is successful, FALSE otherwise. This method also sets the StatusCode property to "No error" (0) if successful.

Parameters:

Username - username to sign on to host with

Password - password to sign on to host with

Returns:

true if successful, false otherwise

signon

public boolean signon(java.lang.String Username,
                      java.lang.String Password,
                      java.lang.String ActAsIP)

Given a username and password, returns TRUE if signon is successful, FALSE otherwise. This method also sets the StatusCode property to "No error" (0) if successful. If the API host is trusted, the given IP address will be logged and displayed on the MOVEit Transfer host instead of the API host address.

Parameters:

Username - username to sign on to host with

Password - password to sign on to host with

ActAsIP - IP address to act as

Returns:

true if successful, false otherwise

getOrgSAMLInfo

public com.stdnet.moveit.api.MOVEitSAMLInfo getOrgSAMLInfo(java.lang.String OrgID)

Gets SAML signon information for the specified organization of the MOVEit Transfer host. This method may be called before a signon, and is used to get information about an organization's SAML settings in order to obtain a SAML assertion to be used to authenticate to the MOVEit Transfer server.

Parameters:

OrgID - ID of organization to get SAML information for

Returns:

SAML information object, or null if an error occurred

See Also:

getOrgSAMLInfo(), signonWithSAMLAssertion(Document)

getOrgSAMLInfo

public com.stdnet.moveit.api.MOVEitSAMLInfo getOrgSAMLInfo()

Gets SAML signon information for the default organization of the MOVEit Transfer host. This method may be called before a signon, and is used to get information about an organization's SAML settings in order to obtain a SAML assertion to be used to authenticate to the MOVEit Transfer server.

Returns:

SAML information object, or null if an error occurred

See Also:

getOrgSAMLInfo(String), signonWithSAMLAssertion(Document)

signonWithSAMLAssertion

public boolean signonWithSAMLAssertion(org.w3c.dom.Document SAMLAssertion)

Signs on to a MOVEit Transfer host using a SAML assertion document, rather than a username and password. This document is received from a SAML Identity Provider as a response to a SAML authentication request.

Parameters:

SAMLAssertion - SAML assertion document

Returns:

true if successful; otherwise, false

See Also:

signonWithSAMLAssertion(Document,String), getOrgSAMLInfo()

signonWithSAMLAssertion

public boolean signonWithSAMLAssertion(org.w3c.dom.Document SAMLAssertion,
                                       java.lang.String ActAsIP)

Signs on to a MOVEit Transfer host using a SAML assertion document, rather than a username and password. This document is received from a SAML Identity Provider as a response to a SAML authentication request. If the API host is trusted, the provided IP address will be logged and displayed on the MOVEit Transfer host instead of the API host address.

Parameters:

SAMLAssertion - SAML assertion document

ActAsIP - IP address to act as

Returns:

true if successful; otherwise, false

See Also:

signonWithSAMLAssertion(Document), getOrgSAMLInfo()

signoff

public boolean signoff()

Signs off the current user. Another use of the SignOn method is required before any other commands are given. Returns TRUE if successful; FALSE otherwise.

Returns:

true if successful, false otherwise

asAgent

public java.lang.String asAgent()

Gets the current agent string to be logged and displayed on the MOVEit Transfer server.

Returns:

agent name to report

asAgent

public java.lang.String asAgent(java.lang.String sAgent)

Sets an agent string to be logged and displayed on the MOVEit Transfer server.

Parameters:

sAgent - agent name to report

Returns:

agent name to report

actAsIP

public java.lang.String actAsIP()

Returns the ActAs IP address specified during the signon process. If one has not been specified, returns a blank string.

Returns:

ActAs IP address

clientCertFilePath

public java.lang.String clientCertFilePath(java.lang.String path)

Tells MOVEit Transfer API to use a client certificate from the given file when connecting to MOVEit Transfer.

Overrides:

clientCertFilePath in class com.stdnet.moveit.api.ClientBase

Parameters:

path - filename of a .pfx, .p12, or Java certificate store

Returns:

the path passed in

clientCertFilePath

public java.lang.String clientCertFilePath()

Returns the filename used to provide a client certificates when connecting to MOVEit Transfer.

Overrides:

clientCertFilePath in class com.stdnet.moveit.api.ClientBase

Returns:

the currently-configured client certificate file.

clientCertType

public java.lang.String clientCertType(java.lang.String fileType)

Tells MOVEit Transfer API the type of the client certificate file set in clientCertFilePath.

Overrides:

clientCertType in class com.stdnet.moveit.api.ClientBase

Parameters:

fileType - "PKCS12" for a .pfx (aka .p12) file, or "JKS" for a Java keystore file

Returns:

the given file type

clientCertType

public java.lang.String clientCertType()

Returns the client certificate file type.

Overrides:

clientCertType in class com.stdnet.moveit.api.ClientBase

Returns:

the currently-configured client certificate file type.

clientCertPassword

public java.lang.String clientCertPassword(java.lang.String pw)

Tells MOVEit Transfer API the password to the client certificate file set in clientCertFilePath.

Overrides:

clientCertPassword in class com.stdnet.moveit.api.ClientBase

Parameters:

pw - the password to the client certificate file.

Returns:

the password passed in.

clientCertPassword

public java.lang.String clientCertPassword()

Returns the to the client certificate file.

Overrides:

clientCertPassword in class com.stdnet.moveit.api.ClientBase

Returns:

the currently-configured client certificate file.

errorCode

public int errorCode()

Returns the status code of the last action performed. A code of 0 indicates no error; other codes an error has occured.

Overrides:

errorCode in class com.stdnet.moveit.api.ClientBase

Returns:

last status code with 0 or 40 indicating success

errorDescription

public java.lang.String errorDescription()

Returns a description of the last action performed. A description of "" usually indicates no error, but not always. Use the "errorCode" property to programmatically respond to MOVEit Transfer API error codes; use the "errorDescription" property to display information to a user or into your own log files.

Overrides:

errorDescription in class com.stdnet.moveit.api.ClientBase

Returns:

last status description

homeFolder

public java.lang.String homeFolder()

The full path of this user's home folder. This value will be blank for users who have not yet or failed to sign on. It will be the path of the root folder for users who do not have a home folder.

Returns:

current user home folder path

homeFolderID

public int homeFolderID()

The ID of this user's home folder. This value will be -1 for users who have not yet or failed to sign on. It will be the ID of the root folder for users who do not have a home folder.

Returns:

current user home folder ID

welcomeMessage

public java.lang.String welcomeMessage()

Returns:

The organization welcome message.

host

public java.lang.String host()

The hostname or IP address of the remote MOVEit Transfer server. Examples: "192.168.3.48" or "moveit.stdnet.com". Please note that if an IP address is used, you will probably have to set the "IgnoreCertProbs" property to false. (This is often required because SSL certificates are linked to hostnames, not IP addresses.) There is no default value for the "Host" property; you must always set it explicitly.

Overrides:

host in class com.stdnet.moveit.api.ClientBase

Returns:

currently configured host

host

public java.lang.String host(java.lang.String sHost)

The hostname or IP address of the remote MOVEit Transfer server. Examples: "192.168.3.48" or "moveit.stdnet.com". Please note that if an IP address is used, you will probably have to set the "IgnoreCertProbs" property to false. (This is often required because SSL certificates are linked to hostnames, not IP addresses.) There is no default value for the "Host" property; you must always set it explicitly.

Overrides:

host in class com.stdnet.moveit.api.ClientBase

Parameters:

sHost - host to configure

Returns:

currently configured host

technicalDebug

public boolean technicalDebug()

Returns current debug flag.

Overrides:

technicalDebug in class com.stdnet.moveit.api.ClientBase

Returns:

current value of debug flag

technicalDebug

public boolean technicalDebug(boolean bDebug)

Sets and returns debug flag.

Overrides:

technicalDebug in class com.stdnet.moveit.api.ClientBase

Parameters:

bDebug - true or false (default is false)

Returns:

current value of debug flag

ignoreCertProbs

public boolean ignoreCertProbs()

Tells MOVEit Transfer API to ignore certificate problems such as those caused by "test certificates" (bad CA) and connections by IP address rather than by host (name mismatch). However, this value does not apply to expired certificates, which will always cause MOVEit Transfer API to halt its connection process. By default, this value is set to FALSE.

Overrides:

ignoreCertProbs in class com.stdnet.moveit.api.ClientBase

Returns:

currently configured IgnoreCertProbs value

ignoreCertProbs

public boolean ignoreCertProbs(boolean bIgnoreCertProbs)

Tells MOVEit Transfer API to ignore certificate problems such as those caused by "test certificates" (bad CA) and connections by IP address rather than by host (name mismatch). However, this value does not apply to expired certificates, which will always cause MOVEit Transfer API to halt its connection process. By default, this value is set to FALSE.

Overrides:

ignoreCertProbs in class com.stdnet.moveit.api.ClientBase

Parameters:

bIgnoreCertProbs - IgnoreCertProbs value to configure

Returns:

currently configured IgnoreCertProbs value

orgID

public int orgID()

The Organization ID of the current user. This value will be 0 for SysAdmins, -1 for users who have not yet or failed to sign on, and a positive 4-digit integer for all other users.

Returns:

current organization ID

orgName

public java.lang.String orgName()

The Organization Name of the current user. This value will be blank for users who have not yet or failed to sign on.

Returns:

current organization name

payload

public org.w3c.dom.Node payload()

The raw XML payload returned by the MOVEit Transfer server for the last transaction.

Returns:

node object containing response payload

port

public int port()

The port used by the HTTP or HTTPS service on the remote MOVEit Transfer server. Examples: 80 and 443. By default, this value is set to 80 when the "Secure" property is FALSE and is set to 443 when the "Secure" property is TRUE.

Overrides:

port in class com.stdnet.moveit.api.ClientBase

Returns:

currently configured port

port

public int port(int iPort)

The port used by the HTTP or HTTPS service on the remote MOVEit Transfer server. Examples: 80 and 443. By default, this value is set to 80 when the "Secure" property is FALSE and is set to 443 when the "Secure" property is TRUE.

Overrides:

port in class com.stdnet.moveit.api.ClientBase

Parameters:

iPort - port to configure

Returns:

current configured port

rawResponse

public java.lang.String rawResponse()

Returns the raw data returned from the MOVEit Transfer host in response to the most recent transaction.

Returns:

raw response text

scriptPath

public java.lang.String scriptPath()

Used only when MOVEit Transfer has been installed into a subdirectory of an existing webserver, this property indicates what that subdirectory is. For example, if MOVEit Transfer has been installed on "www.stdnet.com" in the "midmz" folder (full URL: "https://www.stdnet.com/midmz"), then the value of this property must be set to "midmz".

Returns:

currently configured script path

scriptPath

public java.lang.String scriptPath(java.lang.String sScriptPath)

Used only when MOVEit Transfer has been installed into a subdirectory of an existing webserver, this property indicates what that subdirectory is. For example, if MOVEit Transfer has been installed on "www.stdnet.com" in the "midmz" folder (full URL: "https://www.stdnet.com/midmz"), then the value of this property must be set to "midmz".

Parameters:

sScriptPath - script path to configure

Returns:

currently configured script path

secure

public boolean secure()

Indicates whether to use unencrypted HTTP (if FALSE) or encrypted HTTPS (if TRUE) for all communications to MOVEit Transfer. Default value is TRUE.

Overrides:

secure in class com.stdnet.moveit.api.ClientBase

Returns:

currently configured secure connection value

secure

public boolean secure(boolean bSecure)

Indicates whether to use unencrypted HTTP (if FALSE) or encrypted HTTPS (if TRUE) for all communications to MOVEit Transfer. Default value is TRUE.

Overrides:

secure in class com.stdnet.moveit.api.ClientBase

Parameters:

bSecure - secure connection value to configure

Returns:

currently configured secure connection value

sessionID

public java.lang.String sessionID()

Returns the session ID of the current session, if the API instance is signed on to a MOVEit Transfer server. Otherwise, returns a blank string.

Returns:

current session ID if signed on, blank string otherwise

sessionCookie

public java.lang.String sessionCookie()

Returns the session cookie of the current session, if the API instance is signed on to a MOVEit Transfer server. Otherwise, returns a blank string.

Returns:

current session cookie if signed on, blank string otherwise

statusCode

public int statusCode()

Returns the status code of the last action performed. A code of 0 indicates no error; other codes an error has occured.

Overrides:

statusCode in class com.stdnet.moveit.api.ClientBase

Returns:

last status code with 0 or 40 indicating success

statusDescription

public java.lang.String statusDescription()

Returns a description of the last action performed. A description of "" usually indicates no error, but not always. Use the "statusCode" property to programmatically respond to MOVEit Transfer API error codes; use the "statusDescription" property to display information to a user or into your own log files.

Overrides:

statusDescription in class com.stdnet.moveit.api.ClientBase

Returns:

last status description

userListCount

public int userListCount()

Returns the total number of users available via the most recent listUsers or listUsersAdvanced function call. If no call has been made, returns 0.

Returns:

total number of users available via the most recent listUsers or listUsersAdvanced call

username

public java.lang.String username()

Returns the Username of the currently signed on user. (e.g. "jmith"). This property will be blank prior to a successful signon.

Returns:

currently signed on username

userID

public java.lang.String userID()

Returns the ID of the currently signed on user. (e.g. "jsmithr8my61b5oj"). This property will be blank prior to a successful signon.

Returns:

currently signed on user ID

userRealname

public java.lang.String userRealname()

Returns the Realname of the currently signed on user. (e.g. "John Smith"). This property will be blank prior to a successful signon.

Returns:

currently signed on user display name

useProxy

public void useProxy(boolean bUseProxy)

Indicates whether proxy settings should be used. Default is false, which means that proxyHost, etc., will be ignored.

Parameters:

bUseProxy - is true if proxy settings should be used

useProxy

public boolean useProxy()

Indicates whether proxy settings should be used. Default is false, which means that proxyHost, etc., will be ignored.

Returns:

true if proxy settings are being used

httpProxyHost

public void httpProxyHost(java.lang.String host)

The proxy hostname to use for HTTP requests.

Parameters:

host - the proxy hostname to use for HTTP requests

httpProxyHost

public java.lang.String httpProxyHost()

The proxy hostname to use for HTTP requests.

Returns:

the proxy hostname that is being used for HTTP requests

httpProxyPort

public void httpProxyPort(int port)

The proxy port to use for HTTP requests.

Parameters:

port - the proxy port to use for HTTP requests

httpProxyPort

public int httpProxyPort()

The proxy port to use for HTTP requests.

Returns:

the proxy port that is being used for HTTP requests

httpProxyUser

public void httpProxyUser(java.lang.String user)

The proxy username to use for HTTP requests. Note: not all proxies require username/password.

Parameters:

user - the proxy username to use for HTTP requests

httpProxyUser

public java.lang.String httpProxyUser()

The proxy username to use for HTTP requests.

Returns:

the proxy username that is being used for HTTP requests

httpProxyPassword

public void httpProxyPassword(java.lang.String password)

The proxy password to use for HTTP requests.

Parameters:

password - the proxy password to use for HTTP requests

httpProxyPassword

public java.lang.String httpProxyPassword()

The proxy password to use for HTTP requests.

Returns:

the proxy password that is being used for HTTP requests

httpsProxyHost

public void httpsProxyHost(java.lang.String host)

The proxy hostname to use for HTTPS requests.

Parameters:

host - the proxy hostname to use for HTTPS requests

httpsProxyHost

public java.lang.String httpsProxyHost()

The proxy hostname to use for HTTPS requests.

Returns:

the proxy hostname that is being used for HTTPS requests

httpsProxyPort

public void httpsProxyPort(int port)

The proxy port to use for HTTPS requests.

Parameters:

port - the proxy port to use for HTTPS requests

httpsProxyPort

public int httpsProxyPort()

The proxy port to use for HTTPS requests.

Returns:

the proxy port that is being used for HTTPS requests

httpsProxyUser

public void httpsProxyUser(java.lang.String user)

The proxy username to use for HTTPS requests. Note: not all proxies require username/password.

Parameters:

user - the proxy username to use for HTTPS requests

httpsProxyUser

public java.lang.String httpsProxyUser()

The proxy username to use for HTTPS requests.

Returns:

the proxy username that is being used for HTTPS requests

httpsProxyPassword

public void httpsProxyPassword(java.lang.String password)

The proxy password to use for HTTPS requests.

Parameters:

password - the proxy password to use for HTTPS requests

httpsProxyPassword

public java.lang.String httpsProxyPassword()

The proxy password to use for HTTPS requests.

Returns:

the proxy password that is being used for HTTPS requests