ServletContainerServices

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 String APPLICATION_PARAMETERS_XML_PATH String WEB_XML_PATH
From interface com.microstrategy.web.platform.ContainerServices String SPNEGO_CREDENTIAL

[Expand] Inherited Fields
From class com.microstrategy.web.platform.AbstractConfigurableContainerServices protected static boolean _prependSlashToResource

Public Constructors
	ServletContainerServices() Creates a new ServletContainerServices object.
	ServletContainerServices(boolean hasOutputStream)

[Expand] Inherited Methods
From class com.microstrategy.web.platform.HttpServletContainerServices 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) HashList getCookies(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)
From class com.microstrategy.web.platform.AbstractConfigurableContainerServices String decrypt(String encryptedData) String encrypt(String clearData) ApplicationParameters getApplicationParameters() Returns the an ApplicationParameters instance that includes all the parameters defined in the microstrategy.xml or web.xml file abstract String getControllerName() String getControllerParameter(String paramName, String controllerName) Returns initialization parameter value for the given controller. GenericCookie getCookie(String name) This method retrieves a platform-independent Cookie with a specific name. GenericCookie getCookie(String name, ContainerServicesNamespace namespace) This method retrieves a platform-independent Cookie with a specific name. static ContainerServicesNamespace getCookieNamespace() Returns the namespace object for Cookies. int getCookieNamespaceCapacity() Returns the namespace capacity for cookies. abstract HashList getCookies(ContainerServicesNamespace namespace) String getInitParameter(String paramName) Returns initialization parameter value for the controller associated with this ContainerServices. Enumeration getInitParameterNames() Returns enumeration of initialization parameter names String getNamespacePrefix() String getNamespaceValue(ContainerServicesNamespace namespace) Get the namespace value. static String getRealName(String nativeName) Get the real name from native name. ContainerServicesNamespace getSessionNamespace() Returns the namespace object for sessions. int getSessionNamespaceCapacity() return the capacity of namespace of session. static void initFromPropertiesFile() void initGlobalObjects() Initializes global instances, like FileLoader and Plugins, using this ContainerServices instance. boolean isEncryptedByRedirect(String name) boolean isEncryptedParameter(String name) static boolean isNamespacedName(String nativeName) Check if the native name is namespaced name. GenericCookie newCookie(String cookieName, String cookieValue) This method creates a new platform-independent Cookie. GenericCookie newCookie(String cookieName, String cookieValue, ContainerServicesNamespace namespace) This method creates a new platform-independent Cookie. ParameterBuilder newHiddenInputParameterBuilder() Create a new instance of a ParameterBuilder that is suited for building hidden inputs. NamespaceEncoder newNamespaceEncoder() Create a new instance of a NamespaceEncoder that can provide global namespace support. ParameterBuilder newURIParameterBuilder() Create a new instance of a ParameterBuilder that is suited for building URIs. static boolean useNamespace(ContainerServicesNamespace namespace) Indicates wheter to use namespace
From class java.lang.Object Object clone() boolean equals(Object arg0) void finalize() final Class<?> getClass() int hashCode() final void notify() final void notifyAll() String toString() final void wait() final void wait(long arg0, int arg1) final void wait(long arg0)
From interface com.microstrategy.web.platform.ContainerServices abstract void addCookieToResponse(GenericCookie cookie) This method associates a platform-independent Cookie with a response. abstract Object getApplicationAttribute(String name) This method returns the value of an Application Attribute. abstract String getApplicationPath() This method returns the full application path of the servlet abstract int getCodePage() Returns an integer that represents the character formatting codepage. abstract GenericCookie getCookie(String cookieName) This method retrieves a platform-independent Cookie with a specific name. abstract GenericCookie getCookie(String cookieName, ContainerServicesNamespace namespace) This method retrieves a platform-independent Cookie with a specific name. abstract ContainerStringCollection getCookieStrings(ContainerServicesNamespace namespace) This method returns the contents of all Cookies as a collection of sub strings (as name/value pairs). abstract ContainerStringCollection getCookieStrings() This method returns the contents of all Cookies as a collection of sub strings (as name/value pairs). abstract ContainerStringCollection getFormAndQueryStrings() This method returns the contents of the Form Data and Query String as a collection of sub strings (as name/value pairs). abstract String getHeaderValue(String headerName) This method returns the value of the requested header abstract String getMethod() Return the request's method is post or get abstract OutputStream getOutputStream() abstract PostedFile getPostedFile(String name) Provides a way to access individual files that have been uploaded by a client. abstract String getQueryString() This method returns the entire Query String. abstract String getRemoteAddress() This method returns the client IP address abstract Object getRequestAttribute(String name) This method returns the value of a Request Attribute. abstract String getRequestServerName() This method returns the Web Server Name from the request object abstract ContainerStringCollection getServerVariables() Returns a collection of server variables. abstract Object getSessionAttribute(String name, ContainerServicesNamespace namespace) This method returns the value of a Session Attribute. abstract Object getSessionAttribute(String name) This method returns the value of a Session Attribute. abstract String getSessionID() Returns HTTP session ID abstract int getSessionMaxIdleTime() Returns the maximum time interval, in seconds, that the container will keep this session open between client accesses. abstract ContainerStringCollection getSessionStrings() This method returns the contents of the Session Variables as a collection of sub strings (as name/value pairs). abstract ContainerStringCollection getSessionStrings(ContainerServicesNamespace namespace) This method returns the contents of the Session Variables as a collection of sub strings (as name/value pairs) from the namespace specified. abstract int getStatusCode() Returns the HTTP Status code specified for this response. abstract boolean hasOutputStream() abstract void invalidateHttpSession() If the security preference is selected, invalidate and create new http session in jsp part set a flag to show whether a new session need to be created in asp part abstract boolean isJavaURLSessionSupported() Indicates if the instance of this container services supports cookieless environments abstract boolean isRequestSecure() Returns a boolean indicating whether this request was made using a secure channel, such as HTTPS abstract boolean isSessionlessRequest() Does the request has a pre-established session id. abstract GenericCookie newCookie(String cookieName, String cookieValue) This method creates a new platform-independent Cookie. abstract GenericCookie newCookie(String cookieName, String cookieValue, ContainerServicesNamespace namespace) This method creates a new platform-independent Cookie. abstract ParameterBuilder newHiddenInputParameterBuilder() Create a new instance of a ParameterBuilder that is suited for building hidden inputs. abstract NamespaceEncoder newNamespaceEncoder() Create a new instance of a NamespaceEncoder that can provide global namespace support. abstract ParameterBuilder newURIParameterBuilder() Create a new instance of a ParameterBuilder that is suited for building URIs. abstract void sendBinaryContent(MarkupOutput mo) Outputs binary content of the MarkupOutput abstract boolean sendError(int sc) Sends an error response to the client using the specified status code. abstract boolean sendError(int sc, String msg) Sends an error response to the client using the specified status code. abstract void setApplicationAttribute(String name, Object value) This method sets the value of a Application Attribute. abstract void setCodePage(int code) Sets the code page, an integer representing the character formatting. abstract void setContentType(String type) Stes HTTP response content type abstract void setHeaderValue(String name, String value) Sets HTTP response header abstract void setJavaURLSessionSupported(boolean value) Sets if the instance of this container services supports cookieless environments abstract void setRequestAttribute(String name, Object value) This method sets the value of a Request Attribute. abstract void setSessionAttribute(String name, Object value) This method sets the value of a Session Attribute. abstract void setSessionAttribute(String name, Object value, ContainerServicesNamespace namespace) This method sets the value of a Session Attribute in the given namespace. abstract void setStatusCode(int statusCode) Sets the HTTP Status code specified for this response.
From interface com.microstrategy.web.platform.ContainerServicesContext abstract ApplicationParameters getApplicationParameters() Returns the an ApplicationParameters instance that includes all the parameters defined in the microstrategy.xml or web.xml file abstract String getContextPath() Returns the context path. abstract String getControllerParameter(String paramName, String controllerName) Returns initialization parameter value for the given controller. abstract String getInitParameter(String paramName) Returns initialization parameter value for the controller associated with this ContainerServices. abstract Enumeration<String> getInitParameterNames() Returns enumeration of initialization parameter names abstract String getRealPath(String relPath) This is a low level API call to the outside world - it returns the real path to a server-side resource. abstract URL getResource(String relPath) Returns the URL associated with the given resource path. abstract InputStream getResourceAsStream(String relPath) This method returns the contents of a file resource relative to the web application as an input stream. abstract Set<String> getResourcePaths(String relPath) Returns a directory path strings of all the paths to resources within the application whose longest sub-path matches the supplied path. abstract void initGlobalObjects() Initializes global instances, like FileLoader and Plugins, using this ContainerServices instance.