com.loop54.user

Class NullClientInfo

java.lang.Object

com.loop54.user.NullClientInfo

All Implemented Interfaces:

IRemoteClientInfo

public class NullClientInfo
extends java.lang.Object
implements IRemoteClientInfo

Field Summary

Fields

Modifier and Type	Field and Description
java.util.Map<java.lang.String,java.lang.String>	headers

Constructor Summary

Constructors

Constructor and Description
NullClientInfo()

Method Summary

Modifier and Type	Method and Description
java.lang.String	getCookie(java.lang.String name) Gets the value of a cookie with a given name.
java.lang.String	getReferrer() Get the Referer(sic) header sent by the end-user.
java.lang.String	getRemoteIp() Get the IP address of the end-user.
java.lang.String	getRequestHeader(java.lang.String name) Get a named header from the request made by the end-user.
java.lang.String	getUserAgent() Get the User-Agent header sent by the end-user.
void	setCookie(java.lang.String name, java.lang.String value, java.time.LocalDateTime expiryTime) Sets a cookie with a given name, value and expiryTime.

Methods inherited from class java.lang.Object

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

Field Detail

headers

public java.util.Map<java.lang.String,java.lang.String> headers

Constructor Detail

NullClientInfo

public NullClientInfo()

Method Detail

getRequestHeader

public java.lang.String getRequestHeader(java.lang.String name)

Description copied from interface: IRemoteClientInfo

Get a named header from the request made by the end-user.

Specified by:

getRequestHeader in interface IRemoteClientInfo

Parameters:

name - The name of the header. Can be of any casing.

Returns:

If the header isn't set return null, otherwise the string value of the header.

setCookie

public void setCookie(java.lang.String name,
                      java.lang.String value,
                      java.time.LocalDateTime expiryTime)

Description copied from interface: IRemoteClientInfo

Sets a cookie with a given name, value and expiryTime. Cookies set by this method needs to be accessible with IRemoteClientInfo.getCookie(String);

Specified by:

setCookie in interface IRemoteClientInfo

Parameters:

name - Name of the cookie to set

value - What value to set on the cookie

expiryTime - When the cookie should expire

getCookie

public java.lang.String getCookie(java.lang.String name)

Description copied from interface: IRemoteClientInfo

Gets the value of a cookie with a given name. This needs to be able return cookies set with IRemoteClientInfo.setCookie(String, String, LocalDateTime)

Specified by:

getCookie in interface IRemoteClientInfo

Parameters:

name - Name of the cookie

Returns:

Return the cookie data or null if it doesn't exist.

getReferrer

public java.lang.String getReferrer()

Description copied from interface: IRemoteClientInfo

Get the Referer(sic) header sent by the end-user.

Specified by:

getReferrer in interface IRemoteClientInfo

Returns:

Referer header or null if it doesn't exist.

getUserAgent

public java.lang.String getUserAgent()

Description copied from interface: IRemoteClientInfo

Get the User-Agent header sent by the end-user.

Specified by:

getUserAgent in interface IRemoteClientInfo

Returns:

User-Agent header or null if it doesn't exist.

getRemoteIp

public java.lang.String getRemoteIp()

Description copied from interface: IRemoteClientInfo

Get the IP address of the end-user.

Specified by:

getRemoteIp in interface IRemoteClientInfo

Returns:

IP address or null if it doesn't exist.