Overview  Package   Class  Use  Deprecated  Index
Home >> All >> org >> opennms >> [ web overview ]	PREV CLASS  NEXT CLASS
SUMMARY:  JAVADOC |  SOURCE |  DOWNLOAD | NESTED | FIELD | CONSTR | METHOD	DETAIL: FIELD | CONSTR | METHOD

---

org.opennms.web
Class Util  

java.lang.Object
  org.opennms.web.Util

---

public abstract class Util

extends java.lang.Object

Provides convenience functions for web-based interfaces.

---

Nested Class Summary
static class	Util.IgnoreType

 

Field Summary
protected static java.lang.Boolean	usePortInBaseUrls           Internal flag used to cache a servlet context parameter

 

Constructor Summary

Util()

 

Method Summary
static java.lang.String	calculateUrlBase(javax.servlet.http.HttpServletRequest request)           Return a string that represents the fully qualified URL for our servlet context, suitable for use in the HTML base tag.
static java.lang.String[]	createCommandArray(java.lang.String s, char delim)           Convenience method for creating arrays of strings suitable for use as command-line parameters when executing an external process.
static java.lang.String	getHostname(java.lang.String ipAddress)           Deprecated. Please use NetworkElementFactory.getHostname 55 instead.
static java.lang.String	getHumanReadableIfSpeed(int ifSpeed)           Method used to convert an integer bits-per-second value and a more commonly recognized abbreviation for network interface speeds.
static java.util.Map	getOrderedMap(java.lang.String[][] names)
static java.lang.String	makeHiddenTags(javax.servlet.http.HttpServletRequest request)           Creates hidden tags for all the parameters given in the request.
static java.lang.String	makeHiddenTags(javax.servlet.http.HttpServletRequest request, java.util.Map additions)           Creates hidden tags for all the parameters given in the request.
static java.lang.String	makeHiddenTags(javax.servlet.http.HttpServletRequest request, java.util.Map additions, java.lang.String[] ignores)           Creates hidden tags for all the parameters given in the request plus the additions, except for the parameters and additions listed in the ignore list.
static java.lang.String	makeHiddenTags(javax.servlet.http.HttpServletRequest request, java.util.Map additions, java.lang.String[] ignores, Util.IgnoreType ignoreType)           Creates hidden tags for all the parameters given in the request plus the additions, except for the parmeters listed in the ignore list.
static java.lang.String	makeHiddenTags(javax.servlet.http.HttpServletRequest request, java.lang.String[] ignores)           Creates hidden tags for all the parameters given in the request.
static java.lang.String	makeQueryString(javax.servlet.http.HttpServletRequest request)           Creates a query string of the format "key1=value1&key2=value2" for each parameter in the given HttpServletRequest.
static java.lang.String	makeQueryString(javax.servlet.http.HttpServletRequest request, java.util.Map additions)           Creates a query string of the format "key1=value1&key2=value2" for each parameter in the given HttpServletRequest and key in given Map.
static java.lang.String	makeQueryString(javax.servlet.http.HttpServletRequest request, java.util.Map additions, java.lang.String[] ignores)           Creates a query string of the format "key1=value1&key2=value2" for each parameter in the given HttpServletRequest and key in given Map that is not listed in the ignore list.
static java.lang.String	makeQueryString(javax.servlet.http.HttpServletRequest request, java.util.Map additions, java.lang.String[] ignores, Util.IgnoreType ignoreType)           Creates a query string of the format "key1=value1&key2=value2" for each parameter in the given HttpServletRequest and key in given Map that is not listed in the ignore list.
static java.lang.String	makeQueryString(javax.servlet.http.HttpServletRequest request, java.lang.String[] ignores)           Creates a query string of the format "key1=value1&key2=value2" for each parameter in the given HttpServletRequest that is not listed in the ignore list.
static java.lang.String	resolveIpAddress(java.lang.String ipAddress)           Deprecated. Please use NetworkElementFactory.getHostname 55 instead.
static void	streamToStream(java.io.InputStream in, java.io.OutputStream out)           Convenience method for reading data from an InputStream and then immediately writing that data to an OutputStream with a default buffer size of one kilobyte (1,024 bytes).
static void	streamToStream(java.io.InputStream in, java.io.OutputStream out, int bufferSize)           Convenience method for reading data from an InputStream and then immediately writing that data to an OutputStream.
static void	streamToStream(java.io.Reader in, java.io.Writer out)           Convenience method for reading data from a Reader and then immediately writing that data to a Writer with a default buffer size of one kilobyte (1,024 chars).
static void	streamToStream(java.io.Reader in, java.io.Writer out, int bufferSize)           Convenience method for reading data from a Reader and then immediately writing that data to a Writer.

 

Methods inherited from class java.lang.Object

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

 

Field Detail

usePortInBaseUrls

protected static java.lang.Boolean usePortInBaseUrls

Internal flag used to cache a servlet context parameter

Constructor Detail

Util

public Util()

Method Detail

calculateUrlBase

public static java.lang.String calculateUrlBase(javax.servlet.http.HttpServletRequest request)

Return a string that represents the fully qualified URL for our servlet context, suitable for use in the HTML base tag.

As an example, suppose your host was www.mycompany.com, you are serving from port 80, and your web application name was "opennms," then this method would return: http://www.mycompany.com:80/opennms/

---

getHostname

public static java.lang.String getHostname(java.lang.String ipAddress)

Deprecated. Please use NetworkElementFactory.getHostname 55 instead.

Convenience method for resolving the human-readable hostname for an IP address, if at all possible. If the hostname cannot be found, this method returns the IP address parameter.

---

resolveIpAddress

public static java.lang.String resolveIpAddress(java.lang.String ipAddress)

Deprecated. Please use NetworkElementFactory.getHostname 55 instead.

Convenience method for resolving the human-readable hostname for an IP address, if at all possible. If the hostname cannot be found, from the table, this method returns the IP address parameter. This method doesnt throw any exception.

---

getHumanReadableIfSpeed

public static java.lang.String getHumanReadableIfSpeed(int ifSpeed)

Method used to convert an integer bits-per-second value and a more commonly recognized abbreviation for network interface speeds. Feel free to expand it as necessary to accomodate different values.

---

makeHiddenTags

public static java.lang.String makeHiddenTags(javax.servlet.http.HttpServletRequest request)

Creates hidden tags for all the parameters given in the request.

---

makeHiddenTags

public static java.lang.String makeHiddenTags(javax.servlet.http.HttpServletRequest request,
                                              java.util.Map additions)

Creates hidden tags for all the parameters given in the request.

---

makeHiddenTags

public static java.lang.String makeHiddenTags(javax.servlet.http.HttpServletRequest request,
                                              java.lang.String[] ignores)

Creates hidden tags for all the parameters given in the request.

---

makeHiddenTags

public static java.lang.String makeHiddenTags(javax.servlet.http.HttpServletRequest request,
                                              java.util.Map additions,
                                              java.lang.String[] ignores)

Creates hidden tags for all the parameters given in the request plus the additions, except for the parameters and additions listed in the ignore list.

---

makeHiddenTags

public static java.lang.String makeHiddenTags(javax.servlet.http.HttpServletRequest request,
                                              java.util.Map additions,
                                              java.lang.String[] ignores,
                                              Util.IgnoreType ignoreType)

Creates hidden tags for all the parameters given in the request plus the additions, except for the parmeters listed in the ignore list.

---

makeQueryString

public static java.lang.String makeQueryString(javax.servlet.http.HttpServletRequest request)

Creates a query string of the format "key1=value1&key2=value2" for each parameter in the given HttpServletRequest.

---

makeQueryString

public static java.lang.String makeQueryString(javax.servlet.http.HttpServletRequest request,
                                               java.util.Map additions)

Creates a query string of the format "key1=value1&key2=value2" for each parameter in the given HttpServletRequest and key in given Map.

---

makeQueryString

public static java.lang.String makeQueryString(javax.servlet.http.HttpServletRequest request,
                                               java.lang.String[] ignores)

Creates a query string of the format "key1=value1&key2=value2" for each parameter in the given HttpServletRequest that is not listed in the ignore list.

---

makeQueryString

public static java.lang.String makeQueryString(javax.servlet.http.HttpServletRequest request,
                                               java.util.Map additions,
                                               java.lang.String[] ignores)

Creates a query string of the format "key1=value1&key2=value2" for each parameter in the given HttpServletRequest and key in given Map that is not listed in the ignore list.

---

makeQueryString

public static java.lang.String makeQueryString(javax.servlet.http.HttpServletRequest request,
                                               java.util.Map additions,
                                               java.lang.String[] ignores,
                                               Util.IgnoreType ignoreType)

Creates a query string of the format "key1=value1&key2=value2" for each parameter in the given HttpServletRequest and key in given Map that is not listed in the ignore list.

---

getOrderedMap

public static java.util.Map getOrderedMap(java.lang.String[][] names)

---

streamToStream

public static void streamToStream(java.io.Reader in,
                                  java.io.Writer out)
                           throws java.io.IOException

Convenience method for reading data from a Reader and then immediately writing that data to a Writer with a default buffer size of one kilobyte (1,024 chars).

---

streamToStream

public static void streamToStream(java.io.Reader in,
                                  java.io.Writer out,
                                  int bufferSize)
                           throws java.io.IOException

Convenience method for reading data from a Reader and then immediately writing that data to a Writer.

---

streamToStream

public static void streamToStream(java.io.InputStream in,
                                  java.io.OutputStream out)
                           throws java.io.IOException

Convenience method for reading data from an InputStream and then immediately writing that data to an OutputStream with a default buffer size of one kilobyte (1,024 bytes).

---

streamToStream

public static void streamToStream(java.io.InputStream in,
                                  java.io.OutputStream out,
                                  int bufferSize)
                           throws java.io.IOException

Convenience method for reading data from an InputStream and then immediately writing that data to an OutputStream.

---

createCommandArray

public static java.lang.String[] createCommandArray(java.lang.String s,
                                                    char delim)

Convenience method for creating arrays of strings suitable for use as command-line parameters when executing an external process.

The default Runtime.exec 55 method will split a single string based on spaces, but it does not respect spaces within quotation marks, and it will leave the quotation marks in the resulting substrings. This method solves those problems by replacing all in-quote spaces with the given delimiter, removes the quotes, and then splits the resulting string by the remaining out-of-quote spaces. It then goes through each substring and replaces the delimiters with spaces.

Caveat: This method does not respect escaped quotes! It will simply remove them and leave the stray escape characters.

---

Overview  Package   Class  Use  Deprecated  Index
Home >> All >> org >> opennms >> [ web overview ]	PREV CLASS  NEXT CLASS
SUMMARY:  JAVADOC |  SOURCE |  DOWNLOAD | NESTED | FIELD | CONSTR | METHOD	DETAIL: FIELD | CONSTR | METHOD

---