de.tuberlin.onedrivesdk.file

Interface OneFile

public interface OneFile

This Interface provides all Methods to handle a File

Method Summary

Modifier and Type	Method and Description
OneFile	copy(OneFolder targetFolder) Copy this file into the target folder.
OneFile	copy(OneFolder targetFolder, java.lang.String name) Copy this file into the target folder.
boolean	delete() Deletes the current folder.
OneDownloadFile	download(java.io.File targetFile) Downloads this file into the specified local file handle.
java.lang.String	getCRC32Hash() Gets the CRC32 value of the file (if available).
java.util.HashMap<java.lang.String,DriveUser>	getCreatedBy() The created by reference.
long	getCreatedDateTime() The creation timestamp of this file in unix format.
java.lang.String	getCTag() Gets the cTag.
java.lang.String	getDownloadUrl() Returns a URL that can be used to download this file's content.
java.lang.String	getETag() Gets the eTag.
java.lang.String	getId() Gets the OneDrive id of the file.
java.util.HashMap<java.lang.String,DriveUser>	getLastModifiedBy() The last modified reference.
long	getLastModifiedDateTime() The last modified timestamp of this file.
long	getLastRefresh() Returns the last refresh time since the folder metadata was fetched from the OneDrive server.
java.lang.String	getMimeType() Gets the MIME type for the file.
java.lang.String	getName() Gets the name of the folder.
OneFolder	getParentFolder() Gets the currents parent folder.
java.lang.String	getRawJson() Gets the raw JSON which is received from the OneDrive API.
java.lang.String	getSHA1Hash() Gets the SHA1 hash for the contents of the file (if available).
long	getSize() Gets the size of this file in bytes.
java.lang.String	getWebUrl() Gets the URL that displays the resource in the browser.
OneFile	move(OneFolder targetFolder) Move this file into the target folder.
OneFile	refresh() Refreshes the metadata of this file.

Method Detail

getDownloadUrl

java.lang.String getDownloadUrl()

Returns a URL that can be used to download this file's content.

Returns:

web url

getCTag

java.lang.String getCTag()

Gets the cTag.

Returns:

cTag

getETag

java.lang.String getETag()

Gets the eTag.

Returns:

eTag

getId

java.lang.String getId()

Gets the OneDrive id of the file.

Returns:

id

getName

java.lang.String getName()

Gets the name of the folder.

Returns:

name

getSize

long getSize()

Gets the size of this file in bytes.

Returns:

size

getCreatedBy

java.util.HashMap<java.lang.String,DriveUser> getCreatedBy()

The created by reference. Possible keys are 'user', 'application' and 'device'.

Returns:

created by

getCreatedDateTime

long getCreatedDateTime()

The creation timestamp of this file in unix format.

Returns:

unix formatted timestamp

getLastModifiedBy

java.util.HashMap<java.lang.String,DriveUser> getLastModifiedBy()

The last modified reference. Possible keys are 'user', 'application' and 'device'.

Returns:

last modified by

getLastModifiedDateTime

long getLastModifiedDateTime()

The last modified timestamp of this file.

Returns:

unix formatted timestamp

getLastRefresh

long getLastRefresh()

Returns the last refresh time since the folder metadata was fetched from the OneDrive server.

Returns:

unix formatted timestamp

refresh

OneFile refresh()
         throws OneDriveException,
                java.io.IOException

Refreshes the metadata of this file.

Returns:

OneFile with new reference

Throws:

OneDriveException

java.io.IOException

getCRC32Hash

java.lang.String getCRC32Hash()

Gets the CRC32 value of the file (if available).

Returns:

cRC 32 hash

getSHA1Hash

java.lang.String getSHA1Hash()

Gets the SHA1 hash for the contents of the file (if available).

Returns:

SHA1 hash

getMimeType

java.lang.String getMimeType()

Gets the MIME type for the file.

Returns:

mime type

getParentFolder

OneFolder getParentFolder()
                   throws java.io.IOException,
                          OneDriveException

Gets the currents parent folder.

Returns:

the currents parent folder

Throws:

java.io.IOException

OneDriveException

getWebUrl

java.lang.String getWebUrl()

Gets the URL that displays the resource in the browser.

Returns:

web url

download

OneDownloadFile download(java.io.File targetFile)
                  throws java.io.FileNotFoundException

Downloads this file into the specified local file handle. Will block until finished or interrupted.

Parameters:

targetFile - the local file handle. MUST be writable.

Returns:

the DownloadSession

Throws:

java.io.FileNotFoundException

delete

boolean delete()
        throws java.io.IOException,
               OneDriveException

Deletes the current folder.

Returns:

true if the deletion was successful, false otherwise

Throws:

OneDriveException

java.io.IOException

copy

OneFile copy(OneFolder targetFolder)
      throws java.io.IOException,
             OneDriveException,
             org.json.simple.parser.ParseException,
             java.lang.InterruptedException

Copy this file into the target folder.

Parameters:

targetFolder - destination folder

Returns:

the new created reference of the file in the new folder

Throws:

java.io.IOException

OneDriveException

org.json.simple.parser.ParseException

java.lang.InterruptedException

copy

OneFile copy(OneFolder targetFolder,
             java.lang.String name)
      throws java.io.IOException,
             OneDriveException,
             org.json.simple.parser.ParseException,
             java.lang.InterruptedException

Copy this file into the target folder.

Parameters:

targetFolder - destination folder

name - a new name for the file

Returns:

the new created reference of the file in the new folder

Throws:

java.io.IOException

OneDriveException

org.json.simple.parser.ParseException

java.lang.InterruptedException

move

OneFile move(OneFolder targetFolder)
      throws java.lang.InterruptedException,
             OneDriveException,
             org.json.simple.parser.ParseException,
             java.io.IOException

Move this file into the target folder.

Parameters:

targetFolder - destination folder

Returns:

the reference of the file in the new folder

Throws:

java.lang.InterruptedException

OneDriveException

org.json.simple.parser.ParseException

java.io.IOException

getRawJson

java.lang.String getRawJson()

Gets the raw JSON which is received from the OneDrive API.

Returns:

raw json