Package com.netflix.genie.web.resources.writers

Class DefaultDirectoryWriter

java.lang.Object

com.netflix.genie.web.resources.writers.DefaultDirectoryWriter

All Implemented Interfaces:

DirectoryWriter

public class DefaultDirectoryWriter
extends Object
implements DirectoryWriter

A default directory writer implementation.

Since:

3.0.0

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	DefaultDirectoryWriter.Directory	DTO for representing a directory contents.
static class	DefaultDirectoryWriter.Entry	DTO for representing information about an entry within a job directory.

Constructor Summary

Constructors

Constructor	Description
DefaultDirectoryWriter()

Method Summary

Modifier and Type	Method	Description
static String	directoryToHTML(String directoryName, DefaultDirectoryWriter.Directory directory)	Given the provided information render as an HTML string.
protected DefaultDirectoryWriter.Directory	getDirectory(File directory, String requestUrl, boolean includeParent)
String	toHtml(@NotNull File directory, @URL String requestURL, boolean includeParent)	Convert a given directory to an String containing a full valid HTML page.
String	toJson(@NotNull File directory, @URL String requestURL, boolean includeParent)	Convert a given directory to an String of JSON.

Methods inherited from class java.lang.Object

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

Constructor Details

DefaultDirectoryWriter

public DefaultDirectoryWriter()

Method Details

directoryToHTML

public static String directoryToHTML(String directoryName,
 DefaultDirectoryWriter.Directory directory)

Given the provided information render as an HTML string.

Parameters:

directoryName - The name of the directory

directory - The directory information to serialize

Returns:

A string of valid HTML

See Also:

• DefaultServlet

toHtml

public String toHtml(@NotNull
 @NotNull File directory,
 @URL
 @URL String requestURL,
 boolean includeParent)
              throws IOException

Convert a given directory to an String containing a full valid HTML page.

Specified by:

toHtml in interface DirectoryWriter

Parameters:

directory - The directory to convert. Not null. Is directory.

requestURL - The URL of the request that kicked off this process

includeParent - Whether the conversion should include reference to the parent directory.

Returns:

String HTML representation of the directory

Throws:

IOException

See Also:

• DefaultServlet

toJson

public String toJson(@NotNull
 @NotNull File directory,
 @URL
 @URL String requestURL,
 boolean includeParent)
              throws Exception

Convert a given directory to an String of JSON.

Specified by:

toJson in interface DirectoryWriter

Parameters:

directory - The directory to convert. Not null. Is directory.

requestURL - The URL of the request that kicked off this process

includeParent - Whether the conversion should include reference to the parent directory.

Returns:

String HTML representation of the directory

Throws:

Exception - for any conversion problem

getDirectory

protected DefaultDirectoryWriter.Directory getDirectory(File directory,
 String requestUrl,
 boolean includeParent)