Skip navigation links

oracle.search.sdk.query
Interface RequestInfo

public interface RequestInfo

An interface representing information about a request that can be passed to a ResultFilterPlugin for filtering out documents, folders, or entire sources.

Due to differences between requests originating from the Oracle Secure Enterprise Search default query application and from the Web Services interface, this class may store a reference to either an HttpServletRequest object or a web services session context. To determine which type of object is stored in this RequestInfo object, and therefore where the request originated from, test the return value from RequestInfo.getSessionContext() or RequestInfo.getHttpRequest() for null.

See Also:

oracle.search.sdk.security.ResultFilterPlugin

Method Summary

HttpServletRequest	getHttpRequest() Gets the HTTP servlet request handle.
Map	getSessionContext() Gets the session context Map object.

Method Detail

getSessionContext

Map getSessionContext()

Gets the session context Map object. This will be set if the request originated from the Web Services interface. The session context is set by the setSessionContext web service call. The Map returned by this method is a set of name/value pairs representing the context of the user session.

If the request was received through the Oracle Secure Enterprise Search default query application, this method will return null.

Returns:

the session context, or null if this request originated from the default query application

getHttpRequest

HttpServletRequest getHttpRequest()

Gets the HTTP servlet request handle. This will be set if the request originated from the Oracle Secure Enterprise Search default query application.

If the request was received through Web Services, this method will return null.

Returns:

the HTTP request handle, or null if this request originated from the web services interface

See Also:

HttpServletRequest

Skip navigation links