com.acsinet_solutions.cetia4.controller
Interface ControllerConstants

All Superinterfaces:

AttributeKeys

All Known Implementing Classes:

AbstractLinkTag, AbstractRestServlet, AbstractServletRequestContext, ButtonTag, CommentsModule, ControllerTools, DynamicRestServlet, ErrorServlet, FormTag, HiddenPageTag, InitTag, LinkTag, LinkTag, MainServlet, RestModuleSupport, RestRequestHandlerBase, RestServlet, SinglePageCatalogModule, Topics10Servlet, Topics11Servlet, Topics12Servlet, Topics13Servlet, Topics14Servlet, Topics15Servlet, Topics16Servlet, Topics1Servlet, Topics2Servlet, Topics3Servlet, Topics4Servlet, Topics5Servlet, Topics6Servlet, Topics7Servlet, Topics8Servlet, Topics9Servlet, TopicsModule, WebServiceServletRequestContext, WebServletRequestContext, WriteExceptionTag

public interface ControllerConstants
extends AttributeKeys

Miscellaneous useful controller-related constants:

• Navigation keys that control navigation on links and action methods.
• Special HTTP parameters used by the framework.
• Context init parameters that affect the framework.
• Special pages and mappings used by the framework.

Field Summary

static java.lang.String	_METHOD_PARAM Used in REST render requests to select the render method ( view ) to execute; if it's not a default view.
static java.lang.String	_PAGE_PARAM Used in custom login pages to maintain a reference to the required page.
static java.lang.String	_ROOT_PARAM This parameters may be added to links in an application to indicate that the link must be created at the first part of the navigation flow ( just after the default stage in the navigation ).
static java.lang.String	DEFAULT_VIEW System default logical view.
static java.lang.String	ERROR_URL System error mapping.
static java.lang.String	ERROR_VIEW System error logical view.
static java.lang.String	LOAD_CANCEL This constant is used in links and as return value of actions to indicate that if one is in a group of stages in the flow, the page should return the the stage just previous to the start of the given group.
static java.lang.String	LOAD_CURRENT This constant is used in links and as return value of actions to indicate that the current page in the navigation flow must be reloaded.
static java.lang.String	LOAD_DEFAULT This constant is used in links and as return value of actions to indicate that the default stage in the navigation flow must be loaded.
static java.lang.String	LOAD_ERROR This constant is used in return value of actions to indicate that the global error page must be called.
static java.lang.String	LOAD_PREVIOUS This constant is used in links and as return value of actions to indicate that the previous page in the navigation flow must be reloaded.

Fields inherited from interface com.acsinet_solutions.cetia4.controller.AttributeKeys

_BUNDLE_KEY, _CONFIGURATION_KEY, _DEFAULT_CONTROLLER_KEY, _FORM_ACTION_KEY, _FORM_ATTRIBUTE_KEY, _LOCALE_KEY, _MESSAGE_KEY, _NAVIGATION_FLOW_KEY, _PORTAL_PATH_KEY, _RENDER_PARAMETERS_KEY, _SERVICE_LOCATOR_KEY, _SESSION_KEY, _SYSTEM_EXCEPTION_KEY, _VALIDATION_EXCEPTION_KEY

Field Detail

LOAD_CURRENT

static final java.lang.String LOAD_CURRENT

This constant is used in links and as return value of actions to indicate that the current page in the navigation flow must be reloaded. The literal value of this constant ( JSP pages ) is "#current". Java code should always use the constant reference.

For stateless web service actions, this constant ( or others ) has no effect ( except LOAD_ERROR ).

See Also:

NavigationFlow.getCurrentStage(), ControllerTools.getSpecialLink(NavigationFlow,String), Constant Field Values

LOAD_PREVIOUS

static final java.lang.String LOAD_PREVIOUS

This constant is used in links and as return value of actions to indicate that the previous page in the navigation flow must be reloaded. The literal value of this constant ( JSP pages ) is "#previous". Java code should always use the constant reference.

For stateless web service actions, this constant ( or others ) has no effect ( except LOAD_ERROR ).

See Also:

NavigationFlow.getPreviousStage(), ControllerTools.getSpecialLink(NavigationFlow,String), Constant Field Values

LOAD_CANCEL

static final java.lang.String LOAD_CANCEL

This constant is used in links and as return value of actions to indicate that if one is in a group of stages in the flow, the page should return the the stage just previous to the start of the given group. The literal value of this constant ( JSP pages ) is "#cancel". Java code should always use the constant reference.

For stateless web service actions, this constant ( or others ) has no effect ( except LOAD_ERROR ).

See Also:

NavigationFlow.getCancelStage(), ControllerTools.getSpecialLink(NavigationFlow,String), Constant Field Values

LOAD_DEFAULT

static final java.lang.String LOAD_DEFAULT

This constant is used in links and as return value of actions to indicate that the default stage in the navigation flow must be loaded. The default stage is always the first stage in the flow, and is not deletable or changeable. It may be configured on a render method of a servlet using the DefaultController meta attribute. The literal value of this constant ( JSP pages ) is "#default". Java code should always use the constant reference.

For stateless web service actions, this constant ( or others ) has no effect ( except LOAD_ERROR ).

See Also:

NavigationFlow.getPreviousStage(), ControllerTools.getSpecialLink(NavigationFlow,String), DefaultController, MainServlet, Constant Field Values

LOAD_ERROR

static final java.lang.String LOAD_ERROR

This constant is used in return value of actions to indicate that the global error page must be called. The literal value of this constant ( JSP pages ) is "#error". Java code should always use the constant reference.

This return value is interpreted in web and web service calls. The error URL is called using redirection on web applications. The error view is called by the error servlet or by a web service action call. Special constants are defined for both error URL and error view name.

See Also:

RestRequestHandlerBase.getSpecialRenderLink(WebServletRequestContext,String), ERROR_URL, ERROR_VIEW, Constant Field Values

_METHOD_PARAM

static final java.lang.String _METHOD_PARAM

Used in REST render requests to select the render method ( view ) to execute; if it's not a default view. Default views have an empty value. Used int REST action requests to select the method to execute. By default POST requests use "update", PUT requests use "create" and DELETE requests use "delete".

This is an HTTP parameter for use in URLs.

See Also:

RequestContext.getMethod(), RestServlet, ControllerTools#getDefaultDeleteMethod(), ControllerTools#getDefaultPostMethod(), ControllerTools#getDefaultPutMethod(), Constant Field Values

_PAGE_PARAM

static final java.lang.String _PAGE_PARAM

Used in custom login pages to maintain a reference to the required page. Custom login page support is not currently implemented.

This is an HTTP parameter automatically used by the framework in login redirection URLs.

See Also:

AbstractRestServlet.redirectToLoginPage(ServletRequestContext), Constant Field Values

_ROOT_PARAM

static final java.lang.String _ROOT_PARAM

This parameters may be added to links in an application to indicate that the link must be created at the first part of the navigation flow ( just after the default stage in the navigation ). To avoid navigation problems, this parameter is deleted from the saved link in the navigation flow when a stage is created. It is only relevant for web related links, in web services the parameter is completely ignored.

This is an HTTP parameter for use in URLs.

See Also:

Constant Field Values

ERROR_URL

static final java.lang.String ERROR_URL

System error mapping. It is maintained different from error view to help maintain a REST hierarchy if needed. Error servlet should be mapped using this URL in an application, for example:

      
        error
        com.acsinet_solutions.cetia4.controller.support.ErrorServlet
      
      
        error
        /error
      
 

See Also:

ErrorServlet, Constant Field Values

DEFAULT_VIEW

static final java.lang.String DEFAULT_VIEW

System default logical view. It is used for web service actions to provide the generic view that will answer them. In web service actions, an XML response is given to a client. There's no redirection to another resource as it occurs in typical web actions. No special or explicit String responses on the method are followed except LOAD_ERROR. In the default handler implementation, all other responses are forwarded to the default view, that is /WEB-INF/xml/module/default.jsp. Future versions will likely perform a view dispatch based on the action name, but for now, all requests that are not errors result in a dispatch to this default view.

See Also:

com.acsinet_solutions.cetia4.controller.rest.WebServiceActionRequestHandler#handleRequest(ServletRequestContext), Constant Field Values

ERROR_VIEW

static final java.lang.String ERROR_VIEW

System error logical view. Used in render requests and in web service action requests. Also used as the output view of ErrorServlet.

See Also:

ErrorServlet, Constant Field Values