Constants (OSIVIA Portal - API library 4.9.3 API)

java.lang.Object
- org.osivia.portal.api.Constants

public final class Constants
extends Object

Constants.

Author:: Cédric Krommenhoek

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`ATTR_BREADCRUMB` Breadcrumb content attribute name.
`static String`	`ATTR_FIRST_TAB` First tab attribute name.
`static String`	`ATTR_HEADER_APPLICATION_NAME` Application name.
`static String`	`ATTR_HEADER_CANONICAL_URL` Canonical URL.
`static String`	`ATTR_HEADER_METADATA` content of meta tags.
`static String`	`ATTR_HEADER_PORTAL_BASE_URL` Portal base URL.
`static String`	`ATTR_HEADER_TITLE` content of title tag
`static String`	`ATTR_LOGGED_PERSON` Deprecated. please use ATTR_LOGGED_PERSON_2
`static String`	`ATTR_LOGGED_PERSON_2` Logged person.
`static String`	`ATTR_PAGE_CATEGORY` Page category attribute name.
`static String`	`ATTR_PAGE_ID` Current page identifier attribute name.
`static String`	`ATTR_PAGE_NAME` Current page name attribute name.
`static String`	`ATTR_PORTAL_CTX` Portal controller context attribute name.
`static String`	`ATTR_PORTAL_HOME_URL` Portal home page URL.
`static String`	`ATTR_SEARCH_URL` Search URL attribute name.
`static String`	`ATTR_SEARCH_WEB_URL` Search web URL attribute name.
`static String`	`ATTR_SITE_MAP` Site map attribute name.
`static String`	`ATTR_SPACE_CONFIG` Native space object attribute name.
`static String`	`ATTR_SPACE_SITE_INDICATOR` Space site indicator.
`static String`	`ATTR_TOOLBAR_ADMINISTRATION_CONTENT` Administration HTML content attribute name.
`static String`	`ATTR_TOOLBAR_LOGIN_URL` Login URL attribute name.
`static String`	`ATTR_TOOLBAR_MY_PROFILE` User's profile
`static String`	`ATTR_TOOLBAR_MY_SPACE_URL` My space URL attribute name.
`static String`	`ATTR_TOOLBAR_PERSON` Principal alias
`static String`	`ATTR_TOOLBAR_PRINCIPAL` Principal attribute name.
`static String`	`ATTR_TOOLBAR_REFRESH_PAGE_URL` User refresh page URL attribute name.
`static String`	`ATTR_TOOLBAR_SIGN_OUT_URL` Sign out URL attribute name.
`static String`	`ATTR_TOOLBAR_TASKS_COUNT` Toolbar tasks count.
`static String`	`ATTR_TOOLBAR_TASKS_URL` Toolbar tasks URL.
`static String`	`ATTR_TOOLBAR_USER_CONTENT` User content.
`static String`	`ATTR_TOOLBAR_USER_SETTINGS_URL` Toolbar user settings URL.
`static String`	`ATTR_URL_FACTORY` URL factory attribute name.
`static String`	`ATTR_USER_DATAS` User session data attribute name.
`static String`	`ATTR_USER_PORTAL` User portal attribute name.
`static String`	`ATTR_WIZARD_MODE` Wizard mode indicator.
`static String`	`CACHE_SERVICE_NAME` Cache service name.
`static String`	`CONTRIBUTION_SERVICE_NAME` Contribution service name.
`static String`	`DIRECTORY_SERVICE_LOCATOR_NAME` Directory locator service name.
`static String`	`FORMATTER_SERVICE_NAME` Formatter service name.
`static String`	`HEADER_META` metas of the document.
`static String`	`HEADER_TITLE` title of the document.
`static String`	`INTERNATIONALIZATION_SERVICE_NAME` Internationalization service name.
`static String`	`NOTIFICATIONS_SERVICE_NAME` Notifications service name.
`static String`	`PORTAL_NAME` JBP key portalName.
`static String`	`PORTAL_NAME_DEFAULT` name of the default portal.
`static String`	`PORTLET_ATTR_DISPLAY_PAGE` To redisplay the whole all page.
`static String`	`PORTLET_ATTR_HTTP_REQUEST` HTTP request.
`static String`	`PORTLET_ATTR_MENU_BAR` Menu bar.
`static String`	`PORTLET_ATTR_PAGE_REFRESH` refresh indicator.
`static String`	`PORTLET_ATTR_POPUP_CLOSE` To close popup.
`static String`	`PORTLET_ATTR_PORTLET_PATH` To set breadcrumb portlet path.
`static String`	`PORTLET_ATTR_REDIRECTION_URL` Redirection URL
`static String`	`PORTLET_ATTR_SPACE_CONFIG` Space configuration request.
`static String`	`PORTLET_ATTR_START_WINDOW` To start a new Window
`static String`	`PORTLET_ATTR_UNSET_MAX_MODE` To return to normal mode.
`static String`	`PORTLET_ATTR_UPDATE_CONTENTS` To refresh all Contents (portlets + CMS).
`static String`	`PORTLET_ATTR_UPDATE_SPACE_DATA` To notify data change
`static String`	`PORTLET_ATTR_UPDATE_SPACE_DATA_TS` To notify data change
`static String`	`PORTLET_ATTR_USER_DATAS` User datas map.
`static String`	`PORTLET_ATTR_USER_DATAS_REFRESH_TS` User datas Map timestamp.
`static String`	`PORTLET_ATTR_WEBAPP_CONTEXT` for i18n
`static String`	`PORTLET_PARAM_EDITION_PATH` Edition path
`static String`	`PORTLET_PARAM_ONLINE_PATH` Online path.
`static String`	`PORTLET_VALUE_ACTIVATE`
`static String`	`PROFILE_SERVICE_NAME` Profile service name.
`static String`	`REQUEST_ATTR_URI` Portlet CMS URI request attribute name.
`static String`	`REQUEST_ATTR_VERSION` The version of the content.
`static String`	`SESSION_RELOAD_ATTRIBUTE` Reload session attribute name.
`static String`	`STATUS_SERVICE_NAME` Status service name.
`static String`	`URL_SERVICE_NAME` URL service name.
`static String`	`WEBID_SERVICE_NAME` WebId service name
`static String`	`WINDOW_PROP_MAXIMIZED_CMS_URL` Maximized CMS URL window property name.
`static String`	`WINDOW_PROP_SCOPE` The scope of the request.
`static String`	`WINDOW_PROP_URI` The CMS URI of the portlet.
`static String`	`WINDOW_PROP_VERSION` The version of the content.

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

- Field Detail
  - CACHE_SERVICE_NAME
```
public static final String CACHE_SERVICE_NAME
```
    Cache service name.
    
    See Also:
    
    Constant Field Values
  - STATUS_SERVICE_NAME
```
public static final String STATUS_SERVICE_NAME
```
    Status service name.
    
    See Also:
    
    Constant Field Values
  - URL_SERVICE_NAME
```
public static final String URL_SERVICE_NAME
```
    URL service name.
    
    See Also:
    
    Constant Field Values
  - WEBID_SERVICE_NAME
```
public static final String WEBID_SERVICE_NAME
```
    WebId service name
    
    See Also:
    
    Constant Field Values
  - PROFILE_SERVICE_NAME
```
public static final String PROFILE_SERVICE_NAME
```
    Profile service name.
    
    See Also:
    
    Constant Field Values
  - FORMATTER_SERVICE_NAME
```
public static final String FORMATTER_SERVICE_NAME
```
    Formatter service name.
    
    See Also:
    
    Constant Field Values
  - NOTIFICATIONS_SERVICE_NAME
```
public static final String NOTIFICATIONS_SERVICE_NAME
```
    Notifications service name.
    
    See Also:
    
    Constant Field Values
  - INTERNATIONALIZATION_SERVICE_NAME
```
public static final String INTERNATIONALIZATION_SERVICE_NAME
```
    Internationalization service name.
    
    See Also:
    
    Constant Field Values
  - CONTRIBUTION_SERVICE_NAME
```
public static final String CONTRIBUTION_SERVICE_NAME
```
    Contribution service name.
    
    See Also:
    
    Constant Field Values
  - DIRECTORY_SERVICE_LOCATOR_NAME
```
public static final String DIRECTORY_SERVICE_LOCATOR_NAME
```
    Directory locator service name.
    
    See Also:
    
    Constant Field Values
  - PORTAL_NAME
```
public static final String PORTAL_NAME
```
    JBP key portalName.
    
    See Also:
    
    Constant Field Values
  - PORTAL_NAME_DEFAULT
```
public static final String PORTAL_NAME_DEFAULT
```
    name of the default portal.
    
    See Also:
    
    Constant Field Values
  - ATTR_SITE_MAP
```
public static final String ATTR_SITE_MAP
```
    Site map attribute name.
    
    See Also:
    
    Constant Field Values
  - ATTR_URL_FACTORY
```
public static final String ATTR_URL_FACTORY
```
    URL factory attribute name.
    
    See Also:
    
    Constant Field Values
  - ATTR_PORTAL_CTX
```
public static final String ATTR_PORTAL_CTX
```
    Portal controller context attribute name.
    
    See Also:
    
    Constant Field Values
  - ATTR_USER_PORTAL
```
public static final String ATTR_USER_PORTAL
```
    User portal attribute name.
    
    See Also:
    
    Constant Field Values
  - ATTR_PAGE_ID
```
public static final String ATTR_PAGE_ID
```
    Current page identifier attribute name.
    
    See Also:
    
    Constant Field Values
  - ATTR_PAGE_NAME
```
public static final String ATTR_PAGE_NAME
```
    Current page name attribute name.
    
    See Also:
    
    Constant Field Values
  - ATTR_FIRST_TAB
```
public static final String ATTR_FIRST_TAB
```
    First tab attribute name.
    
    See Also:
    
    Constant Field Values
  - ATTR_LOGGED_PERSON
```
@Deprecated
public static final String ATTR_LOGGED_PERSON
```
    Deprecated. please use ATTR_LOGGED_PERSON_2
    
    Logged person.
    
    See Also:
    
    Constant Field Values
  - ATTR_LOGGED_PERSON_2
```
public static final String ATTR_LOGGED_PERSON_2
```
    Logged person.
    
    See Also:
    
    Constant Field Values
  - ATTR_PORTAL_HOME_URL
```
public static final String ATTR_PORTAL_HOME_URL
```
    Portal home page URL.
    
    See Also:
    
    Constant Field Values
  - ATTR_PAGE_CATEGORY
```
public static final String ATTR_PAGE_CATEGORY
```
    Page category attribute name.
    
    See Also:
    
    Constant Field Values
  - ATTR_USER_DATAS
```
public static final String ATTR_USER_DATAS
```
    User session data attribute name.
    
    See Also:
    
    Constant Field Values
  - ATTR_SPACE_CONFIG
```
public static final String ATTR_SPACE_CONFIG
```
    Native space object attribute name.
    
    See Also:
    
    Constant Field Values
  - ATTR_WIZARD_MODE
```
public static final String ATTR_WIZARD_MODE
```
    Wizard mode indicator.
    
    See Also:
    
    Constant Field Values
  - ATTR_SPACE_SITE_INDICATOR
```
public static final String ATTR_SPACE_SITE_INDICATOR
```
    Space site indicator.
    
    See Also:
    
    Constant Field Values
  - ATTR_BREADCRUMB
```
public static final String ATTR_BREADCRUMB
```
    Breadcrumb content attribute name.
    
    See Also:
    
    Constant Field Values
  - ATTR_SEARCH_URL
```
public static final String ATTR_SEARCH_URL
```
    Search URL attribute name.
    
    See Also:
    
    Constant Field Values
  - ATTR_SEARCH_WEB_URL
```
public static final String ATTR_SEARCH_WEB_URL
```
    Search web URL attribute name.
    
    See Also:
    
    Constant Field Values
  - ATTR_HEADER_TITLE
```
public static final String ATTR_HEADER_TITLE
```
    content of title tag
    
    See Also:
    
    Constant Field Values
  - ATTR_HEADER_METADATA
```
public static final String ATTR_HEADER_METADATA
```
    content of meta tags.
    
    See Also:
    
    Constant Field Values
  - ATTR_HEADER_PORTAL_BASE_URL
```
public static final String ATTR_HEADER_PORTAL_BASE_URL
```
    Portal base URL.
    
    See Also:
    
    Constant Field Values
  - ATTR_HEADER_CANONICAL_URL
```
public static final String ATTR_HEADER_CANONICAL_URL
```
    Canonical URL.
    
    See Also:
    
    Constant Field Values
  - ATTR_HEADER_APPLICATION_NAME
```
public static final String ATTR_HEADER_APPLICATION_NAME
```
    Application name.
    
    See Also:
    
    Constant Field Values
  - ATTR_TOOLBAR_LOGIN_URL
```
public static final String ATTR_TOOLBAR_LOGIN_URL
```
    Login URL attribute name.
    
    See Also:
    
    Constant Field Values
  - ATTR_TOOLBAR_SIGN_OUT_URL
```
public static final String ATTR_TOOLBAR_SIGN_OUT_URL
```
    Sign out URL attribute name.
    
    See Also:
    
    Constant Field Values
  - ATTR_TOOLBAR_PERSON
```
public static final String ATTR_TOOLBAR_PERSON
```
    Principal alias
    
    See Also:
    
    Constant Field Values
  - ATTR_TOOLBAR_PRINCIPAL
```
public static final String ATTR_TOOLBAR_PRINCIPAL
```
    Principal attribute name.
    
    See Also:
    
    Constant Field Values
  - ATTR_TOOLBAR_USER_CONTENT
```
public static final String ATTR_TOOLBAR_USER_CONTENT
```
    User content.
    
    See Also:
    
    Constant Field Values
  - ATTR_TOOLBAR_MY_SPACE_URL
```
public static final String ATTR_TOOLBAR_MY_SPACE_URL
```
    My space URL attribute name.
    
    See Also:
    
    Constant Field Values
  - ATTR_TOOLBAR_REFRESH_PAGE_URL
```
public static final String ATTR_TOOLBAR_REFRESH_PAGE_URL
```
    User refresh page URL attribute name.
    
    See Also:
    
    Constant Field Values
  - ATTR_TOOLBAR_ADMINISTRATION_CONTENT
```
public static final String ATTR_TOOLBAR_ADMINISTRATION_CONTENT
```
    Administration HTML content attribute name.
    
    See Also:
    
    Constant Field Values
  - ATTR_TOOLBAR_MY_PROFILE
```
public static final String ATTR_TOOLBAR_MY_PROFILE
```
    User's profile
    
    See Also:
    
    Constant Field Values
  - ATTR_TOOLBAR_USER_SETTINGS_URL
```
public static final String ATTR_TOOLBAR_USER_SETTINGS_URL
```
    Toolbar user settings URL.
    
    See Also:
    
    Constant Field Values
  - ATTR_TOOLBAR_TASKS_URL
```
public static final String ATTR_TOOLBAR_TASKS_URL
```
    Toolbar tasks URL.
    
    See Also:
    
    Constant Field Values
  - ATTR_TOOLBAR_TASKS_COUNT
```
public static final String ATTR_TOOLBAR_TASKS_COUNT
```
    Toolbar tasks count.
    
    See Also:
    
    Constant Field Values
  - HEADER_TITLE
```
public static final String HEADER_TITLE
```
    title of the document.
    
    See Also:
    
    Constant Field Values
  - HEADER_META
```
public static final String HEADER_META
```
    metas of the document.
    
    See Also:
    
    Constant Field Values
  - PORTLET_ATTR_MENU_BAR
```
public static final String PORTLET_ATTR_MENU_BAR
```
    Menu bar.
    
    See Also:
    
    Constant Field Values
  - PORTLET_ATTR_USER_DATAS
```
public static final String PORTLET_ATTR_USER_DATAS
```
    User datas map.
    
    See Also:
    
    Constant Field Values
  - PORTLET_ATTR_USER_DATAS_REFRESH_TS
```
public static final String PORTLET_ATTR_USER_DATAS_REFRESH_TS
```
    User datas Map timestamp.
    
    See Also:
    
    Constant Field Values
  - PORTLET_ATTR_HTTP_REQUEST
```
public static final String PORTLET_ATTR_HTTP_REQUEST
```
    HTTP request.
    
    See Also:
    
    Constant Field Values
  - PORTLET_ATTR_SPACE_CONFIG
```
public static final String PORTLET_ATTR_SPACE_CONFIG
```
    Space configuration request.
    
    See Also:
    
    Constant Field Values
  - PORTLET_ATTR_REDIRECTION_URL
```
public static final String PORTLET_ATTR_REDIRECTION_URL
```
    Redirection URL
    
    See Also:
    
    Constant Field Values
  - PORTLET_PARAM_ONLINE_PATH
```
public static final String PORTLET_PARAM_ONLINE_PATH
```
    Online path.
    
    See Also:
    
    Constant Field Values
  - PORTLET_PARAM_EDITION_PATH
```
public static final String PORTLET_PARAM_EDITION_PATH
```
    Edition path
    
    See Also:
    
    Constant Field Values
  - PORTLET_ATTR_PAGE_REFRESH
```
public static final String PORTLET_ATTR_PAGE_REFRESH
```
    refresh indicator.
    
    See Also:
    
    Constant Field Values
  - PORTLET_ATTR_UPDATE_SPACE_DATA_TS
```
public static final String PORTLET_ATTR_UPDATE_SPACE_DATA_TS
```
    To notify data change
    
    See Also:
    
    Constant Field Values
  - PORTLET_ATTR_DISPLAY_PAGE
```
public static final String PORTLET_ATTR_DISPLAY_PAGE
```
    To redisplay the whole all page.
    
    See Also:
    
    Constant Field Values
  - PORTLET_ATTR_UNSET_MAX_MODE
```
public static final String PORTLET_ATTR_UNSET_MAX_MODE
```
    To return to normal mode.
    
    See Also:
    
    Constant Field Values
  - PORTLET_ATTR_UPDATE_CONTENTS
```
public static final String PORTLET_ATTR_UPDATE_CONTENTS
```
    To refresh all Contents (portlets + CMS).
    
    See Also:
    
    Constant Field Values
  - PORTLET_ATTR_UPDATE_SPACE_DATA
```
public static final String PORTLET_ATTR_UPDATE_SPACE_DATA
```
    To notify data change
    
    See Also:
    
    Constant Field Values
  - PORTLET_ATTR_POPUP_CLOSE
```
public static final String PORTLET_ATTR_POPUP_CLOSE
```
    To close popup.
    
    See Also:
    
    Constant Field Values
  - PORTLET_ATTR_PORTLET_PATH
```
public static final String PORTLET_ATTR_PORTLET_PATH
```
    To set breadcrumb portlet path.
    
    See Also:
    
    Constant Field Values
  - PORTLET_ATTR_START_WINDOW
```
public static final String PORTLET_ATTR_START_WINDOW
```
    To start a new Window
    
    See Also:
    
    Constant Field Values
  - PORTLET_VALUE_ACTIVATE
```
public static final String PORTLET_VALUE_ACTIVATE
```
    See Also:
    
    Constant Field Values
  - PORTLET_ATTR_WEBAPP_CONTEXT
```
public static final String PORTLET_ATTR_WEBAPP_CONTEXT
```
    for i18n
    
    See Also:
    
    Constant Field Values
  - WINDOW_PROP_URI
```
public static final String WINDOW_PROP_URI
```
    The CMS URI of the portlet.
    
    See Also:
    
    Constant Field Values
  - WINDOW_PROP_VERSION
```
public static final String WINDOW_PROP_VERSION
```
    The version of the content.
    
    See Also:
    
    Constant Field Values
  - WINDOW_PROP_SCOPE
```
public static final String WINDOW_PROP_SCOPE
```
    The scope of the request.
    
    See Also:
    
    Constant Field Values
  - WINDOW_PROP_MAXIMIZED_CMS_URL
```
public static final String WINDOW_PROP_MAXIMIZED_CMS_URL
```
    Maximized CMS URL window property name.
    
    See Also:
    
    Constant Field Values
  - REQUEST_ATTR_URI
```
public static final String REQUEST_ATTR_URI
```
    Portlet CMS URI request attribute name.
    
    See Also:
    
    Constant Field Values
  - REQUEST_ATTR_VERSION
```
public static final String REQUEST_ATTR_VERSION
```
    The version of the content.
    
    See Also:
    
    Constant Field Values
  - SESSION_RELOAD_ATTRIBUTE
```
public static final String SESSION_RELOAD_ATTRIBUTE
```
    Reload session attribute name.
    
    See Also:
    
    Constant Field Values

Class Constants

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

CACHE_SERVICE_NAME

STATUS_SERVICE_NAME

URL_SERVICE_NAME

WEBID_SERVICE_NAME

PROFILE_SERVICE_NAME

FORMATTER_SERVICE_NAME

NOTIFICATIONS_SERVICE_NAME

INTERNATIONALIZATION_SERVICE_NAME

CONTRIBUTION_SERVICE_NAME

DIRECTORY_SERVICE_LOCATOR_NAME

PORTAL_NAME

PORTAL_NAME_DEFAULT

ATTR_SITE_MAP

ATTR_URL_FACTORY

ATTR_PORTAL_CTX

ATTR_USER_PORTAL

ATTR_PAGE_ID

ATTR_PAGE_NAME

ATTR_FIRST_TAB

ATTR_LOGGED_PERSON

ATTR_LOGGED_PERSON_2

ATTR_PORTAL_HOME_URL

ATTR_PAGE_CATEGORY

ATTR_USER_DATAS

ATTR_SPACE_CONFIG

ATTR_WIZARD_MODE

ATTR_SPACE_SITE_INDICATOR

ATTR_BREADCRUMB

ATTR_SEARCH_URL

ATTR_SEARCH_WEB_URL

ATTR_HEADER_TITLE

ATTR_HEADER_METADATA

ATTR_HEADER_PORTAL_BASE_URL

ATTR_HEADER_CANONICAL_URL

ATTR_HEADER_APPLICATION_NAME

ATTR_TOOLBAR_LOGIN_URL

ATTR_TOOLBAR_SIGN_OUT_URL

ATTR_TOOLBAR_PERSON

ATTR_TOOLBAR_PRINCIPAL

ATTR_TOOLBAR_USER_CONTENT

ATTR_TOOLBAR_MY_SPACE_URL

ATTR_TOOLBAR_REFRESH_PAGE_URL

ATTR_TOOLBAR_ADMINISTRATION_CONTENT

ATTR_TOOLBAR_MY_PROFILE

ATTR_TOOLBAR_USER_SETTINGS_URL

ATTR_TOOLBAR_TASKS_URL

ATTR_TOOLBAR_TASKS_COUNT

HEADER_TITLE

HEADER_META

PORTLET_ATTR_MENU_BAR

PORTLET_ATTR_USER_DATAS

PORTLET_ATTR_USER_DATAS_REFRESH_TS

PORTLET_ATTR_HTTP_REQUEST

PORTLET_ATTR_SPACE_CONFIG

PORTLET_ATTR_REDIRECTION_URL

PORTLET_PARAM_ONLINE_PATH

PORTLET_PARAM_EDITION_PATH

PORTLET_ATTR_PAGE_REFRESH

PORTLET_ATTR_UPDATE_SPACE_DATA_TS

PORTLET_ATTR_DISPLAY_PAGE

PORTLET_ATTR_UNSET_MAX_MODE

PORTLET_ATTR_UPDATE_CONTENTS

PORTLET_ATTR_UPDATE_SPACE_DATA

PORTLET_ATTR_POPUP_CLOSE

PORTLET_ATTR_PORTLET_PATH

PORTLET_ATTR_START_WINDOW

PORTLET_VALUE_ACTIVATE

PORTLET_ATTR_WEBAPP_CONTEXT

WINDOW_PROP_URI

WINDOW_PROP_VERSION

WINDOW_PROP_SCOPE

WINDOW_PROP_MAXIMIZED_CMS_URL

REQUEST_ATTR_URI

REQUEST_ATTR_VERSION

SESSION_RELOAD_ATTRIBUTE