Package step.resources
Interface ResourceManager
-
- All Known Implementing Classes:
LocalResourceManagerImpl
,RemoteResourceManager
,ResourceManagerImpl
public interface ResourceManager
-
-
Field Summary
Fields Modifier and Type Field Description static java.lang.String
RESOURCE_TYPE_ATTACHMENT
static java.lang.String
RESOURCE_TYPE_DATASOURCE
static java.lang.String
RESOURCE_TYPE_FUNCTIONS
static java.lang.String
RESOURCE_TYPE_PDF_TEST_SCENARIO_FILE
static java.lang.String
RESOURCE_TYPE_SECRET
static java.lang.String
RESOURCE_TYPE_STAGING_CONTEXT_FILES
static java.lang.String
RESOURCE_TYPE_TEMP
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description Resource
createResource(java.lang.String resourceType, java.io.InputStream resourceStream, java.lang.String resourceFileName, boolean checkForDuplicates, ObjectEnricher objectEnricher)
ResourceRevisionContainer
createResourceContainer(java.lang.String resourceType, java.lang.String resourceFileName)
void
deleteResource(java.lang.String resourceId)
Delete the resource and all its revisionsResource
getResource(java.lang.String resourceId)
ResourceRevisionContent
getResourceContent(java.lang.String resourceId)
Get the content of an existingResource
ResourceRevisionFileHandle
getResourceFile(java.lang.String resourceId)
ResourceRevision
getResourceRevisionByResourceId(java.lang.String resourceId)
ResourceRevisionContentImpl
getResourceRevisionContent(java.lang.String resourceRevisionId)
java.lang.String
getResourcesRootPath()
Resource
lookupResourceByName(java.lang.String resourcename)
boolean
resourceExists(java.lang.String resourceId)
Test if a given resource id existsResource
saveResource(Resource resource)
Saved the resource object onlyResource
saveResourceContent(java.lang.String resourceId, java.io.InputStream resourceStream, java.lang.String resourceFileName)
Save the content provided as stream to an existing resource.ResourceRevision
saveResourceRevision(ResourceRevision resourceRevision)
Resource
updateResourceContent(Resource resource, java.io.InputStream resourceStream, java.lang.String resourceFileName, ResourceRevision revision)
-
-
-
Field Detail
-
RESOURCE_TYPE_PDF_TEST_SCENARIO_FILE
static final java.lang.String RESOURCE_TYPE_PDF_TEST_SCENARIO_FILE
- See Also:
- Constant Field Values
-
RESOURCE_TYPE_SECRET
static final java.lang.String RESOURCE_TYPE_SECRET
- See Also:
- Constant Field Values
-
RESOURCE_TYPE_DATASOURCE
static final java.lang.String RESOURCE_TYPE_DATASOURCE
- See Also:
- Constant Field Values
-
RESOURCE_TYPE_FUNCTIONS
static final java.lang.String RESOURCE_TYPE_FUNCTIONS
- See Also:
- Constant Field Values
-
RESOURCE_TYPE_STAGING_CONTEXT_FILES
static final java.lang.String RESOURCE_TYPE_STAGING_CONTEXT_FILES
- See Also:
- Constant Field Values
-
RESOURCE_TYPE_ATTACHMENT
static final java.lang.String RESOURCE_TYPE_ATTACHMENT
- See Also:
- Constant Field Values
-
RESOURCE_TYPE_TEMP
static final java.lang.String RESOURCE_TYPE_TEMP
- See Also:
- Constant Field Values
-
-
Method Detail
-
createResource
Resource createResource(java.lang.String resourceType, java.io.InputStream resourceStream, java.lang.String resourceFileName, boolean checkForDuplicates, ObjectEnricher objectEnricher) throws java.io.IOException, SimilarResourceExistingException
- Parameters:
resourceType
- the type of the resourceresourceStream
- the stream of the resource to be savedresourceFileName
- the name of the resource (filename)checkForDuplicates
- is duplicate should be checkedobjectEnricher
- theObjectEnricher
of the context- Returns:
- the created
Resource
- Throws:
java.io.IOException
- an IOException occurs during the callSimilarResourceExistingException
- a similar resource exist
-
saveResourceContent
Resource saveResourceContent(java.lang.String resourceId, java.io.InputStream resourceStream, java.lang.String resourceFileName) throws java.io.IOException
Save the content provided as stream to an existing resource. This creates a newResourceRevision
for theResource
and saves the content provided as stream under this revision.- Parameters:
resourceId
- the id of the resource to be updatedresourceStream
- the stream of the resource to be savedresourceFileName
- the name of the resource (filename)- Returns:
- the updated
Resource
- Throws:
java.io.IOException
- an IOException occurs during the call
-
saveResource
Resource saveResource(Resource resource) throws java.io.IOException
Saved the resource object only- Parameters:
resource
- the resource to be saved- Returns:
- the updated
Resource
- Throws:
java.io.IOException
- an IOException occurs during the call
-
resourceExists
boolean resourceExists(java.lang.String resourceId)
Test if a given resource id exists- Parameters:
resourceId
- the id of the resource to test- Returns:
- true if the resource exists
-
deleteResource
void deleteResource(java.lang.String resourceId)
Delete the resource and all its revisions- Parameters:
resourceId
- the id of theResource
to be deleted
-
getResourceContent
ResourceRevisionContent getResourceContent(java.lang.String resourceId) throws java.io.IOException
Get the content of an existingResource
- Parameters:
resourceId
- the id of theResource
to be deleted- Returns:
- the content of the resource as stream
- Throws:
java.io.IOException
- an IOException occurs during the call
-
getResourceFile
ResourceRevisionFileHandle getResourceFile(java.lang.String resourceId)
-
getResourceRevisionByResourceId
ResourceRevision getResourceRevisionByResourceId(java.lang.String resourceId)
-
getResourceRevisionContent
ResourceRevisionContentImpl getResourceRevisionContent(java.lang.String resourceRevisionId) throws java.io.IOException
- Throws:
java.io.IOException
-
createResourceContainer
ResourceRevisionContainer createResourceContainer(java.lang.String resourceType, java.lang.String resourceFileName) throws java.io.IOException
- Throws:
java.io.IOException
-
getResource
Resource getResource(java.lang.String resourceId)
-
lookupResourceByName
Resource lookupResourceByName(java.lang.String resourcename)
-
getResourcesRootPath
java.lang.String getResourcesRootPath()
-
updateResourceContent
Resource updateResourceContent(Resource resource, java.io.InputStream resourceStream, java.lang.String resourceFileName, ResourceRevision revision) throws java.io.IOException
- Throws:
java.io.IOException
-
saveResourceRevision
ResourceRevision saveResourceRevision(ResourceRevision resourceRevision) throws java.io.IOException
- Throws:
java.io.IOException
-
-