All Packages  Class Hierarchy  This Package  Previous  Next  Index

Interface ibs.util.IKeys

public interface IKeys

getCookie(String): Call to this method returns a String value for given Request Header Parameter.
getCookieKeys(): Returns an Enumeration of all Cookie keys in the request.
getFormKey(String): Call to this method returns String[] for the given 'MyKey' key from the submitted form.
getFormKey(String, boolean): Call to this method returns an String[] for the given 'MyKey' key from the submitted form.
getFormKeys(): Returns an Enumeration of all keys in the submitted form.
getHeaderKeys(): Returns an Enumeration of all Header keys for the request
getHeaderParam(String): Call to this method returns a String value for given Request Header Parameter.
hasCookie(String): Returns a boolean value - 'true' if cookie Key was found, 'false' otherwise.
hasFormKey(String): Returns a boolean value - 'true' if Form Key was found, 'false' otherwise.
printAll(): Prints all header/data/cookie keys and its values from the submitted form to the standard output.
printAll(PrintWriter): Prints all header, data, cookie keys and its values from the submitted form to the given PrintWriter.
printCookies(): Prints all cookie keys and its values from the submitted form to the standard output.
printCookies(PrintWriter): Prints all cookie keys and its values from the submitted form to the given PrintWriter.
printHeader(): Prints all header keys and its values from the submitted form to the standard output.
printHeader(PrintWriter): Prints all header keys and its values from the submitted form to the given PrintWriter.
printKeys(): Prints all form keys and its values from the submitted form to the standard output.
printKeys(PrintWriter): Prints all form keys and its values from the submitted form to the given PrintWriter.
removeKey(String): Call to this method removes the given key and its values from the key list.

getFormKeys

 public abstract Enumeration getFormKeys()

Returns an Enumeration of all keys in the submitted form.

Returns:: Enumeration An enumeration of form keys

getHeaderKeys

 public abstract Enumeration getHeaderKeys()

Returns an Enumeration of all Header keys for the request

Returns:: Enumeration An enumeration of Header keys

getCookieKeys

 public abstract Enumeration getCookieKeys()

Returns an Enumeration of all Cookie keys in the request.

Returns:: Enumeration An enumeration of Cookie keys

hasFormKey

 public abstract boolean hasFormKey(String MyKey)

Returns a boolean value - 'true' if Form Key was found, 'false' otherwise.

Returns:: a boolean value

hasCookie

 public abstract boolean hasCookie(String MyCookie)

Returns a boolean value - 'true' if cookie Key was found, 'false' otherwise.

Returns:: a boolean value

getFormKey

 public abstract String[] getFormKey(String MyKey) throws KeyNotFoundException

Call to this method returns String[] for the given 'MyKey' key from the submitted form.

Each key has one or more values which are contained in a String[].

Parameters:: MyKey - A key for which KeyValues object is being requested.
Returns:: String[] A String array containing all the values for the given key.

getFormKey

 public abstract String[] getFormKey(String MyKey,
                                     boolean make_new) throws KeyNotFoundException

Call to this method returns an String[] for the given 'MyKey' key from the submitted form. Additionally, this method allows creation of a new key if one already didn't exist.

Each key has one or more values which are contained in a String[]. If given key does not exist and 'make_new' flag is false, it throws a KeyNotFoundException.

Parameters:: MyKey - A key for which KeyValues object is being requested.; make_new - A boolean flag indicating whether or not to make a new key if given key didn't exist.
Returns:: String[] An object containing all the values for the given key.

removeKey

 public abstract void removeKey(String MyKey)

Call to this method removes the given key and its values from the key list.

getHeaderParam

 public abstract String getHeaderParam(String Param) throws KeyNotFoundException

Call to this method returns a String value for given Request Header Parameter.

Each Form Header Parameter has one and only one string value. If given Parameter does not exist, it throws a KeyNotFoundException exception.

Parameters:: Param - A key for which KeyValues object is being requested.
Returns:: String A string value for the given parameter.

getCookie

 public abstract String getCookie(String cookie_name) throws KeyNotFoundException

Call to this method returns a String value for given Request Header Parameter.

Each Form Header Parameter has one and only one string value. If given Parameter does not exist, it throws a KeyNotFoundException exception.

Parameters:: Param - A key for which KeyValues object is being requested.
Returns:: String A string value for the given parameter.

printAll

 public abstract void printAll()

Prints all header/data/cookie keys and its values from the submitted form to the standard output.

printAll

 public abstract void printAll(PrintWriter pw)

Prints all header, data, cookie keys and its values from the submitted form to the given PrintWriter.

To get keys/values displayed on your standard output, just instantiate a PrintWriter object as new PrintWriter(System.out, true) and pass it to this method.
NOTE: In some cases, you may have to construct a PrintWriter object with a 'true' argument to set it to auto flush.

printKeys

 public abstract void printKeys()

Prints all form keys and its values from the submitted form to the standard output.

printKeys

 public abstract void printKeys(PrintWriter pw)

Prints all form keys and its values from the submitted form to the given PrintWriter.

printHeader

 public abstract void printHeader()

Prints all header keys and its values from the submitted form to the standard output.

printHeader

 public abstract void printHeader(PrintWriter pw)

Prints all header keys and its values from the submitted form to the given PrintWriter.

printCookies

 public abstract void printCookies()

Prints all cookie keys and its values from the submitted form to the standard output.

printCookies

 public abstract void printCookies(PrintWriter pw)

Prints all cookie keys and its values from the submitted form to the given PrintWriter.

All Packages  Class Hierarchy  This Package  Previous  Next  Index