Package org.glassfish.jersey.media.multipart

Class ContentDisposition

java.lang.Object

org.glassfish.jersey.media.multipart.ContentDisposition

Direct Known Subclasses:

FormDataContentDisposition

public class ContentDisposition
extends Object

A content disposition header.

Author:

Paul Sandoz, imran@smartitengineering.com, Marek Potociar

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ContentDisposition.ContentDispositionBuilder<T extends ContentDisposition.ContentDispositionBuilder,V extends ContentDisposition>	Builder to build content disposition.

Constructor Summary

Constructors

Modifier	Constructor	Description
	ContentDisposition(String header)
	ContentDisposition(String header, boolean fileNameFix)
protected	ContentDisposition(String type, String fileName, Date creationDate, Date modificationDate, Date readDate, long size)
	ContentDisposition(HttpHeaderReader reader, boolean fileNameFix)

Method Summary

Modifier and Type	Method	Description
protected void	addDateParameter(StringBuilder sb, String name, Date p)
protected void	addLongParameter(StringBuilder sb, String name, Long p)
protected void	addStringParameter(StringBuilder sb, String name, String p)
protected String	encodeAsciiFileName(String fileName)
Date	getCreationDate()	Get the creation-date parameter.
String	getFileName()	Get the filename parameter.
String	getFileName(boolean decodeExtended)	Get the filename parameter.
Date	getModificationDate()	Get the modification-date parameter.
Map<String,String>	getParameters()	Get the parameters.
Date	getReadDate()	Get the read-date parameter.
long	getSize()	Get the size parameter.
String	getType()	Get the type.
String	toString()	Convert the disposition to a "Content-Disposition" header value.
protected StringBuilder	toStringBuffer()
static ContentDisposition.ContentDispositionBuilder	type(String type)	Start building content disposition.

Methods inherited from class java.lang.Object

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

Constructor Details

ContentDisposition

protected ContentDisposition(String type,
 String fileName,
 Date creationDate,
 Date modificationDate,
 Date readDate,
 long size)

ContentDisposition

public ContentDisposition(String header)
                   throws ParseException

Throws:

ParseException

ContentDisposition

public ContentDisposition(String header,
 boolean fileNameFix)
                   throws ParseException

Throws:

ParseException

ContentDisposition

public ContentDisposition(HttpHeaderReader reader,
 boolean fileNameFix)
                   throws ParseException

Throws:

ParseException

Method Details

getType

public String getType()

Get the type.

Returns:

the type

getParameters

public Map<String,String> getParameters()

Get the parameters.

Returns:

the parameters

getFileName

public String getFileName()

Get the filename parameter. Automatically decodes RFC 5987 extended filename*= to be human-readable.

Returns:

the file name

getFileName

public String getFileName(boolean decodeExtended)

Get the filename parameter. If the RFC 5987 extended filename*= is received in Content-Disposition, its encoded value can be decoded to be human-readable.

Parameters:

decodeExtended - decode the filename* to be human-readable when true

Returns:

the filename or the RFC 5987 extended filename

getCreationDate

public Date getCreationDate()

Get the creation-date parameter.

Returns:

the creationDate

getModificationDate

public Date getModificationDate()

Get the modification-date parameter.

Returns:

the modificationDate

getReadDate

public Date getReadDate()

Get the read-date parameter.

Returns:

the readDate

getSize

public long getSize()

Get the size parameter.

Returns:

the size

toString

public String toString()

Convert the disposition to a "Content-Disposition" header value.

Overrides:

toString in class Object

Returns:

the "Content-Disposition" value.

toStringBuffer

protected StringBuilder toStringBuffer()

addStringParameter

protected void addStringParameter(StringBuilder sb,
 String name,
 String p)

addDateParameter

protected void addDateParameter(StringBuilder sb,
 String name,
 Date p)

addLongParameter

protected void addLongParameter(StringBuilder sb,
 String name,
 Long p)

encodeAsciiFileName

protected String encodeAsciiFileName(String fileName)

type

public static ContentDisposition.ContentDispositionBuilder type(String type)

Start building content disposition.

Parameters:

type - the disposition type.

Returns:

the content disposition builder.