ServletUtil (Oracle Communications Billing and Revenue Management Customer Center SDK Java API Reference)

java.lang.Object
- com.portal.web.ServletUtil

```
public class ServletUtil
extends Object
```
WebKit servlet utility class.

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`ACCEPT_CHARSET`
`static String`	`ACCEPT_LANGUAGE`
`static String`	`BRAND`
`static String`	`BUNDLE`
`static String`	`CHARSET`
`static String`	`CONNECTION`
`static String`	`CONTENT_LANGUAGE`
`static String`	`EXCEPTION`
`static String`	`GET_METHOD`
`static String`	`LOCALE`
`static String`	`PARENT_SERVICE`
`static String`	`POST_METHOD`
`static String`	`VARY`

Constructor Summary

Constructors
Constructor and Description

ServletUtil()

Constructors
Constructor and Description
`ServletUtil()`

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static PLightComponentHelper`	`addComponent(PIAComponentCollection col, String name, String fieldDesc)` Adds a field bean to a component collection, using the same description for both model and display fields.
`static PLightComponentHelper`	`addComponent(PIAComponentCollection col, String name, String inputFieldDesc, String outputFieldDesc)` Adds a field bean to a component collection, using the specified model and display field descriptions.
`static boolean`	`checkError(Map errorMap, PLightComponentHelper lc)` Determines whether a field bean exists in the `errorMap`.
`static Object[]`	`convertStrToArgs(String str)` Builds the arguments for `PInfranetMessageFormat`.
`static HashMap`	`gatherFormInput(javax.servlet.http.HttpServletRequest request)` Iterates through the form input sent to the servlet in the `HttpRequest` object.
`static PModelHandle`	`getModelFromSession(javax.servlet.http.HttpSession session)` Validates the session and, if valid, returns its `PModelHandle`.
`static String`	`getServiceName(PModelHandle service, javax.servlet.http.HttpSession session)` A helper function to retrieve service name from the service model
`static Object`	`logIn(PPooledConnectionClientServices pCS)` Logs into Infranet.
`static HashMap`	`parseErrorData(PIAComponentCollection col, com.portal.app.util.CustomerValErrorData[] errorData)` Performs error parsing.
`static HashMap`	`parseErrorDataEnhanced(PIAComponentCollection col, com.portal.app.util.CustomerValErrorData[] errorData)`
`static void`	`saveBrandModel(PPooledConnectionClientServices pCS, String brand, javax.servlet.http.HttpSession session)` Retrieves the brand model handle from the properties file.
`static void`	`saveLocaleInfo(javax.servlet.http.HttpServletRequest req)` Reads the HTTP headers from the `HttpRequest` object, maps the language parameters, and saves them in session.
`static void`	`setLightDataForAll(Map formInput, PIAComponentCollection col, String caller)` Performs `setLightData` on a collection of field beans.
`static String`	`validateDate(String str)` Builds the arguments for `PInfranetMessageFormat`.

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

- Field Detail
  - BUNDLE
```
public static final String BUNDLE
```
    See Also:
    
    Constant Field Values
  - POST_METHOD
```
public static final String POST_METHOD
```
    See Also:
    
    Constant Field Values
  - GET_METHOD
```
public static final String GET_METHOD
```
    See Also:
    
    Constant Field Values
  - LOCALE
```
public static final String LOCALE
```
    See Also:
    
    Constant Field Values
  - CHARSET
```
public static final String CHARSET
```
    See Also:
    
    Constant Field Values
  - BRAND
```
public static final String BRAND
```
    See Also:
    
    Constant Field Values
  - CONTENT_LANGUAGE
```
public static final String CONTENT_LANGUAGE
```
    See Also:
    
    Constant Field Values
  - VARY
```
public static final String VARY
```
    See Also:
    
    Constant Field Values
  - ACCEPT_LANGUAGE
```
public static final String ACCEPT_LANGUAGE
```
    See Also:
    
    Constant Field Values
  - ACCEPT_CHARSET
```
public static final String ACCEPT_CHARSET
```
    See Also:
    
    Constant Field Values
  - EXCEPTION
```
public static final String EXCEPTION
```
    See Also:
    
    Constant Field Values
  - CONNECTION
```
public static final String CONNECTION
```
    See Also:
    
    Constant Field Values
  - PARENT_SERVICE
```
public static final String PARENT_SERVICE
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - ServletUtil
```
public ServletUtil()
```
- Method Detail
  - logIn
```
public static Object logIn(PPooledConnectionClientServices pCS)
```
    Logs into Infranet.
    
    Parameters:
    
    pCS - the pooled client connection services
    
    Returns:
    
    A connection key.
  - saveLocaleInfo
```
public static void saveLocaleInfo(javax.servlet.http.HttpServletRequest req)
```
    Reads the HTTP headers from the HttpRequest object, maps the language parameters, and saves them in session.
    
    Parameters:
    
    req - the servlet request
  - gatherFormInput
```
public static HashMap gatherFormInput(javax.servlet.http.HttpServletRequest request)
```
    Iterates through the form input sent to the servlet in the HttpRequest object.
    
    Parameters:
    
    request - the servlet request
    
    Returns:
    
    All input data in a HashMap.
  - setLightDataForAll
```
public static void setLightDataForAll(Map formInput,
                                      PIAComponentCollection col,
                                      String caller)
```
    Performs setLightData on a collection of field beans.
    
    Parameters:
    
    formInput - map of all input data
    
    col - the collection of field beans
    
    caller - caller information to log
  - parseErrorData
```
public static HashMap parseErrorData(PIAComponentCollection col,
                                     com.portal.app.util.CustomerValErrorData[] errorData)
```
    Performs error parsing.
    
    Parameters:
    
    col - a collection of field beans
    
    errorData - error data
    
    Returns:
    
    A map of the field beans in error, with an error message.
  - parseErrorDataEnhanced
```
public static HashMap parseErrorDataEnhanced(PIAComponentCollection col,
                                             com.portal.app.util.CustomerValErrorData[] errorData)
```
  - checkError
```
public static boolean checkError(Map errorMap,
                                 PLightComponentHelper lc)
```
    Determines whether a field bean exists in the errorMap.
    
    Parameters:
    
    errorMap - a map of the field beans in error, with an error message
    
    lc - the field bean to search for in the errorMap
    
    Returns:
    
    True, if the field bean exists in the errorMap; false otherwise.
  - getModelFromSession
```
public static PModelHandle getModelFromSession(javax.servlet.http.HttpSession session)
                                        throws InvalidSessionException
```
    Validates the session and, if valid, returns its PModelHandle.
    
    Parameters:
    
    session - the HTTP session
    
    Returns:
    
    The PModelHandle for the validated session.
    
    Throws:
    
    InvalidSessionException - thrown if the session has expired or the model handle is null
  - addComponent
```
public static PLightComponentHelper addComponent(PIAComponentCollection col,
                                                 String name,
                                                 String fieldDesc)
```
    Adds a field bean to a component collection, using the same description for both model and display fields.
    
    Parameters:
    
    col - the component collection
    
    name - a String with the name of the field bean
    
    fieldDesc - a String to use for both the modelFieldDescription and displayFieldDescription
    
    Returns:
    
    The field bean.
  - addComponent
```
public static PLightComponentHelper addComponent(PIAComponentCollection col,
                                                 String name,
                                                 String inputFieldDesc,
                                                 String outputFieldDesc)
```
    Adds a field bean to a component collection, using the specified model and display field descriptions.
    
    Parameters:
    
    col - the component collection
    
    name - a String with the name of the field bean
    
    inputFieldDesc - a String to use for the modelFieldDescription
    
    outputFieldDesc - a String to use for the displayFieldDescription
    
    Returns:
    
    The field bean.
  - convertStrToArgs
```
public static Object[] convertStrToArgs(String str)
```
    Builds the arguments for PInfranetMessageFormat.
    
    Parameters:
    
    str - a String that contains the arguments to parse
    
    Returns:
    
    The parsed arguments.
  - validateDate
```
public static String validateDate(String str)
```
    Builds the arguments for PInfranetMessageFormat.
    
    Parameters:
    
    str - a String that contains the arguments to parse
    
    Returns:
    
    The parsed arguments.
  - saveBrandModel
```
public static void saveBrandModel(PPooledConnectionClientServices pCS,
                                  String brand,
                                  javax.servlet.http.HttpSession session)
                           throws RemoteException
```
    Retrieves the brand model handle from the properties file.
    
    Parameters:
    
    pCS - the pooled client connection services
    
    brand - the brand resource ID specified in the properties file
    
    session - the HttpSession
    
    Throws:
    
    RemoteException
  - getServiceName
```
public static String getServiceName(PModelHandle service,
                                    javax.servlet.http.HttpSession session)
                             throws RemoteException
```
    A helper function to retrieve service name from the service model
    
    Parameters:
    
    service - service model
    
    session - HttpSession
    
    Returns:
    
    service name
    
    Throws:
    
    RemoteException

Class ServletUtil

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

BUNDLE

POST_METHOD

GET_METHOD

LOCALE

CHARSET

BRAND

CONTENT_LANGUAGE

VARY

ACCEPT_LANGUAGE

ACCEPT_CHARSET

EXCEPTION

CONNECTION

PARENT_SERVICE

Constructor Detail

ServletUtil

Method Detail

logIn

saveLocaleInfo

gatherFormInput

setLightDataForAll

parseErrorData

parseErrorDataEnhanced

checkError

getModelFromSession

addComponent

addComponent

convertStrToArgs

validateDate

saveBrandModel

getServiceName