com.sapportals.portal.prt.servlets_jsp.server.page

Class PageContextImpl

java.lang.Object
  javax.servlet.jsp.JspContext
      javax.servlet.jsp.PageContext
          com.sapportals.portal.prt.servlets_jsp.server.page.PageContextImpl

Deprecated.

public class PageContextImpl
extends PageContext

Provides access to all the namespaces associated with a JSP page, provides access to several page attributes, as well as a layer above the implementation details.

Field Summary

static String	APPCONTEXT Deprecated. name used to store ServletContext in PageContext name table
protected Hashtable	attributes Deprecated. page scope attributes
protected boolean	autoFlush Deprecated. if the buffer will be autoflushed
protected int	bufferSize Deprecated. size of the buffer
protected IPortalComponent	component Deprecated. a servlet instance of this jsp
protected IPortalComponentRequest	componentRequest Deprecated. response invoked this jsp
protected ServletConfig	config Deprecated. used to pass information to a servlet during initialization
protected ServletContext	context Deprecated. a set of methods that a servlet uses to communicate with its servlet container
protected String	errorPageURL Deprecated. if some error page is specified in jsp
protected JspFactory	factory Deprecated. a number of factory methods available to a JSP page at runtime
protected ServletRequest	m_request Deprecated. response invoked this jsp
protected JSPResponse	m_response Deprecated. response that will be returned from this jsp
protected IPortalComponentSession	m_session Deprecated. a session object for this jsp
protected boolean	needsSession Deprecated. if a new session to be created if the page doesn't take a part at any
protected JspWriter	out Deprecated. initial output stream

Fields inherited from class javax.servlet.jsp.PageContext

APPLICATION, APPLICATION_SCOPE, CONFIG, EXCEPTION, OUT, PAGE, PAGE_SCOPE, PAGECONTEXT, REQUEST, REQUEST_SCOPE, RESPONSE, SESSION, SESSION_SCOPE

Constructor Summary

PageContextImpl()
Deprecated. Primary constructor for PageContext, requires subsequent call to initialize() in order to handle a Servlet request.

Method Summary

protected JspWriter	_createOut(int buffer, boolean flag) Deprecated. Creates and returns a new JspWriter.
Object	backwardCompatibilityGetValue(String name) Deprecated.
Object	findAttribute(String name) Deprecated. Searches for the named attribute in page, request, session (if valid), and application scope(s) in order and returns the value associated or null.
void	forward(String jspFile) Deprecated. This method is used to re-direct, or "forward" the current ServletRequest and ServletResponse to another active component in the application.
Object	getAttribute(String name) Deprecated. Returns the object named .
Object	getAttribute(String name, int scope) Deprecated. Gets an attribute within the scope.
Enumeration	getAttributeNamesInScope(int scope) Deprecated. Returns an enumeration of names (java.lang.String) of all the attributes the specified scope.
int	getAttributesScope(String name) Deprecated. Returns the scope of the object associated with the name specified or 0.
ELContext	getELContext() Deprecated.
Enumeration	getEnum(String[] ar) Deprecated. Returns an Enumeration of the elements of the given array.
Exception	getException() Deprecated. Returns any exception passed to this as an errorpage.
ExpressionEvaluator	getExpressionEvaluator() Deprecated.
JspWriter	getOut() Deprecated. Returns the HttpSession for this PageContext or null.
Object	getPage() Deprecated. Returns the Page implementation class instance (Servlet) associated with this PageContext.
ServletRequest	getRequest() Deprecated. Returns The ServletRequest for this PageContext.
ServletResponse	getResponse() Deprecated. Returns the ServletResponse for this PageContext.
ServletConfig	getServletConfig() Deprecated. Returns the ServletConfig for this PageContext.
ServletContext	getServletContext() Deprecated. Returns the ServletContext for this PageContext.
HttpSession	getSession() Deprecated. Returns the HttpSession for this PageContext or null.
VariableResolver	getVariableResolver() Deprecated.
void	handlePageException(Exception exception) Deprecated. This method is intended to process an unhandled "page" level exception by redirecting the exception to either the specified error page for this JSP, or if none was specified, to perform some implementation dependent action.
void	handlePageException(Throwable parm1) Deprecated.
void	include(String jspFile) Deprecated. Causes the resource specified to be processed as part of the current ServletRequest and ServletResponse being processed by the calling Thread.
void	include(String relativeUrlPath, boolean flush) Deprecated.
void	initialize(IPortalComponentRequest request, JSPResponse response, String errorPageURL, boolean needsSession, int bufferSize, boolean autoFlush) Deprecated. Initiates the instance with servlet parameters.
void	initialize(Servlet servlet, ServletRequest request, ServletResponse response, String errorPageURL, boolean needsSession, int bufferSize, boolean autoFlush) Deprecated. Initiates the instance with servlet parameters.
JspWriter	popBody() Deprecated. Returns the previous JspWriter "out" saved by the matching pushBody(), and update the value of the "out" attribute in the page scope attribute namespace of the PageConxtext.
BodyContent	pushBody() Deprecated. Returns a new BodyContent object, save the current "out" JspWriter, and update the value of the "out" attribute in the page scope attribute namespace of the PageContext.
void	release() Deprecated. This method shall "reset" the internal state of a PageContext, releasing all internal references, and preparing the PageContext for potential reuse by a later invocation of initialize().
void	removeAttribute(String name) Deprecated. Removes the object reference associated with the specified name.
void	removeAttribute(String name, int scope) Deprecated. Removes the object reference associated with the specified name
void	setAttribute(String name, Object attribute) Deprecated. Registers the name and object specified with page scope semantics
void	setAttribute(String name, Object o, int scope) Deprecated. Register the name and object specified with appropriate scope semantics.

Methods inherited from class javax.servlet.jsp.PageContext

getErrorData

Methods inherited from class javax.servlet.jsp.JspContext

pushBody

Methods inherited from class java.lang.Object

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

Field Detail

APPCONTEXT

public static final String APPCONTEXT

Deprecated.

name used to store ServletContext in PageContext name table

See Also:

Constant Field Values

component

protected IPortalComponent component

Deprecated.

a servlet instance of this jsp

config

protected ServletConfig config

Deprecated.

used to pass information to a servlet during initialization

context

protected ServletContext context

Deprecated.

a set of methods that a servlet uses to communicate with its servlet container

factory

protected JspFactory factory

Deprecated.

a number of factory methods available to a JSP page at runtime

needsSession

protected boolean needsSession

Deprecated.

if a new session to be created if the page doesn't take a part at any

errorPageURL

protected String errorPageURL

Deprecated.

if some error page is specified in jsp

autoFlush

protected boolean autoFlush

Deprecated.

if the buffer will be autoflushed

bufferSize

protected int bufferSize

Deprecated.

size of the buffer

attributes

protected transient Hashtable attributes

Deprecated.

page scope attributes

componentRequest

protected transient IPortalComponentRequest componentRequest

Deprecated.

response invoked this jsp

m_request

protected transient ServletRequest m_request

Deprecated.

response invoked this jsp

m_response

protected transient JSPResponse m_response

Deprecated.

response that will be returned from this jsp

m_session

protected transient IPortalComponentSession m_session

Deprecated.

a session object for this jsp

out

protected transient JspWriter out

Deprecated.

initial output stream

Constructor Detail

PageContextImpl

public PageContextImpl()
                throws IOException,
                       IllegalStateException,
                       IllegalArgumentException

Deprecated.

Primary constructor for PageContext, requires subsequent call to initialize() in order to handle a Servlet request.

Throws:

IOException

IllegalStateException

IllegalArgumentException

Method Detail

include

public void include(String jspFile)
             throws ServletException,
                    IOException

Deprecated.

Causes the resource specified to be processed as part of the current ServletRequest and ServletResponse being processed by the calling Thread. The output of the target resources processing of the request is written the the JspWriter specified.

Specified by:

include in class PageContext

Parameters:

jspFile - jspFile to be included

Throws:

ServletException - throws it

IOException - throws it

include

public void include(String relativeUrlPath,
                    boolean flush)
             throws ServletException

Deprecated.

Specified by:

include in class PageContext

Throws:

ServletException

forward

public void forward(String jspFile)
             throws ServletException,
                    IOException

Deprecated.

This method is used to re-direct, or "forward" the current ServletRequest and ServletResponse to another active component in the application.

Specified by:

forward in class PageContext

Parameters:

jspFile - jspFile to be forworded

Throws:

ServletException - throws it

IOException - throws it

handlePageException

public void handlePageException(Exception exception)

Deprecated.

This method is intended to process an unhandled "page" level exception by redirecting the exception to either the specified error page for this JSP, or if none was specified, to perform some implementation dependent action.

Specified by:

handlePageException in class PageContext

Parameters:

exception - thrown exception to be handled

_createOut

protected JspWriter _createOut(int buffer,
                               boolean flag)
                        throws IOException,
                               IllegalArgumentException

Deprecated.

Creates and returns a new JspWriter.

Parameters:

buffer - buffer of writer

flag - autoflush

Returns:

new JspWriter

Throws:

IOException - throws it

IllegalArgumentException - throws it

initialize

public void initialize(Servlet servlet,
                       ServletRequest request,
                       ServletResponse response,
                       String errorPageURL,
                       boolean needsSession,
                       int bufferSize,
                       boolean autoFlush)
                throws IOException,
                       IllegalStateException,
                       IllegalArgumentException

Deprecated.

Initiates the instance with servlet parameters.

Specified by:

initialize in class PageContext

Parameters:

servlet - A refference to this servlet

request - A refference to the request to this jsp

response - A refference to the responce that will be returned from jsp

errorPageURL - If an error page is set in jsp

needsSession - if a new session will be created if there isn't such

bufferSize - size of the buffer

autoFlush - if buffer will be autoflushed

Throws:

IOException

IllegalStateException

IllegalArgumentException

initialize

public void initialize(IPortalComponentRequest request,
                       JSPResponse response,
                       String errorPageURL,
                       boolean needsSession,
                       int bufferSize,
                       boolean autoFlush)
                throws IOException,
                       IllegalStateException,
                       IllegalArgumentException

Deprecated.

Initiates the instance with servlet parameters.

Parameters:

request - A refference to the IPortalServletResquest to this jsp

response - A refference to the responce that will be returned from jsp

errorPageURL - If an error page is set in jsp

needsSession - if a new session will be created if there isn't such

bufferSize - size of the buffer

autoFlush - if buffer will be autoflushed

Throws:

IOException

IllegalStateException

IllegalArgumentException

release

public void release()

Deprecated.

This method shall "reset" the internal state of a PageContext, releasing all internal references, and preparing the PageContext for potential reuse by a later invocation of initialize(). This method is typically called from JspFactory.releasePageContext(). Subclasses shall envelope this method.

Specified by:

release in class PageContext

setAttribute

public void setAttribute(String name,
                         Object attribute)

Deprecated.

Registers the name and object specified with page scope semantics

Specified by:

setAttribute in class JspContext

Parameters:

name - name of the attribute

attribute - Object of the attribuete

setAttribute

public void setAttribute(String name,
                         Object o,
                         int scope)

Deprecated.

Register the name and object specified with appropriate scope semantics.

Specified by:

setAttribute in class JspContext

Parameters:

name - name of the attribute

o - Object of the attribuete

scope - scope of the attribute

getAttribute

public Object getAttribute(String name)

Deprecated.

Returns the object named .

Specified by:

getAttribute in class JspContext

Parameters:

name - name of the object

Returns:

the object named or null if not found

getAttribute

public Object getAttribute(String name,
                           int scope)

Deprecated.

Gets an attribute within the scope.

Specified by:

getAttribute in class JspContext

Parameters:

name - name of attribute

scope - ID of the scope of the attribute

Returns:

attribute within the scope

backwardCompatibilityGetValue

public Object backwardCompatibilityGetValue(String name)

Deprecated.

Parameters:

name -

Returns:

Object

removeAttribute

public void removeAttribute(String name)

Deprecated.

Removes the object reference associated with the specified name.

Specified by:

removeAttribute in class JspContext

Parameters:

name - name of the object

removeAttribute

public void removeAttribute(String name,
                            int scope)

Deprecated.

Removes the object reference associated with the specified name

Specified by:

removeAttribute in class JspContext

Parameters:

name - name of the object

scope - ID of the scope of the object

getAttributesScope

public int getAttributesScope(String name)

Deprecated.

Returns the scope of the object associated with the name specified or 0.

Specified by:

getAttributesScope in class JspContext

Parameters:

name - name of the object

Returns:

the scope of the object associated with the name specified or 0

getEnum

public Enumeration getEnum(String[] ar)

Deprecated.

Returns an Enumeration of the elements of the given array.

Parameters:

ar - an array of String

Returns:

Enumeration of the elements of the array

getAttributeNamesInScope

public Enumeration getAttributeNamesInScope(int scope)

Deprecated.

Returns an enumeration of names (java.lang.String) of all the attributes the specified scope.

Specified by:

getAttributeNamesInScope in class JspContext

Parameters:

scope - ID of the scope

Returns:

an enumeration of names (java.lang.String) of all the attributes the specified scope

pushBody

public BodyContent pushBody()

Deprecated.

Returns a new BodyContent object, save the current "out" JspWriter, and update the value of the "out" attribute in the page scope attribute namespace of the PageContext.

Overrides:

pushBody in class PageContext

Returns:

the new BodyContent

popBody

public JspWriter popBody()

Deprecated.

Returns the previous JspWriter "out" saved by the matching pushBody(), and update the value of the "out" attribute in the page scope attribute namespace of the PageConxtext.

Overrides:

popBody in class JspContext

Returns:

the saved JspWriter

getOut

public JspWriter getOut()

Deprecated.

Returns the HttpSession for this PageContext or null.

Specified by:

getOut in class JspContext

Returns:

the current JspWriter stream being used for client response

getSession

public HttpSession getSession()

Deprecated.

Returns the HttpSession for this PageContext or null.

Specified by:

getSession in class PageContext

Returns:

the HttpSession for this PageContext or null

getServletConfig

public ServletConfig getServletConfig()

Deprecated.

Returns the ServletConfig for this PageContext.

Specified by:

getServletConfig in class PageContext

Returns:

the ServletConfig for this PageContext

getServletContext

public ServletContext getServletContext()

Deprecated.

Returns the ServletContext for this PageContext.

Specified by:

getServletContext in class PageContext

Returns:

the ServletContext for this PageContext

getRequest

public ServletRequest getRequest()

Deprecated.

Returns The ServletRequest for this PageContext.

Specified by:

getRequest in class PageContext

Returns:

The ServletRequest for this PageContext

getResponse

public ServletResponse getResponse()

Deprecated.

Returns the ServletResponse for this PageContext.

Specified by:

getResponse in class PageContext

Returns:

the ServletResponse for this PageContext

getException

public Exception getException()

Deprecated.

Returns any exception passed to this as an errorpage.

Specified by:

getException in class PageContext

Returns:

any exception passed to this as an errorpage

getPage

public Object getPage()

Deprecated.

Returns the Page implementation class instance (Servlet) associated with this PageContext.

Specified by:

getPage in class PageContext

Returns:

the Page implementation class instance (Servlet) associated with this PageContext

findAttribute

public Object findAttribute(String name)

Deprecated.

Searches for the named attribute in page, request, session (if valid), and application scope(s) in order and returns the value associated or null.

Specified by:

findAttribute in class JspContext

Parameters:

name - name of the attribute

Returns:

the value associated or null

handlePageException

public void handlePageException(Throwable parm1)
                         throws ServletException,
                                IOException

Deprecated.

Specified by:

handlePageException in class PageContext

Throws:

ServletException

IOException

getExpressionEvaluator

public ExpressionEvaluator getExpressionEvaluator()

Deprecated.

Specified by:

getExpressionEvaluator in class JspContext

getVariableResolver

public VariableResolver getVariableResolver()

Deprecated.

Specified by:

getVariableResolver in class JspContext

getELContext

public ELContext getELContext()

Deprecated.

Access Rights

This class can be accessed from:

SC	DC	Public Part	ACH
[sap.com] EP-BASIS-API	[sap.com] tc/epbc/prt/lib/api	api	EP-PIN
[sap.com] EP-BASIS-API	[sap.com] tc/epbc/prt/api	api	EP-PIN