com.endeca.infront.content

Class MdexContentRequestBroker

java.lang.Object

com.endeca.infront.content.MdexContentRequestBroker

public class MdexContentRequestBroker
extends Object

Internal class used by Endeca cartridge handlers used to retrieve content using the MDEX-based rules engine -- Should not be used directly outside of Endeca content cartridge handlers.

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	EVENT_EXECUTE
protected boolean	mAuditEnabled
protected MdexResource	mMdexResource
protected NavigationState	mNavigationState
protected SiteState	mSiteState
protected UserState	mUserState
protected static String	PROFILE_GROUP_PREFIX Attribute key expected by MDEX to disambiguate ATG profile groups from Endeca user segments.

Constructor Summary

Constructors

Constructor and Description
MdexContentRequestBroker(MdexResource pMdexResource, NavigationState pNavigationState, UserState pUserState, SiteState pSiteState, boolean pAuditEnabled) Builds an MDEX Content Request Broker

Method Summary

Methods

Modifier and Type	Method and Description
List<RuleAuditData>	getAuditContents(List<String> pContentPaths, List<String> pTemplateTypes, List<String> pTemplateIds, int pRuleLimit) This method is for internal Oracle use only and should never be called. If audit is enabled, returns the audit contents.
List<RuleAuditData>	getAuditContents(String pContentCollection, int pRuleLimit) This method is for internal Oracle use only and should never be called. If audit is enabled, returns the audit contents.
List<String>	getContentPaths(List<String> pContentPaths, List<String> pTemplateTypes, List<String> pTemplateIds, int pRuleLimit) This method is for internal Oracle use only and should never be called. Query for rule-triggered content paths given list of content paths, template types and template IDs.
List<String>	getContentPaths(String pContentCollection, int pRuleLimit) This method is for internal Oracle use only and should never be called. Query for rule-triggered content paths from a specified content collection.
String	getRedirectPath() Returns the keyword redirect path if there is one associated with the user search term
boolean	isAuditEnabled() This method is for internal Oracle use only and should never be called. Returns a value indicating whether audit is enabled.

Methods inherited from class java.lang.Object

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

Field Detail

EVENT_EXECUTE

protected static final String EVENT_EXECUTE

See Also:

Constant Field Values

mMdexResource

protected final MdexResource mMdexResource

mNavigationState

protected final NavigationState mNavigationState

mUserState

protected final UserState mUserState

mSiteState

protected final SiteState mSiteState

mAuditEnabled

protected final boolean mAuditEnabled

PROFILE_GROUP_PREFIX

protected static final String PROFILE_GROUP_PREFIX

Attribute key expected by MDEX to disambiguate ATG profile groups from Endeca user segments.

See Also:

Constant Field Values

Constructor Detail

MdexContentRequestBroker

public MdexContentRequestBroker(MdexResource pMdexResource,
                        NavigationState pNavigationState,
                        UserState pUserState,
                        SiteState pSiteState,
                        boolean pAuditEnabled)

Builds an MDEX Content Request Broker

Parameters:

pMdexResource - Identifies the MDEX to query

pNavigationState - The navigation state

pUserState - The user segment and date state to use for content queries

pAuditEnabled - True if audit should be enabled

Method Detail

isAuditEnabled

public boolean isAuditEnabled()

This method is for internal Oracle use only and should never be called.
Returns a value indicating whether audit is enabled.

getContentPaths

public List<String> getContentPaths(String pContentCollection,
                           int pRuleLimit)
                             throws ContentException

This method is for internal Oracle use only and should never be called.
Query for rule-triggered content paths from a specified content collection.

Parameters:

pContentCollection - the ID of the content collection

pRuleLimit - an upper bound on the length of the content list returned by this method. If this value is less than one, there is no limit.

Returns:

a list of content paths, never null, never longer than the upper bound

Throws:

ContentException - if an error in the system prevents access to the content

getRedirectPath

public String getRedirectPath()
                       throws ContentException

Returns the keyword redirect path if there is one associated with the user search term

Returns:

The keyword redirect url associated with the redirect path

Throws:

ContentException - if an error in the system prevents access to the content

getContentPaths

public List<String> getContentPaths(List<String> pContentPaths,
                           List<String> pTemplateTypes,
                           List<String> pTemplateIds,
                           int pRuleLimit)
                             throws ContentException

This method is for internal Oracle use only and should never be called.
Query for rule-triggered content paths given list of content paths, template types and template IDs.

Parameters:

pContentPaths - a list of content paths

pTemplateTypes - a list of the accepted template types

pTemplateIds - a list of the accepted template ids

pRuleLimit - an upper bound on the length of the content list returned by this method.

Returns:

a list of content paths, never null, never longer than the upper bound

Throws:

ContentException - if an error in the system prevents access to the content

getAuditContents

public List<RuleAuditData> getAuditContents(String pContentCollection,
                                   int pRuleLimit)
                                     throws ContentException

This method is for internal Oracle use only and should never be called.
If audit is enabled, returns the audit contents. Audit content is metadata about the content items returned by the MDEX.

Parameters:

pContentCollection - the ID of the desired content collection

Returns:

a list of audit content items. May be empty, but never null.

Throws:

ContentException

getAuditContents

public List<RuleAuditData> getAuditContents(List<String> pContentPaths,
                                   List<String> pTemplateTypes,
                                   List<String> pTemplateIds,
                                   int pRuleLimit)
                                     throws ContentException

This method is for internal Oracle use only and should never be called.
If audit is enabled, returns the audit contents. Audit content is metadata about the content items returned by the MDEX.

Parameters:

pContentPaths - a list of paths where content is to be drawn from

pTemplateTypes - a list of the accepted template types

pTemplateIds - a list of the accepted template ids

pRuleLimit - upper bound on number of rules returned. All content that triggers subsequently shows up in Audit as "Not Fired".

Returns:

a list of audit content items. May be empty, but never null.

Throws:

ContentException