HATS 7.5.1 Web API Reference

Publicly accessible methods not documented here are for IBM internal use only and may change in a future release of the product.

com.ibm.hats.runtime
Interface IContext

All Known Implementing Classes:
WebContext

public interface IContext

Provides context data


Field Summary
static String COPYRIGHT
          The HATSCopyright.COPYRIGHT field will be updated each release, thereby "magically" updating this class file.
 
Method Summary
 Object getAttribute(String name)
          Returns the specified attribute.
 Enumeration getAttributeNames()
          Returns a list of attribute names.
 String getContextName()
          Returns the application name.
 String getInitParameter(String name)
          Retrieve the specified initialization parameter.
 Enumeration getInitParameterNames()
          Returns an Enumeration of initialization parameter names.
 String getRealPath(String arg0)
          Retrieve the real path.
 IRequestDispatcher getRequestDispatcher(String arg0)
          Get the Request dispatcher associated with the resource in input
 InputStream getResourceAsStream(String resource)
          Retrieve the specified resource as a stream.
 InputStream getResourceAsStream(String[] resources)
          Retrieve the specified resource as a stream.
 void log(String arg0)
          Add the specified information to the log.
 void log(String arg0, Throwable arg1)
          Logs exception information.
 void removeAttribute(String name)
          Removes the specified attribute.
 void setAttribute(String name, Object value)
          Sets the specified attribute.
 

Field Detail

COPYRIGHT

static final String COPYRIGHT
The HATSCopyright.COPYRIGHT field will be updated each release, thereby "magically" updating this class file.

See Also:
Constant Field Values
Method Detail

getResourceAsStream

InputStream getResourceAsStream(String resource)
Retrieve the specified resource as a stream.

Parameters:
resource - The resource to retrieve as a stream. This value cannot be null.
Returns:
The specified InputStream.
Throws:
IllegalArgumentException

getResourceAsStream

InputStream getResourceAsStream(String[] resources)
Retrieve the specified resource as a stream.

Parameters:
resources - The ordered resource place options to retrieve as a stream. This value cannot be null.
Returns:
The specified InputStream.
Throws:
IllegalArgumentException

getRequestDispatcher

IRequestDispatcher getRequestDispatcher(String arg0)
Get the Request dispatcher associated with the resource in input

Parameters:
arg0 - Input parameter used to specify the request dispatcher.
Returns:
The specified request dispatcher.

log

void log(String arg0)
Add the specified information to the log.

Parameters:
arg0 - The log entry.

log

void log(String arg0,
         Throwable arg1)
Logs exception information.

Parameters:
arg0 - The information to log.
arg1 - The exception information to log.

getRealPath

String getRealPath(String arg0)
Retrieve the real path.

Parameters:
arg0 - The real path to retrieve.
Returns:
The real path.

getInitParameter

String getInitParameter(String name)
Retrieve the specified initialization parameter.

Parameters:
name - The name of the initialization parameter to retrieve. This value cannot be null.
Returns:
The specified initialization parameter.

getInitParameterNames

Enumeration getInitParameterNames()
Returns an Enumeration of initialization parameter names.

Returns:
An Enumeration of initialization parameter names.

getAttribute

Object getAttribute(String name)
Returns the specified attribute.

Parameters:
name - The name of the attribute to retrieve. This value cannot be null.
Returns:
The specified attribute.

getAttributeNames

Enumeration getAttributeNames()
Returns a list of attribute names.

Returns:
Returns an Enumeration of attribute names.

setAttribute

void setAttribute(String name,
                  Object value)
Sets the specified attribute.

Parameters:
name - The name of the attribute to be set. This value cannot be null.
value - The value to be used in setting the named attribute. This value cannot be null.

removeAttribute

void removeAttribute(String name)
Removes the specified attribute.

Parameters:
name - The name of the attribute to be removed. This value cannot be null.
Throws:
IllegalArgumentException

getContextName

String getContextName()
Returns the application name.

Returns:
The application name.

HATS 7.5.1 (201005110649)