ExoDocumentUtils (eXo Mobile Android 2.10-SNAPSHOT API)

java.lang.Object
- org.exoplatform.utils.ExoDocumentUtils

public class ExoDocumentUtils
extends Object

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class ExoDocumentUtils.DocumentInfo

Nested Classes
Modifier and Type	Class and Description
`static class`	`ExoDocumentUtils.DocumentInfo`

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`ALL_AUDIO_TYPE`
`static String`	`ALL_IMAGE_TYPE`
`static String`	`ALL_TEXT_TYPE`
`static String`	`ALL_VIDEO_TYPE`
`static String`	`AUDIO_TYPE`
`static String[]`	`FORBIDDEN_TYPES`
`static String`	`IMAGE_TYPE`
`static String`	`MSWORD_TYPE`
`static String`	`OPEN_POWERPOINT_TYPE`
`static String`	`OPEN_WORD_TYPE`
`static String`	`OPEN_XLS_TYPE`
`static String`	`PDF_TYPE`
`static String`	`POWERPOINT_TYPE`
`static int`	`ROTATION_0`
`static int`	`ROTATION_180`
`static int`	`ROTATION_270`
`static int`	`ROTATION_90`
`static String`	`TEXT_TYPE`
`static String`	`VIDEO_TYPE`
`static String`	`XLS_TYPE`

Constructor Summary

Constructors
Constructor and Description

ExoDocumentUtils()

Constructors
Constructor and Description
`ExoDocumentUtils()`

Method Summary

Methods
Modifier and Type	Method and Description
`static String`	`cleanupFilename(String originalName)` On Platform 4.1-M2, the upload service renames the uploaded file.
`static boolean`	`copyFile(String source, String destination)`
`static boolean`	`createFolder(String destination)`
`static boolean`	`deleteFile(String url)` Delete remote folder or file
`static boolean`	`deleteLocalFiles(List<String> files)` Delete the Files at the given paths
`static boolean`	`didRequestPermission(android.app.Activity caller, int permissionCode)` Check whether the application needs to request the permission required by the activity.
`static ExoDocumentUtils.DocumentInfo`	`documentFromContentUri(android.net.Uri contentUri, android.content.Context context)` Gets a DocumentInfo with info coming from the document at the given URI.
`static ExoDocumentUtils.DocumentInfo`	`documentFromFileUri(android.net.Uri fileUri)` Gets a DocumentInfo with info coming from the file at the given URI.
`static ExoDocumentUtils.DocumentInfo`	`documentInfoFromUri(android.net.Uri document, android.content.Context context)` Returns a DocumentInfo with info coming from the file at the given URI
`static CompatibleFileOpen.FileOpenRequest`	`fileOpen(android.content.Context context, String fileType, String filePath, String fileName)`
`static String`	`fullURLofFile(String workSpaceName, String url)`
`static ExoFile`	`getContentOfFolder(org.apache.http.HttpResponse response, ExoFile file)` Get a folder with its sub-files and sub-folders. Parse the XML response with format:
`static ArrayList<ExoFile>`	`getDrives(org.apache.http.HttpResponse response)` Get the list of folders in a drive, from the HTTP response. The response's body is an XM document that is parsed to extract the information of the folders.
`static ArrayList<ExoFile>`	`getDrives(org.apache.http.HttpResponse response, boolean isGroupDrive)` Get the list of folders in a drive, from the HTTP response. The response's body is an XM document that is parsed to extract the information of the folders.
`static int`	`getExifOrientationAngleFromFile(String filePath)` Get the EXIF orientation of the given file
`static String`	`getFileSize(long fileSize)`
`static int`	`getFreeMemory(String path)`
`static String`	`getFullFileType(String fileType)`
`static int`	`getIconFromType(String contentType)`
`static String`	`getLastPathComponent(String url)`
`static String`	`getParentUrl(String url)`
`static ExoFile`	`getPersonalDriveContent(android.content.Context context, ExoFile file)` Get the content (files and folders) of the given folder.
`static boolean`	`isCallable(android.content.Context context, String mimeType, String url)` Check if the device has an application to open this type of file.
`static boolean`	`isContainSpecialChar(String str, String charSet)`
`static boolean`	`isEnoughMemory(int fileSize)`
`static boolean`	`isForbidden(String mimeType)` Check whether the given Mime Type is forbidden.
`static boolean`	`moveFile(String source, String destination)`
`static boolean`	`putFileToServerFromLocal(String url, File fileManager, String fileType)`
`static boolean`	`renameFolder(String source, String destination)`
`static android.graphics.Bitmap`	`rotateBitmapByAngle(android.graphics.Bitmap source, int angle)` Rotate the bitmap by a certain angle.
`static android.graphics.Bitmap`	`rotateBitmapToNormal(String filePath, android.graphics.Bitmap source)` Rotate the bitmap at its correct orientation
`static void`	`setRepositoryHomeUrl(String userName, String userHomeNodePath, String domain)`
`static boolean`	`shouldDisplayExplanation(android.app.Activity activity, int permCode)` Check whether the request for the specified permission should be explained to the user.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - ALL_VIDEO_TYPE
```
public static final String ALL_VIDEO_TYPE
```
    See Also:
    Constant Field Values
  - ALL_AUDIO_TYPE
```
public static final String ALL_AUDIO_TYPE
```
    See Also:
    Constant Field Values
  - ALL_IMAGE_TYPE
```
public static final String ALL_IMAGE_TYPE
```
    See Also:
    Constant Field Values
  - ALL_TEXT_TYPE
```
public static final String ALL_TEXT_TYPE
```
    See Also:
    Constant Field Values
  - IMAGE_TYPE
```
public static final String IMAGE_TYPE
```
    See Also:
    Constant Field Values
  - TEXT_TYPE
```
public static final String TEXT_TYPE
```
    See Also:
    Constant Field Values
  - VIDEO_TYPE
```
public static final String VIDEO_TYPE
```
    See Also:
    Constant Field Values
  - AUDIO_TYPE
```
public static final String AUDIO_TYPE
```
    See Also:
    Constant Field Values
  - MSWORD_TYPE
```
public static final String MSWORD_TYPE
```
    See Also:
    Constant Field Values
  - OPEN_WORD_TYPE
```
public static final String OPEN_WORD_TYPE
```
    See Also:
    Constant Field Values
  - PDF_TYPE
```
public static final String PDF_TYPE
```
    See Also:
    Constant Field Values
  - XLS_TYPE
```
public static final String XLS_TYPE
```
    See Also:
    Constant Field Values
  - OPEN_XLS_TYPE
```
public static final String OPEN_XLS_TYPE
```
    See Also:
    Constant Field Values
  - POWERPOINT_TYPE
```
public static final String POWERPOINT_TYPE
```
    See Also:
    Constant Field Values
  - OPEN_POWERPOINT_TYPE
```
public static final String OPEN_POWERPOINT_TYPE
```
    See Also:
    Constant Field Values
  - FORBIDDEN_TYPES
```
public static final String[] FORBIDDEN_TYPES
```
  - ROTATION_0
```
public static final int ROTATION_0
```
    See Also:
    Constant Field Values
  - ROTATION_90
```
public static final int ROTATION_90
```
    See Also:
    Constant Field Values
  - ROTATION_180
```
public static final int ROTATION_180
```
    See Also:
    Constant Field Values
  - ROTATION_270
```
public static final int ROTATION_270
```
    See Also:
    Constant Field Values
- Constructor Detail
  - ExoDocumentUtils
```
public ExoDocumentUtils()
```
- Method Detail
  - isEnoughMemory
```
public static boolean isEnoughMemory(int fileSize)
```
  - getFreeMemory
```
public static int getFreeMemory(String path)
```
  - getFileSize
```
public static String getFileSize(long fileSize)
```
  - fileOpen
```
public static CompatibleFileOpen.FileOpenRequest fileOpen(android.content.Context context,
                                          String fileType,
                                          String filePath,
                                          String fileName)
```
  - isForbidden
```
public static boolean isForbidden(String mimeType)
```
    Check whether the given Mime Type is forbidden. The list of forbidden types is in ExoDocumentUtils.FORBIDDEN_TYPES
    
    Parameters:
    mimeType -
    
    Returns:
    true if the given Mime Type is in the list
  - isCallable
```
public static boolean isCallable(android.content.Context context,
                 String mimeType,
                 String url)
                          throws IllegalArgumentException
```
    Check if the device has an application to open this type of file.
    
    Parameters:
    context - Context (mandatory)
    mimeType - Mime Type to check (mandatory)
    url - file url to guess the mime type from (optional)
    
    Returns:
    true if an application can open the given Mime Type
    
    Throws:
    
    IllegalArgumentException
  - getFullFileType
```
public static String getFullFileType(String fileType)
```
  - putFileToServerFromLocal
```
public static boolean putFileToServerFromLocal(String url,
                               File fileManager,
                               String fileType)
```
  - setRepositoryHomeUrl
```
public static void setRepositoryHomeUrl(String userName,
                        String userHomeNodePath,
                        String domain)
```
  - getPersonalDriveContent
```
public static ExoFile getPersonalDriveContent(android.content.Context context,
                              ExoFile file)
                                       throws IOException
```
    Get the content (files and folders) of the given folder.
    
    Parameters:
    context -
    file - the folder to get content from
    
    Returns:
    an ExoFile corresponding to the parent folder with its children ExoFile
    
    Throws:
    
    IOException
  - fullURLofFile
```
public static String fullURLofFile(String workSpaceName,
                   String url)
```
  - getDrives
```
public static ArrayList<ExoFile> getDrives(org.apache.http.HttpResponse response)
```
    Get the list of folders in a drive, from the HTTP response.
    The response's body is an XM document that is parsed to extract the information of the folders.
    This method simply calls
```
 ExoDocumentUtils.getDrives(response, false);
 
```
    Parameters:
    response - the HttpResponse from where to extract the list of folders
    
    Returns:
    an ArrayList of ExoFile or an empty ArrayList if a problem happens
    See Also:
    ExoDocumentUtils.getDrives(HttpResponse response, boolean isGroupDrive)
  - getDrives
```
public static ArrayList<ExoFile> getDrives(org.apache.http.HttpResponse response,
                           boolean isGroupDrive)
```
    Get the list of folders in a drive, from the HTTP response.
    The response's body is an XM document that is parsed to extract the information of the folders.
    If isGroupDrive = true , each folder's name is improved to be less technical, by calling ExoFile#createNaturalName()
    
    Parameters:
    response - the HttpResponse from where to extract the list of folders
    isGroupDrive - if true the file's natural name will be created
    
    Returns:
    an ArrayList of ExoFile or an empty ArrayList if a problem happens
  - getContentOfFolder
```
public static ExoFile getContentOfFolder(org.apache.http.HttpResponse response,
                         ExoFile file)
```
    Get a folder with its sub-files and sub-folders.
    Parse the XML response with format:
```
 <Folder canAddChild="bool" canRemove="bool" currentFolder="Name" driveName="DriveName" hasChild="bool" name="Name" nodeType="nt" path="..." title="Title" titlePath="Title" workspaceName="Name">
  <Folders>
    <Folder canAddChild="bool" canRemove="bool" currentFolder="Name" driveName="DriveName" hasChild="bool" name="Name" nodeType="nt" path="..." title="Title" titlePath="Title" workspaceName="Name"/>
  </Folders>
  <Files>
    <File canRemove="bool" creator="username" dateCreated="Date" dateModified="Date" name="doc.jpg" nodeType="nt" path="..." size="0" title="doc.jpg" workspaceName="Name"/>
  </Files>
 </Folder>
 
```
    Example URL:
```
 https://SERVER/rest/managedocument/getFoldersAndFiles?driveName=Personal%
 20Documents&workspaceName=collaboration¤tFolder=Public
 
```
    Parameters:
    response - the response that contains the XML entity
    file - The folder to retrieve the content from
    
    Returns:
    an ExoFile that represents the content of the given folder
  - getIconFromType
```
public static int getIconFromType(String contentType)
```
  - getParentUrl
```
public static String getParentUrl(String url)
```
  - getLastPathComponent
```
public static String getLastPathComponent(String url)
```
  - isContainSpecialChar
```
public static boolean isContainSpecialChar(String str,
                           String charSet)
```
  - deleteFile
```
public static boolean deleteFile(String url)
```
    Delete remote folder or file
    
    Parameters:
    url - the URL of the folder or file to delete
    
    Returns:
    true if the file was deleted, false otherwise
  - copyFile
```
public static boolean copyFile(String source,
               String destination)
```
  - moveFile
```
public static boolean moveFile(String source,
               String destination)
```
  - renameFolder
```
public static boolean renameFolder(String source,
                   String destination)
```
  - createFolder
```
public static boolean createFolder(String destination)
```
  - documentInfoFromUri
```
public static ExoDocumentUtils.DocumentInfo documentInfoFromUri(android.net.Uri document,
                                                android.content.Context context)
```
    Returns a DocumentInfo with info coming from the file at the given URI
    
    Parameters:
    document - the URI of a file or a content
    context -
    
    Returns:
    a DocumentInfo or null if an error occurs
  - documentFromContentUri
```
public static ExoDocumentUtils.DocumentInfo documentFromContentUri(android.net.Uri contentUri,
                                                   android.content.Context context)
```
    Gets a DocumentInfo with info coming from the document at the given URI.
    
    Parameters:
    contentUri - the content URI of the document (content:// ...)
    context -
    
    Returns:
    a DocumentInfo or null if an error occurs
  - documentFromFileUri
```
public static ExoDocumentUtils.DocumentInfo documentFromFileUri(android.net.Uri fileUri)
```
    Gets a DocumentInfo with info coming from the file at the given URI.
    
    Parameters:
    fileUri - the file URI (file:// ...)
    
    Returns:
    a DocumentInfo or null if an error occurs
  - deleteLocalFiles
```
public static boolean deleteLocalFiles(List<String> files)
```
    Delete the Files at the given paths
    
    Parameters:
    files - a list of file paths
    
    Returns:
    true if all files were deleted, false otherwise
  - cleanupFilename
```
public static String cleanupFilename(String originalName)
```
    On Platform 4.1-M2, the upload service renames the uploaded file. Therefore the link to this file in the activity becomes incorrect. To fix this, we rename the file before upload so the same name is used in the activity.
    
    Parameters:
    originalName - the name to clean
    
    Returns:
    a String without forbidden characters
  - getExifOrientationAngleFromFile
```
public static int getExifOrientationAngleFromFile(String filePath)
```
    Get the EXIF orientation of the given file
    
    Parameters:
    filePath -
    
    Returns:
    an int in ExoDocumentUtils.ROTATION_[0 , 90 , 180 , 270]
  - rotateBitmapToNormal
```
public static android.graphics.Bitmap rotateBitmapToNormal(String filePath,
                                           android.graphics.Bitmap source)
```
    Rotate the bitmap at its correct orientation
    
    Parameters:
    filePath - the file where the bitmap is stored
    source - the bitmap itself
    
    Returns:
    the bitmap rotated with ExoDocumentUtils.rotateBitmapByAngle(Bitmap, int)
  - rotateBitmapByAngle
```
public static android.graphics.Bitmap rotateBitmapByAngle(android.graphics.Bitmap source,
                                          int angle)
```
    Rotate the bitmap by a certain angle. Uses Matrix#postRotate(int)
    
    Parameters:
    source - the bitmap to rotate
    angle - the rotation angle
    
    Returns:
    a new rotated bitmap
  - didRequestPermission
```
public static boolean didRequestPermission(android.app.Activity caller,
                           int permissionCode)
```
    Check whether the application needs to request the permission required by the activity. If yes, then the permission is requested (via ActivityCompat.requestPermissions(Activity, String[], int)).
    
    Parameters:
    caller - The activity that requires the permission. Must implement ActivityCompat.OnRequestPermissionsResultCallback.
    permissionCode - The code defined internally, e.g. ExoConstants.REQUEST_PICK_IMAGE_FROM_GALLERY.
    
    Returns:
    true if the permission has been requested
    false if the permission was already granted
  - shouldDisplayExplanation
```
public static boolean shouldDisplayExplanation(android.app.Activity activity,
                               int permCode)
```
    Check whether the request for the specified permission should be explained to the user. Calls ActivityCompat.shouldShowRequestPermissionRationale(Activity, String).
    
    Parameters:
    activity - The activity that requires the permission.
    permCode - The code defined internally, e.g. ExoConstants.REQUEST_PICK_IMAGE_FROM_GALLERY.
    
    Returns:
    true if the user should receive more information about the permission request

Class ExoDocumentUtils

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

ALL_VIDEO_TYPE

ALL_AUDIO_TYPE

ALL_IMAGE_TYPE

ALL_TEXT_TYPE

IMAGE_TYPE

TEXT_TYPE

VIDEO_TYPE

AUDIO_TYPE

MSWORD_TYPE

OPEN_WORD_TYPE

PDF_TYPE

XLS_TYPE

OPEN_XLS_TYPE

POWERPOINT_TYPE

OPEN_POWERPOINT_TYPE

FORBIDDEN_TYPES

ROTATION_0

ROTATION_90

ROTATION_180

ROTATION_270

Constructor Detail

ExoDocumentUtils

Method Detail

isEnoughMemory

getFreeMemory

getFileSize

fileOpen

isForbidden

isCallable

getFullFileType

putFileToServerFromLocal

setRepositoryHomeUrl

getPersonalDriveContent

fullURLofFile

getDrives

getDrives

getContentOfFolder

getIconFromType

getParentUrl

getLastPathComponent

isContainSpecialChar

deleteFile

copyFile

moveFile

renameFolder

createFolder

documentInfoFromUri

documentFromContentUri

documentFromFileUri

deleteLocalFiles

cleanupFilename

getExifOrientationAngleFromFile

rotateBitmapToNormal

rotateBitmapByAngle

didRequestPermission

shouldDisplayExplanation