Package step.client.resources

Class RemoteResourceManager

java.lang.Object

step.client.AbstractRemoteClient

step.client.resources.RemoteResourceManager

All Implemented Interfaces:

java.io.Closeable, java.lang.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

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 revisions
step.grid.io.Attachment	download(java.lang.String resourceId)	Download a resource based on its id
Resource	getResource(java.lang.String resourceId)
ResourceRevisionContent	getResourceContent(java.lang.String resourceId)	Get the content of an existing Resource
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 exists
Resource	saveResource(Resource resource)	Saved the resource object only
Resource	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)
ResourceUploadResponse	upload(java.io.File file)	Upload the local file provided as argument to the controller
ResourceUploadResponse	upload(java.lang.String filename, java.io.InputStream stream)	Upload the local file provided as argument to the controller
protected ResourceUploadResponse	upload(org.glassfish.jersey.media.multipart.FormDataBodyPart bodyPart)
protected ResourceUploadResponse	upload(org.glassfish.jersey.media.multipart.FormDataBodyPart bodyPart, java.lang.String type, boolean checkForDuplicates)

Methods inherited from class step.client.AbstractRemoteClient

close, executeRequest, notImplemented, requestBuilder, requestBuilder

Methods inherited from class java.lang.Object

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

Constructor Detail

RemoteResourceManager

public RemoteResourceManager()

RemoteResourceManager

public RemoteResourceManager(ControllerCredentials credentials)

Method Detail

upload

public ResourceUploadResponse upload(java.io.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(java.lang.String filename,
                                     java.io.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,
                                        java.lang.String type,
                                        boolean checkForDuplicates)

download

public step.grid.io.Attachment download(java.lang.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(java.lang.String resourceType,
                               java.io.InputStream resourceStream,
                               java.lang.String resourceFileName,
                               boolean checkForDuplicates,
                               ObjectEnricher objectEnricher)
                        throws java.io.IOException,
                               SimilarResourceExistingException

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:

java.io.IOException - an IOException occurs during the call

SimilarResourceExistingException - a similar resource exist

saveResourceContent

public Resource saveResourceContent(java.lang.String resourceId,
                                    java.io.InputStream resourceStream,
                                    java.lang.String resourceFileName)
                             throws java.io.IOException

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:

java.io.IOException - an IOException occurs during the call

deleteResource

public void deleteResource(java.lang.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(java.lang.String resourceId)
                                           throws java.io.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:

java.io.IOException - an IOException occurs during the call

getResource

public Resource getResource(java.lang.String resourceId)

Specified by:

getResource in interface ResourceManager

getResourceFile

public ResourceRevisionFileHandle getResourceFile(java.lang.String resourceId)

Specified by:

getResourceFile in interface ResourceManager

getResourceRevisionByResourceId

public ResourceRevision getResourceRevisionByResourceId(java.lang.String resourceId)

Specified by:

getResourceRevisionByResourceId in interface ResourceManager

getResourceRevisionContent

public ResourceRevisionContentImpl getResourceRevisionContent(java.lang.String resourceRevisionId)
                                                       throws java.io.IOException

Specified by:

getResourceRevisionContent in interface ResourceManager

Throws:

java.io.IOException

createResourceContainer

public ResourceRevisionContainer createResourceContainer(java.lang.String resourceType,
                                                         java.lang.String resourceFileName)
                                                  throws java.io.IOException

Specified by:

createResourceContainer in interface ResourceManager

Throws:

java.io.IOException

lookupResourceByName

public Resource lookupResourceByName(java.lang.String resourcename)

Specified by:

lookupResourceByName in interface ResourceManager

resourceExists

public boolean resourceExists(java.lang.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 Resource saveResource(Resource resource)
                      throws java.io.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:

java.io.IOException - an IOException occurs during the call

getResourcesRootPath

public java.lang.String getResourcesRootPath()

Specified by:

getResourcesRootPath in interface ResourceManager

updateResourceContent

public Resource updateResourceContent(Resource resource,
                                      java.io.InputStream resourceStream,
                                      java.lang.String resourceFileName,
                                      ResourceRevision revision)
                               throws java.io.IOException

Specified by:

updateResourceContent in interface ResourceManager

Throws:

java.io.IOException

saveResourceRevision

public ResourceRevision saveResourceRevision(ResourceRevision resourceRevision)
                                      throws java.io.IOException

Specified by:

saveResourceRevision in interface ResourceManager

Throws:

java.io.IOException