com.sap.cloud.sdk.cloudplatform.auditlog

Class AccessRequester

java.lang.Object

com.sap.cloud.sdk.cloudplatform.auditlog.AccessRequester

public class AccessRequester
extends Object

Represents the requester of an access to a security relevant attribute in the context of an audit log.

Therefore this class stores identifiable information of the requester. Information about the field accessed as well as about the access time are handled in the implementation of the AuditLog interface.

Field Summary

Fields

Modifier and Type	Field and Description
static String	UNAUTHENTICATED_USER Default user Id, used in case of an unknown remote user.
static AccessRequester	UNKNOWN Null-Object representing an unknown requester.

Constructor Summary

Constructors

Constructor and Description
AccessRequester(javax.servlet.http.HttpServletRequest request) Creates an AccessRequester based on the given request.
AccessRequester(String userId, String ipAddress, String channel)

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
com.google.common.base.Optional<String>	getChannel() The connection channel used, e.g. http, or https.
com.google.common.base.Optional<String>	getIpAddress() The IP address of the remote user requesting access to an attribute.
com.google.common.base.Optional<String>	getUserId() The Id of the remote user requesting access to an attribute.
int	hashCode()
static AccessRequester	of(javax.servlet.http.HttpServletRequest request) Creates a request based on the given, nullable request.
static AccessRequester	ofCurrentRequest() Creates a request based on the current request.
String	toString()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Field Detail

UNKNOWN

public static final AccessRequester UNKNOWN

Null-Object representing an unknown requester.

UNAUTHENTICATED_USER

public static final String UNAUTHENTICATED_USER

Default user Id, used in case of an unknown remote user.

See Also:

Constant Field Values

Constructor Detail

AccessRequester

public AccessRequester(@NonNull
                       javax.servlet.http.HttpServletRequest request)

Creates an AccessRequester based on the given request.

Parameters:

request - The request which tries to access an attribute.

AccessRequester

public AccessRequester(@Nullable
                       String userId,
                       @Nullable
                       String ipAddress,
                       @Nullable
                       String channel)

Method Detail

getUserId

public com.google.common.base.Optional<String> getUserId()

The Id of the remote user requesting access to an attribute.

Returns:

An Optional containing the user Id.

getIpAddress

public com.google.common.base.Optional<String> getIpAddress()

The IP address of the remote user requesting access to an attribute.

Returns:

An Optional containing the IP address.

getChannel

public com.google.common.base.Optional<String> getChannel()

The connection channel used, e.g. http, or https.

Returns:

An Optional containing the connection channel.

of

@Nullable
public static AccessRequester of(@Nullable
                                           javax.servlet.http.HttpServletRequest request)

Creates a request based on the given, nullable request.

Parameters:

request - The request which tries to access an attribute.

Returns:

An AccessRequester for the given request. Never null.

ofCurrentRequest

@Nullable
public static AccessRequester ofCurrentRequest()

Creates a request based on the current request.

Returns:

An AccessRequester for the current request. Never null.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object