|
OpenNMS API 1.2.3 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.opennms.web.Util
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 |
decode(java.lang.String string)
Encapsulate the deprecated decode method to fix it in one place. |
static java.lang.String |
encode(java.lang.String string)
Encapsulate the deprecated encode method to fix it in one place. |
static java.lang.String |
getHostname(java.lang.String ipAddress)
Deprecated. Please use NetworkElementFactory.getHostname 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 |
htmlify(java.lang.String input)
|
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 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 |
protected static java.lang.Boolean usePortInBaseUrls
Constructor Detail |
public Util()
Method Detail |
public static java.lang.String calculateUrlBase(javax.servlet.http.HttpServletRequest request)
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/
request
- the servlet request you are servicingpublic static java.lang.String getHostname(java.lang.String ipAddress)
NetworkElementFactory.getHostname
instead.
ipAddress
- the IP address for which you want the hostnamepublic static java.lang.String encode(java.lang.String string)
string
- string to be encoded
public static java.lang.String decode(java.lang.String string)
string
- string to be decoded
public static java.lang.String resolveIpAddress(java.lang.String ipAddress)
NetworkElementFactory.getHostname
instead.
ipAddress
- the IP address for which you want the hostnamepublic static java.lang.String getHumanReadableIfSpeed(int ifSpeed)
ifSpeed
- The bits-per-second value to be converted into a string
description
public static java.lang.String makeHiddenTags(javax.servlet.http.HttpServletRequest request)
request
- the HttpServletRequest
to read the parameters
from
paramName
" value=" paramValue
"
/> tag for each parameter.public static java.lang.String makeHiddenTags(javax.servlet.http.HttpServletRequest request, java.util.Map additions)
request
- the HttpServletRequest
to read the parameters
fromadditions
- a map of extra parameters to create hidden tags for
paramName
" value=" paramValue
"
/> tag for each parameter.public static java.lang.String makeHiddenTags(javax.servlet.http.HttpServletRequest request, java.lang.String[] ignores)
request
- the HttpServletRequest
to read the parameters
fromignores
- A string array containing request parameters to ignore
paramName
" value=" paramValue
"
/> tag for each parameter.public static java.lang.String makeHiddenTags(javax.servlet.http.HttpServletRequest request, java.util.Map additions, java.lang.String[] ignores)
request
- the HttpServletRequest
to read the parameters
fromadditions
- a map of extra parameters to create hidden tags forignores
- the list of parameters not to create a hidden tag for
paramName
" value=" paramValue
"
/> tag for each parameter not in the ignore list.public static java.lang.String makeHiddenTags(javax.servlet.http.HttpServletRequest request, java.util.Map additions, java.lang.String[] ignores, Util.IgnoreType ignoreType)
request
- the HttpServletRequest
to read the parameters
fromadditions
- a map of extra parameters to create hidden tags forignores
- the list of parameters not to create a hidden tag forignoreType
- whether the ignore list applies to the request parameters,
values in the additions map, or both
paramName
" value=" paramValue
"
/> tag for each parameter not in the ignore list.public static java.lang.String makeQueryString(javax.servlet.http.HttpServletRequest request)
HttpServletRequest
.
makeQueryString( HttpServletRequest, Map, String[] )
public static java.lang.String makeQueryString(javax.servlet.http.HttpServletRequest request, java.util.Map additions)
HttpServletRequest
and key in
given Map
.
makeQueryString( HttpServletRequest, Map, String[] )
public static java.lang.String makeQueryString(javax.servlet.http.HttpServletRequest request, java.lang.String[] ignores)
HttpServletRequest
that is not
listed in the ignore list.
makeQueryString( HttpServletRequest, Map, String[] )
public static java.lang.String makeQueryString(javax.servlet.http.HttpServletRequest request, java.util.Map additions, java.lang.String[] ignores)
HttpServletRequest
and key in
given Map
that is not listed in the ignore list.
request
- the HttpServletRequest
to read the parameters
fromadditions
- a mapping of strings to strings or string arrays to be
included in the query stringignores
- the list of parameters and map entries not to include
public static java.lang.String makeQueryString(javax.servlet.http.HttpServletRequest request, java.util.Map additions, java.lang.String[] ignores, Util.IgnoreType ignoreType)
HttpServletRequest
and key in
given Map
that is not listed in the ignore list.
request
- the HttpServletRequest
to read the parameters
fromadditions
- a mapping of strings to strings or string arrays to be
included in the query stringignores
- the list of parameters and map entries not to include
public static java.util.Map getOrderedMap(java.lang.String[][] names)
public static void streamToStream(java.io.Reader in, java.io.Writer out) throws java.io.IOException
Reader
and then
immediately writing that data to a Writer
with a default
buffer size of one kilobyte (1,024 chars).
in
- a data sourceout
- a data sink
java.io.IOException
public static void streamToStream(java.io.Reader in, java.io.Writer out, int bufferSize) throws java.io.IOException
Reader
and then
immediately writing that data to a Writer
.
in
- a data sourceout
- a data sinkbufferSize
- the size of the char
buffer to use for each
read/write
java.io.IOException
public static void streamToStream(java.io.InputStream in, java.io.OutputStream out) throws java.io.IOException
InputStream
and then immediately writing that data to an OutputStream
with a default buffer size of one kilobyte (1,024 bytes).
in
- a data sourceout
- a data sink
java.io.IOException
public static void streamToStream(java.io.InputStream in, java.io.OutputStream out, int bufferSize) throws java.io.IOException
InputStream
and then immediately writing that data to an OutputStream
.
in
- a data sourceout
- a data sinkbufferSize
- the size of the byte
buffer to use for each
read/write
java.io.IOException
public static java.lang.String[] createCommandArray(java.lang.String s, char delim)
The default Runtime.exec
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.
s
- the string to splitdelim
- a char that does not already exist in s
java.lang.IllegalArgumentException
- If s
is null or if delim
already exists in s
.public static java.lang.String htmlify(java.lang.String input)
|
OpenNMS API 1.2.3 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |