LogViewHandlers (Admin Console Common 6.0.0-RC1 API)

java.lang.Object
- org.glassfish.admingui.common.handlers.LogViewHandlers

public class LogViewHandlers
extends Object

Field Summary

Fields
Modifier and Type	Field and Description
`static Integer`	`DEFAULT_NUMBER_TO_DISPLAY` If the number to display is not specified, this value will be used (40).
`static char`	`EQUALS` This is the delimiter between the property name and property value.
`static String`	`FIRST_LOG_ROW`
`static int`	`FROM_RECORD`
`static String`	`GET_DATE_FULL` This defines the full date format, used by DATE_FORMAT.
`static String`	`GET_DATE_LONG` This defines the long date format, used by DATE_FORMAT.
`static String`	`GET_DATE_MEDIUM` This defines the medium date format, used by DATE_FORMAT.
`static String`	`GET_DATE_SHORT` This defines the short date format, used by DATE_FORMAT.
`static String`	`LAST_LOG_ROW`
`static String`	`LEVEL_IMAGE_ROOT` This is the root directory of the alert images
`static String`	`NVP_DELIMITERS` The following constant defines the valid delimiters that can be used to seperate nvp entries on input.
`static long`	`ONE_HOUR`
`static String`	`SHOW_LEVEL_IMAGE` This model key is set by the filter method, it is true if a level image should be displayed.
`static String`	`TIME_FORMAT` This specifies how TIME fields are input and displayed.
`static String`	`TIME_FORMAT_2`
`static String`	`TIME_FORMAT_3`

Constructor Summary

Constructors
Constructor and Description

LogViewHandlers()
Creates a new instance of LogViewHandlers

Constructors
Constructor and Description
`LogViewHandlers()` Creates a new instance of LogViewHandlers

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected static Date`	`convertDateTime(com.sun.jsftemplating.layout.descriptors.handler.HandlerContext handlerCtx, Object date, Object time)` This method converts a date/time string to a Date.
`protected static String`	`formatArrayForDisplay(String[] diag)` This method formats the diagnostic to be displayed for HTML Add ' ' to each elements of the ArrayList and returns the String.
`static String`	`formatDateForDisplay(Locale locale, Date date)` This method formats a log file date to a more readable date (based on locale).
`void`	`getDate(com.sun.jsftemplating.layout.descriptors.handler.HandlerContext handlerCtx)` This method returns the current date (as a String).
`static void`	`getFirstLastRecord(com.sun.jsftemplating.layout.descriptors.handler.HandlerContext handlerCtx)` This handler returns the first and last log record.
`void`	`getFormattedDateTime(com.sun.jsftemplating.layout.descriptors.handler.HandlerContext handlerCtx)` This method returns the formatted date (as a String).
`static void`	`getLogQueryAttributes(com.sun.jsftemplating.layout.descriptors.handler.HandlerContext handlerCtx)` This handler creates a Map<String, String> which contains the QUERY_STRING parameters that should be passed to the REST logging endpoint to make a query with the given constraints.
`void`	`getTime(com.sun.jsftemplating.layout.descriptors.handler.HandlerContext handlerCtx)` This method puts the current time (as a String) in the desired attribute.
`static void`	`processLogRecords(com.sun.jsftemplating.layout.descriptors.handler.HandlerContext handlerCtx)` This handler creates a Map<String, String> which contains the QUERY_STRING parameters that should be passed to the REST logging endpoint to make a query with the given constraints.

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

- Field Detail
  - GET_DATE_SHORT
```
public static final String GET_DATE_SHORT
```
    This defines the short date format, used by DATE_FORMAT. ("short")
    
    See Also:
    
    Constant Field Values
  - GET_DATE_MEDIUM
```
public static final String GET_DATE_MEDIUM
```
    This defines the medium date format, used by DATE_FORMAT. ("medium")
    
    See Also:
    
    Constant Field Values
  - GET_DATE_LONG
```
public static final String GET_DATE_LONG
```
    This defines the long date format, used by DATE_FORMAT. ("long")
    
    See Also:
    
    Constant Field Values
  - GET_DATE_FULL
```
public static final String GET_DATE_FULL
```
    This defines the full date format, used by DATE_FORMAT. ("full")
    
    See Also:
    
    Constant Field Values
  - TIME_FORMAT
```
public static final String TIME_FORMAT
```
    This specifies how TIME fields are input and displayed. We need to do this in order to get a display/input that works with milliseconds. Perhaps in the future we may want to just append the milliseconds?
    
    See Also:
    
    Constant Field Values
  - TIME_FORMAT_2
```
public static final String TIME_FORMAT_2
```
    See Also:
    
    Constant Field Values
  - TIME_FORMAT_3
```
public static final String TIME_FORMAT_3
```
    See Also:
    
    Constant Field Values
  - DEFAULT_NUMBER_TO_DISPLAY
```
public static final Integer DEFAULT_NUMBER_TO_DISPLAY
```
    If the number to display is not specified, this value will be used (40).
  - FIRST_LOG_ROW
```
public static final String FIRST_LOG_ROW
```
    See Also:
    
    Constant Field Values
  - FROM_RECORD
```
public static final int FROM_RECORD
```
    See Also:
    
    Constant Field Values
  - LAST_LOG_ROW
```
public static final String LAST_LOG_ROW
```
    See Also:
    
    Constant Field Values
  - NVP_DELIMITERS
```
public static final String NVP_DELIMITERS
```
    The following constant defines the valid delimiters that can be used to seperate nvp entries on input. (" \t\n\r\f,;:")
    
    See Also:
    
    Constant Field Values
  - EQUALS
```
public static final char EQUALS
```
    This is the delimiter between the property name and property value.
    
    See Also:
    
    Constant Field Values
  - SHOW_LEVEL_IMAGE
```
public static final String SHOW_LEVEL_IMAGE
```
    This model key is set by the filter method, it is true if a level image should be displayed.
    
    See Also:
    
    Constant Field Values
  - LEVEL_IMAGE_ROOT
```
public static final String LEVEL_IMAGE_ROOT
```
    This is the root directory of the alert images
    
    See Also:
    
    Constant Field Values
  - ONE_HOUR
```
public static final long ONE_HOUR
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - LogViewHandlers
```
public LogViewHandlers()
```
    Creates a new instance of LogViewHandlers
- Method Detail
  - getLogQueryAttributes
```
public static void getLogQueryAttributes(com.sun.jsftemplating.layout.descriptors.handler.HandlerContext handlerCtx)
```
    This handler creates a Map<String, String> which contains the QUERY_STRING parameters that should be passed to the REST logging endpoint to make a query with the given constraints.
    
    Parameters:
    
    context - The HandlerContext.
  - processLogRecords
```
public static void processLogRecords(com.sun.jsftemplating.layout.descriptors.handler.HandlerContext handlerCtx)
```
    This handler creates a Map<String, String> which contains the QUERY_STRING parameters that should be passed to the REST logging endpoint to make a query with the given constraints.
    
    Parameters:
    
    context - The HandlerContext.
  - convertDateTime
```
protected static Date convertDateTime(com.sun.jsftemplating.layout.descriptors.handler.HandlerContext handlerCtx,
                                      Object date,
                                      Object time)
```
    This method converts a date/time string to a Date.
    
    Parameters:
    
    request - The ServletRequest
    
    date - The date as a String (or the date/time as a Date)
    
    time - The time as a String (or null)
    
    vd - The ViewDescriptor (for exception handling)
    
    view - The View (for exception handling)
  - formatDateForDisplay
```
public static String formatDateForDisplay(Locale locale,
                                          Date date)
```
    This method formats a log file date to a more readable date (based on locale).
  - getFirstLastRecord
```
public static void getFirstLastRecord(com.sun.jsftemplating.layout.descriptors.handler.HandlerContext handlerCtx)
```
    This handler returns the first and last log record.
    
    Output value: "LogFileNames" -- Type: java.util.SelectItem
    
    Parameters:
    
    context - The HandlerContext.
  - formatArrayForDisplay
```
protected static String formatArrayForDisplay(String[] diag)
```
    This method formats the diagnostic to be displayed for HTML Add '
    ' to each elements of the ArrayList and returns the String.
  - getTime
```
public void getTime(com.sun.jsftemplating.layout.descriptors.handler.HandlerContext handlerCtx)
```
    This method puts the current time (as a String) in the desired attribute. The result attribute must be specified via an attribute named "getTimeResultAttribute"
  - getDate
```
public void getDate(com.sun.jsftemplating.layout.descriptors.handler.HandlerContext handlerCtx)
```
    This method returns the current date (as a String). The DATE_FORMAT must be specified, if it is not this method will fail. You may set it to "short", "medium", "long", or "FULL".
    
    If you do not set it to one of these values, you may set it to a valid format string.
  - getFormattedDateTime
```
public void getFormattedDateTime(com.sun.jsftemplating.layout.descriptors.handler.HandlerContext handlerCtx)
```
    This method returns the formatted date (as a String).

Class LogViewHandlers

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

GET_DATE_SHORT

GET_DATE_MEDIUM

GET_DATE_LONG

GET_DATE_FULL

TIME_FORMAT

TIME_FORMAT_2

TIME_FORMAT_3

DEFAULT_NUMBER_TO_DISPLAY

FIRST_LOG_ROW

FROM_RECORD

LAST_LOG_ROW

NVP_DELIMITERS

EQUALS

SHOW_LEVEL_IMAGE

LEVEL_IMAGE_ROOT

ONE_HOUR

Constructor Detail

LogViewHandlers

Method Detail

getLogQueryAttributes

processLogRecords

convertDateTime

formatDateForDisplay

getFirstLastRecord

formatArrayForDisplay

getTime

getDate

getFormattedDateTime