WebUtils (OpenKM Web Application 6.3.2 API)

java.lang.Object
- com.openkm.util.WebUtils

```
public class WebUtils
extends Object
```
Author:

jllort

Field Summary

Fields
Modifier and Type Field and Description

static String EMPTY_STRING

Fields
Modifier and Type	Field and Description
`static String`	`EMPTY_STRING`

Constructor Summary

Constructors
Constructor and Description

WebUtils()

Constructors
Constructor and Description
`WebUtils()`

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static boolean`	`getBoolean(javax.servlet.http.HttpServletRequest request, String name)` Extrae un parámetro de tipo booleano del request.
`static boolean`	`getBoolean(javax.servlet.http.HttpServletRequest request, String name, String trueValue)` Extrae un parámetro de tipo booleano del request.
`static float`	`getFloat(javax.servlet.http.HttpServletRequest request, String name)` Extrae un parámetro de tipo float del request.
`static int`	`getInt(javax.servlet.http.HttpServletRequest request, String name)` Extrae un parámetro de tipo entero del request.
`static int`	`getInt(javax.servlet.http.HttpServletRequest request, String name, int defaultValue)` Extrae un parámetro de tipo entero del request.
`static List<Integer>`	`getIntList(javax.servlet.http.HttpServletRequest request, String name)` Extrae un parámetro de tipo Integer del request.
`static long`	`getLong(javax.servlet.http.HttpServletRequest request, String name)` Extrae un parámetro de tipo long del request.
`static List<Long>`	`getLongList(javax.servlet.http.HttpServletRequest request, String name)` Extrae un parámetro de tipo Long del request.
`static String`	`getString(javax.servlet.http.HttpServletRequest request, String name)` Extrae un parámetro de tipo String del request.
`static String`	`getString(javax.servlet.http.HttpServletRequest request, String name, String defaultValue)` Extrae un parámetro de tipo String del request.
`static List<String>`	`getStringList(javax.servlet.http.HttpServletRequest request, String name)` Extrae un parámetro de tipo String del request.
`static void`	`prepareSendFile(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, String fileName, String mimeType, boolean inline)` Prepare to send the file.
`static void`	`sendFile(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, String fileName, String mimeType, boolean inline, File input)` Send file to client browser.
`static void`	`sendFile(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, String fileName, String mimeType, boolean inline, InputStream is)` Send file to client browser.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail
- EMPTY_STRING
```
public static final String EMPTY_STRING
```
  See Also:
  
  Constant Field Values

Constructor Detail
- WebUtils
```
public WebUtils()
```

Method Detail

getString
```
public static final String getString(javax.servlet.http.HttpServletRequest request,
                                     String name)
```
Extrae un parámetro de tipo String del request. Si el parámetro no existe devuelve un String vacio.

Parameters:

request - Petición de la que extraer el parámetro.

name - Nombre del parámetro

Returns:

El valor String del parámetro o un String vacio si no existe.

getString
```
public static final String getString(javax.servlet.http.HttpServletRequest request,
                                     String name,
                                     String defaultValue)
```
Extrae un parámetro de tipo String del request. Si el parámetro no existe devuelve el valor por defecto especificado.

Parameters:

request - Petición de la que extraer el parámetro.

name - Nombre del parámetro

Valor - per defecto del parámetro.

Returns:

El valor String del parámetro o el valor por defecto si no existe.

getStringList
```
public static final List<String> getStringList(javax.servlet.http.HttpServletRequest request,
                                               String name)
```
Extrae un parámetro de tipo String del request. Si el parámetro no existe devuelve un String vacio.

Parameters:

request - Petición de la que extraer el parámetro.

name - Nombre del parámetro

Returns:

El valor String del parámetro o un String vacio si no existe.

getInt
```
public static final int getInt(javax.servlet.http.HttpServletRequest request,
                               String name)
```
Extrae un parámetro de tipo entero del request. Si el parámetro no existe o no es valido devuelve 0.

Parameters:

request - Petición de la que extraer el parámetro.

name - Nombre del parámetro

Returns:

El valor int del parámetro o 0 si no existe o no es valido.

getInt
```
public static final int getInt(javax.servlet.http.HttpServletRequest request,
                               String name,
                               int defaultValue)
```
Extrae un parámetro de tipo entero del request. Si el parámetro no existe o no es valido devuelve el valor por defecto especificado.

Parameters:

request - Petición de la que extraer el parámetro.

name - Nombre del parámetro

defaultValue - Valor per defecto

Returns:

El valor int del parámetro o el valor por defecto especificado si no existe o no es valido.

getIntList
```
public static final List<Integer> getIntList(javax.servlet.http.HttpServletRequest request,
                                             String name)
```
Extrae un parámetro de tipo Integer del request. Si el parámetro no existe devuelve un Integer vacio.

Parameters:

request - Petición de la que extraer el parámetro.

name - Nombre del parámetro

Returns:

El valor String del parámetro o un String vacio si no existe.

getLongList
```
public static final List<Long> getLongList(javax.servlet.http.HttpServletRequest request,
                                           String name)
```
Extrae un parámetro de tipo Long del request. Si el parámetro no existe devuelve un Long vacio.

Parameters:

request - Petición de la que extraer el parámetro.

name - Nombre del parámetro

Returns:

El valor String del parámetro o un String vacio si no existe.

getLong
```
public static final long getLong(javax.servlet.http.HttpServletRequest request,
                                 String name)
```
Extrae un parámetro de tipo long del request. Si el parámetro no existe o no es valido devuelve 0.

Parameters:

request - Petición de la que extraer el parámetro.

name - Nombre del parámetro

Returns:

El valor int del parámetro o 0 si no existe o no es valido.

getFloat
```
public static final float getFloat(javax.servlet.http.HttpServletRequest request,
                                   String name)
```
Extrae un parámetro de tipo float del request. Si el parámetro no existe o no es valido devuelve 0.

Parameters:

request - Petición de la que extraer el parámetro.

name - Nombre del parámetro

Returns:

El valor float del parámetro o 0 si no existe o no es valido.

getBoolean
```
public static final boolean getBoolean(javax.servlet.http.HttpServletRequest request,
                                       String name)
```
Extrae un parámetro de tipo booleano del request. Si el parámetro existe y no esta vacio devuelve true, en caso contrario devuelve false.

Parameters:

request - Petición de la que extraer el parámetro.

name - Nombre del parámetro

Returns:

true si el parámetro existe y no esta vacio, false en caso contrario.

getBoolean
```
public static final boolean getBoolean(javax.servlet.http.HttpServletRequest request,
                                       String name,
                                       String trueValue)
```
Extrae un parámetro de tipo booleano del request. Si el parámetro existe y es igual al valor especificado devuelve true, en caso contrario devuelve false.

Parameters:

request - Petición de la que extraer el parámetro.

name - Nombre del parámetro

trueValue - Valor considerado true.

Returns:

true si el parámetro existe y es igual a trueValue, false en caso contrario.

sendFile

public static void sendFile(javax.servlet.http.HttpServletRequest request,
                            javax.servlet.http.HttpServletResponse response,
                            String fileName,
                            String mimeType,
                            boolean inline,
                            InputStream is)
                     throws IOException

Send file to client browser.

Throws:: IOException - If there is a communication error.

sendFile

public static void sendFile(javax.servlet.http.HttpServletRequest request,
                            javax.servlet.http.HttpServletResponse response,
                            String fileName,
                            String mimeType,
                            boolean inline,
                            File input)
                     throws IOException

Send file to client browser.

Throws:: IOException - If there is a communication error.

prepareSendFile

public static void prepareSendFile(javax.servlet.http.HttpServletRequest request,
                                   javax.servlet.http.HttpServletResponse response,
                                   String fileName,
                                   String mimeType,
                                   boolean inline)
                            throws UnsupportedEncodingException

Prepare to send the file.

Throws:: UnsupportedEncodingException

Class WebUtils

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

EMPTY_STRING

Constructor Detail

WebUtils

Method Detail

getString

getString

getStringList

getInt

getInt

getIntList

getLongList

getLong

getFloat

getBoolean

getBoolean

sendFile

sendFile

prepareSendFile