com.loop54.user

Interface IRemoteClientInfo

All Known Implementing Classes:

NullClientInfo

public interface IRemoteClientInfo

This interface contains methods used to get information about the end-user client request.

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.

Method Detail

getRequestHeader

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

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

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.

getReferrer

java.lang.String getReferrer()

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

Returns:

Referer header or null if it doesn't exist.

getUserAgent

java.lang.String getUserAgent()

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

Returns:

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

getRemoteIp

java.lang.String getRemoteIp()

Get the IP address of the end-user.

Returns:

IP address or null if it doesn't exist.

getCookie

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

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

Parameters:

name - Name of the cookie

Returns:

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

setCookie

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

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

Parameters:

name - Name of the cookie to set

expiryTime - When the cookie should expire

value - What value to set on the cookie