com.endeca.portal.data.security
Interface MDEXSecurityManager

All Known Implementing Classes:

DefaultMDEXSecurityManager

public interface MDEXSecurityManager

Interface representing a security manager for the MDEX Engine. The default security manager implementation is DefaultMDEXSecurityManager

Method Summary

void	applySecurity(javax.portlet.PortletRequest request, MDEXState mdexState, Query query) Applies security filters to a provided Query.

Method Detail

applySecurity

void applySecurity(javax.portlet.PortletRequest request,
                   MDEXState mdexState,
                   Query query)
                   throws MDEXSecurityException

Applies security filters to a provided Query. This takes a PortletRequest and an MDEXState as parameters, as it is likely that any implementation of this method will make use of user session information (retrieved from the request) and data source configuration information stored on the MDEXState object defining the target MDEX for the given Query.

Parameters:

request - the PortletRequest

mdexState - the MDEXState object representing the target MDEX and its current state

query - the Query to which security filters should be applied

Throws:

MDEXSecurityException - on error parsing, processing, or applying security

See Also:

Query