com.atlassian.http.mime

Class ContentDispositionHeaderGuesser

java.lang.Object

com.atlassian.http.mime.ContentDispositionHeaderGuesser

public class ContentDispositionHeaderGuesser
extends Object

This class can sniff a file according to the current settings specified by the MimeSNiffPolicyProvider and determine how raw files should be handled.

Constructor Summary

Constructors

Constructor and Description
ContentDispositionHeaderGuesser(DownloadPolicyProvider downloadPolicyProvider, HostileExtensionDetector hostileExtensionDetector)

Method Summary

Modifier and Type	Method and Description
String	guessContentDispositionHeader(String fileName, String mimeContentType, String userAgent) This will suggest a content disposition type (inline or attachment) for the given file, respecting the settings given by the provided download policy.
String	guessMIME(String mimeContentType, boolean isBinaryFile) Given a mimeContentType and whether the file is a binary file or not returns text/plain for non-binary files and the given mimeContentType is returned.
String	guessMIME(String filename, String mimeContentType, String userAgent) Deprecated. since 0.0.8 use guessMIME(String, boolean) instead Given a filename, its MIME type, and a browser user agent, return a 'safe' mime type, depending on the download policy configured, such that 'safe' browsers can display the executable text file without causing xss issues. If the download policy is set to DownloadPolicy.Secure or DownloadPolicy.Insecure, then the given mimeContentType will be returned. If the download policy is set to DownloadPolicy.Smart, and the user agent is not Internet Explorer , then for text files that can be displayed in plain text (e.g., text/html, as determined by HostileExtensionDetector.isTextContentType(String) and HostileExtensionDetector.isTextExtension(String)), a 'text/plain' mime type will be returned instead of the given mimeContentType.

Methods inherited from class java.lang.Object

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

Constructor Detail

ContentDispositionHeaderGuesser

public ContentDispositionHeaderGuesser(DownloadPolicyProvider downloadPolicyProvider,
                                       HostileExtensionDetector hostileExtensionDetector)

Method Detail

guessContentDispositionHeader

public String guessContentDispositionHeader(String fileName,
                                            String mimeContentType,
                                            String userAgent)

This will suggest a content disposition type (inline or attachment) for the given file, respecting the settings given by the provided download policy.

Special treatment is given to html/xml - they will always be displayed inline if the contentType is set to a text type, and if the browser is not IE.

Parameters:

fileName - the name of the file

mimeContentType - the existing content type

Returns:

either INLINE or ATTACHMENT ready for a Content-Disposition header

guessMIME

public String guessMIME(String filename,
                        String mimeContentType,
                        String userAgent)

Deprecated. since 0.0.8 use guessMIME(String, boolean) instead Given a filename, its MIME type, and a browser user agent, return a 'safe' mime type, depending on the download policy configured, such that 'safe' browsers can display the executable text file without causing xss issues.

If the download policy is set to DownloadPolicy.Secure or DownloadPolicy.Insecure, then the given mimeContentType will be returned.

If the download policy is set to DownloadPolicy.Smart, and the user agent is not Internet Explorer , then for text files that can be displayed in plain text (e.g., text/html, as determined by HostileExtensionDetector.isTextContentType(String) and HostileExtensionDetector.isTextExtension(String)), a 'text/plain' mime type will be returned instead of the given mimeContentType.

Parameters:

filename - the file to display

mimeContentType - the mime type for the given file

userAgent - the browser user agent.

Returns:

a mime type

guessMIME

public String guessMIME(String mimeContentType,
                        boolean isBinaryFile)

Given a mimeContentType and whether the file is a binary file or not returns text/plain for non-binary files and the given mimeContentType is returned.

If the download policy is set to DownloadPolicy.Secure or DownloadPolicy.Insecure, then the given mimeContentType will be returned.

It is recommended to use the 'X-Content-Type-Options' header with a value of 'nosniff' to avoid XSS issues in IE.

Parameters:

mimeContentType - the the mime type for the given file

isBinaryFile - if the file is a binary file or not (true iff binary)

Returns:

a mime type