# com.bea.control
HttpControl Interface

public interface HttpControl
extends `Control`

HTTP Control base interface

All Superinterfaces
  `Control`, `Serializable`

## Nested Class Summary

Nested classes from interface com.bea.control`.`Control``
`Control.Callback`

## Method Summary

`public com.bea.wli.control.httpCookies.CookiesDocument` | `getCookies`() Get the cookies
`public com.bea.wli.control.httpHeaders.HeadersDocument` | `getResponseHeaders`() Get the response headers
`public void` | `setClientSideSSL`(`String` keyStoreType, `String` keyStoreLocation, `String` keyStorePassword, `String` keyPassword) Sets the Client side SSL properties for the control.
`public void` | `setConnectionRetrycount`(int retryCount) Number of times the application will retry for the request.If not specified it will be tried once
`public void` | `setConnectionTimeOut`(int timeoutInMilliSeconds) Sets the timeout until a connection is etablished.
`public void` | `setCookies`(com.bea.wli.control.httpCookies.CookiesDocument cookies) Set the Cookies
`public void` | `setProperties`(com.bea.wli.control.dynamicProperties.HttpControlPropertiesDocument propsDoc) Sets the dynamic properties for the control.
`public void` | `setProxyConfig`(`String` host, int port, `String` userName, `String` password) Sets the Proxy server properties for the control.
`public void` | `setServerSideSSL`(`String` trustStoreLocation, boolean hostVerificationFlag) Sets the Server side SSL properties for the control.

## Method Detail

### getCookies() Method

    public com.bea.wli.control.httpCookies.CookiesDocument getCookies()
         throws Exception

Get the cookies

#### Exceptions

``Exception``

### getResponseHeaders() Method

    public com.bea.wli.control.httpHeaders.HeadersDocument getResponseHeaders()
         throws Exception

Get the response headers

#### Exceptions

``Exception``

### setClientSideSSL(String, String, String, String) Method

    public void setClientSideSSL(String keyStoreType,
                                 String keyStoreLocation,
                                 String keyStorePassword,
                                 String keyPassword)
         throws Exception

Sets the Client side SSL properties for the control.

#### Parameters

keyStoreType
  Key Store Type.There are two keystore types(JKS, PKCS12).If user don't give anything, the dafault key store type would be selected

keyStoreLocation
  Key Store location needs to be set for two way ssl

keyStorePassword
  Key store password needs to be set for two way ssl

keyPassword
  Private key password needs to be set for two way ssl

#### Exceptions

``Exception``

### setConnectionRetrycount(int) Method

    public void setConnectionRetrycount(int retryCount)
         throws Exception

Number of times the application will retry for the request.If not specified it will be tried once

#### Parameters

retryCount
  Numbers of retry request

#### Exceptions

``Exception``

### setConnectionTimeOut(int) Method

    public void setConnectionTimeOut(int timeoutInMilliSeconds)
         throws Exception

Sets the timeout until a connection is etablished. A timeout value of zero means the timeout is not used. The default value is zero.

#### Parameters

timeoutInMilliSeconds
  Connection timeout in milli seconds

#### Exceptions

``Exception``

### setCookies(com.bea.wli.control.httpCookies.CookiesDocument) Method

    public void setCookies(com.bea.wli.control.httpCookies.CookiesDocument cookies)
         throws Exception

Set the Cookies

#### Parameters

cookies
  the cookies to be set for the Http request

#### Exceptions

``Exception``

### setProperties(com.bea.wli.control.dynamicProperties.HttpControlPropertiesDocument) Method

    public void setProperties(com.bea.wli.control.dynamicProperties.HttpControlPropertiesDocument propsDoc)
         throws IllegalArgumentException

Sets the dynamic properties for the control.

#### Parameters

propsDoc
  the dynamic properties for the control.

#### Exceptions

``IllegalArgumentException``

### setProxyConfig(String, int, String, String) Method

    public void setProxyConfig(String host,
                               int port,
                               String userName,
                               String password)
         throws IllegalArgumentException

Sets the Proxy server properties for the control.

#### Parameters

host
  proxy host name

port
  proxy host port

userName
  user Name for the connecting to proxy host

password
  password for the user connecting to proxy host

#### Exceptions

``IllegalArgumentException``

### setServerSideSSL(String, boolean) Method

    public void setServerSideSSL(String trustStoreLocation,
                                 boolean hostVerificationFlag)
         throws Exception

Sets the Server side SSL properties for the control.

#### Parameters

trustStoreLocation
  the trust store location needs to be specified for one way ssl

hostVerificationFlag
  Host Verification Ignored flag.If true, then host name varification will be ignored

#### Exceptions

``Exception``