to.etc.domui.parts

Class TempFilePart

java.lang.Object

to.etc.domui.parts.TempFilePart

All Implemented Interfaces:

IPartFactory, IUnbufferedPartFactory

public class TempFilePart
extends Object
implements IUnbufferedPartFactory

Safe reference to a server-side tempfile.

Author:

Frits Jalvingh Created on Jul 20, 2010

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TempFilePart.Disposition

Constructor Summary

Constructors

Constructor and Description
TempFilePart()

Method Summary

Modifier and Type	Method and Description
static void	createDownloadAction(NodeBase sourcePage, File target, String mime, TempFilePart.Disposition disposition, String name) Force the browser to download the specified file, by sending "location.href = (url-to-file)" to the browser.
void	generate(DomApplication app, String rurl, RequestContextImpl param)
static String	getDownloadLink(IRequestContext ctx, Blob blob, String mime, String type, String filename) Saves blob into temporary file, register temporary file in provided context, and returns generated download link.
static String	registerTempFile(File target, String mime, TempFilePart.Disposition disp, String name) Register a temp file that can be accessed by the browser.
static String	registerTempFile(IRequestContext ctx, File target, String mime, String type, String name) Deprecated.

Methods inherited from class java.lang.Object

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

Constructor Detail

TempFilePart

public TempFilePart()

Method Detail

registerTempFile

@Deprecated
public static String registerTempFile(@Nonnull
                                                  IRequestContext ctx,
                                                  @Nonnull
                                                  File target,
                                                  @Nonnull
                                                  String mime,
                                                  @Nullable
                                                  String type,
                                                  @Nullable
                                                  String name)

Deprecated.

Use the version registerTempFile(java.io.File, String, to.etc.domui.parts.TempFilePart.Disposition, String)

Parameters:

ctx -

target -

mime -

type -

name -

Returns:

registerTempFile

public static String registerTempFile(@Nonnull
                                      File target,
                                      @Nonnull
                                      String mime,
                                      @Nonnull
                                      TempFilePart.Disposition disp,
                                      @Nullable
                                      String name)

Register a temp file that can be accessed by the browser. The file can reside anywhere but should usually be put in temp files. Only people knowing the full name for the file, including a set of random-generated "passwords", can access it. This returns the absolute URL to the file, including host name etc.

Parameters:

target -

mime -

disp - The disposition: attachment or inline (download or view)

name -

Returns:

The absolute full URL to the file.

getDownloadLink

public static String getDownloadLink(@Nonnull
                                     IRequestContext ctx,
                                     @Nonnull
                                     Blob blob,
                                     String mime,
                                     String type,
                                     String filename)
                              throws Exception

Saves blob into temporary file, register temporary file in provided context, and returns generated download link.

Parameters:

ctx -

blob -

mime -

type -

filename -

Returns:

Throws:

Exception

createDownloadAction

public static void createDownloadAction(@Nonnull
                                        NodeBase sourcePage,
                                        @Nonnull
                                        File target,
                                        @Nonnull
                                        String mime,
                                        @Nonnull
                                        TempFilePart.Disposition disposition,
                                        @Nullable
                                        String name)

Force the browser to download the specified file, by sending "location.href = (url-to-file)" to the browser.

Parameters:

sourcePage -

target -

mime -

disposition -

name -

generate

public void generate(@Nonnull
                     DomApplication app,
                     @Nonnull
                     String rurl,
                     @Nonnull
                     RequestContextImpl param)
              throws Exception

Specified by:

generate in interface IUnbufferedPartFactory

Throws:

Exception