org.gcube.common.homelibrary.util

Class WorkspaceUtil

java.lang.Object

org.gcube.common.homelibrary.util.WorkspaceUtil

public class WorkspaceUtil
extends Object

Author:

Federico De Faveri defaveri@isti.cnr.it

Field Summary

Fields

Modifier and Type	Field and Description
protected static org.slf4j.Logger	logger

Constructor Summary

Constructors

Constructor and Description
WorkspaceUtil()

Method Summary

Methods

Modifier and Type	Method and Description
static String	cleanName(String name) Clean the given name from invalid chars.
static FolderItem	createExternalFile(WorkspaceFolder destinationFolder, String name, String description, InputStream is) Create a external file in the specified folder.
static FolderItem	createExternalFile(WorkspaceFolder destinationFolder, String name, String description, InputStream is, Map<String,String> properties) Create an external file with properties
static FolderItem	createExternalFile(WorkspaceFolder destinationFolder, String name, String description, InputStream is, Map<String,String> properties, String mimeType, long size) Create an external file with mimetype and properties
static FolderItem	createExternalFile(WorkspaceFolder destinationFolder, String name, String description, String storageId) Create an external file in the specified folder.
static FolderItem	createExternalFile(WorkspaceFolder destinationFolder, String name, String description, String mimeType, InputStream is) Create an item by inpustream with a given mimetype
static FolderItem	createExternalFile(WorkspaceFolder destinationFolder, String name, String description, String storageId, Map<String,String> properties) Create a external file with properties
static FolderItem	createExternalFile(WorkspaceFolder destinationFolder, String name, String description, String storageId, Map<String,String> properties, String mimeType, long size) Create a external file with properties
static FolderItem	createExternalFile(WorkspaceFolder destinationFolder, String name, String description, String mimeType, String storageId)
static ACLType	getACLTypeByKey(List<String> list) Get ACL by key
static String	getCopyName(String initialName, WorkspaceFolder folder) Retrieve an unique name copying a item to the specified folder.
static List<String>	getMembersByGroup(String id) Get members by group ID
static String	getUniqueName(String initialName, WorkspaceFolder folder) Retrieve an unique name for the specified folder.
static void	overwrite(WorkspaceItem item, FileInputStream fileInputStream)
static String	returnThreeDigitNo(int number) Add prefix to number e.g (1 = 001)

Methods inherited from class java.lang.Object

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

Field Detail

logger

protected static org.slf4j.Logger logger

Constructor Detail

WorkspaceUtil

public WorkspaceUtil()

Method Detail

getUniqueName

public static String getUniqueName(String initialName,
                   WorkspaceFolder folder)
                            throws InternalErrorException

Retrieve an unique name for the specified folder.

Parameters:

initialName - the initial name.

folder - the item folder.

Returns:

the unique name.

Throws:

InternalErrorException - if an error occurs.

getCopyName

public static String getCopyName(String initialName,
                 WorkspaceFolder folder)
                          throws InternalErrorException

Retrieve an unique name copying a item to the specified folder.

Parameters:

initialName - the initial name.

folder - the item folder.

Returns:

the unique name.

Throws:

InternalErrorException - if an error occurs.

returnThreeDigitNo

public static String returnThreeDigitNo(int number)

Add prefix to number e.g (1 = 001)

Parameters:

number -

Returns:

cleanName

public static String cleanName(String name)
                        throws InternalErrorException

Clean the given name from invalid chars.

Parameters:

name - the name to clean.

Returns:

the cleaned name.

Throws:

InternalErrorException - if an error occurs.

createExternalFile

public static FolderItem createExternalFile(WorkspaceFolder destinationFolder,
                            String name,
                            String description,
                            String storageId)
                                     throws InsufficientPrivilegesException,
                                            InternalErrorException,
                                            ItemAlreadyExistException,
                                            IOException

Create an external file in the specified folder.

Parameters:

destinationFolder - the destination folder.

name - the external file name.

description - the external file description.

is - the external file data.

Returns:

the created external file.

Throws:

InsufficientPrivilegesException - if an error occurs.

InternalErrorException - if an error occurs.

ItemAlreadyExistException - if an error occurs.

IOException

createExternalFile

public static FolderItem createExternalFile(WorkspaceFolder destinationFolder,
                            String name,
                            String description,
                            String mimeType,
                            String storageId)
                                     throws InsufficientPrivilegesException,
                                            InternalErrorException,
                                            ItemAlreadyExistException,
                                            IOException

Throws:

InsufficientPrivilegesException

InternalErrorException

ItemAlreadyExistException

IOException

createExternalFile

public static FolderItem createExternalFile(WorkspaceFolder destinationFolder,
                            String name,
                            String description,
                            String storageId,
                            Map<String,String> properties)
                                     throws InsufficientPrivilegesException,
                                            InternalErrorException,
                                            ItemAlreadyExistException,
                                            IOException

Create a external file with properties

Parameters:

destinationFolder - the destination folder.

name - the external file name.

description - the external file description.

mimeType - the external file mimetype.

is - the external file data.

Returns:

the created external file.

Throws:

InsufficientPrivilegesException - if an error occurs.

InternalErrorException - if an error occurs.

ItemAlreadyExistException - if an error occurs.

IOException

createExternalFile

public static FolderItem createExternalFile(WorkspaceFolder destinationFolder,
                            String name,
                            String description,
                            String storageId,
                            Map<String,String> properties,
                            String mimeType,
                            long size)
                                     throws InsufficientPrivilegesException,
                                            InternalErrorException,
                                            ItemAlreadyExistException,
                                            IOException

Create a external file with properties

Parameters:

destinationFolder - the destination folder.

name - the external file name.

description - the external file description.

mimeType - the external file mimetype.

is - the external file data.

Returns:

the created external file.

Throws:

InsufficientPrivilegesException - if an error occurs.

InternalErrorException - if an error occurs.

ItemAlreadyExistException - if an error occurs.

IOException

createExternalFile

public static FolderItem createExternalFile(WorkspaceFolder destinationFolder,
                            String name,
                            String description,
                            InputStream is)
                                     throws InsufficientPrivilegesException,
                                            InternalErrorException,
                                            ItemAlreadyExistException,
                                            IOException

Create a external file in the specified folder.

Parameters:

destinationFolder - the destination folder.

name - the external file name.

description - the external file description.

mimeType - the external file mimetype.

is - the external file data.

Returns:

the created external file.

Throws:

InsufficientPrivilegesException - if an error occurs.

InternalErrorException - if an error occurs.

ItemAlreadyExistException - if an error occurs.

IOException

createExternalFile

public static FolderItem createExternalFile(WorkspaceFolder destinationFolder,
                            String name,
                            String description,
                            String mimeType,
                            InputStream is)
                                     throws InsufficientPrivilegesException,
                                            InternalErrorException,
                                            ItemAlreadyExistException,
                                            IOException

Create an item by inpustream with a given mimetype

Parameters:

destinationFolder -

name -

description -

mimeType -

is -

Returns:

the created external file.

Throws:

InsufficientPrivilegesException

InternalErrorException

ItemAlreadyExistException

IOException

createExternalFile

public static FolderItem createExternalFile(WorkspaceFolder destinationFolder,
                            String name,
                            String description,
                            InputStream is,
                            Map<String,String> properties)
                                     throws InsufficientPrivilegesException,
                                            InternalErrorException,
                                            ItemAlreadyExistException,
                                            IOException

Create an external file with properties

Parameters:

destinationFolder - the destination folder.

name - the external file name.

description - the external file description.

mimeType - the external file mimetype.

is - the external file data.

Returns:

the created external file.

Throws:

InsufficientPrivilegesException - if an error occurs.

InternalErrorException - if an error occurs.

ItemAlreadyExistException - if an error occurs.

IOException

createExternalFile

public static FolderItem createExternalFile(WorkspaceFolder destinationFolder,
                            String name,
                            String description,
                            InputStream is,
                            Map<String,String> properties,
                            String mimeType,
                            long size)
                                     throws InsufficientPrivilegesException,
                                            InternalErrorException,
                                            ItemAlreadyExistException,
                                            IOException

Create an external file with mimetype and properties

Parameters:

destinationFolder -

name -

description -

is -

mimeType -

properties -

Returns:

the created external file.

Throws:

InsufficientPrivilegesException

InternalErrorException

ItemAlreadyExistException

IOException

getACLTypeByKey

public static ACLType getACLTypeByKey(List<String> list)
                               throws InternalErrorException

Get ACL by key

Parameters:

list -

Throws:

InternalErrorException

getMembersByGroup

public static List<String> getMembersByGroup(String id)
                                      throws InternalErrorException

Get members by group ID

Parameters:

id - the gruoup ID

Returns:

the members of a group ID

Throws:

InternalErrorException

overwrite

public static void overwrite(WorkspaceItem item,
             FileInputStream fileInputStream)
                      throws InternalErrorException,
                             InsufficientPrivilegesException,
                             ItemNotFoundException

Parameters:

item -

fileInputStream -

Throws:

InternalErrorException

InsufficientPrivilegesException

ItemNotFoundException