Package step.client.resources
Class RemoteResourceManager
- java.lang.Object
-
- step.client.AbstractRemoteClient
-
- step.client.resources.RemoteResourceManager
-
- All Implemented Interfaces:
Closeable
,AutoCloseable
,ResourceManager
public class RemoteResourceManager extends AbstractRemoteClient implements ResourceManager
This class provides an API to upload resources (compiled code of a keyword, etc) to the controller
-
-
Field Summary
-
Fields inherited from class step.client.AbstractRemoteClient
client, cookies, credentials
-
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 RemoteResourceManager()
RemoteResourceManager(ControllerCredentials credentials)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description Resource
createResource(String resourceType, InputStream resourceStream, String resourceFileName, boolean checkForDuplicates, ObjectEnricher objectEnricher)
ResourceRevisionContainer
createResourceContainer(String resourceType, String resourceFileName)
void
deleteResource(String resourceId)
Delete the resource and all its revisionsstep.grid.io.Attachment
download(String resourceId)
Download a resource based on its idResource
getResource(String resourceId)
ResourceRevisionContent
getResourceContent(String resourceId)
Get the content of an existingResource
ResourceRevisionFileHandle
getResourceFile(String resourceId)
ResourceRevision
getResourceRevisionByResourceId(String resourceId)
ResourceRevisionContentImpl
getResourceRevisionContent(String resourceRevisionId)
Resource
lookupResourceByName(String resourcename)
boolean
resourceExists(String resourceId)
Test if a given resource id existsResource
saveResource(Resource resource)
Saved the resource object onlyResource
saveResourceContent(String resourceId, InputStream resourceStream, String resourceFileName)
Save the content provided as stream to an existing resource.ResourceUploadResponse
upload(File file)
Upload the local file provided as argument to the controllerResourceUploadResponse
upload(String filename, InputStream stream)
Upload the local file provided as argument to the controllerprotected ResourceUploadResponse
upload(org.glassfish.jersey.media.multipart.FormDataBodyPart bodyPart)
protected ResourceUploadResponse
upload(org.glassfish.jersey.media.multipart.FormDataBodyPart bodyPart, String type, boolean checkForDuplicates)
-
Methods inherited from class step.client.AbstractRemoteClient
close, executeRequest, notImplemented, requestBuilder, requestBuilder
-
-
-
-
Constructor Detail
-
RemoteResourceManager
public RemoteResourceManager()
-
RemoteResourceManager
public RemoteResourceManager(ControllerCredentials credentials)
-
-
Method Detail
-
upload
public ResourceUploadResponse upload(File file)
Upload the local file provided as argument to the controller- Parameters:
file
- the local file to be uploaded- Returns:
- the
ResourceUploadResponse
containing an handle to the uploaded file
-
upload
public ResourceUploadResponse upload(String filename, InputStream stream)
Upload the local file provided as argument to the controller- Parameters:
filename
- the path to the local file to be uploaded- Returns:
- the
ResourceUploadResponse
containing an handle to the uploaded file
-
upload
protected ResourceUploadResponse upload(org.glassfish.jersey.media.multipart.FormDataBodyPart bodyPart)
-
upload
protected ResourceUploadResponse upload(org.glassfish.jersey.media.multipart.FormDataBodyPart bodyPart, String type, boolean checkForDuplicates)
-
download
public step.grid.io.Attachment download(String resourceId)
Download a resource based on its id- Parameters:
resourceId
- the id of the resource to be downloaded- Returns:
- the
Response
containing an handle to the uploaded file
-
createResource
public Resource createResource(String resourceType, InputStream resourceStream, String resourceFileName, boolean checkForDuplicates, ObjectEnricher objectEnricher) throws IOException, SimilarResourceExistingException
- Specified by:
createResource
in interfaceResourceManager
- 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:
IOException
- an IOException occurs during the callSimilarResourceExistingException
- a similar resource exist
-
saveResourceContent
public Resource saveResourceContent(String resourceId, InputStream resourceStream, String resourceFileName) throws IOException
Description copied from interface:ResourceManager
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.- Specified by:
saveResourceContent
in interfaceResourceManager
- 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:
IOException
- an IOException occurs during the call
-
deleteResource
public void deleteResource(String resourceId)
Description copied from interface:ResourceManager
Delete the resource and all its revisions- Specified by:
deleteResource
in interfaceResourceManager
- Parameters:
resourceId
- the id of theResource
to be deleted
-
getResourceContent
public ResourceRevisionContent getResourceContent(String resourceId) throws IOException
Description copied from interface:ResourceManager
Get the content of an existingResource
- Specified by:
getResourceContent
in interfaceResourceManager
- Parameters:
resourceId
- the id of theResource
to be deleted- Returns:
- the content of the resource as stream
- Throws:
IOException
- an IOException occurs during the call
-
getResource
public Resource getResource(String resourceId)
- Specified by:
getResource
in interfaceResourceManager
-
getResourceFile
public ResourceRevisionFileHandle getResourceFile(String resourceId)
- Specified by:
getResourceFile
in interfaceResourceManager
-
getResourceRevisionByResourceId
public ResourceRevision getResourceRevisionByResourceId(String resourceId)
- Specified by:
getResourceRevisionByResourceId
in interfaceResourceManager
-
getResourceRevisionContent
public ResourceRevisionContentImpl getResourceRevisionContent(String resourceRevisionId) throws IOException
- Specified by:
getResourceRevisionContent
in interfaceResourceManager
- Throws:
IOException
-
createResourceContainer
public ResourceRevisionContainer createResourceContainer(String resourceType, String resourceFileName) throws IOException
- Specified by:
createResourceContainer
in interfaceResourceManager
- Throws:
IOException
-
lookupResourceByName
public Resource lookupResourceByName(String resourcename)
- Specified by:
lookupResourceByName
in interfaceResourceManager
-
resourceExists
public boolean resourceExists(String resourceId)
Description copied from interface:ResourceManager
Test if a given resource id exists- Specified by:
resourceExists
in interfaceResourceManager
- Parameters:
resourceId
- the id of the resource to test- Returns:
- true if the resource exists
-
saveResource
public Resource saveResource(Resource resource) throws IOException
Description copied from interface:ResourceManager
Saved the resource object only- Specified by:
saveResource
in interfaceResourceManager
- Parameters:
resource
- the resource to be saved- Returns:
- the updated
Resource
- Throws:
IOException
- an IOException occurs during the call
-
-