org.kuali.rice.ksb.messaging.serviceconnectors

Enum HttpClientParams

java.lang.Object

java.lang.Enum<HttpClientParams>

org.kuali.rice.ksb.messaging.serviceconnectors.HttpClientParams

All Implemented Interfaces:

Serializable, Comparable<HttpClientParams>

public enum HttpClientParams
extends Enum<HttpClientParams>

Contains some utility methods for dealing with configuration of the HttpComponents HttpClient.

To limit the impact of transitioning from Commons HttpClient to HttpComponents, certain legacy parameters (namely, those that map over directly) are enumerated in this class. There are methods here to help retrieve those config param values as well.

NOTE: The full list of supported parameters can be found in the source for this class.

Author:

Kuali Rice Team (rice.collab@kuali.org)

Enum Constant Summary

Enum Constants

Enum Constant and Description
ALLOW_CIRCULAR_REDIRECTS
CONNECTION_MANAGER_TIMEOUT
CONNECTION_TIMEOUT
COOKIE_POLICY
HTTP_CONTENT_CHARSET
MAX_REDIRECTS
MAX_TOTAL_CONNECTIONS
REJECT_RELATIVE_REDIRECT
SO_LINGER
SO_RCVBUF
SO_SNDBUF
SO_TIMEOUT
STALE_CONNECTION_CHECK
TCP_NODELAY
USE_EXPECT_CONTINUE

Method Summary

Methods

Modifier and Type	Method and Description
String	getParamName()
Class	getParamValueClass()
<T> T	getValue()
<T> T	getValueOrDefault(T defaultValue)
static HttpClientParams	valueOf(String name) Returns the enum constant of this type with the specified name.
static HttpClientParams[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

USE_EXPECT_CONTINUE

public static final HttpClientParams USE_EXPECT_CONTINUE

HTTP_CONTENT_CHARSET

public static final HttpClientParams HTTP_CONTENT_CHARSET

COOKIE_POLICY

public static final HttpClientParams COOKIE_POLICY

SO_TIMEOUT

public static final HttpClientParams SO_TIMEOUT

TCP_NODELAY

public static final HttpClientParams TCP_NODELAY

SO_SNDBUF

public static final HttpClientParams SO_SNDBUF

SO_RCVBUF

public static final HttpClientParams SO_RCVBUF

SO_LINGER

public static final HttpClientParams SO_LINGER

CONNECTION_TIMEOUT

public static final HttpClientParams CONNECTION_TIMEOUT

STALE_CONNECTION_CHECK

public static final HttpClientParams STALE_CONNECTION_CHECK

MAX_TOTAL_CONNECTIONS

public static final HttpClientParams MAX_TOTAL_CONNECTIONS

CONNECTION_MANAGER_TIMEOUT

public static final HttpClientParams CONNECTION_MANAGER_TIMEOUT

REJECT_RELATIVE_REDIRECT

public static final HttpClientParams REJECT_RELATIVE_REDIRECT

MAX_REDIRECTS

public static final HttpClientParams MAX_REDIRECTS

ALLOW_CIRCULAR_REDIRECTS

public static final HttpClientParams ALLOW_CIRCULAR_REDIRECTS

Method Detail

values

public static HttpClientParams[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (HttpClientParams c : HttpClientParams.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static HttpClientParams valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

getValue

public <T> T getValue()

getValueOrDefault

public <T> T getValueOrDefault(T defaultValue)

getParamName

public String getParamName()

getParamValueClass

public Class getParamValueClass()