oracle.webclipping.bean
Class WebClippingConnection

java.lang.Object
  |
  +--oracle.webclipping.bean.WebClippingConnection

All Implemented Interfaces:

WebClippingExceptionConstants

public class WebClippingConnection

extends java.lang.Object

implements WebClippingExceptionConstants

This class is the starting point of all communication channels from your Java client to the Web Clipping Server. It allows opening of an HTTP connection to the server and then allows the execution given a Web Clipping request object based on that connection, returning a Web Clipping Response.

Field Summary

Fields inherited from interface oracle.webclipping.bean.WebClippingExceptionConstants

APPLICATION_ERROR, CANNOT_OPENSTREAM, INTERNAL_ERROR, INVALID_PROTOCOL, INVALID_URL

Constructor Summary

WebClippingConnection(java.lang.String url)
Constructs a connection with the Web Clipping Server by passing in a connection url.

Method Summary

WebClippingResponse

execute(WebClippingRequest request) Heart of the operation; this calls out using HTTP to the Web Clipping Server to execute the Web Clipping and return its responses.

Methods inherited from class java.lang.Object

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

Constructor Detail

WebClippingConnection

public WebClippingConnection(java.lang.String url)
                      throws WebClippingException

Constructs a connection with the Web Clipping Server by passing in a connection url. So far, we only deal with HTTP or HTTP/S as they are supported by the HTTP handling engine.

Parameters:

url - The String version of the URL

Throws:

HTTPClient.ParseException - When the passed in URL is not a valid one

HTTPClient.ProtocolNotSuppException - When the passed in scheme is not a protocol that is supported by the HTTP handling engine. The current supported ones are http, https, and shttp

WebClippingException

Method Detail

execute

public WebClippingResponse execute(WebClippingRequest request)
                            throws WebClippingException

Heart of the operation; this calls out using HTTP to the Web Clipping Server to execute the Web Clipping and return its responses.

Parameters:

request - The request that holds all the needed parameters

Returns:

WebClippingResponse The response that can be iterated.

WebClippingException