com.yanzhenjie.andserver.framework.website

Class BasicWebsite

java.lang.Object

com.yanzhenjie.andserver.framework.website.Website

com.yanzhenjie.andserver.framework.website.BasicWebsite

All Implemented Interfaces:

ETag, HandlerAdapter, LastModified

Direct Known Subclasses:

AssetsWebsite, FileBrowser, StorageWebsite

public abstract class BasicWebsite
extends Website

Created by Zhenjie Yan on 2018/9/6.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	DEFAULT_INDEX

Constructor Summary

Constructors

Constructor and Description
BasicWebsite()
BasicWebsite(java.lang.String indexFileName) Create a website object.

Method Summary

Modifier and Type	Method and Description
protected java.lang.String	addEndSlash(java.lang.String target) Add '/' at the ending.
protected java.lang.String	addStartSlash(java.lang.String target) Add the '/' to the beginning.
java.lang.String	getETag(HttpRequest request) Get the ETag requesting the specified resource.
protected java.lang.String	getIndexFileName() Get the name of the indexFile.
long	getLastModified(HttpRequest request) The return value will be sent to the HTTP client as Last-Modified header, and compared with If-Modified-Since headers that the client sends back.
protected java.lang.String	queryString(HttpRequest request)
protected java.lang.String	trimEndSlash(java.lang.String target) Remove '/' at the ending.
protected java.lang.String	trimSlash(java.lang.String target) Remove the '/' at the beginning and ending.
protected java.lang.String	trimStartSlash(java.lang.String target) Remove '/' at the beginning.

Methods inherited from class com.yanzhenjie.andserver.framework.website.Website

getBody, getHandler

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.yanzhenjie.andserver.framework.handler.HandlerAdapter

intercept

Field Detail

DEFAULT_INDEX

public static final java.lang.String DEFAULT_INDEX

See Also:

Constant Field Values

Constructor Detail

BasicWebsite

public BasicWebsite()

BasicWebsite

public BasicWebsite(java.lang.String indexFileName)

Create a website object.

Parameters:

indexFileName - the default file name for each directory, e.g. index.html.

Method Detail

getETag

public java.lang.String getETag(HttpRequest request)
                         throws java.lang.Throwable

Description copied from interface: ETag

Get the ETag requesting the specified resource.

Can simply return null if there's no support.

Specified by:

getETag in interface ETag

Overrides:

getETag in class Website

Throws:

java.lang.Throwable

getLastModified

public long getLastModified(HttpRequest request)
                     throws java.lang.Throwable

Description copied from interface: LastModified

The return value will be sent to the HTTP client as Last-Modified header, and compared with If-Modified-Since headers that the client sends back. The content will only get regenerated if there has been a modification.

Specified by:

getLastModified in interface LastModified

Overrides:

getLastModified in class Website

Parameters:

request - current request

Returns:

the time the underlying resource was last modified, or -1 meaning that the content must always be regenerated.

Throws:

java.lang.Throwable

getIndexFileName

protected final java.lang.String getIndexFileName()

Get the name of the indexFile.

Returns:

file name, does not include the path.

addStartSlash

protected java.lang.String addStartSlash(java.lang.String target)

Add the '/' to the beginning.

Parameters:

target - target string.

Returns:

rule result.

addEndSlash

protected java.lang.String addEndSlash(java.lang.String target)

Add '/' at the ending.

Parameters:

target - target string.

Returns:

rule result.

trimStartSlash

protected java.lang.String trimStartSlash(java.lang.String target)

Remove '/' at the beginning.

Parameters:

target - target string.

Returns:

rule result.

trimEndSlash

protected java.lang.String trimEndSlash(java.lang.String target)

Remove '/' at the ending.

Parameters:

target - target string.

Returns:

rule result.

trimSlash

protected java.lang.String trimSlash(java.lang.String target)

Remove the '/' at the beginning and ending.

Parameters:

target - target string.

Returns:

rule result.

queryString

protected java.lang.String queryString(HttpRequest request)