oracle.webclipping.bean
Class WebClippingRequest

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

All Implemented Interfaces:

WebClippingConstants

public class WebClippingRequest

extends java.lang.Object

implements WebClippingConstants

This class embodies the formal request that is made to a Web Clipping Server URL to execute a particular Web Clipping. In many ways it is similar to a regular HTTP request but the APIs provided here are more restrictive.

Field Summary

Fields inherited from interface oracle.webclipping.bean.WebClippingConstants

DEF_PREF, HDR_CLIP_ID, HDR_MOBILE_LOC_ADDR_LASTLINE, HDR_MOBILE_LOC_ADDR_LINE1, HDR_MOBILE_LOC_ADDR_LINE2, HDR_MOBILE_LOC_BLOCK, HDR_MOBILE_LOC_CITY, HDR_MOBILE_LOC_COMPANY_NAME, HDR_MOBILE_LOC_COUNTRY, HDR_MOBILE_LOC_COUNTY, HDR_MOBILE_LOC_POSTALCODE, HDR_MOBILE_LOC_POSTALCODE_EXT, HDR_MOBILE_LOC_STATE, HDR_MOBILE_LOC_TYPE, HDR_MOBILE_LOC_X, HDR_MOBILE_LOC_Y, HDR_MOBILE_USER_AUTHKIND, HDR_MOBILE_USER_DISPNAME, HDR_MOBILE_USER_KIND, HDR_MOBILE_USER_LOCALE, HDR_MOBILE_USER_NAME, LOC_PREF, USR_PREF

Constructor Summary

WebClippingRequest(javax.servlet.http.HttpServletRequest request)
Creates a Web Clipping Request from an HTTP Servlet Request, inheriting relevant header information.

WebClippingRequest(javax.servlet.http.HttpServletRequest request, int iClipId)
Creates a Web Clipping Request from an HTTP Servlet Request, inheriting relevant header information, as well as a Clip Id as it was known at the time of construction.

WebClippingRequest(int iClipId)
Constructor of the Web Clipping Request that takes in a Clip Id.

Method Summary

void	addHeader(java.lang.String headerName, java.lang.String headerValue) Allows manipulation of Web Clipping Headers.
void	addParam(java.lang.String paramName, java.lang.String paramValue) Allows manipulation of Web Clipping Parameters.
void	setClipId(int iClipId) Sets the Id of the Clip you wish to execute.

Methods inherited from class java.lang.Object

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

Constructor Detail

WebClippingRequest

public WebClippingRequest(javax.servlet.http.HttpServletRequest request)

Creates a Web Clipping Request from an HTTP Servlet Request, inheriting relevant header information. This constructor is useful for development of J2EE Web Applications as they facilitate the process of building a Web Clipping Request. The HTTP Header information from within the HTTP Servlet Requet is filtered before sending over to the Web Clipping Server.

Parameters:

request - The HTTP request object containing URL request parameters as well as headers that may give valuable contextual information to the Web Clipping Server.

WebClippingRequest

public WebClippingRequest(int iClipId)

Constructor of the Web Clipping Request that takes in a Clip Id. This is usually the approach taken from a non-web app usage of Web Clippings, where an HTTP Servlet Request is not accessible.

Parameters:

iClipId - The Id of the Clip you wish to execute. This can be changed dynamically for the duration of a request so that the same object can be re-used without having the caller have to create multiple instances of the request object.

WebClippingRequest

public WebClippingRequest(javax.servlet.http.HttpServletRequest request,
                          int iClipId)

Creates a Web Clipping Request from an HTTP Servlet Request, inheriting relevant header information, as well as a Clip Id as it was known at the time of construction. This constructor is useful for development of J2EE Web Applications as they facilitate the process of building a Web Clipping Request. The HTTP Header information from within the HTTP Servlet Requet is filtered before sending over to the Web Clipping Server.

Parameters:

iClipId - The Id of the Clip you wish to execute. This can be changed dynamically for the duration of a request so that the same object can be re-used without having the caller have to create multiple instances of the request object.

request - The HTTP request object containing URL request parameters as well as headers that may give valuable contextual information to the Web Clipping Server.

Method Detail

setClipId

public void setClipId(int iClipId)

Sets the Id of the Clip you wish to execute. This method is exposed to allow the caller to explicitly set the clip id as it may not be available at the time of construction.

Parameters:

iClipId - The Id of the Clip you wish to execute. This can be changed dynamically for the duration of a request so that the same object can be re-used without having the caller have to create multiple instances of the request object.

addParam

public void addParam(java.lang.String paramName,
                     java.lang.String paramValue)

Allows manipulation of Web Clipping Parameters. This allows the user to add input parameter values for the Web Clipping before executing it.

Parameters:

paramName - The name of the Parameter. This is the "User Friendly Name" that was used when the Web Clipping was being parameterized. Note: if the User Friendly Name has been altered, corresponding changes need to happen on the Client code.

paramValue - The value of the parameter. Usually, this is passed down to the web app that calls out to the Web Clipping Server.

addHeader

public void addHeader(java.lang.String headerName,
                      java.lang.String headerValue)

Allows manipulation of Web Clipping Headers. This allows the user to add a header of the Web Clipping before executing it. The list of possible headers that a user can set can be found in the the WebClippingConstants class.

Parameters:

headerName - The name of the Header. This is the "User Friendly Name" that was used when the Web Clipping was being headerized. Note: if the User Friendly Name has been altered, corresponding changes need to happen on the Client code.

headerValue - The value of the header. Usually, this is passed down to the web app that calls out to the Web Clipping Server.

See Also:

WebClippingConstants