Package step.resources

Class ResourceManagerImpl

java.lang.Object

step.resources.ResourceManagerImpl

All Implemented Interfaces:

ResourceManager

Direct Known Subclasses:

LocalResourceManagerImpl

public class ResourceManagerImpl
extends Object
implements ResourceManager

Field Summary

Fields

Modifier and Type	Field	Description
protected static org.slf4j.Logger	logger
protected ResourceAccessor	resourceAccessor
protected ResourceRevisionAccessor	resourceRevisionAccessor
protected File	resourceRootFolder
protected Map<String,step.resources.ResourceType>	resourceTypes

Fields inherited from interface step.resources.ResourceManager

RESOURCE_TYPE_ATTACHMENT, RESOURCE_TYPE_DATASOURCE, RESOURCE_TYPE_FUNCTIONS, RESOURCE_TYPE_PDF_TEST_SCENARIO_FILE, RESOURCE_TYPE_SECRET, RESOURCE_TYPE_STAGING_CONTEXT_FILES, RESOURCE_TYPE_TEMP

Constructor Summary

Constructors

Constructor	Description
ResourceManagerImpl(File resourceRootFolder, ResourceAccessor resourceAccessor, ResourceRevisionAccessor resourceRevisionAccessor)

Method Summary

Modifier and Type	Method	Description
protected void	closeResourceContainer(step.resources.Resource resource, step.resources.ResourceRevision resourceRevision, boolean checkForDuplicates, step.core.objectenricher.ObjectEnricher objectEnricher)
protected void	closeResourceRevisionContent(step.resources.Resource resource)
step.resources.Resource	createResource(String resourceType, boolean isDirectory, InputStream resourceStream, String resourceFileName, boolean checkForDuplicates, step.core.objectenricher.ObjectEnricher objectEnricher)
step.resources.Resource	createResource(String resourceType, InputStream resourceStream, String resourceFileName, boolean checkForDuplicates, step.core.objectenricher.ObjectEnricher objectEnricher)
ResourceRevisionContainer	createResourceContainer(String resourceType, String resourceFileName)
void	deleteResource(String resourceId)	Delete the resource and all its revisions
step.resources.Resource	getResource(String resourceId)
ResourceRevisionContent	getResourceContent(String resourceId)	Get the content of an existing Resource
ResourceRevisionFileHandle	getResourceFile(String resourceId)
step.resources.ResourceRevision	getResourceRevision(String resourceRevisionId)
ResourceRevisionContentImpl	getResourceRevisionContent(String resourceRevisionId)
protected File	getResourceRevisionFile(step.resources.Resource resource, step.resources.ResourceRevision revision)
String	getResourcesRootPath()
void	registerResourceType(String name, step.resources.ResourceType resourceType)
boolean	resourceExists(String resourceId)	Test if a given resource id exists
step.resources.Resource	saveResource(step.resources.Resource resource)	Saved the resource object only
step.resources.Resource	saveResourceContent(String resourceId, InputStream resourceStream, String resourceFileName)	Save the content provided as stream to an existing resource.
step.resources.ResourceRevision	saveResourceRevision(step.resources.ResourceRevision resourceRevision)

Methods inherited from class java.lang.Object

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

Field Detail

resourceRootFolder

protected final File resourceRootFolder

resourceAccessor

protected final ResourceAccessor resourceAccessor

resourceRevisionAccessor

protected final ResourceRevisionAccessor resourceRevisionAccessor

resourceTypes

protected final Map<String,step.resources.ResourceType> resourceTypes

logger

protected static final org.slf4j.Logger logger

Constructor Detail

ResourceManagerImpl

public ResourceManagerImpl(File resourceRootFolder,
                           ResourceAccessor resourceAccessor,
                           ResourceRevisionAccessor resourceRevisionAccessor)

Method Detail

registerResourceType

public void registerResourceType(String name,
                                 step.resources.ResourceType resourceType)

createResourceContainer

public ResourceRevisionContainer createResourceContainer(String resourceType,
                                                         String resourceFileName)
                                                  throws IOException

Specified by:

createResourceContainer in interface ResourceManager

Throws:

IOException

createResource

public step.resources.Resource createResource(String resourceType,
                                              InputStream resourceStream,
                                              String resourceFileName,
                                              boolean checkForDuplicates,
                                              step.core.objectenricher.ObjectEnricher objectEnricher)
                                       throws IOException,
                                              SimilarResourceExistingException,
                                              InvalidResourceFormatException

Specified by:

createResource in interface ResourceManager

Parameters:

resourceType - the type of the resource

resourceStream - the stream of the resource to be saved

resourceFileName - the name of the resource (filename)

checkForDuplicates - is duplicate should be checked

objectEnricher - the ObjectEnricher of the context

Returns:

the created Resource

Throws:

IOException - an IOException occurs during the call

SimilarResourceExistingException - a similar resource exist

InvalidResourceFormatException

createResource

public step.resources.Resource createResource(String resourceType,
                                              boolean isDirectory,
                                              InputStream resourceStream,
                                              String resourceFileName,
                                              boolean checkForDuplicates,
                                              step.core.objectenricher.ObjectEnricher objectEnricher)
                                       throws IOException,
                                              SimilarResourceExistingException,
                                              InvalidResourceFormatException

Specified by:

createResource in interface ResourceManager

Throws:

IOException

SimilarResourceExistingException

InvalidResourceFormatException

closeResourceContainer

protected void closeResourceContainer(step.resources.Resource resource,
                                      step.resources.ResourceRevision resourceRevision,
                                      boolean checkForDuplicates,
                                      step.core.objectenricher.ObjectEnricher objectEnricher)
                               throws IOException,
                                      SimilarResourceExistingException,
                                      InvalidResourceFormatException

Throws:

IOException

SimilarResourceExistingException

InvalidResourceFormatException

saveResourceContent

public step.resources.Resource saveResourceContent(String resourceId,
                                                   InputStream resourceStream,
                                                   String resourceFileName)
                                            throws IOException,
                                                   InvalidResourceFormatException

Description copied from interface: ResourceManager

Save the content provided as stream to an existing resource. This creates a new ResourceRevision for the Resource and saves the content provided as stream under this revision.

Specified by:

saveResourceContent in interface ResourceManager

Parameters:

resourceId - the id of the resource to be updated

resourceStream - the stream of the resource to be saved

resourceFileName - the name of the resource (filename)

Returns:

the updated Resource

Throws:

IOException - an IOException occurs during the call

InvalidResourceFormatException

deleteResource

public void deleteResource(String resourceId)

Description copied from interface: ResourceManager

Delete the resource and all its revisions

Specified by:

deleteResource in interface ResourceManager

Parameters:

resourceId - the id of the Resource to be deleted

getResourceContent

public ResourceRevisionContent getResourceContent(String resourceId)
                                           throws IOException

Description copied from interface: ResourceManager

Get the content of an existing Resource

Specified by:

getResourceContent in interface ResourceManager

Parameters:

resourceId - the id of the Resource to be deleted

Returns:

the content of the resource as stream

Throws:

IOException - an IOException occurs during the call

closeResourceRevisionContent

protected void closeResourceRevisionContent(step.resources.Resource resource)

getResourceRevisionContent

public ResourceRevisionContentImpl getResourceRevisionContent(String resourceRevisionId)
                                                       throws IOException

Specified by:

getResourceRevisionContent in interface ResourceManager

Throws:

IOException

getResourceFile

public ResourceRevisionFileHandle getResourceFile(String resourceId)

Specified by:

getResourceFile in interface ResourceManager

getResource

public step.resources.Resource getResource(String resourceId)

Specified by:

getResource in interface ResourceManager

getResourceRevision

public step.resources.ResourceRevision getResourceRevision(String resourceRevisionId)

Specified by:

getResourceRevision in interface ResourceManager

getResourceRevisionFile

protected File getResourceRevisionFile(step.resources.Resource resource,
                                       step.resources.ResourceRevision revision)

resourceExists

public boolean resourceExists(String resourceId)

Description copied from interface: ResourceManager

Test if a given resource id exists

Specified by:

resourceExists in interface ResourceManager

Parameters:

resourceId - the id of the resource to test

Returns:

true if the resource exists

saveResource

public step.resources.Resource saveResource(step.resources.Resource resource)
                                     throws IOException

Description copied from interface: ResourceManager

Saved the resource object only

Specified by:

saveResource in interface ResourceManager

Parameters:

resource - the resource to be saved

Returns:

the updated Resource

Throws:

IOException - an IOException occurs during the call

saveResourceRevision

public step.resources.ResourceRevision saveResourceRevision(step.resources.ResourceRevision resourceRevision)
                                                     throws IOException

Specified by:

saveResourceRevision in interface ResourceManager

Throws:

IOException

getResourcesRootPath

public String getResourcesRootPath()

Specified by:

getResourcesRootPath in interface ResourceManager