com.helger.phase4.messaging

Interface IAS4IncomingMessageMetadata

public interface IAS4IncomingMessageMetadata

This interface lets you access optional metadata for a single incoming message.

Since:

0.9.8

Author:

Philip Helger

Method Summary

Modifier and Type	Method and Description
com.helger.commons.collection.impl.ICommonsList<javax.servlet.http.Cookie>	cookies()
LocalDateTime	getIncomingDT()
String	getIncomingUniqueID()
EAS4IncomingMessageMode	getMode()
String	getRemoteAddr() Returns the Internet Protocol (IP) address of the client or last proxy that sent the request.
String	getRemoteHost() Returns the fully qualified name of the client or the last proxy that sent the request.
int	getRemotePort() Returns the Internet Protocol (IP) source port of the client or last proxy that sent the request.
String	getRemoteUser() Returns the login of the user making this request, if the user has been authenticated, or null if the user has not been authenticated.
default boolean	hasRemoteAddr()
default boolean	hasRemoteHost()
default boolean	hasRemotePort()
default boolean	hasRemoteUser()

Method Detail

getIncomingUniqueID

@Nonnull
 @Nonempty
String getIncomingUniqueID()

Returns:

A unique ID created just for this message metadata. It can be used to reference to this message internally. Usually this is a UUID. Never null nor empty.

getIncomingDT

@Nonnull
LocalDateTime getIncomingDT()

Returns:

The date and time when the request was received. Never null.

getMode

@Nonnull
EAS4IncomingMessageMode getMode()

Returns:

The message mode. May be null.

getRemoteAddr

@Nullable
String getRemoteAddr()

Returns the Internet Protocol (IP) address of the client or last proxy that sent the request.

Returns:

a String containing the IP address of the client that sent the request

hasRemoteAddr

default boolean hasRemoteAddr()

getRemoteHost

@Nullable
String getRemoteHost()

Returns the fully qualified name of the client or the last proxy that sent the request. If the engine cannot or chooses not to resolve the hostname (to improve performance), this method returns the dotted-string form of the IP address.

Returns:

a String containing the fully qualified name of the client

hasRemoteHost

default boolean hasRemoteHost()

getRemotePort

@CheckForSigned
int getRemotePort()

Returns the Internet Protocol (IP) source port of the client or last proxy that sent the request.

Returns:

an integer specifying the port number or a negative value if not set

hasRemotePort

default boolean hasRemotePort()

getRemoteUser

@Nullable
String getRemoteUser()

Returns the login of the user making this request, if the user has been authenticated, or null if the user has not been authenticated. Whether the user name is sent with each subsequent request depends on the browser and type of authentication.

Returns:

a String specifying the login of the user making this request, or null if the user login is not known

Since:

0.9.10

hasRemoteUser

default boolean hasRemoteUser()

cookies

@Nonnull
 @ReturnsMutableObject
com.helger.commons.collection.impl.ICommonsList<javax.servlet.http.Cookie> cookies()

Returns:

A list of all Cookies contained in the request. Never null but maybe empty. The returned list is mutable so handle with care.

Since:

0.9.10