org.jclouds.snia.cdmi.v1.features

Interface DataNonCDMIContentTypeApi

public interface DataNonCDMIContentTypeApi

Data Object Resource Operations

Method Summary

Modifier and Type	Method and Description
void	create(String dataObjectName, Payload payload) create CDMI Data object Non CDMI Content Type
void	create(String dataObjectName, String input) create CDMI Data object Non CDMI Content Type
void	createPartial(String dataObjectName, Payload payload) create CDMI Data object partial Non CDMI Content Type Only part of the object is contained in the payload and the X-CDMI-Partial header flag is set to true
void	delete(String dataObjectName) delete CDMI Data object
DataObject	get(String dataObjectName, DataObjectQueryParams queryParams) get CDMI Data object
Payload	getValue(String dataObjectName) get CDMI Data object
Payload	getValue(String dataObjectName, String range) get CDMI Data object

Method Detail

getValue

@GET
 @Consumes
 @Path(value="/{dataObjectName}")
Payload getValue(@PathParam(value="dataObjectName")
                                                                   String dataObjectName)

get CDMI Data object

Parameters:

dataObjectName - dataObjectName must not end with a forward slash, /.

Returns:

DataObjectNonCDMIContentType

  Examples: 
  
  dataObject = get("myDataObject");
  dataObject = get("parentContainer/childContainer/","myDataObject");
 
 
 

getValue

@GET
 @Consumes
 @Path(value="/{dataObjectName}")
Payload getValue(@PathParam(value="dataObjectName")
                                                                   String dataObjectName,
                                                                   @HeaderParam(value="Range")
                                                                   String range)

get CDMI Data object

Parameters:

dataObjectName - dataObjectName must not end with a forward slash, /.

range - a valid ranges-specifier (see RFC2616 Section 14.35.1)

Returns:

DataObjectNonCDMIContentType

  Examples: 
  
  dataObject = get("myDataObject","bytes=0-10");
 
 
         

get

@GET
 @Consumes(value="application/json")
 @Path(value="/{dataObjectName}")
DataObject get(@PathParam(value="dataObjectName")
                                                                                           String dataObjectName,
                                                                                           DataObjectQueryParams queryParams)

get CDMI Data object

Parameters:

dataObjectName - dataObjectName must not end with a forward slash, /.

queryParams - enables getting only certain fields, metadata, value range

Returns:

DataObject

  Examples: 
  
  dataObject = get("myDataObject",ContainerQueryParams.Builder.field("parentURI").field("objectName"));
  dataObject = get("myDataObject",ContainerQueryParams.Builder.value(0,10));
 
 
         

create

@PUT
 @Consumes
 @Path(value="/{dataObjectName}")
void create(@PathParam(value="dataObjectName")
                                                              String dataObjectName,
                                                              Payload payload)

create CDMI Data object Non CDMI Content Type

Parameters:

dataObjectName - dataObjectName must not end with a forward slash, /.

payload - enables defining the body's payload i.e. file, inputStream, String, ByteArray

  Examples: 
  
  create("myDataObject",new StringPayload("value");
  create("myDataObject",new ByteArrayPayload(bytes);
  create("myDataObject",new FilePayload(myFileIn);
  create("myDataObject",new InputStreamPayload(is);
  
  File f = new File("yellow-flowers.jpg");
  payloadIn = new InputStreamPayload(new FileInputStream(f));
  payloadIn.setContentMetadata(BaseMutableContentMetadata.fromContentMetadata(
            payloadIn.getContentMetadata().toBuilder()
            .contentType(MediaType.JPEG.toString())
            .contentLength(new Long(inFile.length()))
            .build()));
  dataNonCDMIContentTypeApi.create(containerName, f.getName(),
 					payloadIn);
 
 
           

createPartial

@PUT
 @Consumes
 @Path(value="/{dataObjectName}")
void createPartial(@PathParam(value="dataObjectName")
                                                                     String dataObjectName,
                                                                     Payload payload)

create CDMI Data object partial Non CDMI Content Type Only part of the object is contained in the payload and the X-CDMI-Partial header flag is set to true

Parameters:

dataObjectName - dataObjectName must not end with a forward slash, /.

payload - enables defining the body's payload i.e. file, inputStream, String, ByteArray

  Examples: 
  
  createPartial("myDataObject",new StringPayload("value");
  createPartial("myDataObject",new ByteArrayPayload(bytes);
  createPartial("myDataObject",new FilePayload(myFileIn);
  createPartial("myDataObject",new InputStreamPayload(is);
 
 
           

create

@PUT
 @Consumes
 @Produces(value="text/plain")
 @Path(value="/{dataObjectName}")
void create(@PathParam(value="dataObjectName")
                                                                                             String dataObjectName,
                                                                                             String input)

create CDMI Data object Non CDMI Content Type

Parameters:

dataObjectName - dataObjectName must not end with a forward slash, /.

input - simple string input

  Examples: 
  
  create("myDataObject",new String("value");
 
 
           

delete

@DELETE
 @Consumes
 @Path(value="/{dataObjectName}")
void delete(@PathParam(value="dataObjectName")
                                                                 String dataObjectName)

delete CDMI Data object

Parameters:

dataObjectName - dataObjectName must not end with a forward slash, /.

  Examples: 
  
  delete("myDataObject");