Return-Path: Delivered-To: apmail-hc-commits-archive@www.apache.org Received: (qmail 44240 invoked from network); 8 Dec 2010 16:18:51 -0000 Received: from unknown (HELO mail.apache.org) (140.211.11.3) by 140.211.11.9 with SMTP; 8 Dec 2010 16:18:51 -0000 Received: (qmail 3939 invoked by uid 500); 8 Dec 2010 16:18:51 -0000 Delivered-To: apmail-hc-commits-archive@hc.apache.org Received: (qmail 3898 invoked by uid 500); 8 Dec 2010 16:18:50 -0000 Mailing-List: contact commits-help@hc.apache.org; run by ezmlm Precedence: bulk List-Help: List-Unsubscribe: List-Post: List-Id: Reply-To: "HttpComponents Project" Delivered-To: mailing list commits@hc.apache.org Received: (qmail 3891 invoked by uid 99); 8 Dec 2010 16:18:50 -0000 Received: from nike.apache.org (HELO nike.apache.org) (192.87.106.230) by apache.org (qpsmtpd/0.29) with ESMTP; Wed, 08 Dec 2010 16:18:50 +0000 X-ASF-Spam-Status: No, hits=-2000.0 required=10.0 tests=ALL_TRUSTED X-Spam-Check-By: apache.org Received: from [140.211.11.4] (HELO eris.apache.org) (140.211.11.4) by apache.org (qpsmtpd/0.29) with ESMTP; Wed, 08 Dec 2010 16:18:45 +0000 Received: by eris.apache.org (Postfix, from userid 65534) id C69CE23889B2; Wed, 8 Dec 2010 16:18:20 +0000 (UTC) Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit Subject: svn commit: r1043489 - in /httpcomponents/httpclient/trunk/src/docbkx: advanced.xml authentication.xml connmgmt.xml fundamentals.xml httpagent.xml statemgmt.xml Date: Wed, 08 Dec 2010 16:18:20 -0000 To: commits@hc.apache.org From: sebb@apache.org X-Mailer: svnmailer-1.0.8 Message-Id: <20101208161820.C69CE23889B2@eris.apache.org> X-Virus-Checked: Checked by ClamAV on apache.org Author: sebb Date: Wed Dec 8 16:18:20 2010 New Revision: 1043489 URL: http://svn.apache.org/viewvc?rev=1043489&view=rev Log: Added constant names for parameter name strings Modified: httpcomponents/httpclient/trunk/src/docbkx/advanced.xml httpcomponents/httpclient/trunk/src/docbkx/authentication.xml httpcomponents/httpclient/trunk/src/docbkx/connmgmt.xml httpcomponents/httpclient/trunk/src/docbkx/fundamentals.xml httpcomponents/httpclient/trunk/src/docbkx/httpagent.xml httpcomponents/httpclient/trunk/src/docbkx/statemgmt.xml Modified: httpcomponents/httpclient/trunk/src/docbkx/advanced.xml URL: http://svn.apache.org/viewvc/httpcomponents/httpclient/trunk/src/docbkx/advanced.xml?rev=1043489&r1=1043488&r2=1043489&view=diff ============================================================================== --- httpcomponents/httpclient/trunk/src/docbkx/advanced.xml (original) +++ httpcomponents/httpclient/trunk/src/docbkx/advanced.xml Wed Dec 8 16:18:20 2010 @@ -165,7 +165,7 @@ httpclient.setUserTokenHandler(new UserT - 'http.user-token': + <constant>ClientContext.USER_TOKEN</constant>='http.user-token': Object instance representing the actual user identity, usually expected to be an instance of Principle interface Modified: httpcomponents/httpclient/trunk/src/docbkx/authentication.xml URL: http://svn.apache.org/viewvc/httpcomponents/httpclient/trunk/src/docbkx/authentication.xml?rev=1043489&r1=1043488&r2=1043489&view=diff ============================================================================== --- httpcomponents/httpclient/trunk/src/docbkx/authentication.xml (original) +++ httpcomponents/httpclient/trunk/src/docbkx/authentication.xml Wed Dec 8 16:18:20 2010 @@ -133,7 +133,7 @@ pwd - 'http.protocol.handle-authentication': + <constant>ClientPNames.HANDLE_AUTHENTICATION</constant>='http.protocol.handle-authentication': defines whether authentication should be handled automatically. This parameter expects a value of type java.lang.Boolean. If this parameter is not set, HttpClient will handle authentication @@ -142,7 +142,7 @@ pwd - 'http.auth.credential-charset': + <constant>AuthPNames.CREDENTIAL_CHARSET</constant>='http.auth.credential-charset': defines the charset to be used when encoding user credentials. This parameter expects a value of type java.lang.String. If this parameter is not set, US-ASCII will be used. @@ -150,7 +150,7 @@ pwd - 'http.auth.target-scheme-pref': + <constant>AuthPNames.TARGET_AUTH_PREF</constant>='http.auth.target-scheme-pref': Defines the order of preference for supported AuthSchemes when authenticating with the target host. This parameter expects a value of type @@ -161,7 +161,7 @@ pwd - 'http.auth.proxy-scheme-pref': + <constant>AuthPNames.PROXY_AUTH_PREF</constant>='http.auth.proxy-scheme-pref': Defines the order of preference for supported AuthSchemes when authenticating with the proxy host. This parameter expects a value of type @@ -190,25 +190,25 @@ httpclient.getParams().setParameter(Auth - Basic: + AuthPolicy.BASIC: Basic authentication - Digest: + AuthPolicy.DIGEST: Digest authentication - NTLM: + AuthPolicy.NTLM: NTLMv1, NTLMv2, and NTLM2 Session authentication - SPNEGO: + AuthPolicy.SPNEGO: SPNEGO/Kerberos authentication @@ -277,7 +277,7 @@ null - 'http.authscheme-registry': + <constant>ClientContext.AUTHSCHEME_REGISTRY</constant>='http.authscheme-registry': AuthSchemeRegistry instance representing the actual authentication scheme registry. The value of this attribute set in the local context takes precedence over the default one. @@ -285,7 +285,7 @@ null - 'http.auth.credentials-provider': + <constant>ClientContext.CREDS_PROVIDER</constant>='http.auth.credentials-provider': CookieSpec instance representing the actual credentials provider. The value of this attribute set in the local context takes precedence over the default one. @@ -293,7 +293,7 @@ null - 'http.auth.target-scope': + <constant>ClientContext.TARGET_AUTH_STATE</constant>='http.auth.target-scope': AuthState instance representing the actual target authentication state. The value of this attribute set in the local context takes precedence over the default one. @@ -301,7 +301,7 @@ null - 'http.auth.proxy-scope': + <constant>ClientContext.PROXY_AUTH_STATE</constant>='http.auth.proxy-scope': AuthState instance representing the actual proxy authentication state. The value of this attribute set in the local context takes precedence over the default one. @@ -309,7 +309,7 @@ null - 'http.auth.auth-cache': + <constant>ClientContext.AUTH_CACHE</constant>='http.auth.auth-cache': AuthCache instance representing the actual authentication data cache. The value of this attribute set in the local context takes precedence over the default one. @@ -409,6 +409,7 @@ for (int i = 0; i < 3; i++) { HTTP request against NTLM protected resources. For detailed discussion on stateful HTTP connections please refer to this section. + As NTLM connections are stateful it is generally recommended to trigger NTLM authentication using a relatively cheap method, such as GET or HEAD, and re-use the same Modified: httpcomponents/httpclient/trunk/src/docbkx/connmgmt.xml URL: http://svn.apache.org/viewvc/httpcomponents/httpclient/trunk/src/docbkx/connmgmt.xml?rev=1043489&r1=1043488&r2=1043489&view=diff ============================================================================== --- httpcomponents/httpclient/trunk/src/docbkx/connmgmt.xml (original) +++ httpcomponents/httpclient/trunk/src/docbkx/connmgmt.xml Wed Dec 8 16:18:20 2010 @@ -32,7 +32,7 @@ - 'http.socket.timeout': + <constant>CoreConnectionPNames.SO_TIMEOUT</constant>='http.socket.timeout': defines the socket timeout (SO_TIMEOUT) in milliseconds, which is the timeout for waiting for data or, put differently, a maximum period inactivity between two consecutive data packets). A timeout @@ -43,7 +43,7 @@ - 'http.tcp.nodelay': + <constant>CoreConnectionPNames.TCP_NODELAY</constant>='http.tcp.nodelay': determines whether Nagle's algorithm is to be used. Nagle's algorithm tries to conserve bandwidth by minimizing the number of segments that are sent. When applications wish to decrease network latency and increase @@ -56,7 +56,7 @@ - 'http.socket.buffer-size': + <constant>CoreConnectionPNames.SOCKET_BUFFER_SIZE</constant>='http.socket.buffer-size': determines the size of the internal socket buffer used to buffer data while receiving / transmitting HTTP messages. This parameter expects a value of type java.lang.Integer. If this parameter is not @@ -65,7 +65,7 @@ - 'http.socket.linger': + <constant>CoreConnectionPNames.SO_LINGER</constant>='http.socket.linger': sets SO_LINGER with the specified linger time in seconds. The maximum timeout value is platform specific. Value 0 implies that the option is disabled. Value -1 implies that the JRE default is used. @@ -75,7 +75,7 @@ - 'http.connection.timeout': + <constant>CoreConnectionPNames.CONNECTION_TIMEOUT</constant>='http.connection.timeout': determines the timeout in milliseconds until a connection is established. A timeout value of zero is interpreted as an infinite timeout. This parameter expects a value of type java.lang.Integer. @@ -85,7 +85,7 @@ - 'http.connection.stalecheck': + <constant>CoreConnectionPNames.STALE_CONNECTION_CHECK</constant>='http.connection.stalecheck': determines whether stale connection check is to be used. Disabling stale connection check may result in a noticeable performance improvement (the check can cause up to 30 millisecond overhead per request) at the risk of @@ -98,7 +98,7 @@ - 'http.connection.max-line-length': + <constant>CoreConnectionPNames.MAX_LINE_LENGTH</constant>='http.connection.max-line-length': determines the maximum line length limit. If set to a positive value, any HTTP line exceeding this limit will cause an java.io.IOException. A negative or zero @@ -109,7 +109,7 @@ - 'http.connection.max-header-count': + <constant>CoreConnectionPNames.MAX_HEADER_COUNT</constant>='http.connection.max-header-count': determines the maximum HTTP header count allowed. If set to a positive value, the number of HTTP headers received from the data stream exceeding this limit will cause an java.io.IOException. @@ -120,7 +120,7 @@ - 'http.connection.max-status-line-garbage': + <constant>ConnConnectionPNames.MAX_STATUS_LINE_GARBAGE</constant>='http.connection.max-status-line-garbage': defines the maximum number of ignorable lines before we expect a HTTP response's status line. With HTTP/1.1 persistent connections, the problem arises that broken scripts could return a wrong @@ -203,7 +203,7 @@ - 'http.route.default-proxy': + <constant>ConnRoutePNames.DEFAULT_PROXY</constant>='http.route.default-proxy': defines a proxy host to be used by default route planners that do not make use of JRE settings. This parameter expects a value of type HttpHost. If this parameter is not set, direct @@ -212,7 +212,7 @@ - 'http.route.local-address': + <constant>.ConnRoutePNames.LOCAL_ADDRESS</constant>='http.route.local-address': defines a local address to be used by all default route planner. On machines with multiple network interfaces, this parameter can be used to select the network interface from which the connection originates. This @@ -223,7 +223,7 @@ - 'http.route.forced-route': + <constant>ConnRoutePNames.FORCED_ROUTE</constant>='http.route.forced-route': defines an forced route to be used by all default route planner. Instead of computing a route, the given forced route will be returned, even if it points to a completely different target host. This parameter expects a value Modified: httpcomponents/httpclient/trunk/src/docbkx/fundamentals.xml URL: http://svn.apache.org/viewvc/httpcomponents/httpclient/trunk/src/docbkx/fundamentals.xml?rev=1043489&r1=1043488&r2=1043489&view=diff ============================================================================== --- httpcomponents/httpclient/trunk/src/docbkx/fundamentals.xml (original) +++ httpcomponents/httpclient/trunk/src/docbkx/fundamentals.xml Wed Dec 8 16:18:20 2010 @@ -520,42 +520,42 @@ byte[] response = httpclient.execute(htt - 'http.connection': + <constant>ExecutionContext.HTTP_CONNECTION</constant>='http.connection': HttpConnection instance representing the actual connection to the target server. - 'http.target_host': + <constant>ExecutionContext.HTTP_TARGET_HOST</constant>='http.target_host': HttpHost instance representing the connection target. - 'http.proxy_host': + <constant>ExecutionContext.HTTP_PROXY_HOST</constant>='http.proxy_host': HttpHost instance representing the connection proxy, if used - 'http.request': + <constant>ExecutionContext.HTTP_REQUEST</constant>='http.request': HttpRequest instance representing the actual HTTP request. - 'http.response': + <constant>ExecutionContext.HTTP_RESPONSE</constant>='http.response': HttpResponse instance representing the actual HTTP response. - 'http.request_sent': + <constant>ExecutionContext.HTTP_REQ_SENT</constant>='http.request_sent': java.lang.Boolean object representing the flag indicating whether the actual request has been fully transmitted to the connection target. @@ -891,7 +891,7 @@ null - 'http.protocol.version': + <constant>CoreProtocolPNames.PROTOCOL_VERSION</constant>='http.protocol.version': defines HTTP protocol version used if not set explicitly on the request object. This parameter expects a value of type ProtocolVersion. If this parameter is not @@ -900,7 +900,7 @@ null - 'http.protocol.element-charset': + <constant>CoreProtocolPNames.HTTP_ELEMENT_CHARSET</constant>='http.protocol.element-charset': defines the charset to be used for encoding HTTP protocol elements. This parameter expects a value of type java.lang.String. If this parameter is not set US-ASCII will be @@ -909,7 +909,7 @@ null - 'http.protocol.content-charset': + <constant>CoreProtocolPNames.HTTP_CONTENT_CHARSET</constant>='http.protocol.content-charset': defines the charset to be used per default for content body coding. This parameter expects a value of type java.lang.String. If this parameter is not set ISO-8859-1 will be @@ -918,7 +918,7 @@ null - 'http.useragent': + <constant>CoreProtocolPNames.USER_AGENT</constant>='http.useragent': defines the content of the User-Agent header. This parameter expects a value of type java.lang.String. If this parameter is not set, HttpClient will automatically generate a value @@ -927,7 +927,7 @@ null - 'http.protocol.strict-transfer-encoding': + <constant>CoreProtocolPNames.STRICT_TRANSFER_ENCODING</constant>='http.protocol.strict-transfer-encoding': defines whether responses with an invalid Transfer-Encoding header should be rejected. This parameter expects a value of type java.lang.Boolean. @@ -937,7 +937,7 @@ null - 'http.protocol.expect-continue': + <constant>CoreProtocolPNames.USE_EXPECT_CONTINUE</constant>='http.protocol.expect-continue': activates the Expect: 100-Continue handshake for the entity enclosing methods. The purpose of the Expect: 100-Continue handshake is to allow the client that is sending @@ -956,7 +956,7 @@ null - 'http.protocol.wait-for-continue': + <constant>CoreProtocolPNames.WAIT_FOR_CONTINUE</constant>='http.protocol.wait-for-continue': defines the maximum period of time in milliseconds the client should spend waiting for a 100-continue response. This parameter expects a value of type java.lang.Integer. If this Modified: httpcomponents/httpclient/trunk/src/docbkx/httpagent.xml URL: http://svn.apache.org/viewvc/httpcomponents/httpclient/trunk/src/docbkx/httpagent.xml?rev=1043489&r1=1043488&r2=1043489&view=diff ============================================================================== --- httpcomponents/httpclient/trunk/src/docbkx/httpagent.xml (original) +++ httpcomponents/httpclient/trunk/src/docbkx/httpagent.xml Wed Dec 8 16:18:20 2010 @@ -95,7 +95,7 @@ httpclient.getConnectionManager().shutdo - 'http.protocol.handle-redirects': + <constant>ClientPNames.HANDLE_REDIRECTS</constant>='http.protocol.handle-redirects': defines whether redirects should be handled automatically. This parameter expects a value of type java.lang.Boolean. If this parameter is not set HttpClient will handle redirects automatically. @@ -103,7 +103,7 @@ httpclient.getConnectionManager().shutdo - 'http.protocol.reject-relative-redirect': + <constant>ClientPNames.REJECT_RELATIVE_REDIRECT</constant>='http.protocol.reject-relative-redirect': defines whether relative redirects should be rejected. HTTP specification requires the location value be an absolute URI. This parameter expects a value of type java.lang.Boolean. If this parameter is @@ -112,7 +112,7 @@ httpclient.getConnectionManager().shutdo - 'http.protocol.max-redirects': + <constant>ClientPNames.MAX_REDIRECTS</constant>='http.protocol.max-redirects': defines the maximum number of redirects to be followed. The limit on number of redirects is intended to prevent infinite loops caused by broken server side scripts. This parameter expects a value of type @@ -122,7 +122,7 @@ httpclient.getConnectionManager().shutdo - 'http.protocol.allow-circular-redirects': + <constant>ClientPNames.ALLOW_CIRCULAR_REDIRECTS</constant>='http.protocol.allow-circular-redirects': defines whether circular redirects (redirects to the same location) should be allowed. The HTTP spec is not sufficiently clear whether circular redirects are permitted, therefore optionally they can be enabled. This @@ -132,7 +132,7 @@ httpclient.getConnectionManager().shutdo - 'http.connection-manager.factory-class-name': + <constant>ClientPNames.CONNECTION_MANAGER_FACTORY_CLASS_NAME</constant>='http.connection-manager.factory-class-name': defines the class name of the default ClientConnectionManager implementation. This parameter expects a value of type @@ -143,7 +143,7 @@ httpclient.getConnectionManager().shutdo - 'http.virtual-host': + <constant>ClientPNames.VIRTUAL_HOST</constant>='http.virtual-host': defines the virtual host name to be used in the Host header instead of the physical host name. This parameter expects a value of type HttpHost. If this parameter is not set name or @@ -152,7 +152,7 @@ httpclient.getConnectionManager().shutdo - 'http.default-headers': + <constant>ClientPNames.DEFAULT_HEADERS</constant>='http.default-headers': defines the request headers to be sent per default with each request. This parameter expects a value of type java.util.Collection containing @@ -161,7 +161,7 @@ httpclient.getConnectionManager().shutdo - 'http.default-host': + <constant>ClientPNames.DEFAULT_HOST</constant>='http.default-host': defines the default host. The default value will be used if the target host is not explicitly specified in the request URI (relative URIs). This parameter expects a value of type HttpHost. Modified: httpcomponents/httpclient/trunk/src/docbkx/statemgmt.xml URL: http://svn.apache.org/viewvc/httpcomponents/httpclient/trunk/src/docbkx/statemgmt.xml?rev=1043489&r1=1043488&r2=1043489&view=diff ============================================================================== --- httpcomponents/httpclient/trunk/src/docbkx/statemgmt.xml (original) +++ httpcomponents/httpclient/trunk/src/docbkx/statemgmt.xml Wed Dec 8 16:18:20 2010 @@ -172,7 +172,7 @@ stdCookie.setAttribute(ClientCookie.PORT - 'http.protocol.cookie-datepatterns': + <constant>CookieSpecPNames.DATE_PATTERNS</constant>='http.protocol.cookie-datepatterns': defines valid date patterns to be used for parsing non-standard expires attribute. Only required for compatibility with non-compliant servers that still use expires defined @@ -187,7 +187,7 @@ stdCookie.setAttribute(ClientCookie.PORT - 'http.protocol.single-cookie-header': + <constant>CookieSpecPNames.SINGLE_COOKIE_HEADER</constant>='http.protocol.single-cookie-header': defines whether cookies should be forced into a single Cookie request header. Otherwise, each cookie is formatted as a separate Cookie header. This parameter @@ -201,7 +201,7 @@ stdCookie.setAttribute(ClientCookie.PORT - 'http.protocol.cookie-policy': + <constant>ClientPNames.COOKIE_POLICY</constant>='http.protocol.cookie-policy': defines the name of a cookie specification to be used for HTTP state management. This parameter expects a value of type java.lang.String. If this parameter is not set, @@ -323,7 +323,7 @@ httpclient.setCookieStore(cookieStore); - 'http.cookiespec-registry': + <constant>ClientContext.COOKIESPEC_REGISTRY</constant>='http.cookiespec-registry': CookieSpecRegistry instance representing the actual cookie specification registry. The value of this attribute set in the local context takes precedence over the default one. @@ -331,21 +331,21 @@ httpclient.setCookieStore(cookieStore); - 'http.cookie-spec': + <constant>ClientContext.COOKIE_SPEC</constant>='http.cookie-spec': CookieSpec instance representing the actual cookie specification. - 'http.cookie-origin': + <constant>ClientContext.COOKIE_ORIGIN</constant>='http.cookie-origin': CookieOrigin instance representing the actual details of the origin server. - 'http.cookie-store': + <constant>ClientContext.COOKIE_STORE</constant>='http.cookie-store': CookieStore instance representing the actual cookie store. The value of this attribute set in the local context takes precedence over the default one.