atg.search.query.formhandlers
Class BrowseFormHandler

java.lang.Object
  atg.nucleus.logging.VariableArgumentApplicationLoggingImpl
      atg.nucleus.GenericService
          atg.droplet.EmptyFormHandler
              atg.droplet.GenericFormHandler
                  atg.search.query.formhandlers.BaseSearchFormHandler
                      atg.search.query.formhandlers.BrowseFormHandler

All Implemented Interfaces:

DropletFormHandler, NameContextBindingListener, NameContextElement, NameResolver, AdminableService, ApplicationLogging, atg.nucleus.logging.ApplicationLoggingSender, atg.nucleus.logging.TraceApplicationLogging, atg.nucleus.logging.VariableArgumentApplicationLogging, ComponentNameResolver, Service, ServiceListener, java.util.EventListener

public class BrowseFormHandler
extends BaseSearchFormHandler

This form handler issues requests using the <browse> tag, which also corresponds to the ClientCategoryRequest of the searchclient API.

Field Summary

static java.lang.String

CLASS_VERSION Class version string

Fields inherited from class atg.search.query.formhandlers.BaseSearchFormHandler

DEFAULT_ANONYMOUS_USERNAME, DEFAULT_SITE_NAME

Fields inherited from class atg.droplet.GenericFormHandler

PARAM_DEFER_FORWARD_OR_REDIRECT, PARAM_USE_FORWARDS

Fields inherited from class atg.nucleus.GenericService

SERVICE_INFO_KEY

Fields inherited from interface atg.nucleus.logging.TraceApplicationLogging

DEFAULT_LOG_TRACE_STATUS

Fields inherited from interface atg.nucleus.logging.ApplicationLogging

DEFAULT_LOG_DEBUG_STATUS, DEFAULT_LOG_ERROR_STATUS, DEFAULT_LOG_INFO_STATUS, DEFAULT_LOG_WARNING_STATUS

Constructor Summary

BrowseFormHandler()

Method Summary

protected ClientRequest	createClientRequest(DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse) Create the appropriate ClientRequest subtype for this query type, in this case ClientCategoryRequest.
protected SearchMessage	createSearchMessage(ClientRequest pQueryRequest, DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse) Create the JMS message to represent a ClientQueryRequest and associated response data.
protected ClientCategoryRequest	getClientCategoryRequest() Convenience method for this class to avoid massive casting
java.lang.String	getInput() Get the value for the <input> tag (query) or null
java.lang.String	getSearchConfigAttributeName() Get search config attribute name.
java.lang.String	getSearchConfigName(DynamoHttpServletRequest pRequest) Get the search config name.
SearchConfigNameService	getSearchConfigNameService() Get nucleus service that return search config name.
protected void	prepareClientRequest(DynamoHttpServletRequest pRequest) This method is overriden to translate the search config name to the XML request
void	setInput(java.lang.String pInput) Set the <input> tag's body
void	setSearchConfigAttributeName(java.lang.String pSearchConfigAttributeName) Set search config attribute name.
void	setSearchConfigNameService(SearchConfigNameService pSearchConfigNameService) Set nucleus service.

Methods inherited from class atg.search.query.formhandlers.BaseSearchFormHandler

afterSearch, beforeGet, beforeSearch, beforeSet, buildClientRequest, buildSimpleTag, createOptionSet, createSearchSession, createSessionConfig, decodeMapData, dumpMap, dumpRequestInfo, encodeArrayData, encodeCollectionData, encodeMapData, getAnonymousUserName, getAutoRedirect, getBooleanRequestAttribute, getBoolRequestAttribute, getClearQueryURL, getClientRequest, getDocumentSets, getDocumentSetsBuilder, getErrorURL, getIntegerRequestAttribute, getIntRequestAttribute, getOptionSet, getOptionSetName, getParserOptions, getParserOptionsBuilder, getRequestAttribute, getRequestAttributes, getResults, getResultsFetcher, getSearchContext, getSearchMessageSource, getSearchService, getSearchSession, getSessionBasedSearchRequest, getSessionBasedSearchResults, getSessionConfigLanguage, getSiteDefaultOptionSet, getSiteName, getStringArrayRequestAttribute, getSuccessURL, getUserProfile, handleAutoRedirect, handleClearQuery, handleErrorCondition, handleSearch, isRequestLogging, mergeMaps, sendSearchMessage, setAnonymousUserName, setAutoRedirect, setBooleanRequestAttribute, setClearQueryURL, setClientRequest, setDocumentSetsBuilder, setErrorURL, setOptionSet, setOptionSetName, setParserOptionsBuilder, setRequestAttribute, setRequestAttributes, setRequestLogging, setResults, setResultsFetcher, setSearchContext, setSearchService, setSessionBasedSearchRequest, setSessionBasedSearchResults, setSessionConfigLanguage, setSiteName, setSuccessURL, setUserProfile

Methods inherited from class atg.droplet.GenericFormHandler

addFormException, addUncheckedFormException, afterSet, checkFormRedirect, createFormSubmissionMessage, getCancelURL, getCheckForValidSession, getFormError, getFormExceptions, getFormName, getMessagePort, getMessageSource, getMessageType, getPropertyExceptions, getSendMessages, getUncheckedFormExceptions, handleCancel, handleFormException, handleUncheckedFormException, hasUncheckedFormExceptions, isDeferForwardsAndRedirects, isRestorableForm, isUseForwards, isValidSession, redirectOrForward, resetFormExceptions, setCancelURL, setCheckForValidSession, setDeferForwardsAndRedirects, setFormName, setMessagePort, setMessageSource, setMessageType, setRestorableForm, setSendMessages, setUseForwards

Methods inherited from class atg.droplet.EmptyFormHandler

afterGet

Methods inherited from class atg.nucleus.GenericService

addLogListener, createAdminServlet, doStartService, doStopService, getAbsoluteName, getAdminServlet, getLoggingForVlogging, getLogListenerCount, getLogListeners, getName, getNameContext, getNucleus, getRoot, getServiceConfiguration, getServiceInfo, isLoggingDebug, isLoggingError, isLoggingInfo, isLoggingTrace, isLoggingWarning, isRunning, logDebug, logDebug, logDebug, logError, logError, logError, logInfo, logInfo, logInfo, logTrace, logTrace, logTrace, logWarning, logWarning, logWarning, nameContextElementBound, nameContextElementUnbound, removeLogListener, resolveName, resolveName, resolveName, resolveName, sendLogEvent, setLoggingDebug, setLoggingError, setLoggingInfo, setLoggingTrace, setLoggingWarning, setNucleus, setServiceInfo, startService, stopService

Methods inherited from class atg.nucleus.logging.VariableArgumentApplicationLoggingImpl

vlogDebug, vlogDebug, vlogDebug, vlogDebug, vlogError, vlogError, vlogError, vlogError, vlogInfo, vlogInfo, vlogInfo, vlogInfo, vlogTrace, vlogTrace, vlogTrace, vlogTrace, vlogWarning, vlogWarning, vlogWarning, vlogWarning

Methods inherited from class java.lang.Object

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

Field Detail

CLASS_VERSION

public static java.lang.String CLASS_VERSION

Class version string

Constructor Detail

BrowseFormHandler

public BrowseFormHandler()

Method Detail

setInput

public void setInput(java.lang.String pInput)

Set the <input> tag's body

Parameters:

pInput - the search input text

getInput

public java.lang.String getInput()

Get the value for the <input> tag (query) or null

Returns:

the input tag's value

getSearchConfigNameService

public SearchConfigNameService getSearchConfigNameService()

Get nucleus service that return search config name.

Returns:

SearchConfigNameService - current instance of the nucleus service.

setSearchConfigNameService

public void setSearchConfigNameService(SearchConfigNameService pSearchConfigNameService)

Set nucleus service.

Parameters:

pSearchConfigNameService - new instance of SearchConfigNameService.

getSearchConfigAttributeName

public java.lang.String getSearchConfigAttributeName()

Get search config attribute name.

Returns:

String - search config attribute name.

setSearchConfigAttributeName

public void setSearchConfigAttributeName(java.lang.String pSearchConfigAttributeName)

Set search config attribute name.

Parameters:

pSearchConfigAttributeName - String

createClientRequest

protected ClientRequest createClientRequest(DynamoHttpServletRequest pRequest,
                                            DynamoHttpServletResponse pResponse)

Create the appropriate ClientRequest subtype for this query type, in this case ClientCategoryRequest.

Specified by:

createClientRequest in class BaseSearchFormHandler

Parameters:

pRequest - the Dynamo http request

pResponse - the Dynamo http response

Returns:

a new ClientRequest object

createSearchMessage

protected SearchMessage createSearchMessage(ClientRequest pQueryRequest,
                                            DynamoHttpServletRequest pRequest,
                                            DynamoHttpServletResponse pResponse)

Create the JMS message to represent a ClientQueryRequest and associated response data.

Specified by:

createSearchMessage in class BaseSearchFormHandler

Parameters:

pQueryRequest - the ClientCategoryRequest object

pRequest - the Dynamo http request

pResponse - the Dynamo http response

Returns:

the JMS message to be sent

getClientCategoryRequest

protected ClientCategoryRequest getClientCategoryRequest()

Convenience method for this class to avoid massive casting

Returns:

the ClientCategoryRequest

prepareClientRequest

protected void prepareClientRequest(DynamoHttpServletRequest pRequest)

This method is overriden to translate the search config name to the XML request

Overrides:

prepareClientRequest in class BaseSearchFormHandler

Parameters:

pRequest - DynamoHttpServletRequest

getSearchConfigName

public java.lang.String getSearchConfigName(DynamoHttpServletRequest pRequest)

Get the search config name.

Returns:

String - search config name