| Modifier and Type | Field and Description |
|---|---|
protected RequestContext |
DependencyDirectiveData.context
This is required for backwards compatibility to support WebScripts that are still using *.head.ftl files to add dependencies.
|
| Modifier and Type | Method and Description |
|---|---|
RequestContext |
ChromeDetectionDirective.getContext() |
RequestContext |
ChromeDetectionDirectiveData.getContext() |
RequestContext |
RenderServiceFreeMarkerDirective.getRequestContext()
Returns the
RequestContext supplied when instantiating the class |
RequestContext |
RenderServiceExtensibilityDirective.getRequestContext()
Returns the
RequestContext supplied when instantiating the class |
RequestContext |
AbstractDependencyExtensibilityDirective.getRequestContext()
Retrieves the
RequestContext for the current thread. |
| Modifier and Type | Method and Description |
|---|---|
AddInlineJavaScriptDirective |
DirectiveFactory.createAddInlineJavaScriptDirective(String directiveName,
ModelObject object,
org.springframework.extensions.surf.extensibility.ExtensibilityModel extensibilityModel,
RequestContext context)
Creates a new
AddInlineJavaScriptDirective directive. |
AddInlineJavaScriptDirective |
DefaultDirectiveFactory.createAddInlineJavaScriptDirective(String directiveName,
ModelObject object,
org.springframework.extensions.surf.extensibility.ExtensibilityModel extensibilityModel,
RequestContext context)
Creates a new
AddInlineJavaScriptDirective directive. |
AutoComponentRegionDirective |
DirectiveFactory.createAutoComponentRegionDirective(String directiveName,
RequestContext context,
RenderService renderService)
Creates a new
AutoComponentRegionDirective. |
AutoComponentRegionDirective |
DefaultDirectiveFactory.createAutoComponentRegionDirective(String directiveName,
RequestContext context,
RenderService renderService) |
ChecksumResourceDirective |
DirectiveFactory.createChecksumResourceDirective(String directiveName,
ModelObject object,
org.springframework.extensions.surf.extensibility.ExtensibilityModel extensibilityModel,
RequestContext context)
Creates a new
ChecksumResourceDirective directive. |
ChecksumResourceDirective |
DefaultDirectiveFactory.createChecksumResourceDirective(String directiveName,
ModelObject object,
org.springframework.extensions.surf.extensibility.ExtensibilityModel extensibilityModel,
RequestContext context)
Creates a new
ChecksumResourceDirective directive. |
ChromeDetectionDirective |
DirectiveFactory.createChromeDetectionDirective(String directiveName,
org.springframework.extensions.surf.extensibility.ExtensibilityModel extensibilityModel,
WebFrameworkConfigElement webFrameworkConfigElement,
RequestContext context)
Creates a new
ChromeDetectionDirective. |
ChromeDetectionDirective |
DefaultDirectiveFactory.createChromeDetectionDirective(String directiveName,
org.springframework.extensions.surf.extensibility.ExtensibilityModel extensibilityModel,
WebFrameworkConfigElement webFrameworkConfigElement,
RequestContext context)
Creates a new
ChromeDetectionDirective. |
CreateWebScriptWidgetsDirective |
DirectiveFactory.createCreateWebScriptsDirective(String directiveName,
ModelObject object,
org.springframework.extensions.surf.extensibility.ExtensibilityModel extensibilityModel,
RequestContext context)
Creates a new
CreateWebScriptWidgetsDirective directive. |
CreateWebScriptWidgetsDirective |
DefaultDirectiveFactory.createCreateWebScriptsDirective(String directiveName,
ModelObject object,
org.springframework.extensions.surf.extensibility.ExtensibilityModel extensibilityModel,
RequestContext context)
Creates a new
CreateWebScriptWidgetsDirective directive. |
CssDependencyDirective |
DirectiveFactory.createCssDependencyDirective(String directiveName,
ModelObject object,
org.springframework.extensions.surf.extensibility.ExtensibilityModel extensibilityModel,
RequestContext context)
Creates a new
CssDependencyDirective directive. |
CssDependencyDirective |
DefaultDirectiveFactory.createCssDependencyDirective(String directiveName,
ModelObject object,
org.springframework.extensions.surf.extensibility.ExtensibilityModel extensibilityModel,
RequestContext context)
Creates a new
CssDependencyDirective directive. |
JavaScriptDependencyDirective |
DirectiveFactory.createJavaScriptDependencyDirective(String directiveName,
ModelObject object,
org.springframework.extensions.surf.extensibility.ExtensibilityModel extensibilityModel,
RequestContext context)
Creates a new
JavaScriptDependencyDirective directive. |
JavaScriptDependencyDirective |
DefaultDirectiveFactory.createJavaScriptDependencyDirective(String directiveName,
ModelObject object,
org.springframework.extensions.surf.extensibility.ExtensibilityModel extensibilityModel,
RequestContext context)
Creates a new
JavaScriptDependencyDirective directive. |
MessagesDependencyDirective |
DirectiveFactory.createMessagesDependencyDirective(String directiveName,
ModelObject object,
org.springframework.extensions.surf.extensibility.ExtensibilityModel extensibilityModel,
RequestContext context) |
MessagesDependencyDirective |
DefaultDirectiveFactory.createMessagesDependencyDirective(String directiveName,
ModelObject object,
org.springframework.extensions.surf.extensibility.ExtensibilityModel extensibilityModel,
RequestContext context)
Creates a new
MessagesDependencyDirective directive. |
OutputCSSDirective |
DirectiveFactory.createOutputCssDirective(String directiveName,
ModelObject object,
org.springframework.extensions.surf.extensibility.ExtensibilityModel extensibilityModel,
RequestContext context)
Creates a new
OutputCSSDirective directive. |
OutputCSSDirective |
DefaultDirectiveFactory.createOutputCssDirective(String directiveName,
ModelObject object,
org.springframework.extensions.surf.extensibility.ExtensibilityModel extensibilityModel,
RequestContext context)
Creates a new
OutputCSSDirective directive. |
OutputJavaScriptDirective |
DirectiveFactory.createOutputJavaScriptDirective(String directiveName,
ModelObject object,
org.springframework.extensions.surf.extensibility.ExtensibilityModel extensibilityModel,
RequestContext context)
Creates a new
OutputJavaScriptDirective directive. |
OutputJavaScriptDirective |
DefaultDirectiveFactory.createOutputJavaScriptDirective(String directiveName,
ModelObject object,
org.springframework.extensions.surf.extensibility.ExtensibilityModel extensibilityModel,
RequestContext context)
Creates a new
OutputJavaScriptDirective directive. |
ProcessJsonModelDirective |
DirectiveFactory.createProcessJsonModelDirective(String directiveName,
ModelObject object,
org.springframework.extensions.surf.extensibility.ExtensibilityModel extensibilityModel,
RequestContext context,
WebFrameworkConfigElement webFrameworkConfig)
Creates a new
ProcessJsonModelDirective. |
ProcessJsonModelDirective |
DefaultDirectiveFactory.createProcessJsonModelDirective(String directiveName,
ModelObject object,
org.springframework.extensions.surf.extensibility.ExtensibilityModel extensibilityModel,
RequestContext context,
WebFrameworkConfigElement webFrameworkConfig) |
RelocateJavaScriptOutputDirective |
DirectiveFactory.createRelocateJavaScriptDirective(String directiveName,
ModelObject object,
org.springframework.extensions.surf.extensibility.ExtensibilityModel extensibilityModel,
RequestContext context)
Creates a new
RelocateJavaScriptOutputDirective directive. |
RelocateJavaScriptOutputDirective |
DefaultDirectiveFactory.createRelocateJavaScriptDirective(String directiveName,
ModelObject object,
org.springframework.extensions.surf.extensibility.ExtensibilityModel extensibilityModel,
RequestContext context)
Creates a new
RelocateJavaScriptOutputDirective directive. |
StandaloneWebScriptWrapper |
DirectiveFactory.createStandaloneWebScriptWrapperDirective(String directiveName,
ModelObject object,
org.springframework.extensions.surf.extensibility.ExtensibilityModel extensibilityModel,
RequestContext context) |
StandaloneWebScriptWrapper |
DefaultDirectiveFactory.createStandaloneWebScriptWrapperDirective(String directiveName,
ModelObject object,
org.springframework.extensions.surf.extensibility.ExtensibilityModel extensibilityModel,
RequestContext context)
Creates a new
ChromeDetectionDirective. |
void |
AutoComponentRegionDirective.setRequestContext(RequestContext context)
Set the
RequestContext required for rendering the Component. |
void |
AbstractDependencyExtensibilityDirective.setRequestContext(RequestContext requestContext)
Sets the
RequestContext for the current thread. |
protected void |
DefaultDirectiveFactory.setupDirective(AbstractDependencyExtensibilityDirective directive,
ModelObject object,
RequestContext context)
Sets up a directive with the core objects needed.
|
| Constructor and Description |
|---|
ChromeDetectionDirective(String directiveName,
org.springframework.extensions.surf.extensibility.ExtensibilityModel model,
WebFrameworkConfigElement webFrameworkConfig,
RequestContext context) |
ChromeDetectionDirectiveData(String id,
String action,
String target,
String directiveName,
freemarker.template.TemplateDirectiveBody body,
freemarker.core.Environment env,
WebFrameworkConfigElement config,
RequestContext context) |
ChromeIncludeFreeMarkerDirective(String directiveName,
RequestContext context,
ModelObject object,
RenderService renderService)
Instantiates a new
ChromeIncludeFreeMarkerDirective. |
ComponentFreemarkerTagDirective(String directiveName,
RequestContext context,
ModelObject object,
RenderService renderService)
Instantiates a new
ComponentFreemarkerTagDirective. |
RegionDirectiveData(String id,
String action,
String target,
String directiveName,
Map<String,Object> params,
RenderService renderService,
RequestContext context,
freemarker.template.TemplateDirectiveBody body,
freemarker.core.Environment env) |
RegionFreemarkerTagDirective(String directiveName,
org.springframework.extensions.surf.extensibility.ExtensibilityModel model,
RequestContext context,
ModelObject object,
RenderService renderService)
Instantiates a new
RegionFreemarkerTagDirective. |
RenderServiceExtensibilityDirective(String directiveName,
org.springframework.extensions.surf.extensibility.ExtensibilityModel model,
RequestContext context,
ModelObject object,
RenderService renderService) |
RenderServiceFreeMarkerDirective(String directiveName,
RequestContext context,
ModelObject object,
RenderService renderService)
This constructor will need to invoked by subclasses and ensures that a directive name,
RequestContext
and RenderService are provided. |
ResourceFreemarkerTagDirective(String directiveName,
RequestContext context,
ModelObject object,
RenderService renderService)
Instantiates a new
ResourceFreemarkerTagDirective. |
StyleSheetFreeMarkerDirective(String directiveName,
RequestContext context,
ModelObject object,
RenderService renderService)
Instantiates a new
StyleSheetFreeMarkerDirective. |
SurfBugIncludeFreeMarkerDirective(String directiveName,
RequestContext context,
ModelObject object,
RenderService renderService)
Instantiates a new
SurfBugIncludeFreeMarkerDirective. |
| Modifier and Type | Method and Description |
|---|---|
static RequestContext |
FrameworkUtil.getCurrentRequestContext()
Deprecated.
Retrieves the request context for the current thread.
|
static RequestContext |
RequestContextUtil.initRequestContext(org.springframework.context.ApplicationContext applicationContext,
javax.servlet.http.HttpServletRequest request)
Instantiates a default request context for the given http servlet request
|
static RequestContext |
RequestContextUtil.initRequestContext(org.springframework.context.ApplicationContext applicationContext,
javax.servlet.http.HttpServletRequest request,
boolean silentInit)
Instantiates a default request context for the given http servlet request
|
RequestContext |
RequestContextFactory.newInstance(org.springframework.web.context.request.WebRequest webRequest)
Produces a new RequestContext instance for a given request.
|
| Modifier and Type | Method and Description |
|---|---|
org.springframework.extensions.webscripts.connector.Connector |
FrameworkBean.getConnector(RequestContext context,
String endpointId)
Creates an authenticated connector to a given endpoint.
|
static org.springframework.extensions.webscripts.connector.Connector |
FrameworkUtil.getConnector(RequestContext context,
String endpointId)
Deprecated.
Creates an authenticated connector to a given endpoint.
|
org.springframework.extensions.webscripts.connector.ConnectorSession |
FrameworkBean.getConnectorSession(RequestContext context,
String endpointId)
Retrieves the Connector Session instance for the current
user and given endpoint.
|
static org.springframework.extensions.webscripts.connector.ConnectorSession |
FrameworkUtil.getConnectorSession(RequestContext context,
String endpointId)
Deprecated.
Retrieves the Connector Session instance for the current
user and given endpoint.
|
org.springframework.extensions.webscripts.connector.CredentialVault |
FrameworkBean.getCredentialVault(RequestContext context,
String userId)
Retrieves the session-bound credential vault for a given user.
|
static org.springframework.extensions.webscripts.connector.CredentialVault |
FrameworkUtil.getCredentialVault(RequestContext context,
String userId)
Deprecated.
This has been deprecated as all static helper methods need to be removed.
TODO Indicate which bean to use once it has been named!
|
org.springframework.extensions.webscripts.connector.User |
UserFactory.initialiseUser(RequestContext context,
javax.servlet.http.HttpServletRequest request)
Loads a user from the remote user store and store it into the session.
|
org.springframework.extensions.webscripts.connector.User |
UserFactory.initialiseUser(RequestContext context,
javax.servlet.http.HttpServletRequest request,
boolean force)
Loads a user from the remote user store and stores it into the session.
|
org.springframework.extensions.webscripts.connector.User |
UserFactory.initialiseUser(RequestContext context,
javax.servlet.http.HttpServletRequest request,
String endpoint)
Loads a user from the remote user store and store it into the session.
|
org.springframework.extensions.webscripts.connector.User |
UserFactory.initialiseUser(RequestContext context,
javax.servlet.http.HttpServletRequest request,
String endpoint,
boolean force)
Loads a user from the remote user store and stores it into the session.
|
org.springframework.extensions.webscripts.connector.User |
UserFactory.loadUser(RequestContext context,
String userId)
Loads a user object from the default endpoint.
|
org.springframework.extensions.webscripts.connector.User |
UserFactory.loadUser(RequestContext context,
String userId,
String endpointId)
Loads a user object from the given endpoint.
|
String |
LinkBuilder.object(RequestContext context,
String objectId)
Constructs a link to a given object.
|
String |
LinkBuilder.object(RequestContext context,
String objectId,
String formatId)
Constructs a link to a given object.
|
String |
LinkBuilder.object(RequestContext context,
String objectId,
String formatId,
Map<String,String> params)
Constructs a link to a given object.
|
String |
LinkBuilder.page(RequestContext context,
String pageId)
Constructs a link to a given page instance.
|
String |
LinkBuilder.page(RequestContext context,
String pageId,
String formatId)
Constructs a link to a given page for a given format.
|
String |
LinkBuilder.page(RequestContext context,
String pageId,
String formatId,
String objectId)
Constructs a link to a given page for a given format.
|
String |
LinkBuilder.page(RequestContext context,
String pageId,
String formatId,
String objectId,
Map<String,String> params)
Constructs a link to a given page for a given format.
|
String |
LinkBuilder.pageType(RequestContext context,
String pageTypeId)
Constructs a link to a given page type.
|
String |
LinkBuilder.pageType(RequestContext context,
String pageTypeId,
String formatId)
Constructs a link to a given page type for a given format.
|
String |
LinkBuilder.pageType(RequestContext context,
String pageTypeId,
String formatId,
String objectId)
Constructs a link to a given page type for a given format.
|
String |
LinkBuilder.pageType(RequestContext context,
String pageTypeId,
String formatId,
String objectId,
Map<String,String> params)
Constructs a link to a given page type for a given format.
|
static void |
RequestContextUtil.populateRequestContext(RequestContext context,
javax.servlet.http.HttpServletRequest request)
Populates an existing request context with context and user information
|
static void |
RequestContextUtil.populateRequestContext(RequestContext context,
javax.servlet.http.HttpServletRequest request,
boolean silentInit)
Populates an existing request context with environment and user information
|
void |
FrameworkBean.removeConnectorSessions(RequestContext context)
Removes all session-bound Connector Sessions for the current user
|
static void |
FrameworkUtil.removeConnectorSessions(RequestContext context)
Deprecated.
Removes all session-bound Connector Sessions for the current user
|
String |
LinkBuilder.resource(RequestContext context,
String uri)
Constructs a link to a resources at a given relative uri.
|
| Modifier and Type | Method and Description |
|---|---|
boolean |
ExtensionModuleEvaluator.applyModule(RequestContext context,
Map<String,String> evaluationProperties)
Determines whether or not to apply a module.
|
boolean |
SubComponentEvaluation.evaluate(RequestContext context,
org.springframework.context.ApplicationContext applicationContext)
Processes all the configured
evaluator instances and returns the overall
result. |
boolean |
SubComponentEvaluator.evaluate(RequestContext context,
Map<String,String> params)
Evaluates whether or not the information in the supplied
RequestContext meets the criteria
defined in the supplied parameter Map. |
List<ExtensionModule> |
ExtensibilityModuleHandler.evaluateModules(RequestContext context)
Evaluates the
ExtensionModule instances that are applicable for the supplied
RequestContext. |
| Modifier and Type | Method and Description |
|---|---|
protected boolean |
BasicExtensibilityModuleHandler.applyModule(ModuleDeployment module,
RequestContext context)
Determines whether or not to apply the supplied
ModuleDeployment based on the supplied RequestContext. |
boolean |
ConfigApprovalEvaluator.applyModule(RequestContext context,
Map<String,String> evaluationProperties) |
boolean |
ApproveAllModulesEvaluator.applyModule(RequestContext context,
Map<String,String> evaluationProperties) |
boolean |
DefaultSubComponentEvaluation.evaluate(RequestContext context,
org.springframework.context.ApplicationContext applicationContext)
Iterates over all the entries in the
evaluators map evaluating each one. |
boolean |
DefaultSubComponentEvaluator.evaluate(RequestContext context,
Map<String,String> params) |
boolean |
RejectionSubComponentEvaluator.evaluate(RequestContext context,
Map<String,String> params) |
List<ExtensionModule> |
BasicExtensibilityModuleHandler.evaluateModules(RequestContext context)
Retrieves a list of modules that can be applied to the file defined by the supplied path.
|
| Modifier and Type | Method and Description |
|---|---|
protected static void |
PageView.debug(RequestContext context,
String value)
Debug logger helper function.
|
void |
PageView.dispatchPage(RequestContext context,
String pageId,
String formatId)
Dispatches a given page in a given format.
|
void |
TemplateView.dispatchTemplate(RequestContext context) |
protected boolean |
PageView.loginRequiredForPage(RequestContext context,
javax.servlet.http.HttpServletRequest request,
Page page)
Return if login page should be display for the given page.
|
protected void |
AbstractWebFrameworkView.populateRequestContext(RequestContext context,
javax.servlet.http.HttpServletRequest request)
Performs default population of the request context.
|
protected void |
ComponentView.renderView(RequestContext context) |
protected void |
ErrorHandlerPageView.renderView(RequestContext context) |
protected void |
PageView.renderView(RequestContext context) |
protected void |
RegionView.renderView(RequestContext context) |
protected void |
TemplateView.renderView(RequestContext context) |
protected abstract void |
AbstractWebFrameworkView.renderView(RequestContext context)
To be implemented by view classes to provide render dispatch
|
protected void |
SystemPageView.renderView(RequestContext context) |
protected void |
PageView.validateRequestContext(RequestContext context,
javax.servlet.http.HttpServletRequest request) |
protected void |
TemplateView.validateRequestContext(RequestContext context,
javax.servlet.http.HttpServletRequest request) |
protected void |
AbstractWebFrameworkView.validateRequestContext(RequestContext context,
javax.servlet.http.HttpServletRequest request)
Extension point for performing any validation of the request context state
If the request context state is invalid, it can either be adjusted or an exception
can be raised.
|
| Modifier and Type | Field and Description |
|---|---|
protected RequestContext |
RenderContextRequest.renderContext |
| Modifier and Type | Method and Description |
|---|---|
static RequestContext |
RenderUtil.getContext(javax.servlet.http.HttpServletRequest request)
Attempts to retrieve the render context instance bound to the given
http servlet request
|
RequestContext |
ProcessorContext.getRequestContext() |
| Modifier and Type | Method and Description |
|---|---|
void |
AbstractRenderer.all(RequestContext context,
ModelObject object)
Renders both the header and body focus by calling the
header and body methods
in succession. |
void |
Renderer.all(RequestContext renderContext,
ModelObject object)
Executes the renderer in the "all" mode
|
abstract void |
AbstractRenderer.body(RequestContext context,
ModelObject object)
This method must be implemented by concrete subclasses to render the body focus for artifact
being handled by the renderer.
|
void |
Renderer.body(RequestContext renderContext,
ModelObject object)
Executes the renderer in the "body" mode
|
String |
RenderService.generateResourceURL(RequestContext renderContext,
ModelObject object,
String name,
String id,
String protocol,
String endpoint,
String objectId,
String payload) |
static Object |
RenderUtil.getComponentBindingSourceObject(RequestContext context,
Component component)
Returns the object to which this component is bound
This is the same as calling component.getSourceObject()
|
Component |
RenderService.getComponentBoundToRegion(RequestContext context,
String regionId,
String regionScopeId,
String regionSourceId)
Determines the component which is bound to the given region
If there is no component bound, then null is returned.
|
static String |
RenderUtil.getSourceId(RequestContext context,
String scopeId)
Return the "source" ID for the given scope ID for the supplied context.
|
protected void |
RenderService.handleError(RequestContext context,
String errorTitle,
String errorDescription,
Throwable t)
This method sets up the
RequestContext and attempts to redirect the
request to the general error page. |
protected void |
RenderService.handleRenderProblem(String targetId,
String errorPageId,
RequestContext context,
Throwable t)
This method is invoked whenever the
RenderService fails to render something. |
void |
AbstractRenderer.header(RequestContext context,
ModelObject object)
This method should be overridden by concrete subclasses to render the header focus for artifact
being handled by the renderer.
|
void |
Renderer.header(RequestContext renderContext,
ModelObject object)
Executes the renderer in the "head" mode
|
static void |
RenderUtil.object(RequestContext context,
javax.servlet.http.HttpServletRequest request,
javax.servlet.http.HttpServletResponse response,
String objectId,
String formatId)
/**
Renders the fully formed URL string for a link to a given content object
|
static void |
RenderUtil.page(RequestContext context,
javax.servlet.http.HttpServletRequest request,
javax.servlet.http.HttpServletResponse response,
String pageId,
String formatId,
String objectId)
Renders the fully formed URL string for a link to a given page
|
static void |
RenderUtil.pageType(RequestContext context,
javax.servlet.http.HttpServletRequest request,
javax.servlet.http.HttpServletResponse response,
String pageTypeId,
String formatId,
String objectId)
Renders the fully formed URL string for a link to a given page type
|
protected static void |
AbstractRenderer.print(RequestContext context,
String str)
Commits the given string to the response output stream
|
void |
RenderService.processComponent(RequestContext context,
RenderFocus renderFocus,
Component component,
boolean chromeless)
Executes the processor for the given render focus on the given component instance.
|
void |
RenderService.processRenderable(RequestContext context,
RenderFocus renderFocus,
ModelObject object,
Renderable renderable)
Executes the processor for the given focus on the provided renderable object.
|
void |
RenderService.processTemplate(RequestContext context,
RenderFocus renderFocus,
TemplateInstance template)
Executes the processor for the given render focus on the given template instance.
|
void |
AbstractRenderer.render(RequestContext context,
ModelObject object,
RenderFocus focus)
This method directs rendering requests to the appropriate method for the
RenderFocus provided. |
void |
Renderer.render(RequestContext renderContext,
ModelObject object,
RenderFocus focus)
Executes the renderer in the given focus
|
void |
RenderService.renderChromeInclude(RequestContext context,
ModelObject object)
Renders either a component or a region depending upon the value of
RENDER_TYPE key set in the
current RequestContext. |
void |
RenderService.renderComponent(RequestContext context,
RenderFocus renderFocus,
Component component,
String chromeIdOverride,
boolean chromeless)
Entry point for the rendering a single identified component
with the default chrome.
|
void |
RenderService.renderComponent(RequestContext context,
RenderFocus renderFocus,
String componentId,
String overrideChromeId,
boolean chromeless)
Entry point for the rendering a component with the given chrome.
|
boolean |
RenderService.renderErrorHandlerPage(RequestContext context,
String errorHandlerPageId)
Renders a default error handler page
A system page can be configured to handle a fault state for the web framework.
|
static String |
RenderUtil.renderLinkImport(RequestContext context,
String uri)
Renders an HTML stylesheet tag.
|
static String |
RenderUtil.renderLinkImport(RequestContext context,
String uri,
String id)
Renders an HTML stylesheet tag and optionally appends
the incoming query string to the URL.
|
void |
RenderService.renderPage(RequestContext context,
RenderFocus renderFocus)
Entry point for the rendering of the current page as provided
by the request context.
|
void |
RenderService.renderRegion(RequestContext context,
RenderFocus renderFocus,
String templateId,
String regionId,
String regionScopeId,
String overrideChromeId,
boolean chromeless)
Entry point for the rendering a region of a given template
|
void |
RenderService.renderRegionComponents(RequestContext context,
ModelObject object,
boolean chromeless)
Renders the components of the region described by the render context
This method is generally called from the region include tag.
|
static String |
RenderUtil.renderScriptImport(RequestContext context,
String uri)
Renders an HTML tag to the output stream
|
void |
RenderService.renderSubComponent(SubComponent subComponent,
RequestContext context,
RenderFocus renderFocus)
Renders the supplied
SubComponent. |
void |
RenderService.renderSurfBugInclude(RequestContext context)
Convenience method provided for both the "surfbugInclude" FreeMarker directive and
JSP tag to use.
|
boolean |
RenderService.renderSystemPage(RequestContext context,
String systemPageId)
Renders a default system page
A system container is a page fragment that is rendered
as a container of other elements like components.
|
void |
RenderService.renderTemplate(RequestContext context,
RenderFocus renderFocus)
Entry point for the rendering of the current content item as
provided by the request context.
|
String |
RenderService.renderTemplateHeaderAsString(RequestContext context,
ModelObject object)
Generates text to be inserted into template markup head for a given
renderer context.
|
void |
RenderService.updateStyleSheetImports(RequestContext context,
String href)
Adds to the (or creates a new)
LinkedList of CSS style sheet URLs stored as the
WebFrameworkConstants.STYLESHEET_RENDER_CONTEXT_NAME attribute in the supplied
RequestContext. |
| Constructor and Description |
|---|
ProcessorContext(RequestContext context) |
RenderContextRequest(RequestContext context,
ModelObject object,
javax.servlet.http.HttpServletRequest request) |
| Modifier and Type | Method and Description |
|---|---|
void |
TemplateInstanceRenderer.body(RequestContext context,
ModelObject object)
Renders the current template
|
void |
ComponentRenderer.body(RequestContext context,
ModelObject object) |
void |
RegionRenderer.body(RequestContext context,
ModelObject object) |
void |
PageRenderer.body(RequestContext context,
ModelObject object)
Renders the current page
|
void |
ChromeRenderer.body(RequestContext context,
ModelObject object) |
protected void |
JSPProcessor.doInclude(RequestContext context,
ModelObject object,
String jspPath) |
void |
TemplateInstanceRenderer.header(RequestContext context,
ModelObject object) |
void |
ComponentRenderer.header(RequestContext context,
ModelObject object) |
void |
RegionRenderer.header(RequestContext context,
ModelObject object) |
void |
TemplateInstanceRenderer.postHeaderProcess(RequestContext context) |
void |
ComponentRenderer.postProcess(RequestContext context)
Post-processing of components
|
void |
RegionRenderer.postProcess(RequestContext context)
Post-processing of regions
|
void |
ChromeRenderer.render(RequestContext context,
ModelObject object,
RenderFocus focus)
Overrides the method provided by
AbstractRenderer to set a RENDER_TYPE entry into the
RequestContext where the value indicates whether Component or Region chrome is being rendered. |
| Modifier and Type | Method and Description |
|---|---|
static String |
ThemeUtil.getCurrentThemeId(RequestContext context)
Gets the current theme id.
|
static Page |
SiteUtil.getRootPage(RequestContext context)
Returns the root page for the current request context
|
static Page |
SiteUtil.getRootPage(RequestContext context,
Configuration siteConfiguration)
Returns the root page for the given site configuration
|
static Configuration |
SiteUtil.getSiteConfiguration(RequestContext context)
Returns the site configuration object to use for the current request.
|
static void |
CacheUtil.invalidateModelObjectServiceCache(RequestContext context)
Invalidate model object service object cache.
|
static void |
ThemeUtil.setCurrentThemeId(RequestContext context,
String themeId)
Sets the current theme.
|
| Modifier and Type | Class and Description |
|---|---|
class |
AbstractRequestContext
Abstract base class for RequestContext implementations.
|
class |
ServletRequestContext
Servlet implementation of a request context object for Surf.
|
class |
ThreadLocalRequestContext
An abstract Request Context implementation that is responsible for holding the value
of the Request Context for the current thread.
|
| Modifier and Type | Method and Description |
|---|---|
static RequestContext |
ThreadLocalRequestContext.getRequestContext()
Instance getter to return the RequestContext for the current thread
|
abstract RequestContext |
AbstractRequestContextFactory.newInstance(org.springframework.web.context.request.WebRequest webRequest) |
RequestContext |
ServletRequestContextFactory.newInstance(org.springframework.web.context.request.WebRequest webRequest) |
| Modifier and Type | Method and Description |
|---|---|
protected String |
AlfrescoUserFactory.buildUserMetadataRestUrl(RequestContext context,
String userId,
String endpointId)
Build the REST URl to use to retrieve the metadata for the supplied user
|
protected org.springframework.extensions.webscripts.connector.User |
AbstractUserFactory.getGuestUser(RequestContext context)
Retrieve the special "Guest" user instance.
|
org.springframework.extensions.webscripts.connector.User |
AbstractUserFactory.initialiseUser(RequestContext context,
javax.servlet.http.HttpServletRequest request)
Loads a user from the remote user store and store it into the session.
|
org.springframework.extensions.webscripts.connector.User |
AbstractUserFactory.initialiseUser(RequestContext context,
javax.servlet.http.HttpServletRequest request,
boolean force)
Loads a user from the remote user store and stores it into the session.
|
org.springframework.extensions.webscripts.connector.User |
AbstractUserFactory.initialiseUser(RequestContext context,
javax.servlet.http.HttpServletRequest request,
String endpoint)
Loads a user from the remote user store and store it into the session.
|
org.springframework.extensions.webscripts.connector.User |
AbstractUserFactory.initialiseUser(RequestContext context,
javax.servlet.http.HttpServletRequest request,
String endpoint,
boolean force)
Loads a user from the remote user store and stores it into the session.
|
org.springframework.extensions.webscripts.connector.User |
DefaultUserFactory.loadUser(RequestContext context,
String userId) |
org.springframework.extensions.webscripts.connector.User |
AlfrescoUserFactory.loadUser(RequestContext context,
String userId) |
abstract org.springframework.extensions.webscripts.connector.User |
AbstractUserFactory.loadUser(RequestContext context,
String userId)
Load the user from a store
|
org.springframework.extensions.webscripts.connector.User |
DefaultUserFactory.loadUser(RequestContext context,
String userId,
String endpointId) |
org.springframework.extensions.webscripts.connector.User |
AlfrescoUserFactory.loadUser(RequestContext context,
String requestedUserId,
String endpointId) |
org.springframework.extensions.webscripts.connector.User |
Alfresco32UserFactory.loadUser(RequestContext context,
String userId,
String endpointId) |
abstract org.springframework.extensions.webscripts.connector.User |
AbstractUserFactory.loadUser(RequestContext context,
String userId,
String endpointId)
Load the user from a store
|
String |
AbstractLinkBuilder.object(RequestContext context,
String objectId) |
String |
AbstractLinkBuilder.object(RequestContext context,
String objectId,
String formatId) |
String |
RequestParameterLinkBuilder.object(RequestContext context,
String objectId,
String formatId,
Map<String,String> params) |
String |
ServletLinkBuilder.object(RequestContext context,
String resourceId,
String formatId,
Map<String,String> params) |
abstract String |
AbstractLinkBuilder.object(RequestContext context,
String objectId,
String formatId,
Map<String,String> params) |
String |
AbstractLinkBuilder.page(RequestContext context,
String pageId) |
String |
AbstractLinkBuilder.page(RequestContext context,
String pageId,
String formatId) |
String |
AbstractLinkBuilder.page(RequestContext context,
String pageId,
String formatId,
String objectId) |
String |
RequestParameterLinkBuilder.page(RequestContext context,
String pageId,
String formatId,
String objectId,
Map<String,String> params) |
String |
ServletLinkBuilder.page(RequestContext context,
String pageId,
String formatId,
String objectId,
Map<String,String> params) |
abstract String |
AbstractLinkBuilder.page(RequestContext context,
String pageId,
String formatId,
String objectId,
Map<String,String> params) |
String |
AbstractLinkBuilder.pageType(RequestContext context,
String pageTypeId) |
String |
AbstractLinkBuilder.pageType(RequestContext context,
String pageTypeId,
String formatId) |
String |
AbstractLinkBuilder.pageType(RequestContext context,
String pageTypeId,
String formatId,
String objectId) |
String |
RequestParameterLinkBuilder.pageType(RequestContext context,
String pageTypeId,
String formatId,
String objectId,
Map<String,String> params) |
String |
ServletLinkBuilder.pageType(RequestContext context,
String pageTypeId,
String formatId,
String objectId,
Map<String,String> params) |
abstract String |
AbstractLinkBuilder.pageType(RequestContext context,
String pageTypeId,
String formatId,
String objectId,
Map<String,String> params) |
String |
RequestParameterLinkBuilder.resource(RequestContext context,
String uri) |
String |
ServletLinkBuilder.resource(RequestContext context,
String uri) |
abstract String |
AbstractLinkBuilder.resource(RequestContext context,
String uri) |
| Modifier and Type | Method and Description |
|---|---|
protected RequestContext |
TagBase.getRenderContext() |
protected RequestContext |
TagBase.getRequestContext()
Gets the request context bound to the current request
|
| Modifier and Type | Method and Description |
|---|---|
protected abstract int |
RenderServiceTag.invokeRenderService(RenderService renderService,
RequestContext renderContext,
ModelObject object)
This method should be implemented to invoke the required method of the
RenderService
that the subclass needs to render its output |
protected int |
IncludeTag.invokeRenderService(RenderService renderService,
RequestContext renderContext,
ModelObject object) |
protected int |
RegionTag.invokeRenderService(RenderService renderService,
RequestContext context,
ModelObject object) |
protected int |
ObjectLinkTag.invokeRenderService(RenderService renderService,
RequestContext requestContext,
ModelObject object) |
protected int |
ObjectAnchorTag.invokeRenderService(RenderService renderService,
RequestContext requestContext,
ModelObject object)
Generates the URL to the requested resource (either a page or page type with optional object and format
request parameters) and then opens an HTML anchor tag using the generated URL as the HREF argument and setting
a target if provided.
|
protected int |
ComponentTag.invokeRenderService(RenderService renderService,
RequestContext renderContext,
ModelObject object) |
protected int |
ResourceTag.invokeRenderService(RenderService renderService,
RequestContext renderContext,
ModelObject modelObject) |
protected int |
SurfBugInclude.invokeRenderService(RenderService renderService,
RequestContext renderContext,
ModelObject object) |
protected int |
StylesheetTag.invokeRenderService(RenderService renderService,
RequestContext renderContext,
ModelObject object) |
| Modifier and Type | Method and Description |
|---|---|
SubComponent.RenderData |
SubComponent.determineURI(RequestContext context,
org.springframework.context.ApplicationContext applicationContext)
Determines the URL to use to render the SubComponent instance.
|
PageImpl[] |
PageImpl.getChildPages(RequestContext context) |
Page[] |
Page.getChildPages(RequestContext context)
Gets the child pages.
|
ComponentType |
Component.getComponentType(RequestContext context)
Gets the component type.
|
ComponentType |
ComponentImpl.getComponentType(RequestContext context) |
Page |
PageAssociation.getDestPage(RequestContext context)
Gets the dest object.
|
Page |
PageAssociationImpl.getDestPage(RequestContext context) |
ModelObject |
ContentAssociationImpl.getObject(RequestContext context) |
ModelObject |
ContentAssociation.getObject(RequestContext context)
Gets the object that is being associated.
|
PageType |
PageImpl.getPageType(RequestContext context) |
PageType |
Page.getPageType(RequestContext context)
Gets the page type.
|
Object |
Component.getSourceObject(RequestContext context)
Gets the source object.
|
Object |
ComponentImpl.getSourceObject(RequestContext context) |
Page |
PageAssociation.getSourcePage(RequestContext context)
Gets the source page.
|
Page |
PageAssociationImpl.getSourcePage(RequestContext context) |
TemplateInstance |
PageImpl.getTemplate(RequestContext context) |
TemplateInstance |
Page.getTemplate(RequestContext context)
Gets the template.
|
TemplateInstance |
PageImpl.getTemplate(RequestContext context,
String formatId) |
TemplateInstance |
Page.getTemplate(RequestContext context,
String formatId)
Gets the template.
|
Map<String,TemplateInstance> |
PageImpl.getTemplates(RequestContext context) |
Map<String,TemplateInstance> |
Page.getTemplates(RequestContext context)
Gets the templates.
|
TemplateType |
TemplateInstanceImpl.getTemplateType(RequestContext context) |
TemplateType |
TemplateInstance.getTemplateType(RequestContext context)
Gets the template type.
|
| Modifier and Type | Method and Description |
|---|---|
static List<Map<String,String>> |
UriUtils.getTokenMaps(RequestContext context)
Builds a list of all the maps that can be used for performing token substitution.
|
static String |
UriUtils.replaceTokens(String s,
RequestContext context,
Pattern tokenPattern,
Integer groupNumber,
String missingTokenString)
Replaces tokens in using all available properties built from the
getTokenMaps() method. |
| Modifier and Type | Field and Description |
|---|---|
protected RequestContext |
ScriptBase.context |
| Modifier and Type | Method and Description |
|---|---|
protected RequestContext |
LocalWebScriptRuntimeContainer.getRequestContext() |
RequestContext |
LocalWebScriptContext.getRequestContext() |
RequestContext |
ScriptBase.getRequestContext()
Gets the request context.
|
| Modifier and Type | Method and Description |
|---|---|
void |
LocalWebScriptRuntimeContainer.bindRequestContext(RequestContext context)
Bind the RequestContext to the current thread.
|
URLHelper |
DefaultURLHelperFactory.createUrlHelper(RequestContext context) |
URLHelper |
URLHelperFactory.createUrlHelper(RequestContext context) |
URLHelper |
DefaultURLHelperFactory.createUrlHelper(RequestContext context,
Map<String,String> templateArgs) |
URLHelper |
URLHelperFactory.createUrlHelper(RequestContext context,
Map<String,String> templateArgs) |
void |
WebTemplateProcessor.executeScriptBodyExtensions(RequestContext context,
String scriptPath,
Map<String,Object> scriptModel,
Map<String,Object> resultModel,
ModelObject object)
Executes controller scripts that have been provided to extend the template being rendered.
|
static ScriptModelObject |
ScriptHelper.getObject(RequestContext context,
String objectTypeId,
String objectId)
Retrieves a model object from the underlying store and hands it back
wrapped as a ScriptModelObject.
|
protected static String |
ScriptForm.getPrefix(RequestContext context,
ModelObject object) |
String |
ScriptLinkBuilder.page(RequestContext context,
String pageId,
Map<String,String> params)
Constructs a link to a given page for the default format.
|
String |
ScriptLinkBuilder.page(RequestContext context,
String pageId,
String formatId,
String objectId,
Map<String,String> params)
Constructs a link to a given page for a given format.
|
void |
ProcessorModelHelper.populateScriptModel(RequestContext context,
Map<String,Object> model,
ModelObject object)
Populate the model for script processor.
|
void |
ProcessorModelHelper.populateTemplateModel(RequestContext context,
Map<String,Object> model,
ModelObject object)
Populate the model for template processor.
|
protected static String |
ScriptForm.prefix(RequestContext context,
ModelObject object,
String id) |
void |
LocalWebScriptContext.setRequestContext(RequestContext requestContext) |
static org.springframework.extensions.webscripts.ScriptableMap |
ScriptHelper.toScriptableMap(RequestContext context,
Map<String,ModelObject> objects)
Creates a Scriptable Map for a given map of model objects
|
static org.springframework.extensions.webscripts.ScriptableMap |
ScriptHelper.toScriptableMap(RequestContext context,
ModelObject[] modelObjects)
Creates a Scriptable Map for a given array of model objects
|
static ScriptModelObject |
ScriptHelper.toScriptModelObject(RequestContext context,
ModelObject modelObject)
Wraps a ModelObject with a script wrapper to produce a ScriptModelObject
that can be used by the script and Freemarker engines.
|
static Object[] |
ScriptHelper.toScriptModelObjectArray(RequestContext context,
Map<String,ModelObject> objects)
Converts a map of model objects to an array of ScriptModelObjects
which can be used by the script and Freemarker engines.
|
static Object[] |
ScriptHelper.toScriptModelObjectArray(RequestContext context,
ModelObject[] modelObjects)
Converts an array of ModelObjects to an array of ScriptModelObjects
which can be used by the script and Freemarker engines.
|
| Constructor and Description |
|---|
DefaultURLHelper(RequestContext context)
Construction
|
DefaultURLHelper(RequestContext context,
Map<String,String> templateArgs)
Construction
|
ScriptBase(RequestContext context)
Instantiates a new web framework script base
|
ScriptForm(RequestContext context,
ModelObject object)
Instantiates a new script form.
|
ScriptFormData(RequestContext context,
ModelObject object)
Instantiates a new script form.
|
ScriptLinkBuilder(RequestContext context)
Constructs a new ScriptLinkBuilder object.
|
ScriptModelObject(RequestContext context,
ModelObject modelObject)
Instantiates a new script model object.
|
ScriptRenderContext(RequestContext context)
Constructs a new ScriptRequestContext object.
|
ScriptRenderingInstance(RequestContext context,
ModelObject object)
Instantiates a new script renderer instance.
|
ScriptResource(RequestContext context,
Resource resource) |
ScriptResourceContent(RequestContext context,
ScriptResource resource,
ResourceContent resourceContent)
Constructor
|
ScriptResources(RequestContext context,
ModelObject modelObject)
Instantiates a new resources object
|
ScriptSiteData(RequestContext context,
org.springframework.context.ApplicationContext applicationContext)
Constructs a new ScriptSite object around the provided request context
|
ScriptSurf(RequestContext context) |
ScriptUser(RequestContext context,
org.springframework.extensions.webscripts.connector.User user)
Instantiates a new ScriptUser object which wraps a given request
context and framework user object.
|
ScriptWebApplication(RequestContext context)
Constructs a new ScriptWebApplication object.
|
Copyright © 2005–2016 Alfresco Software. All rights reserved.