com.nitido.nimbox.http
Class HttpNimletInput

java.lang.Object
  com.nitido.nimbox.http.HttpNimletInput

All Implemented Interfaces:

NimletInput

public class HttpNimletInput
extends java.lang.Object
implements NimletInput

The HttpNimletInput provide the HTTP implementation for the NimletInput interface.

The values in the HttpNimletInput are retrieved in the following priority:

• If the values have been specified in the inValues parameter of the constructor, return that value.
• else, if the copyFromReqAttr flag is true and a value has been found in the request's attribute, return that value
• else, if the copyFromReqParam flag is true and a value has been found in the request's parameter (submitted by the browser), return that value.
• If all the values are not specified in all the previous cases, then this object will treat it as no value declared for the key.

Field Summary

Fields inherited from interface com.nitido.nim.NimletInput

UPLOADED_FILES

Constructor Summary

HttpNimletInput(HttpNimletContainer container, java.util.HashMap inValues)
The default constructor.

Method Summary

java.util.Vector	getAllValuesForKey(java.lang.String key) This method returns all the values associated to the given key.
java.lang.String[]	getKeys() This method returns all the available keys in the NimletInput.
NimletContainer	getNimletContainer() This method returns a reference to the NimletContainer.
java.lang.Object	getValueForKey(java.lang.String key) Get the first value associated to the given key.

Methods inherited from class java.lang.Object

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

Constructor Detail

HttpNimletInput

public HttpNimletInput(HttpNimletContainer container,
                       java.util.HashMap inValues)

The default constructor.

Parameters:

container - The HttpNimletContainer created by the HttpNimletDriver.

inValues - A HashMap of Vector objects that represents the input values for this HttpNimletInput object. These input values comes from the NimletOutput objects of the Nimlet that deploy the current Nimlet. Therefore, this is usually an empty HashMap if the Nimlet is the first one being called by the HttpNimletDriver. However, it must never be null. Moreover, this NimletInput object will use the HashMap object as is without cloning it. A developer must ensure other part of the system will not modify it accidentally.

Method Detail

getValueForKey

public java.lang.Object getValueForKey(java.lang.String key)

Description copied from interface: NimletInput

Get the first value associated to the given key. The exact order depends on the underlying Container Server implementation.

Specified by:

getValueForKey in interface NimletInput

Parameters:

key - The key associated to the requested value. This parameter cannot be null.

Returns:

The object that is associated to the given key. If the key has no value associated to it, this method returns null.

getAllValuesForKey

public java.util.Vector getAllValuesForKey(java.lang.String key)

Description copied from interface: NimletInput

This method returns all the values associated to the given key.

Specified by:

getAllValuesForKey in interface NimletInput

Parameters:

key - The key associated to the requested values. This parameter cannot be null.

Returns:

A Vector of all the objects that are associated to the given key. If the key has no objects associated to it, this method returns an empty Vector.

getKeys

public java.lang.String[] getKeys()

Description copied from interface: NimletInput

This method returns all the available keys in the NimletInput.

Specified by:

getKeys in interface NimletInput

Returns:

A String array of the keys in the NimletInput. This array is not sorted in any pre-defined order.

getNimletContainer

public NimletContainer getNimletContainer()

Description copied from interface: NimletInput

This method returns a reference to the NimletContainer.

Specified by:

getNimletContainer in interface NimletInput

Returns:

Reference to the NimletContainer.