com.technia.tvc.core.util

Class ActionUtils

java.lang.Object

com.technia.tvc.core.util.ActionUtils

public final class ActionUtils
extends java.lang.Object

Since:

forever

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	DEFAULT_SERVLET_MAPPING
static java.lang.String	ERROR_FORWARD
static java.lang.String	LOGIN_FORWARD
static java.lang.String	MISSING_PARAMETER_ERROR_KEY
static java.lang.String	OBJECTID_REQUIRED_IN_3DDASHBOARD
static java.lang.String	UNEXPECTED_ERROR_KEY

Method Summary

Modifier and Type	Method and Description
static com.technia.tvc.struts.action.ActionForward	findErrorForward(javax.servlet.http.HttpServletRequest request, javax.servlet.ServletContext ctx, com.technia.tvc.struts.action.ActionMapping mapping)
static com.technia.tvc.struts.action.ActionForward	findForward(javax.servlet.http.HttpServletRequest request, javax.servlet.ServletContext ctx, com.technia.tvc.struts.action.ActionMapping mapping, java.lang.String name)
static com.technia.tvc.struts.action.ActionForward	findLoginForward(javax.servlet.http.HttpServletRequest request, javax.servlet.ServletContext ctx, com.technia.tvc.struts.action.ActionMapping mapping)
static void	forward(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, javax.servlet.ServletContext ctx, com.technia.tvc.struts.action.ActionForward forward)
static void	forward(javax.servlet.jsp.PageContext pageContext, com.technia.tvc.struts.action.ActionForward forward)
static void	forwardToAction(javax.servlet.jsp.PageContext pc, java.lang.String path) Forward the request to the specified action.
static void	forwardToAction(javax.servlet.ServletContext sc, javax.servlet.ServletRequest req, javax.servlet.ServletResponse resp, java.lang.String path) Forward the request to the specified action.
static javax.servlet.RequestDispatcher	getActionRequestDispatcher(javax.servlet.ServletContext sc, java.lang.String path) Returns a request dispatched to the specified action.
static java.lang.String	getActionURL(javax.servlet.http.HttpServletRequest request, javax.servlet.ServletContext ctx, java.lang.String path) Deprecated. Deprecated since 6.1.0
static java.lang.String	getActionURL(javax.servlet.http.HttpServletRequest request, javax.servlet.ServletContext ctx, java.lang.String path, boolean absolute) Deprecated. Deprecated since 6.1.0
static java.lang.String	getActionURL(javax.servlet.http.HttpServletRequest request, java.lang.String path) Returns an absolute URL to the specified action.
static java.lang.String	getActionURL(javax.servlet.http.HttpServletRequest request, java.lang.String path, boolean absolute) Returns an absolute or relative URL to the specified action.
static java.lang.String	getActionURL(javax.servlet.jsp.PageContext pageContext, java.lang.String path) Returns an absolute URL to the specified action.
static java.lang.String	getActionURL(javax.servlet.jsp.PageContext pageContext, java.lang.String path, boolean absolute) Returns an absolute or relative URL to the specified action.
static java.lang.String	getActionURL(java.lang.String path)
static matrix.db.Context	getContext(javax.servlet.http.HttpServletRequest request)
static com.technia.tvc.struts.action.ActionMapping	getMapping(javax.servlet.http.HttpServletRequest request)
static java.lang.String	getServletMapping() Returns the servlet mapping.
static java.lang.String	getServletMapping(javax.servlet.ServletContext ctx) Deprecated. Deprecated since 6.1.0
static boolean	isLoggedIn(javax.servlet.http.HttpServletRequest request)

Methods inherited from class java.lang.Object

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

Field Detail

ERROR_FORWARD

public static final java.lang.String ERROR_FORWARD

See Also:

Constant Field Values

LOGIN_FORWARD

public static final java.lang.String LOGIN_FORWARD

See Also:

Constant Field Values

UNEXPECTED_ERROR_KEY

public static final java.lang.String UNEXPECTED_ERROR_KEY

See Also:

Constant Field Values

MISSING_PARAMETER_ERROR_KEY

public static final java.lang.String MISSING_PARAMETER_ERROR_KEY

See Also:

Constant Field Values

OBJECTID_REQUIRED_IN_3DDASHBOARD

public static final java.lang.String OBJECTID_REQUIRED_IN_3DDASHBOARD

See Also:

Constant Field Values

DEFAULT_SERVLET_MAPPING

public static final java.lang.String DEFAULT_SERVLET_MAPPING

See Also:

Constant Field Values

Method Detail

getContext

public static matrix.db.Context getContext(javax.servlet.http.HttpServletRequest request)
                                    throws TVCException

Throws:

TVCException

isLoggedIn

public static boolean isLoggedIn(javax.servlet.http.HttpServletRequest request)

findForward

public static com.technia.tvc.struts.action.ActionForward findForward(javax.servlet.http.HttpServletRequest request,
                                                                      javax.servlet.ServletContext ctx,
                                                                      com.technia.tvc.struts.action.ActionMapping mapping,
                                                                      java.lang.String name)

findErrorForward

public static com.technia.tvc.struts.action.ActionForward findErrorForward(javax.servlet.http.HttpServletRequest request,
                                                                           javax.servlet.ServletContext ctx,
                                                                           com.technia.tvc.struts.action.ActionMapping mapping)

findLoginForward

public static com.technia.tvc.struts.action.ActionForward findLoginForward(javax.servlet.http.HttpServletRequest request,
                                                                           javax.servlet.ServletContext ctx,
                                                                           com.technia.tvc.struts.action.ActionMapping mapping)

forward

public static void forward(javax.servlet.http.HttpServletRequest request,
                           javax.servlet.http.HttpServletResponse response,
                           javax.servlet.ServletContext ctx,
                           com.technia.tvc.struts.action.ActionForward forward)
                    throws javax.servlet.ServletException,
                           java.io.IOException

Throws:

javax.servlet.ServletException

java.io.IOException

forward

public static void forward(javax.servlet.jsp.PageContext pageContext,
                           com.technia.tvc.struts.action.ActionForward forward)
                    throws javax.servlet.ServletException,
                           java.io.IOException

Throws:

javax.servlet.ServletException

java.io.IOException

getMapping

public static com.technia.tvc.struts.action.ActionMapping getMapping(javax.servlet.http.HttpServletRequest request)

getServletMapping

@Deprecated
public static java.lang.String getServletMapping(javax.servlet.ServletContext ctx)

Deprecated. Deprecated since 6.1.0

See Also:

getServletMapping()

getServletMapping

public static java.lang.String getServletMapping()

Returns the servlet mapping.

Returns:

Returns the servlet mapping.

Since:

6.1.0

getActionURL

public static java.lang.String getActionURL(javax.servlet.jsp.PageContext pageContext,
                                            java.lang.String path)

Returns an absolute URL to the specified action.

getActionURL

public static java.lang.String getActionURL(javax.servlet.jsp.PageContext pageContext,
                                            java.lang.String path,
                                            boolean absolute)

Returns an absolute or relative URL to the specified action. Note that relative URLs will be based on the server root (i.e., context-path + url-to-action).

getActionURL

@Deprecated
public static java.lang.String getActionURL(javax.servlet.http.HttpServletRequest request,
                                                        javax.servlet.ServletContext ctx,
                                                        java.lang.String path)

Deprecated. Deprecated since 6.1.0

See Also:

getActionURL(HttpServletRequest, String)

getActionURL

public static java.lang.String getActionURL(javax.servlet.http.HttpServletRequest request,
                                            java.lang.String path)

Returns an absolute URL to the specified action.

getActionURL

@Deprecated
public static java.lang.String getActionURL(javax.servlet.http.HttpServletRequest request,
                                                        javax.servlet.ServletContext ctx,
                                                        java.lang.String path,
                                                        boolean absolute)

Deprecated. Deprecated since 6.1.0

See Also:

getActionURL(HttpServletRequest, String, boolean)

getActionURL

public static java.lang.String getActionURL(javax.servlet.http.HttpServletRequest request,
                                            java.lang.String path,
                                            boolean absolute)

Returns an absolute or relative URL to the specified action. Note that relative URLs will be based on the server root (i.e., context-path + url-to-action).

Parameters:

request - The request that holds information on the current context path, host, port, etc.

path - The path to the action (without servlet mapping).

absolute - Whether the URL should be absolute or not.

Returns:

The URL to the specified action.

getActionURL

public static java.lang.String getActionURL(java.lang.String path)

Parameters:

path - The path.

Returns:

the path to the specified action. Note that the returned URL is relative to the context-root

Since:

2010.3.0

getActionRequestDispatcher

public static javax.servlet.RequestDispatcher getActionRequestDispatcher(javax.servlet.ServletContext sc,
                                                                         java.lang.String path)

Returns a request dispatched to the specified action.

Parameters:

sc - The servlet context in which the TVC servlet is deployed.

path - The path to the action (without servlet-mapping).

Returns:

A request dispatcher that can be used to dispatch requests to the specified action.

forwardToAction

public static void forwardToAction(javax.servlet.ServletContext sc,
                                   javax.servlet.ServletRequest req,
                                   javax.servlet.ServletResponse resp,
                                   java.lang.String path)
                            throws java.io.IOException,
                                   javax.servlet.ServletException

Forward the request to the specified action.

Parameters:

sc - The servlet context in which the TVC servlet is deployed.

req - The request to forward.

resp - The response to forward.

path - The path to the action (without servlet mapping).

Throws:

java.io.IOException - If an IO error occurs.

javax.servlet.ServletException - If a servlet error occurs.

forwardToAction

public static void forwardToAction(javax.servlet.jsp.PageContext pc,
                                   java.lang.String path)
                            throws java.io.IOException,
                                   javax.servlet.ServletException

Forward the request to the specified action.

Parameters:

pc - The current page context.

path - The path to the action (without servlet mapping).

Throws:

java.io.IOException - If an IO error occurs.

javax.servlet.ServletException - If a servlet error occurs.