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 an object 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
String	tenantId Tenant Id of the user requesting the access.
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(javax.servlet.http.HttpServletRequest request, Tenant tenant) Creates an AccessRequester based on the given request and tenant.
AccessRequester(String userId, String tenantId, String ipAddress, String channel)

Method Summary

Modifier and Type	Method and Description
protected boolean	canEqual(Object other)
boolean	equals(Object o)
Optional<String>	getChannel() The connection channel used, e.g.
Optional<String>	getIpAddress() The IP address of the remote user requesting access.
Optional<String>	getTenantId() The tenant Id of the remote user requesting access.
Optional<String>	getUserId() The Id of the remote user requesting access.
int	hashCode()
static AccessRequester	of(javax.servlet.http.HttpServletRequest request) Creates a request based on the given, nullable request.
static AccessRequester	of(javax.servlet.http.HttpServletRequest request, Tenant tenant) Creates a request based on the given, nullable request and tenant.
static AccessRequester	ofCurrentRequest() Creates a request based on the current request.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, 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

tenantId

@Nullable
public final String tenantId

Tenant Id of the user requesting the access.

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 object.

AccessRequester

public AccessRequester(@Nonnull
                       javax.servlet.http.HttpServletRequest request,
                       @Nonnull
                       Tenant tenant)

Creates an AccessRequester based on the given request and tenant.

Parameters:

request - The request which tries to access an object.

tenant - The tenant which tries to access an object.

AccessRequester

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

Method Detail

getUserId

public Optional<String> getUserId()

The Id of the remote user requesting access.

Returns:

An Optional containing the user Id.

getTenantId

public Optional<String> getTenantId()

The tenant Id of the remote user requesting access.

Returns:

An Optional containing the tenant Id.

getIpAddress

public Optional<String> getIpAddress()

The IP address of the remote user requesting access.

Returns:

An Optional containing the IP address.

getChannel

public 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 object.

Returns:

An AccessRequester for the given request. Never null.

of

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

Creates a request based on the given, nullable request and tenant.

Parameters:

request - The request which tries to access an object.

tenant - The tenant which tries to access an object.

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

canEqual

protected boolean canEqual(Object other)

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object