com.stdnet.moveit.api

Class MOVEitFileInfo

java.lang.Object

com.stdnet.moveit.api.MOVEitObjectInfo

com.stdnet.moveit.api.MOVEitFilesystemObjectInfo

com.stdnet.moveit.api.MOVEitFileInfo

public class MOVEitFileInfo
extends MOVEitFilesystemObjectInfo

Container object used to provide information about a specific file on a MOVEit Transfer server. Instances of the object are returned by various methods of the Client object. An instance of the object is populated using information returned from the MOVEit Transfer host, and then passed on to the calling program, which can then access the information through the available methods.

Constructor Summary

Constructors

Constructor and Description
MOVEitFileInfo()

Method Summary

Modifier and Type	Method and Description
java.lang.String	currentFileType() Describes the type of file viewed.
int	downloadCount() Number of times this file has been downloaded.
long	fileSize() Size in bytes of this file.
java.lang.String	folderID() ID of the folder this file is currently in.
int	isNew() Determines if the file is considered "new" for the current user.
java.lang.String	name() The name of this file.
java.lang.String	originalFilename() The original name of this file.
java.lang.String	originalFileType() Describes what type of file this file was originally.
java.lang.String	path() The full path of this file.
java.lang.String	uploadAgentBrand() Brand of the agent used to upload this file.
java.lang.String	uploadAgentVersion() Version of the agent used to upload this file.
java.lang.String	uploadComment() Contains any optional comments used to describe this upload.
int	uploadIntegrity() 1 if file was uploaded with integrity checking, 0 if file was not.
java.lang.String	uploadIP() The IP Address, if any, from which this file was uploaded.
java.lang.String	uploadRealname() The real name of the person or automated account (e.g.
java.lang.String	uploadStamp() The date and time this file was uploaded.
java.lang.String	uploadUserID() The user ID of the person or automated account (e.g.
java.lang.String	uploadUsername() The username of the person or automated account (e.g.

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

ID, instID, orgID, parentID

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

dataInitialized

Methods inherited from class java.lang.Object

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

Constructor Detail

MOVEitFileInfo

public MOVEitFileInfo()

Method Detail

folderID

public java.lang.String folderID()

ID of the folder this file is currently in.

Returns:

Folder ID

fileSize

public long fileSize()

Size in bytes of this file.

Returns:

Filesize in bytes

originalFileType

public java.lang.String originalFileType()

Describes what type of file this file was originally.

Returns:

Filetype code of the original file

Possible codes are:

• 3 = Webpost in CSV format
• 4 = Webpost in XML format
• 6 = Audit log archive in XML format
• 31 = Raw file (no conversion)

currentFileType

public java.lang.String currentFileType()

Describes the type of file viewed.

Returns:

Filetype code of the current file

Possible codes are:

• 3 = Webpost in CSV format
• 4 = Webpost in XML format
• 6 = Audit log archive in XML format
• 31 = Raw file (no conversion)

uploadStamp

public java.lang.String uploadStamp()

The date and time this file was uploaded.

Returns:

Date and time

uploadUsername

public java.lang.String uploadUsername()

The username of the person or automated account (e.g. "jsmith") which uploaded this file.

Returns:

Username

uploadUserID

public java.lang.String uploadUserID()

The user ID of the person or automated account (e.g. "jsmithr8my61b5oj") which uploaded this file.

Returns:

User ID

uploadRealname

public java.lang.String uploadRealname()

The real name of the person or automated account (e.g. "John Smith") which uploaded this file.

Returns:

Display name

uploadComment

public java.lang.String uploadComment()

Contains any optional comments used to describe this upload.

Returns:

Any comments

uploadIP

public java.lang.String uploadIP()

The IP Address, if any, from which this file was uploaded.

Returns:

IP address

uploadAgentBrand

public java.lang.String uploadAgentBrand()

Brand of the agent used to upload this file. Example: "Netscape".

Returns:

Agent brand

uploadAgentVersion

public java.lang.String uploadAgentVersion()

Version of the agent used to upload this file. Example: "6.02b".

Returns:

Agent version

uploadIntegrity

public int uploadIntegrity()

1 if file was uploaded with integrity checking, 0 if file was not. Integrity checks are automatically conducted between MOVEit clients and MOVEit Transfer. For example, all uploads and downloads performed by MOVEit Transfer API are conducted with integrity checks. Integrity checks are useful because they prove that a file transferred through the MOVEit system is identical to the original when it arrives at its destination. (When used with authentication, integrity checks provide non-repudiation.)

Returns:

Integrity check indicator

downloadCount

public int downloadCount()

Number of times this file has been downloaded.

Returns:

Download count

originalFilename

public java.lang.String originalFilename()

The original name of this file. Example: "readme.txt". In folders where "enforce unique filenames" is turned off, there may be several files with the same originalFilename.

Returns:

Original name of the file

name

public java.lang.String name()

The name of this file. Example: "readme.txt". In folders where "enforce unique filenames" is turned off, this will generally be a combination of the original file name and the file ID. Example: "readme_1234567.txt".

Overrides:

name in class MOVEitFilesystemObjectInfo

Returns:

Name of the file

path

public java.lang.String path()

The full path of this file. Example: "/Distribution/Software 2003/readme.txt". This will be a combination of the parent folder's path, and the file's name. Example: "/Distribution/Software 2003/readme_1234567.txt".

Overrides:

path in class MOVEitFilesystemObjectInfo

Returns:

Full path of the file

isNew

public int isNew()

Determines if the file is considered "new" for the current user.

Returns:

1 if the file is new, 0 if it is not, or -1 if the "new" status of the file is not known