org.glassfish.admin.payload

Class PayloadImpl.Outbound

java.lang.Object

org.glassfish.admin.payload.PayloadImpl.Outbound

All Implemented Interfaces:

org.glassfish.api.admin.Payload.Outbound

Enclosing class:

PayloadImpl

public abstract static class PayloadImpl.Outbound
extends Object
implements org.glassfish.api.admin.Payload.Outbound

Constructor Summary

Constructors

Constructor and Description
Outbound()

Method Summary

Modifier and Type	Method and Description
void	addPart(int index, String contentType, String name, Properties props, InputStream content)
void	addPart(String contentType, String name, Properties props, InputStream content)
void	addPart(String contentType, String name, Properties props, String content)
void	attachFile(String contentType, URI fileURI, String dataRequestName, File file)
void	attachFile(String contentType, URI fileURI, String dataRequestName, File file, boolean isRecursive)
void	attachFile(String contentType, URI fileURI, String dataRequestName, Properties props, File file)
void	attachFile(String contentType, URI fileURI, String dataRequestName, Properties props, File file, boolean isRecursive)
abstract String	getComplexContentType() Returns the Content-Type which reflects that multiple Parts will be in the Payload.
String	getContentType()
String	getHeaderName()
ArrayList<org.glassfish.api.admin.Payload.Part>	getParts()
boolean	isDirty()
static PayloadImpl.Outbound	newInstance()
Iterator<org.glassfish.api.admin.Payload.Part>	parts()
void	requestFileRemoval(URI fileURI, String dataRequestName, Properties props)
void	requestFileRemoval(URI fileURI, String dataRequestName, Properties props, boolean isRecursive)
void	requestFileReplacement(String contentType, URI fileURI, String dataRequestName, Properties props, File file, boolean isRecursive)
void	resetDirty()
int	size()
protected abstract void	writePartsTo(OutputStream os) Writes the Parts in this Outbound Payload to the specified output stream; concrete implementations will implement this abstract method.
void	writeTo(OutputStream os) Writes the Payload to the specified output stream.

Methods inherited from class java.lang.Object

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

Constructor Detail

Outbound

public Outbound()

Method Detail

size

public int size()

Specified by:

size in interface org.glassfish.api.admin.Payload.Outbound

addPart

public void addPart(String contentType,
                    String name,
                    Properties props,
                    String content)
             throws IOException

Specified by:

addPart in interface org.glassfish.api.admin.Payload.Outbound

Throws:

IOException

addPart

public void addPart(String contentType,
                    String name,
                    Properties props,
                    InputStream content)
             throws IOException

Specified by:

addPart in interface org.glassfish.api.admin.Payload.Outbound

Throws:

IOException

addPart

public void addPart(int index,
                    String contentType,
                    String name,
                    Properties props,
                    InputStream content)
             throws IOException

Specified by:

addPart in interface org.glassfish.api.admin.Payload.Outbound

Throws:

IOException

attachFile

public void attachFile(String contentType,
                       URI fileURI,
                       String dataRequestName,
                       File file)
                throws IOException

Specified by:

attachFile in interface org.glassfish.api.admin.Payload.Outbound

Throws:

IOException

attachFile

public void attachFile(String contentType,
                       URI fileURI,
                       String dataRequestName,
                       File file,
                       boolean isRecursive)
                throws IOException

Specified by:

attachFile in interface org.glassfish.api.admin.Payload.Outbound

Throws:

IOException

attachFile

public void attachFile(String contentType,
                       URI fileURI,
                       String dataRequestName,
                       Properties props,
                       File file)
                throws IOException

Specified by:

attachFile in interface org.glassfish.api.admin.Payload.Outbound

Throws:

IOException

attachFile

public void attachFile(String contentType,
                       URI fileURI,
                       String dataRequestName,
                       Properties props,
                       File file,
                       boolean isRecursive)
                throws IOException

Specified by:

attachFile in interface org.glassfish.api.admin.Payload.Outbound

Throws:

IOException

requestFileReplacement

public void requestFileReplacement(String contentType,
                                   URI fileURI,
                                   String dataRequestName,
                                   Properties props,
                                   File file,
                                   boolean isRecursive)
                            throws IOException

Specified by:

requestFileReplacement in interface org.glassfish.api.admin.Payload.Outbound

Throws:

IOException

requestFileRemoval

public void requestFileRemoval(URI fileURI,
                               String dataRequestName,
                               Properties props)
                        throws IOException

Specified by:

requestFileRemoval in interface org.glassfish.api.admin.Payload.Outbound

Throws:

IOException

requestFileRemoval

public void requestFileRemoval(URI fileURI,
                               String dataRequestName,
                               Properties props,
                               boolean isRecursive)
                        throws IOException

Specified by:

requestFileRemoval in interface org.glassfish.api.admin.Payload.Outbound

Throws:

IOException

getHeaderName

public String getHeaderName()

Specified by:

getHeaderName in interface org.glassfish.api.admin.Payload.Outbound

getContentType

public String getContentType()

Specified by:

getContentType in interface org.glassfish.api.admin.Payload.Outbound

getParts

public ArrayList<org.glassfish.api.admin.Payload.Part> getParts()

writePartsTo

protected abstract void writePartsTo(OutputStream os)
                              throws IOException

Writes the Parts in this Outbound Payload to the specified output stream; concrete implementations will implement this abstract method.

Parameters:

os - the OutputStream to which the Parts should be written

Throws:

IOException

writeTo

public void writeTo(OutputStream os)
             throws IOException

Writes the Payload to the specified output stream.

Specified by:

writeTo in interface org.glassfish.api.admin.Payload.Outbound

Parameters:

os - the OutputStream to which the Payload should be written

Throws:

IOException

getComplexContentType

public abstract String getComplexContentType()

Returns the Content-Type which reflects that multiple Parts will be in the Payload.

This content type might vary among different implementations of Payload.

Returns:

the content type for complex payloads

newInstance

public static PayloadImpl.Outbound newInstance()

parts

public Iterator<org.glassfish.api.admin.Payload.Part> parts()

Specified by:

parts in interface org.glassfish.api.admin.Payload.Outbound

isDirty

public boolean isDirty()

Specified by:

isDirty in interface org.glassfish.api.admin.Payload.Outbound

resetDirty

public void resetDirty()

Specified by:

resetDirty in interface org.glassfish.api.admin.Payload.Outbound