org.glassfish.api.admin

Interface Payload.Part

Enclosing interface:

Payload

public static interface Payload.Part

Public API for the payload Part.

Method Summary

Methods

Modifier and Type	Method and Description
void	copy(OutputStream os) Copies the contents of the Part to the specified OutputStream.
String	getContentType() Returns the content type of the part.
File	getExtracted() File where content was extracted from the payload.
InputStream	getInputStream() Returns an InputStream suitable for reading the content of the Part.
String	getName() Returns the name assigned to the part when it was created.
Properties	getProperties() Returns the Properties associated with the Part.
boolean	isRecursive() Indicates if the Part represents a recursive action or not.
void	setExtracted(File extractedFile) Extractor of content can note where the content was extracted.

Method Detail

getName

String getName()

Returns the name assigned to the part when it was created.

Returns:

name

getContentType

String getContentType()

Returns the content type of the part.

Returns:

content type

getProperties

Properties getProperties()

Returns the Properties associated with the Part.

Returns:

Properties for the Part

getInputStream

InputStream getInputStream()

Returns an InputStream suitable for reading the content of the Part.

Returns:

copy

void copy(OutputStream os)
          throws IOException

Copies the contents of the Part to the specified OutputStream.

Parameters:

os - target OutputStream to receive the content of the Part

Throws:

IOException

isRecursive

boolean isRecursive()

Indicates if the Part represents a recursive action or not.

Returns:

setExtracted

void setExtracted(File extractedFile)

Extractor of content can note where the content was extracted. It can help next user of the same Part to read content.

Parameters:

extractedFile -

getExtracted

File getExtracted()

File where content was extracted from the payload.