Payload (Apache jclouds 2.4.0 API)

This project has retired. For details please refer to its Attic page.

Payload (Apache jclouds 2.4.0 API)

All Superinterfaces:

AutoCloseable, Closeable

All Known Implementing Classes:

ApacheHCUtils.HttpEntityPayload, BaseCipherPayload, BasePayload, ByteArrayPayload, ByteSourcePayload, ChunkedUploadPayload, DelegatingPayload, FilePayload, InputStreamPayload, MultipartForm, Part, PhantomPayload, RSADecryptingPayload, RSAEncryptingPayload, StringPayload, UrlEncodedFormPayload
```
public interface Payload
extends Closeable
```

Method Summary

All Methods Instance Methods Abstract Methods Deprecated Methods
Modifier and Type	Method	Description
`MutableContentMetadata`	`getContentMetadata()`
`InputStream`	`getInput()`	Deprecated. see `openStream()`.
`Object`	`getRawContent()`	Payload in its original form.
`boolean`	`isRepeatable()`	Tells if the payload is capable of producing its data more than once.
`boolean`	`isSensitive()`	Returns whether the payload contains sensitive information.
`InputStream`	`openStream()`	Creates a new InputStream object of the payload.
`void`	`release()`	release resources used by this entity.
`void`	`setContentMetadata(MutableContentMetadata in)`
`void`	`setSensitive(boolean isSensitive)`	Sets whether the payload contains sensitive information.

Methods inherited from interface java.io.Closeable
close

- Method Detail
  - openStream
```
InputStream openStream()
                throws IOException
```
    Creates a new InputStream object of the payload.
    
    Throws:
    
    IOException
  - getInput
```
@Deprecated
InputStream getInput()
```
    Deprecated.
    see openStream().
    
    Creates a new InputStream object of the payload.
  - getRawContent
```
Object getRawContent()
```
    Payload in its original form.
  - isRepeatable
```
boolean isRepeatable()
```
    Tells if the payload is capable of producing its data more than once.
  - release
```
void release()
```
    release resources used by this entity. This should be called when data is discarded.
  - getContentMetadata
```
MutableContentMetadata getContentMetadata()
```
  - setContentMetadata
```
void setContentMetadata(MutableContentMetadata in)
```
  - setSensitive
```
void setSensitive(boolean isSensitive)
```
    Sets whether the payload contains sensitive information. This is used when trying to decide whether to print out the payload information or not in logs
  - isSensitive
```
boolean isSensitive()
```
    Returns whether the payload contains sensitive information. This is used when trying to decide whether to print out the payload information or not in logs