org.apache.beehive.netui.pageflow
Class PageFlowUtils

Object
  extended by PageFlowUtils

public class PageFlowUtils
extends Object

Utility methods related to Page Flow.


Constructor Summary
PageFlowUtils()
           
 
Method Summary
static void addActionOutput(String name, Object value, ServletRequest request)
          Set a named action output, which corresponds to an input declared by the pageInput JSP tag.
static void addBindingUpdateError(ServletRequest request, String expression, String message, Throwable e)
          Deprecated. This is an internal utility. InternalUtils.addBindingUpdateError(javax.servlet.ServletRequest, java.lang.String, java.lang.String, java.lang.Throwable) can be used, but it is not guaranteed to be supported in the future.
static void addPageInput(String name, Object value, ServletRequest request)
          Deprecated. Use addActionOutput(java.lang.String, java.lang.Object, javax.servlet.ServletRequest) instead.
static void addValidationError(String propertyName, String messageKey, Object[] messageArgs, ServletRequest request)
          Add a validation error that will be shown with the Errors and Error tags.
static void addValidationError(String propertyName, String messageKey, Object messageArg, ServletRequest request)
          Add a validation error that will be shown with the Errors and Error tags.
static void addValidationError(String propertyName, String messageKey, ServletRequest request)
          Add a validation error that will be shown with the Errors and Error tags.
static void deleteGlobalApp(HttpServletRequest request)
           
static void deleteSharedFlow(String sharedFlowClassName, HttpServletRequest request)
           
static void deleteSingletonPageFlow(String modulePath, HttpServletRequest request)
          Delete a "singleton" page flow from the session.
static void destroyPageFlowStack(HttpServletRequest request)
          Deprecated. Use PageFlowStack.destroy(javax.servlet.http.HttpServletRequest) instead.
static void dumpRequest(HttpServletRequest request, PrintStream output)
          Deprecated. This is an internal utility. InternalUtils.dumpRequest(javax.servlet.http.HttpServletRequest, java.io.PrintStream) can be used, but it is not guaranteed to be supported in the future.
static void dumpServletContext(ServletContext context, PrintStream output)
          Deprecated. This is an internal utility. InternalUtils.dumpServletContext(javax.servlet.ServletContext, java.io.PrintStream) can be used, but it is not guaranteed to be supported in the future.
static boolean ensureAppDeployment(HttpServletRequest request, HttpServletResponse response, ServletContext servletContext)
          Deprecated. This method no longer has any effect, and will be removed without replacement in a future release.
static PageFlowController ensureCurrentPageFlow(HttpServletRequest request, HttpServletResponse response)
          Deprecated. Use getCurrentPageFlow(javax.servlet.http.HttpServletRequest) instead.
static PageFlowController ensureCurrentPageFlow(HttpServletRequest request, HttpServletResponse response, ServletContext servletContext)
          Deprecated. Use getCurrentPageFlow(javax.servlet.http.HttpServletRequest) instead.
static GlobalApp ensureGlobalApp(HttpServletRequest request, HttpServletResponse response)
          Deprecated. Use getGlobalApp(javax.servlet.http.HttpServletRequest) instead.
static GlobalApp ensureGlobalApp(HttpServletRequest request, HttpServletResponse response, ServletContext servletContext)
          Deprecated. Use getGlobalApp(javax.servlet.http.HttpServletRequest) instead.
static ModuleConfig ensureModuleConfig(String modulePath, ServletRequest request, ServletContext context)
          Deprecated. This is an internal utility. InternalUtils.ensureModuleConfig(java.lang.String, javax.servlet.ServletRequest, javax.servlet.ServletContext) can be used, but it is not guaranteed to be supported in the future.
static Object getActionOutput(String name, ServletRequest request)
          Get a named action output that was registered in the current request.
static String getActionURI(ServletRequest request)
          Get the most recent action URI that was processed by FlowController.execute(org.apache.struts.action.ActionMapping, org.apache.struts.action.ActionForm, javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse).
static String getBeginActionURI(String requestURI)
          Get a URI for the "begin" action in the PageFlowController associated with the given request URI.
static Map getBindingUpdateErrors(ServletRequest request)
          Deprecated. This is an internal utility. InternalUtils.getBindingUpdateErrors(javax.servlet.ServletRequest) can be used, but it is not guaranteed to be supported in the future.
static ActionResolver getCurrentActionResolver(HttpServletRequest request)
          Get the current ActionResolver (PageFlowController).
static PageFlowController getCurrentPageFlow(HttpServletRequest request)
          Get the current PageFlowController.
static String getFileExtension(String filename)
          Deprecated. Use FileUtils.getFileExtension(java.lang.String) instead.
static String getFormBeanName(ActionForm formInstance, HttpServletRequest request)
          Get the name for the type of a ActionForm instance.
static String getFormBeanName(Class formBeanClass, HttpServletRequest request)
          Get the name for an ActionForm type.
static GlobalApp getGlobalApp(HttpServletRequest request)
          Get the current GlobalApp instance.
static ModuleConfig getGlobalAppConfig(ServletContext servletContext)
          Deprecated. This will be removed with no replacement in a future release.
static String getJpfClassName(String uri)
          Get the class name of a PageFlowController, given the URI to it.
static ModuleConfig getModuleConfig(String modulePath, ServletContext context)
          Deprecated. This is an internal utility. InternalUtils.getModuleConfig(java.lang.String, javax.servlet.ServletContext) can be used, but it is not guaranteed to be supported in the future.
static String getModuleConfPath(String modulePath)
          Deprecated. Use PageFlowActionServlet.getModuleConfPath(java.lang.String) instead. Get the path to the Struts module configration file (e.g., "/WEB-INF/.pageflow-struts-generated/jpf-struts-config-someModule") for a given module path (e.g., "someModule"), according to the PageFlow convention.
static String getModulePath(HttpServletRequest request)
          Get the Struts module path for the current request URI.
static String getModulePath(HttpServletRequest request, String requestURI)
          Get the Struts module path for a URI.
static String getModulePathForRelativeURI(String uri)
          Get the Struts module path for a URI that is relative to the web application root.
static PageFlowController getNestingPageFlow(HttpServletRequest request)
          Get the PageFlowController that is nesting the current one.
static String getPageFlowClassName(String modulePath, ServletRequest request, ServletContext context)
          Deprecated. This is an internal utility. InternalUtils.getFlowControllerClassName(java.lang.String, javax.servlet.ServletRequest, javax.servlet.ServletContext) can be used, but it is not guaranteed to be supported in the future.
static Stack getPageFlowStack(HttpServletRequest request)
          Deprecated. Use PageFlowStack.get(javax.servlet.http.HttpServletRequest) instead.
static String getPageFlowURI(String className)
          Get the URI for a PageFlowController, given its class name.
static Object getPageInput(String name, ServletRequest request)
          Deprecated. Use getActionOutput(java.lang.String, javax.servlet.ServletRequest) instead.
static String getRelativeURI(HttpServletRequest request, PageFlowController relativeTo)
          Get the request URI, relative to the URI of the given PageFlowController.
static String getRelativeURI(HttpServletRequest request, String uri, PageFlowController relativeTo)
          Get a URI relative to the URI of the given PageFlowController.
static SharedFlowController getSharedFlow(HttpServletRequest request, ServletContext servletContext)
           
static SharedFlowController getSharedFlow(String sharedFlowClassName, HttpServletRequest request)
           
static PageFlowController getSingletonPageFlow(String modulePath, HttpServletRequest request)
          Get the singleton page flow instance associated with the given module (directory) path.
static boolean isAbsoluteURI(String uri)
          Deprecated. Use FileUtils.isAbsoluteURI(java.lang.String) instead.
static Boolean isSecureResource(String uri, ServletContext context)
          Deprecated. Use isSecureResource(String, ServletContext, HttpServletRequest) instead.
static Boolean isSecureResource(String uri, ServletContext servletContext, HttpServletRequest request)
          Tell whether a web application resource requires a secure transport protocol.
static void preventCache(HttpServletResponse response)
          Deprecated. Use ServletUtils.preventCache(javax.servlet.http.HttpServletResponse) instead.
static void setCurrentActionResolver(ActionResolver resolver, HttpServletRequest request)
          Deprecated. This is an internal utility. InternalUtils.setCurrentActionResolver(org.apache.beehive.netui.pageflow.ActionResolver, javax.servlet.http.HttpServletRequest) can be used, but it is not guaranteed to be supported in the future.
static void setOutputForm(ActionMapping mapping, ActionForm form, HttpServletRequest request, boolean overwrite)
          Make a form bean available as an attributet in the request/session (as appropriate).
static void setOutputForms(ActionMapping mapping, ActionForm[] outputForms, HttpServletRequest request)
          Make a set of form beans available as attributets in the request/session (as appropriate).
static void setOutputForms(ActionMapping mapping, ActionForm[] outputForms, HttpServletRequest request, boolean overwrite)
          Make a set of form beans available as attributets in the request/session (as appropriate).
static void setOutputForms(ActionMapping mapping, Forward fwd, HttpServletRequest request)
          Make any form beans in the given Forward object available as attributets in the request/session (as appropriate).
static void setOutputForms(ActionMapping mapping, Forward fwd, HttpServletRequest request, boolean overwrite)
          Make any form beans in the given Forward object available as attributets in the request/session (as appropriate).
static ActionResult strutsLookup(ServletContext context, ServletRequest request, HttpServletResponse response, String actionOverride, String[] autoResolveExtensions)
          Resolve the given action to a URI by running an entire request-processing cycle on the given ScopedRequest and ScopedResponse.
static HttpServletRequest unwrapMultipart(HttpServletRequest request)
          If the given request is a MultipartRequestWrapper (Struts class that doesn't extend HttpServletRequestWrapper), return the wrapped request; otherwise, return the given request.
 
Methods inherited from class Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

PageFlowUtils

public PageFlowUtils()
Method Detail

getModulePath

public static String getModulePath(HttpServletRequest request,
                                   String requestURI)
Get the Struts module path for a URI. This is the parent directory, relative to the web application root, of the file referenced by the URI.

Parameters:
request - the current HttpServletRequest.
requestURI - the URI for which to get the Struts module path.

getModulePath

public static String getModulePath(HttpServletRequest request)
Get the Struts module path for the current request URI. This is the parent directory, relative to the web application root, of the file referenced by the request URI.

Parameters:
request - the current HttpServletRequest.

getModulePathForRelativeURI

public static String getModulePathForRelativeURI(String uri)
Get the Struts module path for a URI that is relative to the web application root.

Parameters:
uri - the URI for which to get the module path.

getRelativeURI

public static final String getRelativeURI(HttpServletRequest request,
                                          PageFlowController relativeTo)
Get the request URI, relative to the URI of the given PageFlowController.

Parameters:
request - the current HttpServletRequest.
relativeTo - a PageFlowController to which the returned URI should be relative, or null if the returned URI should be relative to the webapp root.

getRelativeURI

public static final String getRelativeURI(HttpServletRequest request,
                                          String uri,
                                          PageFlowController relativeTo)
Get a URI relative to the URI of the given PageFlowController.

Parameters:
request - the current HttpServletRequest.
uri - the URI which should be made relative.
relativeTo - a PageFlowController to which the returned URI should be relative, or null if the returned URI should be relative to the webapp root.

getBeginActionURI

public static String getBeginActionURI(String requestURI)
Get a URI for the "begin" action in the PageFlowController associated with the given request URI.

Returns:
a String that is the URI for the "begin" action in the PageFlowController associated with the given request URI.

getPageFlowStack

public static final Stack getPageFlowStack(HttpServletRequest request)
Deprecated. Use PageFlowStack.get(javax.servlet.http.HttpServletRequest) instead.

Get the stack of nested page flows for the current user session. Create and store an empty stack if none exists.

Parameters:
request - the current HttpServletRequest
Returns:
a PageFlowStack of nested page flows (PageFlowControllers) for the current user session.

destroyPageFlowStack

public static void destroyPageFlowStack(HttpServletRequest request)
Deprecated. Use PageFlowStack.destroy(javax.servlet.http.HttpServletRequest) instead.

Destroys the stack of PageFlowControllers that have invoked nested page flows.

Parameters:
request - the current HttpServletRequest.

getNestingPageFlow

public static PageFlowController getNestingPageFlow(HttpServletRequest request)
Get the PageFlowController that is nesting the current one.

Parameters:
request - the current HttpServletRequest.
Returns:
the nesting PageFlowController, or null if the current one is not being nested.

getCurrentPageFlow

public static final PageFlowController getCurrentPageFlow(HttpServletRequest request)
Get the current PageFlowController.

Parameters:
request - the current HttpServletRequest.
Returns:
the current PageFlowController from the user session, or null if there is none.

getCurrentActionResolver

public static ActionResolver getCurrentActionResolver(HttpServletRequest request)
Get the current ActionResolver (PageFlowController).

Returns:
the current ActionResolver from the user session, or null if there is none.

getGlobalApp

public static GlobalApp getGlobalApp(HttpServletRequest request)
Get the current GlobalApp instance.

Parameters:
request - the current HttpServletRequest.
Returns:
the current GlobalApp from the user session, or null if none exists.

getSharedFlow

public static SharedFlowController getSharedFlow(HttpServletRequest request,
                                                 ServletContext servletContext)

getSharedFlow

public static SharedFlowController getSharedFlow(String sharedFlowClassName,
                                                 HttpServletRequest request)

deleteGlobalApp

public static void deleteGlobalApp(HttpServletRequest request)

deleteSharedFlow

public static void deleteSharedFlow(String sharedFlowClassName,
                                    HttpServletRequest request)

deleteSingletonPageFlow

public static void deleteSingletonPageFlow(String modulePath,
                                           HttpServletRequest request)
Delete a "singleton" page flow from the session. Once it is created, a singleton page flow is never removed from the session unless this method or FlowController.delete() is called. Navigating to another page flow hides the current singleton controller, but does not remove it.


getSingletonPageFlow

public static PageFlowController getSingletonPageFlow(String modulePath,
                                                      HttpServletRequest request)
Get the singleton page flow instance associated with the given module (directory) path.

Parameters:
modulePath - the webapp-relative path to the directory containing the singleton page flow.
request - the current HttpServletRequest.
Returns:
the singleton page flow instance associated with the given module, or null if none is found.

setOutputForms

public static void setOutputForms(ActionMapping mapping,
                                  Forward fwd,
                                  HttpServletRequest request,
                                  boolean overwrite)
Make any form beans in the given Forward object available as attributets in the request/session (as appropriate).

Parameters:
mapping - the ActionMapping for the current Struts action being processed.
fwd - the Forward object that contains the ActionForm instances to be made available in the request/session (as appropriate).
request - the current HttpServletRequest.
overwrite - if false a form from fwd will only be set in the request if there is no existing form with the same name.

setOutputForms

public static void setOutputForms(ActionMapping mapping,
                                  Forward fwd,
                                  HttpServletRequest request)
Make any form beans in the given Forward object available as attributets in the request/session (as appropriate).

Parameters:
mapping - the ActionMapping for the current Struts action being processed.
fwd - the Forward object that contains the ActionForm instances to be made available in the request/session (as appropriate).
request - the current HttpServletRequest.

setOutputForms

public static void setOutputForms(ActionMapping mapping,
                                  ActionForm[] outputForms,
                                  HttpServletRequest request)
Make a set of form beans available as attributets in the request/session (as appropriate).

Parameters:
mapping - the ActionMapping for the current Struts action being processed.
outputForms - an array of ActionForm instances to be made available in the request/session (as appropriate).
request - the current HttpServletRequest.

setOutputForms

public static void setOutputForms(ActionMapping mapping,
                                  ActionForm[] outputForms,
                                  HttpServletRequest request,
                                  boolean overwrite)
Make a set of form beans available as attributets in the request/session (as appropriate).

Parameters:
mapping - the ActionMapping for the current Struts action being processed.
outputForms - an array of ActionForm instances to be made available in the request/session (as appropriate).
overwrite - if false a form from fwd will only be set in the request if there is no existing form with the same name.
request - the current HttpServletRequest.

setOutputForm

public static void setOutputForm(ActionMapping mapping,
                                 ActionForm form,
                                 HttpServletRequest request,
                                 boolean overwrite)
Make a form bean available as an attributet in the request/session (as appropriate).

Parameters:
mapping - the ActionMapping for the current Struts action being processed.
form - an ActionForm instance to be made available in the request/session (as appropriate).
overwrite - if false a form from fwd will only be set in the request if there is no existing form with the same name.
request - the current HttpServletRequest.

getFormBeanName

public static String getFormBeanName(ActionForm formInstance,
                                     HttpServletRequest request)
Get the name for the type of a ActionForm instance. Use a name looked up from the current Struts module, or, if none is found, create one.

Parameters:
formInstance - the ActionForm instance whose type will determine the name.
request - the current HttpServletRequest, which contains a reference to the current Struts module.
Returns:
the name found in the Struts module, or, if none is found, a name that is either:
  • a camel-cased version of the base class name (minus any package or outer-class qualifiers, or, if that name is already taken,
  • the full class name, with '.' and '$' replaced by '_'.

getFormBeanName

public static String getFormBeanName(Class formBeanClass,
                                     HttpServletRequest request)
Get the name for an ActionForm type. Use a name looked up from the current Struts module, or, if none is found, create one.

Parameters:
formBeanClass - the ActionForm-derived class whose type will determine the name.
request - the current HttpServletRequest, which contains a reference to the current Struts module.
Returns:
the name found in the Struts module, or, if none is found, a name that is either:
  • a camel-cased version of the base class name (minus any package or outer-class qualifiers, or, if that name is already taken,
  • the full class name, with '.' and '$' replaced by '_'.

getJpfClassName

public static String getJpfClassName(String uri)
Get the class name of a PageFlowController, given the URI to it.

Parameters:
uri - the URI to the PageFlowController, which should be relative to the web application root (i.e., it should not include the context path).

getPageFlowURI

public static String getPageFlowURI(String className)
Get the URI for a PageFlowController, given its class name.

Parameters:
className - the name of the PageFlowController class.
Returns:
a String that is the URI for the PageFlowController, relative to the web application root (i.e., not including the context path).

getModuleConfPath

public static String getModuleConfPath(String modulePath)
Deprecated. Use PageFlowActionServlet.getModuleConfPath(java.lang.String) instead. Get the path to the Struts module configration file (e.g., "/WEB-INF/.pageflow-struts-generated/jpf-struts-config-someModule") for a given module path (e.g., "someModule"), according to the PageFlow convention.

Parameters:
modulePath - the Struts module path.
Returns:
a String that is the path to the Struts configuration file, relative to the web application root.

getActionURI

public static String getActionURI(ServletRequest request)
Get the most recent action URI that was processed by FlowController.execute(org.apache.struts.action.ActionMapping, org.apache.struts.action.ActionForm, javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse).

Parameters:
request - the current ServletRequest.
Returns:
a String that is the most recent action URI. This is only valid during a request that has been forwarded from the action URI.

isSecureResource

public static Boolean isSecureResource(String uri,
                                       ServletContext servletContext,
                                       HttpServletRequest request)
Tell whether a web application resource requires a secure transport protocol. This is determined from web.xml; for example, the following block specifies that all resources under /login require a secure transport protocol.
    <security-constraint>
        <web-resource-collection>
          <web-resource-name>Secure PageFlow - begin</web-resource-name> 
          <url-pattern>/login/*</url-pattern>
        </web-resource-collection>
        <user-data-constraint>
           <transport-guarantee>CONFIDENTIAL</transport-guarantee>
        </user-data-constraint>
    </security-constraint>
 

Parameters:
uri - a webapp-relative URI for a resource. There must not be query parameters or a scheme on the URI.
request - the current request.
Returns:
Boolean.TRUE if a transport-guarantee of CONFIDENTIAL or INTEGRAL is associated with the given resource; Boolean.FALSE a transport-guarantee of NONE is associated with the given resource; or null if there is no transport-guarantee associated with the given resource.

isSecureResource

public static Boolean isSecureResource(String uri,
                                       ServletContext context)
Deprecated. Use isSecureResource(String, ServletContext, HttpServletRequest) instead.


addPageInput

public static void addPageInput(String name,
                                Object value,
                                ServletRequest request)
Deprecated. Use addActionOutput(java.lang.String, java.lang.Object, javax.servlet.ServletRequest) instead.

Set a named action output, which corresponds to an input declared by the pageInput JSP tag. The actual value can be read from within a JSP using the "pageInput" databinding context.

Parameters:
name - the name of the action output.
value - the value of the action output.
request - the current ServletRequest.

addActionOutput

public static void addActionOutput(String name,
                                   Object value,
                                   ServletRequest request)
Set a named action output, which corresponds to an input declared by the pageInput JSP tag. The actual value can be read from within a JSP using the "pageInput" databinding context.

Parameters:
name - the name of the action output.
value - the value of the action output.
request - the current ServletRequest.

getPageInput

public static Object getPageInput(String name,
                                  ServletRequest request)
Deprecated. Use getActionOutput(java.lang.String, javax.servlet.ServletRequest) instead.

Get a named action output that was registered in the current request.

Parameters:
name - the name of the action output.
request - the current ServletRequest
See Also:
addActionOutput(java.lang.String, java.lang.Object, javax.servlet.ServletRequest)

getActionOutput

public static Object getActionOutput(String name,
                                     ServletRequest request)
Get a named action output that was registered in the current request.

Parameters:
name - the name of the action output.
request - the current ServletRequest
See Also:
addActionOutput(java.lang.String, java.lang.Object, javax.servlet.ServletRequest)

addValidationError

public static void addValidationError(String propertyName,
                                      String messageKey,
                                      Object[] messageArgs,
                                      ServletRequest request)
Add a validation error that will be shown with the Errors and Error tags.

Parameters:
propertyName - the name of the property with which to associate this error.
messageKey - the message-resources key for the error message.
messageArgs - an array of arguments for the error message.
request - the current ServletRequest.

addValidationError

public static void addValidationError(String propertyName,
                                      String messageKey,
                                      Object messageArg,
                                      ServletRequest request)
Add a validation error that will be shown with the Errors and Error tags.

Parameters:
propertyName - the name of the property with which to associate this error.
messageKey - the message-resources key for the error message.
messageArg - an argument for the error message.
request - the current ServletRequest.

addValidationError

public static void addValidationError(String propertyName,
                                      String messageKey,
                                      ServletRequest request)
Add a validation error that will be shown with the Errors and Error tags.

Parameters:
propertyName - the name of the property with which to associate this error.
messageKey - the message-resources key for the error message.
request - the current ServletRequest.

strutsLookup

public static ActionResult strutsLookup(ServletContext context,
                                        ServletRequest request,
                                        HttpServletResponse response,
                                        String actionOverride,
                                        String[] autoResolveExtensions)
                                 throws Exception
Resolve the given action to a URI by running an entire request-processing cycle on the given ScopedRequest and ScopedResponse.

Parameters:
context - the current ServletContext
request - the ServletRequest, which must be a ScopedRequest.
response - the ServletResponse, which must be a ScopedResponse.
actionOverride - if not null, this action-name is used to construct an action URI which is set as the request URI.
autoResolveExtensions - a list of URI extensions (e.g., ".do", ".jpf") that will be auto-resolved, i.e., on which this method will be recursively called. If null, the default extensions ".do" and ".jpf" will be used.
Throws:
Exception

unwrapMultipart

public static HttpServletRequest unwrapMultipart(HttpServletRequest request)
If the given request is a MultipartRequestWrapper (Struts class that doesn't extend HttpServletRequestWrapper), return the wrapped request; otherwise, return the given request.


ensureGlobalApp

public static GlobalApp ensureGlobalApp(HttpServletRequest request,
                                        HttpServletResponse response)
Deprecated. Use getGlobalApp(javax.servlet.http.HttpServletRequest) instead.

Get or create the current GlobalApp instance.

Parameters:
request - the current HttpServletRequest.
response - the current HttpServletResponse
Returns:
the current GlobalApp from the user session, or a newly-instantiated one (based on the user's Global.app file) if none was in the session. Failing that, return null.

ensureGlobalApp

public static GlobalApp ensureGlobalApp(HttpServletRequest request,
                                        HttpServletResponse response,
                                        ServletContext servletContext)
Deprecated. Use getGlobalApp(javax.servlet.http.HttpServletRequest) instead.

Get or create the current GlobalApp instance.

Parameters:
request - the current HttpServletRequest.
response - the current HttpServletResponse
Returns:
the current GlobalApp from the user session, or a newly-instantiated one (based on the user's Global.app file) if none was in the session. Failing that, return null.

getBindingUpdateErrors

public static Map getBindingUpdateErrors(ServletRequest request)
Deprecated. This is an internal utility. InternalUtils.getBindingUpdateErrors(javax.servlet.ServletRequest) can be used, but it is not guaranteed to be supported in the future.


ensureModuleConfig

public static ModuleConfig ensureModuleConfig(String modulePath,
                                              ServletRequest request,
                                              ServletContext context)
                                       throws IOException,
                                              ServletException
Deprecated. This is an internal utility. InternalUtils.ensureModuleConfig(java.lang.String, javax.servlet.ServletRequest, javax.servlet.ServletContext) can be used, but it is not guaranteed to be supported in the future.

Throws:
IOException
ServletException

getGlobalAppConfig

public static ModuleConfig getGlobalAppConfig(ServletContext servletContext)
Deprecated. This will be removed with no replacement in a future release.


getModuleConfig

public static ModuleConfig getModuleConfig(String modulePath,
                                           ServletContext context)
Deprecated. This is an internal utility. InternalUtils.getModuleConfig(java.lang.String, javax.servlet.ServletContext) can be used, but it is not guaranteed to be supported in the future.


getFileExtension

public static String getFileExtension(String filename)
Deprecated. Use FileUtils.getFileExtension(java.lang.String) instead.

Get the file extension from a file name.

Parameters:
filename - the file name.
Returns:
the file extension (everything after the last '.'), or the empty string if there is no file extension.

getPageFlowClassName

public static String getPageFlowClassName(String modulePath,
                                          ServletRequest request,
                                          ServletContext context)
Deprecated. This is an internal utility. InternalUtils.getFlowControllerClassName(java.lang.String, javax.servlet.ServletRequest, javax.servlet.ServletContext) can be used, but it is not guaranteed to be supported in the future.


ensureAppDeployment

public static boolean ensureAppDeployment(HttpServletRequest request,
                                          HttpServletResponse response,
                                          ServletContext servletContext)
Deprecated. This method no longer has any effect, and will be removed without replacement in a future release.


isAbsoluteURI

public static boolean isAbsoluteURI(String uri)
Deprecated. Use FileUtils.isAbsoluteURI(java.lang.String) instead.

Tell whether a given URI is absolute, i.e., whether it contains a scheme-part (e.g., "http:").

Parameters:
uri - the URI to test.
Returns:
true if the given URI is absolute.

ensureCurrentPageFlow

public static final PageFlowController ensureCurrentPageFlow(HttpServletRequest request,
                                                             HttpServletResponse response,
                                                             ServletContext servletContext)
Deprecated. Use getCurrentPageFlow(javax.servlet.http.HttpServletRequest) instead.


ensureCurrentPageFlow

public static final PageFlowController ensureCurrentPageFlow(HttpServletRequest request,
                                                             HttpServletResponse response)
Deprecated. Use getCurrentPageFlow(javax.servlet.http.HttpServletRequest) instead.


addBindingUpdateError

public static void addBindingUpdateError(ServletRequest request,
                                         String expression,
                                         String message,
                                         Throwable e)
Deprecated. This is an internal utility. InternalUtils.addBindingUpdateError(javax.servlet.ServletRequest, java.lang.String, java.lang.String, java.lang.Throwable) can be used, but it is not guaranteed to be supported in the future.


dumpRequest

public static void dumpRequest(HttpServletRequest request,
                               PrintStream output)
Deprecated. This is an internal utility. InternalUtils.dumpRequest(javax.servlet.http.HttpServletRequest, java.io.PrintStream) can be used, but it is not guaranteed to be supported in the future.


dumpServletContext

public static void dumpServletContext(ServletContext context,
                                      PrintStream output)
Deprecated. This is an internal utility. InternalUtils.dumpServletContext(javax.servlet.ServletContext, java.io.PrintStream) can be used, but it is not guaranteed to be supported in the future.


preventCache

public static void preventCache(HttpServletResponse response)
Deprecated. Use ServletUtils.preventCache(javax.servlet.http.HttpServletResponse) instead.


setCurrentActionResolver

public static void setCurrentActionResolver(ActionResolver resolver,
                                            HttpServletRequest request)
Deprecated. This is an internal utility. InternalUtils.setCurrentActionResolver(org.apache.beehive.netui.pageflow.ActionResolver, javax.servlet.http.HttpServletRequest) can be used, but it is not guaranteed to be supported in the future.