WSRPConstants (GateIn WSRP Common Classes 2.3.1.Final API)

java.lang.Object
- org.gatein.wsrp.WSRPConstants

```
public final class WSRPConstants
extends Object
```
Since:

2.4

Version:

$Revision: 11317 $

Author:

Chris Laprun

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`CACHE_FOR_ALL` The markup is not specific to the UserContext and therefore may be supplied to all users of the Consumer.
`static String`	`CACHE_PER_USER` The markup is specific to the userContext for which it was generated.
`static String`	`CERTIFICATE_USER_AUTHENTICATION` The End-User presented a security certificate to validate their identity.
`static String`	`CONSUMER_AGENT` The String identifying the portal consumer agent
`static String`	`DEFAULT_CHARACTER_SET` Default character set used to generate markup.
`static String`	`DEFAULT_CONSUMER_NAME` Default consumer name if none has been provided in the WSRP descriptor (*-wsrp.xml)
`static String`	`DEFAULT_LOCALE`
`static String`	`EDIT_MODE` Within the `wsrp:edit` mode, a Portlet should provide content and logic that let a user customize the behavior of the Portlet , though such customizations are not limited to screens generated while in this mode.
`static String`	`FROM_WSRP_ATTRIBUTE_NAME` The name of the attribute used by the producer to set a portlet request attribute to `Boolean.TRUE` as part of its invocation process to allow the invoked portlets to check whether the request is coming from WSRP.
`static String`	`HELP_MODE` When in `wsrp:help` mode, a Portlet may provide help screens that explains the Portlet and its expected usage.
`static String`	`MAXIMIZED_WINDOW_STATE` The `wsrp:maximized` window state is an indication the Portlet is likely the only Portlet being rendered in the aggregated page, or that the Portlet has more space compared to other Portlets in the aggregated page.
`static String`	`MINIMIZED_WINDOW_STATE` When the window state is `wsrp:minimized`, the Portlet SHOULD NOT render visible markup, but is free to include non-visible data such as JavaScript or hidden forms.
`static String`	`NONE_USER_AUTHENTICATION` No authentication was done, user information is asserted for informational purposes only.
`static String`	`NORMAL_WINDOW_STATE` The `wsrp:normal` window state indicates the Portlet is likely sharing the aggregated page with other Portlets.
`static String`	`PASSWORD_USER_AUTHENTICATION` The End-User identified themselves using the common userid/password scenario.
`static String`	`PREVIEW_MODE` In `wsrp:preview` mode, a Portlet should provide a rendering of its standard `wsrp:view` mode content, as a visual sample of how this Portlet will appear on the End-User's page with the current configuration.
`static boolean`	`RUNS_IN_EPP`
`static String`	`SERVICES_DIRECTORY_URL` The directory where WSRP services are deployed for automatic detection by `ResourceFinder`.
`static int`	`SESSION_NEVER_EXPIRES` The value of SessionContext.expires if the session will never expire.
`static String`	`SOLO_WINDOW_STATE` The `wsrp:solo` window state is an indication the Portlet is the only Portlet being rendered in the aggregated page.
`static String`	`VIEW_MODE` The expected functionality for a Portlet in `wsrp:view` mode is to render markup reflecting the current state of the Portlet.
`static String`	`WSRP_SERVICE_VERSION` The version of the WSRP service.
`static QName`	`XSD_ANY_SIMPLE_TYPE`
`static QName`	`XSD_BASE_64_BINARY`
`static QName`	`XSD_BOOLEAN`
`static QName`	`XSD_BYTE`
`static QName`	`XSD_DATE`
`static QName`	`XSD_DATE_TIME`
`static QName`	`XSD_DECIMAL`
`static QName`	`XSD_DOUBLE`
`static QName`	`XSD_FLOAT`
`static QName`	`XSD_HEX_BINARY`
`static QName`	`XSD_INT`
`static QName`	`XSD_INTEGER`
`static QName`	`XSD_LONG`
`static QName`	`XSD_SHORT`
`static QName`	`XSD_STRING` A QName representing the string type defined as part of XML Schemas Part 2
`static QName`	`XSD_TIME`
`static QName`	`XSD_UNSIGNED_INT`
`static QName`	`XSD_UNSIGNED_SHORT`

Method Summary

Methods
Modifier and Type Method and Description

static List<String> getDefaultLocales()

static List<String> getDefaultMimeTypes()
- Methods inherited from class java.lang.Object
  clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods
Modifier and Type	Method and Description
`static List<String>`	`getDefaultLocales()`
`static List<String>`	`getDefaultMimeTypes()`

- Field Detail
  - RUNS_IN_EPP
```
public static final boolean RUNS_IN_EPP
```
  - SERVICES_DIRECTORY_URL
```
public static String SERVICES_DIRECTORY_URL
```
    The directory where WSRP services are deployed for automatic detection by ResourceFinder.
  - WSRP_SERVICE_VERSION
```
public static final String WSRP_SERVICE_VERSION
```
    The version of the WSRP service. This should match the maven version of the module. Right now, checked via the UpdateWSRPForGatein.sh script.
  - NORMAL_WINDOW_STATE
```
public static final String NORMAL_WINDOW_STATE
```
    The wsrp:normal window state indicates the Portlet is likely sharing the aggregated page with other Portlets. The wsrp:normal window state MAY also indicate that the target device has limited display capabilities. Therefore, a Portlet SHOULD restrict the size of its rendered output in this window state.
    
    Conformant Portlets MUST support the wsrp:normal window state.
    
    See Also:
    Constant Field Values
  - MINIMIZED_WINDOW_STATE
```
public static final String MINIMIZED_WINDOW_STATE
```
    When the window state is wsrp:minimized, the Portlet SHOULD NOT render visible markup, but is free to include non-visible data such as JavaScript or hidden forms. The getMarkup operation can be invoked for the wsrp:minimized state just as for all other window states.
    
    See Also:
    Constant Field Values
  - MAXIMIZED_WINDOW_STATE
```
public static final String MAXIMIZED_WINDOW_STATE
```
    The wsrp:maximized window state is an indication the Portlet is likely the only Portlet being rendered in the aggregated page, or that the Portlet has more space compared to other Portlets in the aggregated page. A Portlet SHOULD generate richer content when its window state is wsrp:maximized.
    
    See Also:
    Constant Field Values
  - SOLO_WINDOW_STATE
```
public static final String SOLO_WINDOW_STATE
```
    The wsrp:solo window state is an indication the Portlet is the only Portlet being rendered in the aggregated page. A Portlet SHOULD generate richer content when its window state is wsrp:solo.
    
    See Also:
    Constant Field Values
  - VIEW_MODE
```
public static final String VIEW_MODE
```
    The expected functionality for a Portlet in wsrp:view mode is to render markup reflecting the current state of the Portlet. The wsrp:view mode of a Portlet will include one or more screens that the End-User can navigate and interact with or it may consist of static content devoid of user interactions.
    
    The behavior and the generated content of a Portlet in the wsrp:view mode may depend on configuration, personalization and all forms of state.
    
    Conformant Portlets MUST support the wsrp:view mode.
    
    See Also:
    Constant Field Values
  - EDIT_MODE
```
public static final String EDIT_MODE
```
    Within the wsrp:edit mode, a Portlet should provide content and logic that let a user customize the behavior of the Portlet , though such customizations are not limited to screens generated while in this mode. The wsrp:edit mode can include one or more screens which users can navigate to enter their customization data.
    
    Typically, Portlets in wsrp:edit mode will set or update Portlet enduring state. How such changes impact Consumer management of Portlet usage by End-Users is discussed in [Section 6.4.3].
    
    See Also:
    Constant Field Values
  - HELP_MODE
```
public static final String HELP_MODE
```
    When in wsrp:help mode, a Portlet may provide help screens that explains the Portlet and its expected usage. Some Portlets will provide context-sensitive help based on the markup the End-User was viewing when entering this mode.
    
    See Also:
    Constant Field Values
  - PREVIEW_MODE
```
public static final String PREVIEW_MODE
```
    In wsrp:preview mode, a Portlet should provide a rendering of its standard wsrp:view mode content, as a visual sample of how this Portlet will appear on the End-User's page with the current configuration. This could be useful for a Consumer that offers an advanced layout capability.
    
    See Also:
    Constant Field Values
  - NONE_USER_AUTHENTICATION
```
public static final String NONE_USER_AUTHENTICATION
```
    No authentication was done, user information is asserted for informational purposes only.
    
    See Also:
    Constant Field Values
  - PASSWORD_USER_AUTHENTICATION
```
public static final String PASSWORD_USER_AUTHENTICATION
```
    The End-User identified themselves using the common userid/password scenario.
    
    See Also:
    Constant Field Values
  - CERTIFICATE_USER_AUTHENTICATION
```
public static final String CERTIFICATE_USER_AUTHENTICATION
```
    The End-User presented a security certificate to validate their identity.
    
    See Also:
    Constant Field Values
  - DEFAULT_CHARACTER_SET
```
public static final String DEFAULT_CHARACTER_SET
```
    Default character set used to generate markup.
    
    See Also:
    Constant Field Values
  - DEFAULT_CONSUMER_NAME
```
public static final String DEFAULT_CONSUMER_NAME
```
    Default consumer name if none has been provided in the WSRP descriptor (*-wsrp.xml)
  - CONSUMER_AGENT
```
public static final String CONSUMER_AGENT
```
    The String identifying the portal consumer agent
  - CACHE_PER_USER
```
public static final String CACHE_PER_USER
```
    The markup is specific to the userContext for which it was generated. Changes to the data of the UserContext MUST invalidate the cached markup.
    
    See Also:
    Constant Field Values
  - CACHE_FOR_ALL
```
public static final String CACHE_FOR_ALL
```
    The markup is not specific to the UserContext and therefore may be supplied to all users of the Consumer.
    
    See Also:
    Constant Field Values
  - SESSION_NEVER_EXPIRES
```
public static final int SESSION_NEVER_EXPIRES
```
    The value of SessionContext.expires if the session will never expire.
    
    See Also:
    Constant Field Values
  - XSD_STRING
```
public static final QName XSD_STRING
```
    A QName representing the string type defined as part of XML Schemas Part 2
  - XSD_INTEGER
```
public static final QName XSD_INTEGER
```
  - XSD_INT
```
public static final QName XSD_INT
```
  - XSD_LONG
```
public static final QName XSD_LONG
```
  - XSD_SHORT
```
public static final QName XSD_SHORT
```
  - XSD_DECIMAL
```
public static final QName XSD_DECIMAL
```
  - XSD_FLOAT
```
public static final QName XSD_FLOAT
```
  - XSD_DOUBLE
```
public static final QName XSD_DOUBLE
```
  - XSD_BOOLEAN
```
public static final QName XSD_BOOLEAN
```
  - XSD_BYTE
```
public static final QName XSD_BYTE
```
  - XSD_DATE_TIME
```
public static final QName XSD_DATE_TIME
```
  - XSD_BASE_64_BINARY
```
public static final QName XSD_BASE_64_BINARY
```
  - XSD_HEX_BINARY
```
public static final QName XSD_HEX_BINARY
```
  - XSD_UNSIGNED_INT
```
public static final QName XSD_UNSIGNED_INT
```
  - XSD_UNSIGNED_SHORT
```
public static final QName XSD_UNSIGNED_SHORT
```
  - XSD_TIME
```
public static final QName XSD_TIME
```
  - XSD_DATE
```
public static final QName XSD_DATE
```
  - XSD_ANY_SIMPLE_TYPE
```
public static final QName XSD_ANY_SIMPLE_TYPE
```
  - FROM_WSRP_ATTRIBUTE_NAME
```
public static final String FROM_WSRP_ATTRIBUTE_NAME
```
    The name of the attribute used by the producer to set a portlet request attribute to Boolean.TRUE as part of its invocation process to allow the invoked portlets to check whether the request is coming from WSRP.
    
    See Also:
    Constant Field Values
  - DEFAULT_LOCALE
```
public static String DEFAULT_LOCALE
```
- Method Detail
  - getDefaultLocales
```
public static List<String> getDefaultLocales()
```
  - getDefaultMimeTypes
```
public static List<String> getDefaultMimeTypes()
```

Class WSRPConstants

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

RUNS_IN_EPP

SERVICES_DIRECTORY_URL

WSRP_SERVICE_VERSION

NORMAL_WINDOW_STATE

MINIMIZED_WINDOW_STATE

MAXIMIZED_WINDOW_STATE

SOLO_WINDOW_STATE

VIEW_MODE

EDIT_MODE

HELP_MODE

PREVIEW_MODE

NONE_USER_AUTHENTICATION

PASSWORD_USER_AUTHENTICATION

CERTIFICATE_USER_AUTHENTICATION

DEFAULT_CHARACTER_SET

DEFAULT_CONSUMER_NAME

CONSUMER_AGENT

CACHE_PER_USER

CACHE_FOR_ALL

SESSION_NEVER_EXPIRES

XSD_STRING

XSD_INTEGER

XSD_INT

XSD_LONG

XSD_SHORT

XSD_DECIMAL

XSD_FLOAT

XSD_DOUBLE

XSD_BOOLEAN

XSD_BYTE

XSD_DATE_TIME

XSD_BASE_64_BINARY

XSD_HEX_BINARY

XSD_UNSIGNED_INT

XSD_UNSIGNED_SHORT

XSD_TIME

XSD_DATE

XSD_ANY_SIMPLE_TYPE

FROM_WSRP_ATTRIBUTE_NAME

DEFAULT_LOCALE

Method Detail

getDefaultLocales

getDefaultMimeTypes