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 java.lang.Object
implements DirectoryWriter

A default directory writer implementation.

Since:

3.0.0

Nested Class Summary

Nested Classes

Modifier and Type	Class and 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 and Description
DefaultDirectoryWriter()

Method Summary

Modifier and Type	Method and Description
static java.lang.String	directoryToHTML(java.lang.String directoryName, DefaultDirectoryWriter.Directory directory) Given the provided information render as an HTML string.
protected DefaultDirectoryWriter.Directory	getDirectory(java.io.File directory, java.lang.String requestUrl, boolean includeParent)
java.lang.String	toHtml(@NotNull java.io.File directory, @URL java.lang.String requestURL, boolean includeParent) Convert a given directory to an String containing a full valid HTML page.
java.lang.String	toJson(@NotNull java.io.File directory, @URL java.lang.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 Detail

DefaultDirectoryWriter

public DefaultDirectoryWriter()

Method Detail

directoryToHTML

public static java.lang.String directoryToHTML(java.lang.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:

org.apache.catalina.servlets.DefaultServlet

toHtml

public java.lang.String toHtml(@NotNull
                               @NotNull java.io.File directory,
                               @URL
                               @URL java.lang.String requestURL,
                               boolean includeParent)
                        throws java.io.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:

java.io.IOException

See Also:

org.apache.catalina.servlets.DefaultServlet

toJson

public java.lang.String toJson(@NotNull
                               @NotNull java.io.File directory,
                               @URL
                               @URL java.lang.String requestURL,
                               boolean includeParent)
                        throws java.lang.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:

java.lang.Exception - for any conversion problem

getDirectory

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