public interface

DisconnectedContainerServices

implements ContainerServices
com.microstrategy.web.platform.DisconnectedContainerServices
Known Indirect Subclasses

Class Overview

This interface represents an intermediary between the ASP.net and Microstrategy Java application. At the start of each ASP page request data and all other necessary data must be copied into the object of this class. After request processing is finished response data must be copied from this object to the response.

Summary

[Expand]
Inherited Constants
From interface com.microstrategy.web.platform.ContainerServices
Public Methods
abstract void addCookieToRequest(String nativeCookieName, String nativeCookieValue)
Adds request cookie to the internal collection This method is used by non-J2EE environment to add cookies to MicroStrategy Web application.
abstract void addFormAndQueryString(String name, String value)
Adds a value to the request parameters collection.
abstract void addRequestHeader(String name, String value)
Adds request header to the internal collection
abstract void addServerVariable(String name, String value)
Adds a server variable with a single value.
abstract void addServerVariable(String name, String[] values)
Appends a collection of string values of the specified server variable.
abstract Object getApplicationAttribute(int index)
Returns application attribute
abstract String getApplicationAttributeName(int index)
Returns application attribute name
abstract int getApplicationAttributesCount()
Returns a number of application attributes.
abstract MarkupOutput getBinaryMarkup()
Returns markup outut stored at the sendBinaryContent method.
abstract String getContentType()
Returns response content type
abstract boolean getCreateNewSessionValue()
Gets a boolean value indicating whether create a new http session
abstract int getErrorCode()
Returns the error status code for response.
abstract String getErrorMessage()
Returns the error message for response.
abstract AppGlobalContext getGlobalContext()
Returns the global context held by this services.
abstract Object getRequestAttribute(int index)
Returns requst attribute
abstract String getRequestAttributeName(int index)
Returns requst attribute name
abstract int getRequestAttributesCount()
Returns a number of request attributes.
abstract GenericCookie getResponseCookie(int index)
Returns a cookie that must be added to the response
abstract int getResponseCookiesCount()
Returns number of cookeis that must be added to the response
abstract String getResponseHeaderName(int index)
Returns response header name
abstract String getResponseHeaderValue(int index)
Returns response header value
abstract int getResponseHeadersCount()
Returns number of response headers
abstract Object getSessionAttribute(int i)
Returns session attribute
abstract String getSessionAttributeName(int i)
Returns session attribute name
abstract int getSessionAttributesCount()
Returns a number of session attributes.
abstract void handleMultipartRequest(byte[] request)
This method shall be called if the request type is multipart/form-data
abstract void setCreateNewSessionValue(boolean value)
Sets a boolean indicating whether create a new http session
abstract void setGlobalContext(AppGlobalContext globalContext)
Sets current application global context.
abstract void setMethod(String method)
Sets the request method
abstract void setNativeSessionAttribute(String nativeName, Object nativeValue)
This method sets the value of a Session Attribute without using namespace in Session variable.
abstract void setQueryString(String queryString)
Sets HTTP request query string
abstract void setRemoteAddress(String remoteAddress)
Set the remote (IP) address for this request
abstract void setRequestSecure(boolean value)
Sets a boolean indicating whether this request was made using a secure channel, such as HTTPS
abstract void setSessionID(String sessionID)
Sets the HTTP session ID
[Expand]
Inherited Methods
From interface com.microstrategy.web.platform.ContainerServices
From interface com.microstrategy.web.platform.ContainerServicesContext

Public Methods

public abstract void addCookieToRequest (String nativeCookieName, String nativeCookieValue)

Adds request cookie to the internal collection This method is used by non-J2EE environment to add cookies to MicroStrategy Web application.

Parameters
nativeCookieName The native cookie name used in browser
nativeCookieValue The native cookie value stored in browser

public abstract void addFormAndQueryString (String name, String value)

Adds a value to the request parameters collection. There can be several values assosiated with the same name in this collection.

Parameters
name parameter name.
value parameter value.

public abstract void addRequestHeader (String name, String value)

Adds request header to the internal collection

Parameters
name header name
value header value

public abstract void addServerVariable (String name, String value)

Adds a server variable with a single value. If the server variable already exists, appends the new value

Parameters
name the name of the server variable.
value the value of the server variable.

public abstract void addServerVariable (String name, String[] values)

Appends a collection of string values of the specified server variable. If the server variable already exists, appends the new values.

Parameters
name the name of the server variable.
values an array of string values of the server variable.

public abstract Object getApplicationAttribute (int index)

Returns application attribute

Parameters
index an index in the attribute collection
Returns
  • application attribute

public abstract String getApplicationAttributeName (int index)

Returns application attribute name

Parameters
index an index in the attribute collection
Returns
  • application attribute name

public abstract int getApplicationAttributesCount ()

Returns a number of application attributes. The Application attributes is a read-writy collection. Attributes can be replaced in it during execution. Therefore entire collection shall be copied in and out of disconnected container services.

Returns
  • number of Application attributes.

public abstract MarkupOutput getBinaryMarkup ()

Returns markup outut stored at the sendBinaryContent method. If this method returns not null the content of markup output must be displayed.

Returns
  • binary markup output

public abstract String getContentType ()

Returns response content type

Returns
  • response content type

public abstract boolean getCreateNewSessionValue ()

Gets a boolean value indicating whether create a new http session

public abstract int getErrorCode ()

Returns the error status code for response.

Returns
  • The error status code. We reuse HTTP status code "OK" (200) to mean no error.

public abstract String getErrorMessage ()

Returns the error message for response.

Returns
  • The error message. If no error message, empty string will be returned.

public abstract AppGlobalContext getGlobalContext ()

Returns the global context held by this services.

Returns
  • an AppGlobalContext. If there has no AppGlobalContext been set to this object, nulll will be returned.

public abstract Object getRequestAttribute (int index)

Returns requst attribute

Parameters
index an index in the attribute collection
Returns
  • request attribute

public abstract String getRequestAttributeName (int index)

Returns requst attribute name

Parameters
index an index in the attribute collection
Returns
  • requst attribute name

public abstract int getRequestAttributesCount ()

Returns a number of request attributes. The request attributes is a read-writy collection. Attributes can be replaced in it during execution. Therefore entire collection shall be copied in and out of disconnected container services.

Returns
  • number of request attributes.

public abstract GenericCookie getResponseCookie (int index)

Returns a cookie that must be added to the response

Parameters
index an index in the cookies collection
Returns
  • a cookie that must be added to the response

public abstract int getResponseCookiesCount ()

Returns number of cookeis that must be added to the response

Returns
  • number of cookeis that must be added to the response

public abstract String getResponseHeaderName (int index)

Returns response header name

Parameters
index an index in the collection
Returns
  • response header name

public abstract String getResponseHeaderValue (int index)

Returns response header value

Parameters
index an index in the collection
Returns
  • response header value

public abstract int getResponseHeadersCount ()

Returns number of response headers

Returns
  • number of response headers

public abstract Object getSessionAttribute (int i)

Returns session attribute

Parameters
i an index in the attribute collection
Returns
  • session attribute

public abstract String getSessionAttributeName (int i)

Returns session attribute name

Parameters
i an index in the attribute collection
Returns
  • session attribute name

public abstract int getSessionAttributesCount ()

Returns a number of session attributes. The session attributes is a read-writy collection. Attributes can be replaced in it during execution. Therefore entire collection shall be copied in and out of disconnected container services.

Returns
  • number of session attributes.

public abstract void handleMultipartRequest (byte[] request)

This method shall be called if the request type is multipart/form-data

Parameters
request a byte array containing entire HTTP request
Throws
IOException

public abstract void setCreateNewSessionValue (boolean value)

Sets a boolean indicating whether create a new http session

public abstract void setGlobalContext (AppGlobalContext globalContext)

Sets current application global context.

Parameters
globalContext is an AppGlobalContext object.

public abstract void setMethod (String method)

Sets the request method

public abstract void setNativeSessionAttribute (String nativeName, Object nativeValue)

This method sets the value of a Session Attribute without using namespace in Session variable.

Parameters
nativeName A String which identifies the name of the attribute.
nativeValue An Object representing the value of a named attribute. If used in namespaced mode, the native value should containes the namespace encoding, that can be loaded by load(String)

public abstract void setQueryString (String queryString)

Sets HTTP request query string

Parameters
queryString request query string

public abstract void setRemoteAddress (String remoteAddress)

Set the remote (IP) address for this request

Parameters
remoteAddress IP address

public abstract void setRequestSecure (boolean value)

Sets a boolean indicating whether this request was made using a secure channel, such as HTTPS

public abstract void setSessionID (String sessionID)

Sets the HTTP session ID

Parameters
sessionID HTTP session ID