|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object atg.nucleus.logging.VariableArgumentApplicationLoggingImpl atg.nucleus.GenericService atg.nucleus.TimedOperationService atg.servlet.pipeline.PipelineableServletImpl atg.servlet.pipeline.InsertableServletImpl atg.endeca.assembler.AssemblerPipelineServlet
public class AssemblerPipelineServlet
A pipline servlet that invokes the assembler. It can return content in JSON, XML or forward to a JSP that can handle rendering.
Field Summary | |
---|---|
static java.lang.String |
ASSEMBLER
|
static java.lang.String |
ATG_ASSEMBLER
|
static java.lang.String |
CONTENT_COLLECTION
|
static java.lang.String |
CONTENT_ITEM
|
static java.lang.String |
CONTENT_RENDERER
|
static java.lang.String |
JSON_FORMAT
|
static java.lang.String |
RULE_LIMIT
|
static java.lang.String |
XML_FORMAT
|
Fields inherited from class atg.servlet.pipeline.InsertableServletImpl |
---|
CLASS_VERSION |
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 | |
---|---|
AssemblerPipelineServlet()
|
Method Summary | |
---|---|
protected void |
forwardRequest(DynamoHttpServletRequest pRequest,
DynamoHttpServletResponse pResponse,
ContentItem pContentItem)
Forwards the request to the jsp specified by the contentRenderer servlet context parameter set in the Web.xml. |
java.lang.String[] |
getAllowedMimeTypes()
Sets property allowedMimeTypes. |
AssemblerTools |
getAssemblerTools()
|
java.lang.String |
getDefaultContentRenderer()
|
java.lang.String |
getFormatParamName()
Name of the request parameter that controls the format of the returned content. |
java.util.regex.Pattern |
getIgnoreRequestURIPattern()
Returns property ignoreRequestURIPattern. |
protected java.lang.String |
getMimeTypeForRequest(DynamoHttpServletRequest pRequest)
Extract the mime type for the request. |
MimeTyper |
getMimeTyper()
Returns property mimeTyper. |
boolean |
isAssembleUnknownMimeTypes()
Returns property assembleUnknownMimeTypes. |
protected boolean |
isContentCollectionRequest(DynamoHttpServletRequest pRequest)
Build what the request would look like to the special "/assembler" path which indicates we want a ContentSlotConfig. |
boolean |
isEnable()
Returns property enable. |
protected boolean |
isMimeTypeAllowed(java.lang.String pMimeType)
Return whether the specified mime type is allowed. |
boolean |
isUseMapper()
Returns property useMapper. |
protected java.lang.String |
requestURIWithoutParams(DynamoHttpServletRequest pRequest)
Get the request uri without params |
void |
service(DynamoHttpServletRequest pRequest,
DynamoHttpServletResponse pResponse)
Services a DynamoHttpServletRequest/Response pair |
void |
setAllowedMimeTypes(java.lang.String[] pAllowedMimeTypes)
Sets property allowedMimeTypes. |
void |
setAssemblerTools(AssemblerTools pAssemblerTools)
Set a new assembler tools class |
void |
setAssembleUnknownMimeTypes(boolean pAssembleUnknownMimeTypes)
Sets property assembleUnknownMimeTypes. |
void |
setDefaultContentRenderer(java.lang.String pDefaultContentRenderer)
Set the location of a JSP that knows how to handle the rendering of returned content items. |
void |
setEnable(boolean pEnable)
Sets property enable. |
void |
setFormatParamName(java.lang.String pFormatParamName)
|
void |
setIgnoreRequestURIPattern(java.util.regex.Pattern pIgnoreRequestURIPattern)
Sets property ignoreRequestURIPattern. |
void |
setMimeTyper(MimeTyper pMimeTyper)
Sets property mimeTyper. |
void |
setUseMapper(boolean pUseMapper)
Sets property useMapper. |
protected boolean |
shouldIgnoreRequest(DynamoHttpServletRequest pRequest)
Whether we should ignore this request (as far as invoking the assembler). |
Methods inherited from class atg.servlet.pipeline.InsertableServletImpl |
---|
doStartService, getInsertAfterServlet, setInsertAfterServlet |
Methods inherited from class atg.servlet.pipeline.PipelineableServletImpl |
---|
createAdminServlet, destroy, getAdminServlet, getNextServlet, getServletConfig, getServletInfo, init, isUsePathInfo, passRequest, passRequest, service, service, setNextServlet, setServletInfo, setUsePathInfo |
Methods inherited from class atg.nucleus.TimedOperationService |
---|
getAverageRequestHandlingTime, getHandledRequestCount, getRequestStartTime, getTotalRequestHandlingTime, isKeepingStatistics, notifyHandledRequest, resetStatistics, setKeepingStatistics |
Methods inherited from class atg.nucleus.logging.VariableArgumentApplicationLoggingImpl |
---|
vlogDebug, vlogDebug, vlogDebug, vlogDebug, vlogDebugTrace, 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 |
Methods inherited from interface atg.servlet.pipeline.PipelineableServlet |
---|
getNextServlet, passRequest, setNextServlet |
Methods inherited from interface javax.servlet.Servlet |
---|
destroy, getServletConfig, getServletInfo, init, service |
Field Detail |
---|
public static final java.lang.String ASSEMBLER
public static final java.lang.String CONTENT_COLLECTION
public static final java.lang.String RULE_LIMIT
public static final java.lang.String CONTENT_RENDERER
public static final java.lang.String ATG_ASSEMBLER
public static final java.lang.String CONTENT_ITEM
public static final java.lang.String JSON_FORMAT
public static final java.lang.String XML_FORMAT
Constructor Detail |
---|
public AssemblerPipelineServlet()
Method Detail |
---|
public void setEnable(boolean pEnable)
public boolean isEnable()
public void setAssembleUnknownMimeTypes(boolean pAssembleUnknownMimeTypes)
public boolean isAssembleUnknownMimeTypes()
public java.lang.String getDefaultContentRenderer()
public void setDefaultContentRenderer(java.lang.String pDefaultContentRenderer)
pDefaultContentRenderer
- public AssemblerTools getAssemblerTools()
public void setAssemblerTools(AssemblerTools pAssemblerTools)
pAssemblerTools
- public java.lang.String getFormatParamName()
public void setFormatParamName(java.lang.String pFormatParamName)
pFormatParamName
- Set a new formatParamNamepublic void setUseMapper(boolean pUseMapper)
public boolean isUseMapper()
public void setIgnoreRequestURIPattern(java.util.regex.Pattern pIgnoreRequestURIPattern)
public java.util.regex.Pattern getIgnoreRequestURIPattern()
public void setAllowedMimeTypes(java.lang.String[] pAllowedMimeTypes)
public java.lang.String[] getAllowedMimeTypes()
public void setMimeTyper(MimeTyper pMimeTyper)
public MimeTyper getMimeTyper()
protected boolean isMimeTypeAllowed(java.lang.String pMimeType)
pMimeType
- the mime type off the request.
protected java.lang.String getMimeTypeForRequest(DynamoHttpServletRequest pRequest)
pRequest
- the current requestpResourcePath
- the resource path as returned by AssemblerToolsprotected boolean shouldIgnoreRequest(DynamoHttpServletRequest pRequest)
pRequest
- the current request.
public void service(DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse) throws java.io.IOException, javax.servlet.ServletException
PipelineableServletImpl
service
in class PipelineableServletImpl
java.io.IOException
- if an error occurred while reading or writing
the servlet request
javax.servlet.ServletException
- if an error occurred while processing
the servlet requestprotected void forwardRequest(DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse, ContentItem pContentItem) throws javax.servlet.ServletException, java.io.IOException
pRequest
- HttpRequestpResponse
- HttpResponsepContentItem
- The content item to make available on the page
javax.servlet.ServletException
java.io.IOException
protected boolean isContentCollectionRequest(DynamoHttpServletRequest pRequest)
pRequest
-
protected java.lang.String requestURIWithoutParams(DynamoHttpServletRequest pRequest)
pRequest
-
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |