me.adaptive.arp.api

Class AppResourceData

java.lang.Object

me.adaptive.arp.api.AppResourceData

public class AppResourceData
extends java.lang.Object

This class represents a resource provided by the platform from the application's secure payload.

Since:

v2.1.3

Constructor Summary

Constructors

Constructor and Description
AppResourceData() Default constructor.
AppResourceData(java.lang.String id, byte[] data, java.lang.String rawType, long rawLength, boolean cooked, java.lang.String cookedType, long cookedLength) Convenience constructor.

Method Summary

Modifier and Type	Method and Description
boolean	getCooked() Attribute to denote whether the payload of the resource is cooked.
long	getCookedLength() The length in bytes of the payload after cooking.
java.lang.String	getCookedType() If the resource is cooked, this will return the recipe used during cooking.
byte[]	getData() Returns the payload of the resource.
java.lang.String	getId() Gets The id or path identifier of the resource.
long	getRawLength() Gets the resource payload's original length.
java.lang.String	getRawType() Gets the resource's raw type or mimetype.
void	setCooked(boolean cooked) Attribute to denote whether the payload of the resource is cooked.
void	setCookedLength(long cookedLength) The length in bytes of the payload after cooking.
void	setCookedType(java.lang.String cookedType) If the resource is cooked, the type of recipe used during cooking.
void	setData(byte[] data) Sets the payload of the resource.
void	setId(java.lang.String id) Sets the id or path of the resource.
void	setRawLength(long rawLength) Sets the resource payload's original length.
void	setRawType(java.lang.String rawType) Sets the resource's raw type or mimetype.

Methods inherited from class java.lang.Object

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

Constructor Detail

AppResourceData

public AppResourceData()

Default constructor.

Since:

v2.1.3

AppResourceData

public AppResourceData(java.lang.String id,
                       byte[] data,
                       java.lang.String rawType,
                       long rawLength,
                       boolean cooked,
                       java.lang.String cookedType,
                       long cookedLength)

Convenience constructor.

Parameters:

id - The id or path of the resource retrieved.

data - The payload data of the resource (uncooked).

rawType - The raw type/mimetype of the resource.

rawLength - The raw length/original length in bytes of the resource.

cooked - True if the resource is cooked.

cookedType - Type of recipe used for cooking.

cookedLength - The cooked length in bytes of the resource.

Since:

v2.1.3

Method Detail

getCooked

public boolean getCooked()

Attribute to denote whether the payload of the resource is cooked.

Returns:

True if the resource is cooked, false otherwise.

Since:

v2.1.3

setCooked

public void setCooked(boolean cooked)

Attribute to denote whether the payload of the resource is cooked.

Parameters:

cooked - True if the resource is cooked, false otherwise.

Since:

v2.1.3

getCookedLength

public long getCookedLength()

The length in bytes of the payload after cooking.

Returns:

Length in bytes of cooked payload.

Since:

v2.1.3

setCookedLength

public void setCookedLength(long cookedLength)

The length in bytes of the payload after cooking.

Parameters:

cookedLength - Length in bytes of cooked payload.

Since:

v2.1.3

getCookedType

public java.lang.String getCookedType()

If the resource is cooked, this will return the recipe used during cooking.

Returns:

The cooking recipe to reverse the cooking process.

Since:

v2.1.3

setCookedType

public void setCookedType(java.lang.String cookedType)

If the resource is cooked, the type of recipe used during cooking.

Parameters:

cookedType - The cooking recipe used during cooking.

Since:

v2.1.3

getData

public byte[] getData()

Returns the payload of the resource.

Returns:

Binary payload of the resource.

Since:

v2.1.3

setData

public void setData(byte[] data)

Sets the payload of the resource.

Parameters:

data - Binary payload of the resource.

Since:

v2.1.3

getId

public java.lang.String getId()

Gets The id or path identifier of the resource.

Returns:

id The id or path identifier of the resource.

setId

public void setId(java.lang.String id)

Sets the id or path of the resource.

Parameters:

id - The id or path of the resource.

Since:

v2.1.3

getRawLength

public long getRawLength()

Gets the resource payload's original length.

Returns:

Original length of the resource in bytes before cooking.

Since:

v2.1.3

setRawLength

public void setRawLength(long rawLength)

Sets the resource payload's original length.

Parameters:

rawLength - Original length of the resource in bytes before cooking.

Since:

v2.1.3

getRawType

public java.lang.String getRawType()

Gets the resource's raw type or mimetype.

Returns:

Resource's type or mimetype.

Since:

v2.1.3

setRawType

public void setRawType(java.lang.String rawType)

Sets the resource's raw type or mimetype.

Parameters:

rawType - Resource's type or mimetype.

Since:

v2.1.3