IdcHttpClientConfig (Oracle Fusion Middleware Java API Reference for Oracle WebCenter Content Remote Intradoc Client (RIDC))

java.lang.Object
- oracle.stellent.ridc.IdcClientConfig
- - oracle.stellent.ridc.protocol.http.IdcHttpClientConfig

public class IdcHttpClientConfig
extends IdcClientConfig

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`CHUNK_SIZE`
`static String`	`CONTENT_TYPE`
`static String`	`CONTENTTYPE_UTF8`
`static String`	`DEFAULT_SECURITY_REALM`
`static String`	`IS_ADMIN_SERVER`
`static String`	`NON_PROXY_HOSTS`
`static String`	`PING_SERVICE`
`static String`	`PROP_FORCED_CHUNKING_FOR_LONG_REQUESTS`
`static String`	`PROP_HTTP_OUTPUTSTREAM_BUFFER_SIZE`
`static String`	`PROP_USE_SYSTEM_PROXY`
`static String`	`PROXY_HOST`
`static String`	`PROXY_PASSWORD`
`static String`	`PROXY_PORT`
`static String`	`PROXY_REALM`
`static String`	`PROXY_USERNAME`
`static String`	`SECURITY_REALM`

Fields inherited from class oracle.stellent.ridc.IdcClientConfig
PROP_CONNECTION_POOL, PROP_CONNECTION_SIZE, PROP_CONNECTION_URL, PROP_CONNECTION_WAIT_TIME, PROP_SOCKET_TIMEOUT, PROP_SOCKET_TIMEOUT_DEFAULT

Constructor Summary

Constructors
Constructor and Description

IdcHttpClientConfig()

Constructors
Constructor and Description
`IdcHttpClientConfig()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`getChunkSize()`
`String`	`getContentType()`
`String`	`getHostName()`
`RIDCHttpConstants.HttpLibrary`	`getHttpLibrary()`
`String`	`getNonProxyHosts()`
`int`	`getOutputStreamBufferSize()`
`String`	`getPingService()`
`int`	`getPort()`
`String`	`getProxyHost()`
`String`	`getProxyPassword()`
`int`	`getProxyPort()`
`String`	`getProxyRealm()`
`String`	`getProxyUsername()`
`String`	`getScheme()`
`String`	`getSecurityRealm()` Return the security realm to utilize for use with basic authentication using Oracle HTTPClient
`boolean`	`isAdminServer()`
`boolean`	`isForcedChunkingForLongRequests()`
`boolean`	`isUseSystemProxy()`
`void`	`setChunkSize(int size)`
`void`	`setContentType(String contentType)`
`void`	`setForcedChunkingForLongRequests(boolean forcedChunking)`
`void`	`setHttpLibrary(RIDCHttpConstants.HttpLibrary httpLibrary)`
`void`	`setIsAdminServer(boolean isAdminServer)`
`void`	`setNonProxyHosts(String nonProxyHosts)`
`void`	`setOutputStreamBufferSize(int size)`
`void`	`setPingService(String pingService)`
`void`	`setProxyHost(String proxyHost)`
`void`	`setProxyPassword(String proxyPassword)`
`void`	`setProxyPort(int port)`
`void`	`setProxyRealm(String proxyRealm)`
`void`	`setProxyUsername(String proxyUsername)`
`void`	`setSecurityRealm(String securityRealm)` Specify security realm for use with basic authentication using Oracle HTTPClient
`void`	`setUseSystemProxy(boolean useSystemProxy)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - CHUNK_SIZE
```
public static final String CHUNK_SIZE
```
    See Also:
    
    Constant Field Values
  - PROP_FORCED_CHUNKING_FOR_LONG_REQUESTS
```
public static final String PROP_FORCED_CHUNKING_FOR_LONG_REQUESTS
```
    See Also:
    
    Constant Field Values
  - PROP_HTTP_OUTPUTSTREAM_BUFFER_SIZE
```
public static final String PROP_HTTP_OUTPUTSTREAM_BUFFER_SIZE
```
    See Also:
    
    Constant Field Values
  - PROP_USE_SYSTEM_PROXY
```
public static final String PROP_USE_SYSTEM_PROXY
```
    See Also:
    
    Constant Field Values
  - PROXY_HOST
```
public static final String PROXY_HOST
```
    See Also:
    
    Constant Field Values
  - PROXY_PORT
```
public static final String PROXY_PORT
```
    See Also:
    
    Constant Field Values
  - NON_PROXY_HOSTS
```
public static final String NON_PROXY_HOSTS
```
    See Also:
    
    Constant Field Values
  - PROXY_USERNAME
```
public static final String PROXY_USERNAME
```
    See Also:
    
    Constant Field Values
  - PROXY_PASSWORD
```
public static final String PROXY_PASSWORD
```
    See Also:
    
    Constant Field Values
  - PROXY_REALM
```
public static final String PROXY_REALM
```
    See Also:
    
    Constant Field Values
  - CONTENT_TYPE
```
public static final String CONTENT_TYPE
```
    See Also:
    
    Constant Field Values
  - IS_ADMIN_SERVER
```
public static final String IS_ADMIN_SERVER
```
    See Also:
    
    Constant Field Values
  - PING_SERVICE
```
public static final String PING_SERVICE
```
    See Also:
    
    Constant Field Values
  - SECURITY_REALM
```
public static final String SECURITY_REALM
```
    See Also:
    
    Constant Field Values
  - CONTENTTYPE_UTF8
```
public static final String CONTENTTYPE_UTF8
```
    See Also:
    
    Constant Field Values
  - DEFAULT_SECURITY_REALM
```
public static final String DEFAULT_SECURITY_REALM
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - IdcHttpClientConfig
```
public IdcHttpClientConfig()
```
- Method Detail
  - getHttpLibrary
```
public RIDCHttpConstants.HttpLibrary getHttpLibrary()
```
  - setHttpLibrary
```
public void setHttpLibrary(RIDCHttpConstants.HttpLibrary httpLibrary)
```
  - getChunkSize
```
public int getChunkSize()
```
    Returns:
    
    suggested chunk size to utilize for HTTP chunked transfers
  - setChunkSize
```
public void setChunkSize(int size)
```
    Parameters:
    
    size - number of bytes to utilize as buffer for chunked transfer for supported HTTP implementations. Value should be a multiple of 16k, e.g. 16384, 32768, 65536 etc
  - isForcedChunkingForLongRequests
```
public boolean isForcedChunkingForLongRequests()
```
    Returns:
    
    true to force chunked transfer encoding when content length of the request exceeds Integer.MAX_VALUE (2 GB). false is the default meaning 'long' type fixed length streaming will be leveraged if available
  - setForcedChunkingForLongRequests
```
public void setForcedChunkingForLongRequests(boolean forcedChunking)
```
  - getOutputStreamBufferSize
```
public int getOutputStreamBufferSize()
```
    Returns:
    
    suggested buffer size to utilize for HTTP output stream
  - setOutputStreamBufferSize
```
public void setOutputStreamBufferSize(int size)
```
    Parameters:
    
    size - number of bytes to utilize as buffer for HTTP output stream. Value should be a multiple of 16k, e.g. 32768, 65536 etc
  - isUseSystemProxy
```
public boolean isUseSystemProxy()
```
    Returns:
    
    true to use the system proxy settings unless specifically overridden; false to just look in local config
  - setUseSystemProxy
```
public void setUseSystemProxy(boolean useSystemProxy)
```
  - getProxyHost
```
public String getProxyHost()
```
  - setProxyHost
```
public void setProxyHost(String proxyHost)
```
  - getProxyPort
```
public int getProxyPort()
```
  - setProxyPort
```
public void setProxyPort(int port)
```
  - getNonProxyHosts
```
public String getNonProxyHosts()
```
  - setNonProxyHosts
```
public void setNonProxyHosts(String nonProxyHosts)
```
  - getProxyUsername
```
public String getProxyUsername()
```
  - setProxyUsername
```
public void setProxyUsername(String proxyUsername)
```
  - getProxyPassword
```
public String getProxyPassword()
```
  - setProxyPassword
```
public void setProxyPassword(String proxyPassword)
```
  - setProxyRealm
```
public void setProxyRealm(String proxyRealm)
```
  - getProxyRealm
```
public String getProxyRealm()
```
  - getContentType
```
public String getContentType()
```
  - setContentType
```
public void setContentType(String contentType)
```
  - getHostName
```
public String getHostName()
```
  - getPort
```
public int getPort()
```
  - getScheme
```
public String getScheme()
```
  - setIsAdminServer
```
public void setIsAdminServer(boolean isAdminServer)
```
    Parameters:
    
    isAdminServer - set to true if your url points to an admin server
  - isAdminServer
```
public boolean isAdminServer()
```
    Returns:
    
    true if set to contact admin server
  - setPingService
```
public void setPingService(String pingService)
```
    Parameters:
    
    pingService - set to service call used to detect Form login. By default PING_SERVER or GET_ROOT_IDC_ADMIN_PAGE (admin servers)
  - getPingService
```
public String getPingService()
```
    Returns:
    
    service string used to detect Form login, ie "?IdcService=PING_SERVER&IsJava=1"
  - setSecurityRealm
```
public void setSecurityRealm(String securityRealm)
```
    Specify security realm for use with basic authentication using Oracle HTTPClient
    
    Parameters:
    
    securityRealm - security realm to which the credentials apply
  - getSecurityRealm
```
public String getSecurityRealm()
```
    Return the security realm to utilize for use with basic authentication using Oracle HTTPClient
    
    Returns:
    
    the security realm to leverage

Class IdcHttpClientConfig

Field Summary

Fields inherited from class oracle.stellent.ridc.IdcClientConfig

Constructor Summary

Method Summary

Methods inherited from class oracle.stellent.ridc.IdcClientConfig

Methods inherited from class java.lang.Object

Field Detail

CHUNK_SIZE

PROP_FORCED_CHUNKING_FOR_LONG_REQUESTS

PROP_HTTP_OUTPUTSTREAM_BUFFER_SIZE

PROP_USE_SYSTEM_PROXY

PROXY_HOST

PROXY_PORT

NON_PROXY_HOSTS

PROXY_USERNAME

PROXY_PASSWORD

PROXY_REALM

CONTENT_TYPE

IS_ADMIN_SERVER

PING_SERVICE

SECURITY_REALM

CONTENTTYPE_UTF8

DEFAULT_SECURITY_REALM

Constructor Detail

IdcHttpClientConfig

Method Detail

getHttpLibrary

setHttpLibrary

getChunkSize

setChunkSize

isForcedChunkingForLongRequests

setForcedChunkingForLongRequests

getOutputStreamBufferSize

setOutputStreamBufferSize

isUseSystemProxy

setUseSystemProxy

getProxyHost

setProxyHost

getProxyPort

setProxyPort

getNonProxyHosts

setNonProxyHosts

getProxyUsername

setProxyUsername

getProxyPassword

setProxyPassword

setProxyRealm

getProxyRealm

getContentType

setContentType

getHostName

getPort

getScheme

setIsAdminServer

isAdminServer

setPingService

getPingService

setSecurityRealm

getSecurityRealm