org.forgerock.openam.utils

Class ClientUtils

java.lang.Object

org.forgerock.openam.utils.ClientUtils

public final class ClientUtils
extends Object

Shared utility class for HTTP Clients.

Method Summary

Modifier and Type	Method and Description
static String	getClientIPAddress(org.forgerock.services.context.Context context) Gets the client IP address from the provided Context.
static String	getClientIPAddress(org.forgerock.services.context.Context context, org.forgerock.http.protocol.Request request) Gets the client IP address from the provided Context and Request.
static String	getClientIPAddress(javax.servlet.http.HttpServletRequest request) Returns client IP address.

Methods inherited from class java.lang.Object

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

Method Detail

getClientIPAddress

public static String getClientIPAddress(javax.servlet.http.HttpServletRequest request)

Returns client IP address. The method checks the special HTTP header first (handles Load Balancer case), then checks the remote address contained in the request. Refactored from AuthClientUtils.getClientIPAddress() to enable classes outside of the core (Federation for example) to access this utility method.

Parameters:

request - HttpServletRequest request to be used to obtain client's IP address

Returns:

String representing the client's IP address

getClientIPAddress

public static String getClientIPAddress(org.forgerock.services.context.Context context,
                                        org.forgerock.http.protocol.Request request)

Gets the client IP address from the provided Context and Request.

Parameters:

context - the Commons Http-Framework context which will be examined to obtain the client's ip address.

request - the Commons Http-Framework request which will be examined to obtain the client's ip address

Returns:

the client ip address, specified in either a custom header value, or pulled from the request, via the ClientContext class.

getClientIPAddress

public static String getClientIPAddress(org.forgerock.services.context.Context context)

Gets the client IP address from the provided Context.

Parameters:

context - the Commons Http-Framework context which will be examined to obtain the client's ip address.

Returns:

the client ip address, specified in either a custom header value, or pulled from the request, via the ClientContext class. Differs from the method above as this method relies upon the presence of crest context objects, which are not present in the CHF context.