public class

HttpServletContainerServices

extends AbstractConfigurableContainerServices
java.lang.Object
   ↳ com.microstrategy.web.platform.AbstractConfigurableContainerServices
     ↳ com.microstrategy.web.platform.HttpServletContainerServices
Known Direct Subclasses

Class Overview

This is the implementation class for the ContainerServices interface when application is running in the Java Web Container environment.

This class should ONLY be called and known to by the Main Servlet class and the Tag Libaries.

In the ASPx environment, Web applications should implement another interface DisconnectedContainerServices and are encouraged to extend the reference implementation DisconnectedContainerServicesImpl.

From the perspective of the Web Application Data layer and all other layers which require platform independence, this class should be completely transparent and hidden.

Summary

[Expand]
Inherited Constants
From class com.microstrategy.web.platform.AbstractConfigurableContainerServices
From interface com.microstrategy.web.platform.ContainerServices
[Expand]
Inherited Fields
From class com.microstrategy.web.platform.AbstractConfigurableContainerServices
Public Constructors
HttpServletContainerServices()
Creates a new ServletContainerServices object.
HttpServletContainerServices(boolean hasOutputStream)
Public Methods
void addCookieToResponse(GenericCookie cookie)
String getAppServerInfo()
Object getApplicationAttribute(String name)
String getApplicationPath()
This method returns the application full path of the servlet
int getCodePage()
String getContextPath()
String getControllerName()
ContainerStringCollection getCookieStrings()
ContainerStringCollection getCookieStrings(ContainerServicesNamespace namespace)
ContainerStringCollection getFormAndQueryStrings()
String getHeaderValue(String headerName)
String getMethod()
MultipartRequest getMultipartRequest()
This method is deprecated. this is only used internally by MicroStrategy methods, and may not be visible in future releases
OutputStream getOutputStream()
PostedFile getPostedFile(String name)
String getQueryString()
String getRealPath(String relPath)
String getRemoteAddress()
HttpServletRequest getRequest()
This method retrieves the HttpServletRequest object associated with this class.
Object getRequestAttribute(String name)
String getRequestServerName()
URL getResource(String relPath)
InputStream getResourceAsStream(String relPath)
Set<String> getResourcePaths(String relPath)
HttpServletResponse getResponse()
This method retrieves the HttpServletResponse object associated with this class.
ContainerStringCollection getServerVariables()
ServletConfig getServletConfig()
ServletContext getServletContext()
This method retrieves the ServletContext object associated with this class.
HttpSession getSession()
This method retrieves the HttpSession object associated with this class.
Object getSessionAttribute(String name, ContainerServicesNamespace namespace)
Object getSessionAttribute(String name)
String getSessionID()
int getSessionMaxIdleTime()
ContainerStringCollection getSessionStrings()
ContainerStringCollection getSessionStrings(ContainerServicesNamespace namespace)
int getStatusCode()
boolean hasOutputStream()
void invalidateHttpSession()
boolean isJavaURLSessionSupported()
Indicates if the instance of this container services supports cookieless environments
boolean isRequestSecure()
boolean isSessionlessRequest()
void sendBinaryContent(MarkupOutput mo)
boolean sendError(int sc)
boolean sendError(int sc, String msg)
void setApplicationAttribute(String name, Object value)
void setCodePage(int code)
void setContentType(String type)
void setHeaderValue(String name, String value)
void setJavaURLSessionSupported(boolean value)
Sets if the instance of this container services supports cookieless environments
void setRequest(HttpServletRequest request)
This method sets the HttpServletRequest object which is to be associated with this class.
void setRequestAttribute(String name, Object value)
void setResponse(HttpServletResponse response)
This method sets the HttpServletResponse object which is to be associated with this class.
void setServletConfig(ServletConfig newValue)
void setServletContext(ServletContext servletContext)
This method sets the ServletContext object which is to be associated with this class.
void setSession(HttpSession session)
This method sets the HttpSession object which is to be associated with this class.
void setSessionAttribute(String name, Object value)
void setSessionAttribute(String name, Object value, ContainerServicesNamespace namespace)
void setStatusCode(int statusCode)
Protected Methods
HashList getCookies(ContainerServicesNamespace namespace)
[Expand]
Inherited Methods
From class com.microstrategy.web.platform.AbstractConfigurableContainerServices
From class java.lang.Object
From interface com.microstrategy.web.platform.ContainerServices
From interface com.microstrategy.web.platform.ContainerServicesContext

Public Constructors

public HttpServletContainerServices ()

Creates a new ServletContainerServices object.

public HttpServletContainerServices (boolean hasOutputStream)

Public Methods

public void addCookieToResponse (GenericCookie cookie)

public String getAppServerInfo ()

public Object getApplicationAttribute (String name)

public String getApplicationPath ()

This method returns the application full path of the servlet

Returns
  • A String that indicates the full application path of the servlet. (i.e. http://localhost:8080/MicroStrategy/servlet/)

public int getCodePage ()

public String getContextPath ()

public String getControllerName ()

public ContainerStringCollection getCookieStrings ()

public ContainerStringCollection getCookieStrings (ContainerServicesNamespace namespace)

public ContainerStringCollection getFormAndQueryStrings ()

public String getHeaderValue (String headerName)

public String getMethod ()

public MultipartRequest getMultipartRequest ()

This method is deprecated.
this is only used internally by MicroStrategy methods, and may not be visible in future releases

public OutputStream getOutputStream ()

public PostedFile getPostedFile (String name)

public String getQueryString ()

public String getRealPath (String relPath)

public String getRemoteAddress ()

public HttpServletRequest getRequest ()

This method retrieves the HttpServletRequest object associated with this class.

Returns
  • A HttpServletRequest object.

public Object getRequestAttribute (String name)

public String getRequestServerName ()

public URL getResource (String relPath)

public InputStream getResourceAsStream (String relPath)

public Set<String> getResourcePaths (String relPath)

public HttpServletResponse getResponse ()

This method retrieves the HttpServletResponse object associated with this class.

Returns
  • A HttpServletResponse object.

public ContainerStringCollection getServerVariables ()

public ServletConfig getServletConfig ()

public ServletContext getServletContext ()

This method retrieves the ServletContext object associated with this class.

Returns
  • A ServletContext object.

public HttpSession getSession ()

This method retrieves the HttpSession object associated with this class.

Returns
  • A HttpSession object.

public Object getSessionAttribute (String name, ContainerServicesNamespace namespace)

public Object getSessionAttribute (String name)

public String getSessionID ()

public int getSessionMaxIdleTime ()

public ContainerStringCollection getSessionStrings ()

public ContainerStringCollection getSessionStrings (ContainerServicesNamespace namespace)

public int getStatusCode ()

public boolean hasOutputStream ()

public void invalidateHttpSession ()

public boolean isJavaURLSessionSupported ()

Indicates if the instance of this container services supports cookieless environments

Returns
  • true if cookieless environments are supported

public boolean isRequestSecure ()

public boolean isSessionlessRequest ()

public void sendBinaryContent (MarkupOutput mo)

public boolean sendError (int sc)

public boolean sendError (int sc, String msg)

public void setApplicationAttribute (String name, Object value)

public void setCodePage (int code)

public void setContentType (String type)

public void setHeaderValue (String name, String value)

public void setJavaURLSessionSupported (boolean value)

Sets if the instance of this container services supports cookieless environments

public void setRequest (HttpServletRequest request)

This method sets the HttpServletRequest object which is to be associated with this class.

Parameters
request A HttpServletRequest object.

public void setRequestAttribute (String name, Object value)

public void setResponse (HttpServletResponse response)

This method sets the HttpServletResponse object which is to be associated with this class.

Parameters
response A HttpServletResponse object.

public void setServletConfig (ServletConfig newValue)

public void setServletContext (ServletContext servletContext)

This method sets the ServletContext object which is to be associated with this class.

Parameters
servletContext A ServletContext object.

public void setSession (HttpSession session)

This method sets the HttpSession object which is to be associated with this class.

Parameters
session A HttpSession object.

public void setSessionAttribute (String name, Object value)

public void setSessionAttribute (String name, Object value, ContainerServicesNamespace namespace)

public void setStatusCode (int statusCode)

Protected Methods

protected HashList getCookies (ContainerServicesNamespace namespace)