Package org.ametys.plugins.explorer.resources.actions

Class AddOrUpdateResourceHelper

java.lang.Object

org.ametys.runtime.plugin.component.AbstractLogEnabled

org.ametys.plugins.explorer.resources.actions.AddOrUpdateResourceHelper

All Implemented Interfaces:

LogEnabled, Component, Serviceable

public final class AddOrUpdateResourceHelper
extends AbstractLogEnabled
implements Component, Serviceable

Dedicated helper in order to add or update an explorer resource

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	AddOrUpdateResourceHelper.ResourceOperationMode	Possible add and update modes
static class	AddOrUpdateResourceHelper.ResourceOperationResult	Class representing the result of a resource operation.

Field Summary

Fields

Modifier and Type	Field	Description
protected CurrentUserProvider	_currentUserProvider	The current user provider.
protected ObservationManager	_observationManager	Observer manager.
protected AmetysObjectResolver	_resolver	The ametys resolver
protected ExplorerResourcesDAO	_resourcesDAO	The resource DAO
static String	ROLE	The Avalon role name

Constructor Summary

Constructors

Constructor	Description
AddOrUpdateResourceHelper()

Method Summary

Modifier and Type	Method	Description
private ModifiableResourceCollection	_addCollection(ModifiableResourceCollection collection, String name)
private Resource	_addZipEntry(ModifiableResourceCollection collection, InputStream zipInputStream, String fileName)
protected void	_notifyResourcesCreated(ModifiableResourceCollection parent, List<Resource> resources)	Fire the ObservationConstants.EVENT_RESOURCE_CREATED event
protected void	_notifyResourcesUpdated(ModifiableResourceCollection parent, Resource resource)	Fire the ObservationConstants.EVENT_RESOURCE_UPDATED event
private AddOrUpdateResourceHelper.ResourceOperationResult	_unzip(ModifiableResourceCollection collection, InputStream inputStream)	Unzip an inputStream and add the content to the resource collection
private List<Resource>	_unzip(ModifiableResourceCollection collection, ZipArchiveInputStream zipInputStream)
AddOrUpdateResourceHelper.ResourceOperationResult	performResourceOperation(File file, ModifiableResourceCollection parent, AddOrUpdateResourceHelper.ResourceOperationMode mode)	Perform an add or update resource operation
AddOrUpdateResourceHelper.ResourceOperationResult	performResourceOperation(InputStream inputStream, String fileName, ModifiableResourceCollection parent, AddOrUpdateResourceHelper.ResourceOperationMode mode)	Perform an add or update resource operation
AddOrUpdateResourceHelper.ResourceOperationResult	performResourceOperation(Part part, String parentId, AddOrUpdateResourceHelper.ResourceOperationMode mode)	Perform an add or update resource operation
AddOrUpdateResourceHelper.ResourceOperationResult	performResourceOperation(Part part, ModifiableResourceCollection parent, AddOrUpdateResourceHelper.ResourceOperationMode mode)	Perform an add or update resource operation
void	service(ServiceManager serviceManager)

Methods inherited from class org.ametys.runtime.plugin.component.AbstractLogEnabled

getLogger, setLogger

Methods inherited from class java.lang.Object

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

Field Detail

ROLE

public static final String ROLE

The Avalon role name

_resourcesDAO

protected ExplorerResourcesDAO _resourcesDAO

The resource DAO

_resolver

protected AmetysObjectResolver _resolver

The ametys resolver

_currentUserProvider

protected CurrentUserProvider _currentUserProvider

The current user provider.

_observationManager

protected ObservationManager _observationManager

Observer manager.

Constructor Detail

AddOrUpdateResourceHelper

public AddOrUpdateResourceHelper()

Method Detail

service

public void service(ServiceManager serviceManager)
             throws ServiceException

Specified by:

service in interface Serviceable

Throws:

ServiceException

performResourceOperation

public AddOrUpdateResourceHelper.ResourceOperationResult performResourceOperation(Part part,
                                                                                  String parentId,
                                                                                  AddOrUpdateResourceHelper.ResourceOperationMode mode)

Perform an add or update resource operation

Parameters:

part - The part representing the file for this operation

parentId - The identifier of the parent collection

mode - The operation mode

Returns:

the result of the operation

performResourceOperation

public AddOrUpdateResourceHelper.ResourceOperationResult performResourceOperation(Part part,
                                                                                  ModifiableResourceCollection parent,
                                                                                  AddOrUpdateResourceHelper.ResourceOperationMode mode)

Perform an add or update resource operation

Parameters:

part - The part representing the file for this operation

parent - The parent collection

mode - The operation mode

Returns:

the result of the operation

performResourceOperation

public AddOrUpdateResourceHelper.ResourceOperationResult performResourceOperation(File file,
                                                                                  ModifiableResourceCollection parent,
                                                                                  AddOrUpdateResourceHelper.ResourceOperationMode mode)

Perform an add or update resource operation

Parameters:

file - The file for this operation

parent - The parent collection

mode - The operation mode

Returns:

the result of the operation

performResourceOperation

public AddOrUpdateResourceHelper.ResourceOperationResult performResourceOperation(InputStream inputStream,
                                                                                  String fileName,
                                                                                  ModifiableResourceCollection parent,
                                                                                  AddOrUpdateResourceHelper.ResourceOperationMode mode)

Perform an add or update resource operation

Parameters:

inputStream - The data for this operation

fileName - file name requested

parent - The parent collection

mode - The operation mode

Returns:

the result of the operation

_notifyResourcesCreated

protected void _notifyResourcesCreated(ModifiableResourceCollection parent,
                                       List<Resource> resources)

Fire the ObservationConstants.EVENT_RESOURCE_CREATED event

Parameters:

parent - The parent collection of the resource

resources - The created resources

_notifyResourcesUpdated

protected void _notifyResourcesUpdated(ModifiableResourceCollection parent,
                                       Resource resource)

Fire the ObservationConstants.EVENT_RESOURCE_UPDATED event

Parameters:

parent - The parent collection of the resource

resource - The updated resource

_unzip

private AddOrUpdateResourceHelper.ResourceOperationResult _unzip(ModifiableResourceCollection collection,
                                                                 InputStream inputStream)

Unzip an inputStream and add the content to the resource collection

Parameters:

collection - The collection where to unzip

inputStream - the inputStream of data we want to unzip

Returns:

messages

_unzip

private List<Resource> _unzip(ModifiableResourceCollection collection,
                              ZipArchiveInputStream zipInputStream)
                       throws IOException

Throws:

IOException

_addCollection

private ModifiableResourceCollection _addCollection(ModifiableResourceCollection collection,
                                                    String name)

_addZipEntry

private Resource _addZipEntry(ModifiableResourceCollection collection,
                              InputStream zipInputStream,
                              String fileName)