A B C D E F G H I J L M O P R S T U V W X

A

AbstractAuditor - Class in com.helger.photon.basic.audit

Abstract base class for interface IAuditor.

AbstractAuditor(ICurrentUserIDProvider) - Constructor for class com.helger.photon.basic.audit.AbstractAuditor

AbstractAuditor(ICurrentUserIDProvider, IAuditActionStringProvider) - Constructor for class com.helger.photon.basic.audit.AbstractAuditor

AbstractMenuItemDeterminatorCallback - Class in com.helger.photon.basic.app.menu

Abstract implementation of IMenuItemDeterminatorCallback.

AbstractMenuItemDeterminatorCallback(IMenuTree) - Constructor for class com.helger.photon.basic.app.menu.AbstractMenuItemDeterminatorCallback

AbstractMenuObject<IMPLTYPE extends AbstractMenuObject<IMPLTYPE>> - Class in com.helger.photon.basic.app.menu

Implementation base class for menu items.

AbstractMenuObject(String) - Constructor for class com.helger.photon.basic.app.menu.AbstractMenuObject

AbstractMenuObjectFilter - Class in com.helger.photon.basic.app.menu.filter

Abstract base class for a menu object filter.

AbstractMenuObjectFilter() - Constructor for class com.helger.photon.basic.app.menu.filter.AbstractMenuObjectFilter

AbstractPage - Class in com.helger.photon.basic.app.page

Abstract base implementation for IPage.

AbstractPage(String) - Constructor for class com.helger.photon.basic.app.page.AbstractPage

Constructor

AbstractPage(String, String) - Constructor for class com.helger.photon.basic.app.page.AbstractPage

Constructor

AbstractPage(String, String, String) - Constructor for class com.helger.photon.basic.app.page.AbstractPage

Constructor

AbstractPage(String, IMultilingualText) - Constructor for class com.helger.photon.basic.app.page.AbstractPage

Constructor

AbstractPage(String, IMultilingualText, IMultilingualText) - Constructor for class com.helger.photon.basic.app.page.AbstractPage

Constructor

AbstractPhotonMapBasedWALDAO<INTERFACETYPE extends com.helger.commons.id.IHasID<String> & Serializable,IMPLTYPE extends INTERFACETYPE> - Class in com.helger.photon.basic.app.dao

Special AbstractMapBasedWALDAO that uses the WebFileIO.getDataIO() for read/write.

AbstractPhotonMapBasedWALDAO(Class<IMPLTYPE>, String) - Constructor for class com.helger.photon.basic.app.dao.AbstractPhotonMapBasedWALDAO

AbstractPhotonMapBasedWALDAO(Class<IMPLTYPE>, String, AbstractMapBasedWALDAO.InitSettings<IMPLTYPE>) - Constructor for class com.helger.photon.basic.app.dao.AbstractPhotonMapBasedWALDAO

AbstractPhotonSimpleDAO - Class in com.helger.photon.basic.app.dao

Special AbstractSimpleDAO that uses the WebFileIO.getDataIO() for read/write.

AbstractPhotonSimpleDAO(String) - Constructor for class com.helger.photon.basic.app.dao.AbstractPhotonSimpleDAO

AbstractPhotonSimpleDAO(ISupplier<String>) - Constructor for class com.helger.photon.basic.app.dao.AbstractPhotonSimpleDAO

AbstractPhotonWALDAO<DATATYPE extends Serializable> - Class in com.helger.photon.basic.app.dao

Special AbstractWALDAO that uses the WebFileIO.getDataIO() for read/write.

AbstractPhotonWALDAO(Class<DATATYPE>, String) - Constructor for class com.helger.photon.basic.app.dao.AbstractPhotonWALDAO

AbstractPhotonWALDAO(Class<DATATYPE>, ISupplier<String>) - Constructor for class com.helger.photon.basic.app.dao.AbstractPhotonWALDAO

AbstractRequestParameterHandlerNamed - Class in com.helger.photon.basic.app.request

Base class for IRequestParameterHandler implementations that support special parameter names

AbstractRequestParameterHandlerNamed() - Constructor for class com.helger.photon.basic.app.request.AbstractRequestParameterHandlerNamed

addFavorite(String, String, String, String, Map<String, String>) - Method in class com.helger.photon.basic.favorites.FavoriteManager

Create a new favorite object.

addMigrationResult(SystemMigrationResult) - Method in class com.helger.photon.basic.migration.SystemMigrationManager

addMigrationResultError(String, String) - Method in class com.helger.photon.basic.migration.SystemMigrationManager

Mark the specified migration as failed.

addMigrationResultSuccess(String) - Method in class com.helger.photon.basic.migration.SystemMigrationManager

Mark the specified migration as success.

addResult(LongRunningJobData) - Method in class com.helger.photon.basic.longrun.LongRunningJobResultManager

after() - Method in class com.helger.photon.basic.mock.PhotonBasicTestRule

after() - Method in class com.helger.photon.basic.mock.PhotonBasicWebTestRule

afterRequest(IRequestWebScope) - Method in class com.helger.photon.basic.app.appid.XServletFilterAppIDExplicit

afterRequest(IRequestWebScope) - Method in class com.helger.photon.basic.app.appid.XServletFilterAppIDFromSessionID

and(IMenuObjectFilter) - Method in interface com.helger.photon.basic.app.menu.IMenuObjectFilter

APP_ID_PUBLIC - Static variable in class com.helger.photon.basic.app.appid.CApplicationID

The default application ID to be used for the public application

APP_ID_SECURE - Static variable in class com.helger.photon.basic.app.appid.CApplicationID

The default application ID to be used for the secure application

AsynchronousAuditor - Class in com.helger.photon.basic.audit

The class handles audit items asynchronously.

AsynchronousAuditor(ICurrentUserIDProvider, IConcurrentPerformer<List<IAuditItem>>) - Constructor for class com.helger.photon.basic.audit.AsynchronousAuditor

ATTR_DT - Static variable in class com.helger.photon.basic.audit.AuditItemMicroTypeConverter

ATTR_SUCCESS - Static variable in class com.helger.photon.basic.audit.AuditItemMicroTypeConverter

ATTR_TYPE - Static variable in class com.helger.photon.basic.audit.AuditItemMicroTypeConverter

ATTR_USER - Static variable in class com.helger.photon.basic.audit.AuditItemMicroTypeConverter

attrs() - Method in class com.helger.photon.basic.app.menu.AbstractMenuObject

attrs() - Method in interface com.helger.photon.basic.app.menu.IMenuObject

attrs() - Method in class com.helger.photon.basic.app.page.AbstractPage

attrs() - Method in interface com.helger.photon.basic.app.page.IPage

AuditHelper - Class in com.helger.photon.basic.audit

Simplify system auditing calls.

AuditingLongRunningRequestCallback - Class in com.helger.photon.basic.xservlet

A simple implementation of ILongRunningRequestCallback simply auditing such events.

AuditingLongRunningRequestCallback() - Constructor for class com.helger.photon.basic.xservlet.AuditingLongRunningRequestCallback

AuditingParallelRunningRequestCallback - Class in com.helger.photon.basic.xservlet

A simple implementation of IParallelRunningRequestCallback simply auditing such events.

AuditingParallelRunningRequestCallback() - Constructor for class com.helger.photon.basic.xservlet.AuditingParallelRunningRequestCallback

AuditItem - Class in com.helger.photon.basic.audit

Represents a single change item

AuditItem(String, EAuditActionType, ESuccess, String) - Constructor for class com.helger.photon.basic.audit.AuditItem

AuditItemList - Class in com.helger.photon.basic.audit

Manages a list of IAuditItem objects.

AuditItemList() - Constructor for class com.helger.photon.basic.audit.AuditItemList

AuditItemMicroTypeConverter - Class in com.helger.photon.basic.audit

Convert AuditItem objects to IMicroElement and vice versa.

AuditItemMicroTypeConverter() - Constructor for class com.helger.photon.basic.audit.AuditItemMicroTypeConverter

AuditManager - Class in com.helger.photon.basic.audit

The class handles all system audit actions.

AuditManager(String, ICurrentUserIDProvider) - Constructor for class com.helger.photon.basic.audit.AuditManager

Constructor

B

before() - Method in class com.helger.photon.basic.mock.PhotonBasicTestRule

before() - Method in class com.helger.photon.basic.mock.PhotonBasicWebTestRule

beforeRequest(IRequestWebScope) - Method in class com.helger.photon.basic.app.appid.XServletFilterAppIDExplicit

beforeRequest(IRequestWebScope) - Method in class com.helger.photon.basic.app.appid.XServletFilterAppIDFromSessionID

BuildInfo - Class in com.helger.photon.basic.buildinfo

This class allows you to read the buildinfo.xml files generated by the buildinfo-maven-plugin.

BuildInfo(ICommonsMap<String, String>) - Constructor for class com.helger.photon.basic.buildinfo.BuildInfo

BuildInfo.SinceBuildInfoV2 - Annotation Type in com.helger.photon.basic.buildinfo

Indicate that certain fields are only available from V2

BUILDINFO_FILENAME_XML - Static variable in class com.helger.photon.basic.buildinfo.BuildInfo

The default filename as stored in the JAR files.

buildURL(IRequestWebScopeWithoutResponse, String, Locale, String) - Method in interface com.helger.photon.basic.app.request.IRequestParameterHandler

Build a URL based on the passed base path and an optional list of parameters.

buildURL(IRequestWebScopeWithoutResponse, String, Locale, String) - Method in class com.helger.photon.basic.app.request.RequestParameterHandlerURLParameter

buildURL(IRequestWebScopeWithoutResponse, String, Locale, String) - Method in class com.helger.photon.basic.app.request.RequestParameterHandlerURLPathNamed

buildURL(IRequestWebScopeWithoutResponse, String, Locale, String) - Method in class com.helger.photon.basic.app.request.RequestParameterHandlerURLPathOrdered

C

CApplicationID - Class in com.helger.photon.basic.app.appid

This class contains application IDs for the most common use cases

com.helger.photon.basic - package com.helger.photon.basic

com.helger.photon.basic.app.appid - package com.helger.photon.basic.app.appid

com.helger.photon.basic.app.dao - package com.helger.photon.basic.app.dao

com.helger.photon.basic.app.io - package com.helger.photon.basic.app.io

com.helger.photon.basic.app.locale - package com.helger.photon.basic.app.locale

com.helger.photon.basic.app.menu - package com.helger.photon.basic.app.menu

com.helger.photon.basic.app.menu.filter - package com.helger.photon.basic.app.menu.filter

com.helger.photon.basic.app.page - package com.helger.photon.basic.app.page

com.helger.photon.basic.app.request - package com.helger.photon.basic.app.request

com.helger.photon.basic.app.systemmsg - package com.helger.photon.basic.app.systemmsg

com.helger.photon.basic.audit - package com.helger.photon.basic.audit

com.helger.photon.basic.buildinfo - package com.helger.photon.basic.buildinfo

com.helger.photon.basic.config - package com.helger.photon.basic.config

com.helger.photon.basic.configfile - package com.helger.photon.basic.configfile

com.helger.photon.basic.favorites - package com.helger.photon.basic.favorites

com.helger.photon.basic.longrun - package com.helger.photon.basic.longrun

com.helger.photon.basic.mgr - package com.helger.photon.basic.mgr

com.helger.photon.basic.migration - package com.helger.photon.basic.migration

com.helger.photon.basic.mock - package com.helger.photon.basic.mock

com.helger.photon.basic.xservlet - package com.helger.photon.basic.xservlet

ConfigurationFile - Class in com.helger.photon.basic.configfile

ConfigurationFile(IReadableResource) - Constructor for class com.helger.photon.basic.configfile.ConfigurationFile

Constructor

ConfigurationFileManager - Class in com.helger.photon.basic.configfile

A non-persisting manager for ConfigurationFile objects.

ConfigurationFileManager() - Constructor for class com.helger.photon.basic.configfile.ConfigurationFileManager

Deprecated.

containsAnyApplicationServletPathMapping() - Static method in class com.helger.photon.basic.app.appid.PhotonGlobalState

containsFavoritesOfUser(String) - Method in class com.helger.photon.basic.favorites.FavoriteManager

Check if the specified user ID is contained or not.

convertToMicroElement(AuditItem, String, String) - Method in class com.helger.photon.basic.audit.AuditItemMicroTypeConverter

convertToMicroElement(Favorite, String, String) - Method in class com.helger.photon.basic.favorites.FavoriteMicroTypeConverter

convertToMicroElement(LongRunningJobData, String, String) - Method in class com.helger.photon.basic.longrun.LongRunningJobDataMicroTypeConverter

convertToMicroElement(SystemMigrationResult, String, String) - Method in class com.helger.photon.basic.migration.SystemMigrationResultMicroTypeConverter

convertToNative(IMicroElement) - Method in class com.helger.photon.basic.audit.AuditItemMicroTypeConverter

convertToNative(IMicroElement) - Method in class com.helger.photon.basic.favorites.FavoriteMicroTypeConverter

convertToNative(IMicroElement) - Method in class com.helger.photon.basic.longrun.LongRunningJobDataMicroTypeConverter

convertToNative(IMicroElement) - Method in class com.helger.photon.basic.migration.SystemMigrationResultMicroTypeConverter

createAuditItem(EAuditActionType, ESuccess, String, Object...) - Method in class com.helger.photon.basic.audit.AbstractAuditor

createAuditItem(EAuditActionType, ESuccess, String, Object...) - Method in interface com.helger.photon.basic.audit.IAuditor

Create a new audit item.

createAuditItem(EAuditActionType, ESuccess, String, Object...) - Method in class com.helger.photon.basic.audit.SimpleAuditManager

createFailure(String, String) - Static method in class com.helger.photon.basic.migration.SystemMigrationResult

createFile(File) - Static method in class com.helger.photon.basic.longrun.LongRunningJobResult

createFromResource(IReadableResource) - Static method in class com.helger.photon.basic.buildinfo.BuildInfo

createItem(String, String, IPage) - Method in interface com.helger.photon.basic.app.menu.IMenuOperations

Append a new menu item below the specified parent.

createItem(String, IPage) - Method in interface com.helger.photon.basic.app.menu.IMenuOperations

Append a new menu item below the specified parent.

createItem(IMenuItem, IPage) - Method in interface com.helger.photon.basic.app.menu.IMenuOperations

Append a new menu item below the specified parent.

createItem(IMenuItem, String, ISimpleURL, IHasDisplayText) - Method in interface com.helger.photon.basic.app.menu.IMenuOperations

Append a new menu item below the specified parent.

createItem(IMenuItem, String, IHasSimpleURL, IHasDisplayText) - Method in interface com.helger.photon.basic.app.menu.IMenuOperations

Append a new menu item below the specified parent.

createItem(String, String, ISimpleURL, IHasDisplayText) - Method in interface com.helger.photon.basic.app.menu.IMenuOperations

Append a new menu item below the specified parent.

createItem(String, String, IHasSimpleURL, IHasDisplayText) - Method in interface com.helger.photon.basic.app.menu.IMenuOperations

Append a new menu item below the specified parent.

createItem(String, String, IPage) - Method in class com.helger.photon.basic.app.menu.MenuTree

createItem(String, String, IHasSimpleURL, IHasDisplayText) - Method in class com.helger.photon.basic.app.menu.MenuTree

createLink(ISimpleURL) - Static method in class com.helger.photon.basic.longrun.LongRunningJobResult

createLongRunningJobResult() - Method in interface com.helger.photon.basic.longrun.ILongRunningJob

createRootItem(String, IPage) - Method in interface com.helger.photon.basic.app.menu.IMenuOperations

Append a new menu item at root level.

createRootItem(IPage) - Method in interface com.helger.photon.basic.app.menu.IMenuOperations

Append a new menu item at root level.

createRootItem(String, ISimpleURL, IHasDisplayText) - Method in interface com.helger.photon.basic.app.menu.IMenuOperations

Append a new menu item at root level.

createRootItem(String, IHasSimpleURL, IHasDisplayText) - Method in interface com.helger.photon.basic.app.menu.IMenuOperations

Append a new menu item at root level.

createRootItem(String, IPage) - Method in class com.helger.photon.basic.app.menu.MenuTree

createRootItem(String, IHasSimpleURL, IHasDisplayText) - Method in class com.helger.photon.basic.app.menu.MenuTree

createRootSeparator() - Method in interface com.helger.photon.basic.app.menu.IMenuOperations

Append a new menu item separator at root level

createRootSeparator(String) - Method in interface com.helger.photon.basic.app.menu.IMenuOperations

Append a new menu item separator at root level

createRootSeparator(String) - Method in class com.helger.photon.basic.app.menu.MenuTree

createSeparator(String) - Method in interface com.helger.photon.basic.app.menu.IMenuOperations

Append a new menu item separator as a child of the passed menu item

createSeparator(IMenuItem) - Method in interface com.helger.photon.basic.app.menu.IMenuOperations

Append a new menu item separator as a child of the passed menu item

createSeparator(String, String) - Method in interface com.helger.photon.basic.app.menu.IMenuOperations

Append a new menu item separator as a child of the passed menu item

createSeparator(IMenuItem, String) - Method in interface com.helger.photon.basic.app.menu.IMenuOperations

Append a new menu item separator as a child of the passed menu item

createSeparator(String, String) - Method in class com.helger.photon.basic.app.menu.MenuTree

createSuccess(String) - Static method in class com.helger.photon.basic.migration.SystemMigrationResult

createText(String) - Static method in class com.helger.photon.basic.longrun.LongRunningJobResult

createWriteData() - Method in class com.helger.photon.basic.app.systemmsg.SystemMessageManager

createWriteData() - Method in class com.helger.photon.basic.audit.AuditManager

createWriteData() - Method in class com.helger.photon.basic.audit.SimpleAuditManager

createWriteData() - Method in class com.helger.photon.basic.favorites.FavoriteManager

createWriteData() - Method in class com.helger.photon.basic.migration.SystemMigrationManager

createXML(IMicroNode) - Static method in class com.helger.photon.basic.longrun.LongRunningJobResult

D

DEFAULT - Static variable in enum com.helger.photon.basic.app.systemmsg.ESystemMessageType

DEFAULT_REQUEST_PARAMETER_DISPLAY_LOCALE - Static variable in class com.helger.photon.basic.app.request.AbstractRequestParameterHandlerNamed

The default name of the parameter selecting the current display locale

DEFAULT_REQUEST_PARAMETER_MENUITEM - Static variable in class com.helger.photon.basic.app.request.AbstractRequestParameterHandlerNamed

The default name of the parameter selecting the current menu item

DEFAULT_SEPARATOR_CHAR - Static variable in class com.helger.photon.basic.app.request.RequestParameterHandlerURLPathNamed

The separator char to be used if path based handling is enabled, to separate name and value

DIRECTORY_HTML - Static variable in class com.helger.photon.basic.mgr.PhotonBasicManager

DoNothingAuditor - Class in com.helger.photon.basic.audit

An implementation of IAuditor that does nothing

DoNothingAuditor(ICurrentUserIDProvider) - Constructor for class com.helger.photon.basic.audit.DoNothingAuditor

E

EAuditActionType - Enum in com.helger.photon.basic.audit

Determines the different types of actions of an audit item.

EConfigurationFileSyntax - Enum in com.helger.photon.basic.configfile

Define the syntax of a configuration file.

ELEMENT_ITEM - Static variable in class com.helger.photon.basic.audit.AuditItemMicroTypeConverter

ELEMENT_ITEM - Static variable in class com.helger.photon.basic.audit.AuditManager

Element name of each item in the serialized XML

ELEMENT_ITEMS - Static variable in class com.helger.photon.basic.audit.AuditManager

Element name of the root element of the serialized XML

ELongRunningJobResultType - Enum in com.helger.photon.basic.longrun

EMenuObjectType - Enum in com.helger.photon.basic.app.menu

Enumeration with the different type of menu objects.

EPhotonBasicText - Enum in com.helger.photon.basic

This enumeration defines the texts for this project.

equals(Object) - Method in class com.helger.photon.basic.app.menu.AbstractMenuObject

equals(Object) - Method in class com.helger.photon.basic.app.menu.MenuItemExternal

equals(Object) - Method in class com.helger.photon.basic.app.menu.MenuItemPage

equals(Object) - Method in class com.helger.photon.basic.app.menu.MenuTree

equals(Object) - Method in class com.helger.photon.basic.app.systemmsg.SystemMessageData

equals(Object) - Method in class com.helger.photon.basic.audit.AuditItem

equals(Object) - Method in class com.helger.photon.basic.audit.AuditItemList

equals(Object) - Method in class com.helger.photon.basic.audit.AuditManager

equals(Object) - Method in class com.helger.photon.basic.audit.SimpleAuditManager

equals(Object) - Method in class com.helger.photon.basic.migration.SystemMigrationResult

ErrorXServletHandler - Class in com.helger.photon.basic.xservlet

ErrorXServletHandler(String) - Constructor for class com.helger.photon.basic.xservlet.ErrorXServletHandler

ESystemMessageType - Enum in com.helger.photon.basic.app.systemmsg

This enumeration defines the different system message types.

exists() - Method in class com.helger.photon.basic.configfile.ConfigurationFile

F

Favorite - Class in com.helger.photon.basic.favorites

Default implementation of favourites for bookmarks.

Favorite(String, String, String, String, Map<String, String>) - Constructor for class com.helger.photon.basic.favorites.Favorite

FavoriteManager - Class in com.helger.photon.basic.favorites

This class manages Favorite objects.

FavoriteManager(String) - Constructor for class com.helger.photon.basic.favorites.FavoriteManager

FavoriteMicroTypeConverter - Class in com.helger.photon.basic.favorites

Convert Favorite objects to IMicroElement and vice versa.

FavoriteMicroTypeConverter() - Constructor for class com.helger.photon.basic.favorites.FavoriteMicroTypeConverter

FAVORITES_XML - Static variable in class com.helger.photon.basic.mgr.PhotonBasicManager

G

getAction() - Method in class com.helger.photon.basic.audit.AuditItem

getAction() - Method in interface com.helger.photon.basic.audit.IAuditItem

getAllAdditionalParams() - Method in class com.helger.photon.basic.favorites.Favorite

getAllAdditionalParams() - Method in interface com.helger.photon.basic.favorites.IFavorite

getAllAuditItems() - Method in class com.helger.photon.basic.audit.SimpleAuditManager

getAllAuditItemsOfDate(LocalDate) - Method in class com.helger.photon.basic.audit.AuditManager

getAllAvailableLocales() - Method in class com.helger.photon.basic.app.locale.GlobalLocaleManager

getAllAvailableLocales() - Method in interface com.helger.photon.basic.app.locale.ILocaleManager

getAllAvailableLocales() - Method in class com.helger.photon.basic.app.locale.LocaleManager

getAllConfigurationFiles() - Method in class com.helger.photon.basic.configfile.ConfigurationFileManager

getAllDefaultMenuItemIDs() - Method in interface com.helger.photon.basic.app.menu.IMenuOperations

getAllDefaultMenuItemIDs() - Method in class com.helger.photon.basic.app.menu.MenuTree

getAllDefaultMenuItems() - Method in interface com.helger.photon.basic.app.menu.IMenuOperations

Get the default menu item objects in the correct order.

getAllDefaultMenuItems() - Method in class com.helger.photon.basic.app.menu.MenuTree

getAllDisplayMenuItemIDs(IMenuTree, String) - Static method in class com.helger.photon.basic.app.menu.MenuItemDeterminatorCallback

getAllDisplayMenuItemIDs(IMenuItemDeterminatorCallback) - Static method in class com.helger.photon.basic.app.menu.MenuItemDeterminatorCallback

getAllEnvVars() - Method in class com.helger.photon.basic.buildinfo.BuildInfo

getAllFailedMigrationResults(String) - Method in class com.helger.photon.basic.migration.SystemMigrationManager

getAllFavoritesOfUser(String) - Method in class com.helger.photon.basic.favorites.FavoriteManager

getAllItemIDs() - Method in interface com.helger.photon.basic.app.menu.IMenuItemDeterminatorCallback

getAllItemIDs() - Method in class com.helger.photon.basic.app.menu.MenuItemDeterminatorCallback

getAllItems() - Method in class com.helger.photon.basic.audit.AuditItemList

getAllJobResults() - Method in class com.helger.photon.basic.longrun.LongRunningJobResultManager

getAllMenuItemIDs(IMenuTree) - Static method in class com.helger.photon.basic.app.menu.MenuItemDeterminatorCallback

Get all menu items without usage a separate MenuItemDeterminatorCallback instance.

getAllMigrationIDs() - Method in class com.helger.photon.basic.migration.SystemMigrationManager

getAllMigrationResults(String) - Method in class com.helger.photon.basic.migration.SystemMigrationManager

getAllMigrationResultsFlattened() - Method in class com.helger.photon.basic.migration.SystemMigrationManager

getAllRunningJobs() - Method in class com.helger.photon.basic.longrun.LongRunningJobManager

getAllSystemProperties() - Method in class com.helger.photon.basic.buildinfo.BuildInfo

getAppIDToServletPathMap() - Static method in class com.helger.photon.basic.app.appid.PhotonGlobalState

getApplicationID(IRequestWebScopeWithoutResponse) - Static method in class com.helger.photon.basic.app.appid.RequestSettings

getApplicationID() - Method in class com.helger.photon.basic.favorites.Favorite

getApplicationID() - Method in interface com.helger.photon.basic.favorites.IFavorite

getAsMLT(String) - Static method in class com.helger.photon.basic.app.page.AbstractPage

getAsString() - Method in class com.helger.photon.basic.longrun.LongRunningJobResult

getAuditItemCount() - Method in class com.helger.photon.basic.audit.AuditManager

getAuditItemCount() - Method in class com.helger.photon.basic.audit.SimpleAuditManager

getAuditItemString(IAuditItem) - Method in class com.helger.photon.basic.audit.LoggingAuditor

getAuditor() - Static method in class com.helger.photon.basic.audit.AuditHelper

getAuditor() - Method in class com.helger.photon.basic.audit.AuditManager

getAuditor() - Method in interface com.helger.photon.basic.audit.IAuditManager

getBaseDir() - Method in class com.helger.photon.basic.audit.AuditManager

getBaseDir() - Method in interface com.helger.photon.basic.audit.IAuditManager

getBuildDateTime() - Method in class com.helger.photon.basic.buildinfo.BuildInfo

getBuildPluginArtifactID(int) - Method in class com.helger.photon.basic.buildinfo.BuildInfo

getBuildPluginConfiguration(int) - Method in class com.helger.photon.basic.buildinfo.BuildInfo

getBuildPluginCount() - Method in class com.helger.photon.basic.buildinfo.BuildInfo

getBuildPluginGroupID(int) - Method in class com.helger.photon.basic.buildinfo.BuildInfo

getBuildPluginKey(int) - Method in class com.helger.photon.basic.buildinfo.BuildInfo

getBuildPluginVersion(int) - Method in class com.helger.photon.basic.buildinfo.BuildInfo

getCommonPrefix() - Method in class com.helger.photon.basic.audit.LoggingAuditor

getContentAsString() - Method in class com.helger.photon.basic.configfile.ConfigurationFile

getContentAsString(Charset) - Method in class com.helger.photon.basic.configfile.ConfigurationFile

getCurrentUserID() - Method in class com.helger.photon.basic.mock.MockCurrentUserIDProvider

getDataIO() - Static method in class com.helger.photon.basic.app.io.WebFileIO

getDataPath() - Method in class com.helger.photon.basic.mock.PhotonBasicTestRule

getDataPath() - Method in class com.helger.photon.basic.mock.PhotonBasicWebTestRule

getDateTime() - Method in class com.helger.photon.basic.audit.AuditItem

getDateTime() - Method in interface com.helger.photon.basic.audit.IAuditItem

getDefaultApplicationID() - Method in class com.helger.photon.basic.app.appid.PhotonGlobalState

getDefaultAuditItemString(IAuditItem) - Static method in class com.helger.photon.basic.audit.LoggingAuditor

getDefaultCharset() - Method in class com.helger.photon.basic.configfile.ConfigurationFile

getDefaultLocale() - Method in class com.helger.photon.basic.app.locale.GlobalLocaleManager

getDefaultLocale() - Method in interface com.helger.photon.basic.app.locale.ILocaleManager

getDefaultLocale() - Method in class com.helger.photon.basic.app.locale.LocaleManager

getDefaultMenuItem() - Method in interface com.helger.photon.basic.app.menu.IMenuOperations

Get the default menu item object.

getDefaultMenuItem() - Method in class com.helger.photon.basic.app.menu.MenuTree

getDefaultMenuItemID() - Method in interface com.helger.photon.basic.app.menu.IMenuOperations

Get the default menu item with the highest priority.

getDefaultMenuItemID() - Method in class com.helger.photon.basic.app.menu.MenuTree

getDependencyArtifactID(int) - Method in class com.helger.photon.basic.buildinfo.BuildInfo

getDependencyClassifier(int) - Method in class com.helger.photon.basic.buildinfo.BuildInfo

getDependencyCount() - Method in class com.helger.photon.basic.buildinfo.BuildInfo

getDependencyGroupID(int) - Method in class com.helger.photon.basic.buildinfo.BuildInfo

getDependencyManagementKey(int) - Method in class com.helger.photon.basic.buildinfo.BuildInfo

getDependencyScope(int) - Method in class com.helger.photon.basic.buildinfo.BuildInfo

getDependencySystemPath(int) - Method in class com.helger.photon.basic.buildinfo.BuildInfo

getDependencyType(int) - Method in class com.helger.photon.basic.buildinfo.BuildInfo

getDependencyVersion(int) - Method in class com.helger.photon.basic.buildinfo.BuildInfo

getDescription() - Method in class com.helger.photon.basic.app.menu.filter.AbstractMenuObjectFilter

getDescription() - Method in class com.helger.photon.basic.app.page.AbstractPage

getDescription(Locale) - Method in class com.helger.photon.basic.app.page.AbstractPage

getDescription(Locale) - Method in interface com.helger.photon.basic.app.page.IPage

Get the description of the page in the passed locale.

getDescription() - Method in class com.helger.photon.basic.configfile.ConfigurationFile

getDisplayCountry(IRequestWebScopeWithoutResponse) - Static method in class com.helger.photon.basic.app.appid.RequestSettings

getDisplayFilter() - Method in class com.helger.photon.basic.app.menu.AbstractMenuObject

getDisplayFilter() - Method in interface com.helger.photon.basic.app.menu.IMenuObject

getDisplayLanguage(IRequestWebScopeWithoutResponse) - Static method in class com.helger.photon.basic.app.appid.RequestSettings

getDisplayLocale() - Method in class com.helger.photon.basic.app.appid.PhotonRequestState

getDisplayLocale() - Method in class com.helger.photon.basic.app.appid.PhotonSessionStatePerApp

getDisplayLocale(IRequestWebScopeWithoutResponse) - Static method in class com.helger.photon.basic.app.appid.RequestSettings

getDisplayName() - Method in class com.helger.photon.basic.favorites.Favorite

getDisplayText(Locale) - Method in class com.helger.photon.basic.app.menu.filter.AbstractMenuObjectFilter

getDisplayText(Locale) - Method in interface com.helger.photon.basic.app.menu.IMenuObjectFilter

getDisplayText(Locale) - Method in class com.helger.photon.basic.app.menu.MenuItemExternal

getDisplayText(Locale) - Method in class com.helger.photon.basic.app.menu.MenuItemPage

getDisplayText(Locale) - Method in class com.helger.photon.basic.app.page.AbstractPage

getDisplayText(Locale) - Method in enum com.helger.photon.basic.app.systemmsg.ESystemMessageType

getDisplayText(Locale) - Method in enum com.helger.photon.basic.EPhotonBasicText

getDuration() - Method in class com.helger.photon.basic.longrun.LongRunningJobData

getEarliestAuditDate() - Method in class com.helger.photon.basic.audit.AuditManager

getEarliestAuditDate() - Method in interface com.helger.photon.basic.audit.IAuditManager

getEndDateTime() - Method in class com.helger.photon.basic.longrun.LongRunningJobData

getErrorMessage() - Method in class com.helger.photon.basic.migration.SystemMigrationResult

getExecutionDateTime() - Method in class com.helger.photon.basic.migration.SystemMigrationResult

getExecutionSuccess() - Method in class com.helger.photon.basic.longrun.LongRunningJobData

getFavorite(String, String, String, ICommonsMap<String, String>) - Method in class com.helger.photon.basic.favorites.FavoriteManager

Get the favorite of the specified user ID

getFavoriteManager() - Static method in class com.helger.photon.basic.mgr.PhotonBasicManager

getFromIDOrDefault(String) - Static method in enum com.helger.photon.basic.app.systemmsg.ESystemMessageType

getFromIDOrNull(String) - Static method in enum com.helger.photon.basic.app.menu.EMenuObjectType

getFromIDOrNull(String) - Static method in enum com.helger.photon.basic.audit.EAuditActionType

getFromIDOrNull(String) - Static method in enum com.helger.photon.basic.configfile.EConfigurationFileSyntax

getFromIDOrNull(String) - Static method in enum com.helger.photon.basic.longrun.ELongRunningJobResultType

getID() - Method in class com.helger.photon.basic.app.menu.AbstractMenuObject

getID() - Method in enum com.helger.photon.basic.app.menu.EMenuObjectType

getID() - Method in class com.helger.photon.basic.app.page.AbstractPage

getID() - Method in enum com.helger.photon.basic.app.systemmsg.ESystemMessageType

getID() - Method in enum com.helger.photon.basic.audit.EAuditActionType

getID() - Method in class com.helger.photon.basic.configfile.ConfigurationFile

getID() - Method in enum com.helger.photon.basic.configfile.EConfigurationFileSyntax

getID() - Method in class com.helger.photon.basic.favorites.Favorite

getID() - Method in enum com.helger.photon.basic.longrun.ELongRunningJobResultType

getID() - Method in class com.helger.photon.basic.longrun.LongRunningJobData

getID() - Method in class com.helger.photon.basic.migration.SystemMigrationResult

getInstance() - Static method in class com.helger.photon.basic.app.appid.PhotonGlobalState

getInstance() - Static method in class com.helger.photon.basic.app.appid.PhotonSessionState

getInstance() - Static method in class com.helger.photon.basic.app.locale.GlobalLocaleManager

getInstance() - Static method in class com.helger.photon.basic.app.request.RequestParameterManager

getInstance() - Static method in class com.helger.photon.basic.configfile.ConfigurationFileManager

getInstance() - Static method in class com.helger.photon.basic.mgr.PhotonBasicManager

getInstance() - Static method in class com.helger.photon.basic.mock.MockCurrentUserIDProvider

getInstanceIfInstantiated() - Static method in class com.helger.photon.basic.app.appid.PhotonSessionState

getItemCount() - Method in class com.helger.photon.basic.audit.AuditItemList

getJobDescription() - Method in interface com.helger.photon.basic.longrun.ILongRunningJob

getJobDescription() - Method in class com.helger.photon.basic.longrun.LongRunningJobData

getJobResultOfID(String) - Method in class com.helger.photon.basic.longrun.LongRunningJobResultManager

getLastApplicationID() - Method in class com.helger.photon.basic.app.appid.PhotonSessionState

getLastAuditItems(int) - Method in class com.helger.photon.basic.audit.AuditManager

getLastAuditItems(int) - Method in interface com.helger.photon.basic.audit.IAuditManager

getLastAuditItems(int) - Method in class com.helger.photon.basic.audit.SimpleAuditManager

getLastItems(int) - Method in class com.helger.photon.basic.audit.AuditItemList

getLastUpdateDT() - Method in interface com.helger.photon.basic.app.systemmsg.ISystemMessageData

getLastUpdateDT() - Method in class com.helger.photon.basic.app.systemmsg.SystemMessageData

getLastUpdateDT() - Method in class com.helger.photon.basic.app.systemmsg.SystemMessageManager

getLinkToMenuItem(IRequestWebScopeWithoutResponse, Locale, String) - Method in interface com.helger.photon.basic.app.request.IRequestParameterManager

getLinkToMenuItem(String, IRequestWebScopeWithoutResponse, Locale, String) - Method in interface com.helger.photon.basic.app.request.IRequestParameterManager

getLinkToMenuItem(String, IRequestWebScopeWithoutResponse, Locale, String) - Method in class com.helger.photon.basic.app.request.RequestParameterManager

getLocale() - Method in class com.helger.photon.basic.app.request.PhotonRequestParameters

getLocaleAsString() - Method in class com.helger.photon.basic.app.request.PhotonRequestParameters

getLocaleFromURL(ISimpleURL, IMenuTree) - Method in interface com.helger.photon.basic.app.request.IRequestParameterManager

getLongRunningJobMgr() - Static method in class com.helger.photon.basic.mgr.PhotonBasicManager

getLongRunningJobResultMgr() - Static method in class com.helger.photon.basic.mgr.PhotonBasicManager

getMenuItem() - Method in class com.helger.photon.basic.app.appid.PhotonRequestState

getMenuItem() - Method in class com.helger.photon.basic.app.appid.PhotonSessionStatePerApp

getMenuItem(IRequestWebScopeWithoutResponse) - Static method in class com.helger.photon.basic.app.appid.RequestSettings

getMenuItem() - Method in class com.helger.photon.basic.app.request.PhotonRequestParameters

getMenuItemAsString() - Method in class com.helger.photon.basic.app.request.PhotonRequestParameters

getMenuItemFromURL(ISimpleURL, IMenuTree) - Method in interface com.helger.photon.basic.app.request.IRequestParameterManager

getMenuItemID(IRequestWebScopeWithoutResponse) - Static method in class com.helger.photon.basic.app.appid.RequestSettings

getMenuItemID() - Method in class com.helger.photon.basic.favorites.Favorite

getMenuItemID() - Method in interface com.helger.photon.basic.favorites.IFavorite

getMenuObjectOfID(String) - Method in interface com.helger.photon.basic.app.menu.IMenuOperations

Get the menu object with the specified ID

getMenuObjectOfID(String) - Method in class com.helger.photon.basic.app.menu.MenuTree

getMenuObjectType() - Method in interface com.helger.photon.basic.app.menu.IMenuObject

getMenuObjectType() - Method in class com.helger.photon.basic.app.menu.MenuItemExternal

getMenuObjectType() - Method in class com.helger.photon.basic.app.menu.MenuItemPage

getMenuObjectType() - Method in class com.helger.photon.basic.app.menu.MenuSeparator

getMenuTree() - Method in class com.helger.photon.basic.app.appid.PhotonGlobalStatePerApp

getMenuTree() - Method in class com.helger.photon.basic.app.appid.PhotonRequestState

getMenuTree() - Method in class com.helger.photon.basic.app.appid.PhotonSessionStatePerApp

getMenuTree(IRequestWebScopeWithoutResponse) - Static method in class com.helger.photon.basic.app.appid.RequestSettings

getMenuTree() - Method in class com.helger.photon.basic.app.menu.AbstractMenuItemDeterminatorCallback

getMenuTree() - Method in interface com.helger.photon.basic.app.menu.IMenuItemDeterminatorCallback

getMessage() - Method in interface com.helger.photon.basic.app.systemmsg.ISystemMessageData

getMessage() - Method in class com.helger.photon.basic.app.systemmsg.SystemMessageData

getMessageType() - Method in interface com.helger.photon.basic.app.systemmsg.ISystemMessageData

getMessageType() - Method in class com.helger.photon.basic.app.systemmsg.SystemMessageData

getMessageType() - Method in class com.helger.photon.basic.app.systemmsg.SystemMessageManager

getMessageTypeID() - Method in interface com.helger.photon.basic.app.systemmsg.ISystemMessageData

getMultilingualText() - Method in enum com.helger.photon.basic.EPhotonBasicText

getName() - Method in class com.helger.photon.basic.app.page.AbstractPage

getPage() - Method in interface com.helger.photon.basic.app.menu.IMenuItemPage

getPage() - Method in class com.helger.photon.basic.app.menu.MenuItemPage

getParameterHandler() - Method in interface com.helger.photon.basic.app.request.IRequestParameterManager

getParameterHandler() - Method in class com.helger.photon.basic.app.request.RequestParameterManager

getParametersFromPath(String, IMenuTree) - Method in class com.helger.photon.basic.app.request.RequestParameterHandlerURLPathNamed

getParametersFromPath(String, IMenuTree) - Method in class com.helger.photon.basic.app.request.RequestParameterHandlerURLPathOrdered

getParametersFromRequest(IRequestWebScopeWithoutResponse, IMenuTree) - Method in interface com.helger.photon.basic.app.request.IRequestParameterHandler

Get all request parameters from the provided request.

getParametersFromRequest(IRequestWebScopeWithoutResponse, IMenuTree) - Method in class com.helger.photon.basic.app.request.RequestParameterHandlerURLParameter

getParametersFromRequest(IRequestWebScopeWithoutResponse, IMenuTree) - Method in class com.helger.photon.basic.app.request.RequestParameterHandlerURLPathNamed

getParametersFromRequest(IRequestWebScopeWithoutResponse, IMenuTree) - Method in class com.helger.photon.basic.app.request.RequestParameterHandlerURLPathOrdered

getParametersFromURL(ISimpleURL, IMenuTree) - Method in interface com.helger.photon.basic.app.request.IRequestParameterHandler

Get all request parameters from the provided URL.

getParametersFromURL(ISimpleURL, IMenuTree) - Method in class com.helger.photon.basic.app.request.RequestParameterHandlerURLParameter

getParametersFromURL(ISimpleURL, IMenuTree) - Method in class com.helger.photon.basic.app.request.RequestParameterHandlerURLPathNamed

getParametersFromURL(ISimpleURL, IMenuTree) - Method in class com.helger.photon.basic.app.request.RequestParameterHandlerURLPathOrdered

getParentProjectArtifactID() - Method in class com.helger.photon.basic.buildinfo.BuildInfo

getParentProjectGroupID() - Method in class com.helger.photon.basic.buildinfo.BuildInfo

getParentProjectName() - Method in class com.helger.photon.basic.buildinfo.BuildInfo

getParentProjectVersion() - Method in class com.helger.photon.basic.buildinfo.BuildInfo

getProjectArtifactID() - Method in class com.helger.photon.basic.buildinfo.BuildInfo

getProjectGroupID() - Method in class com.helger.photon.basic.buildinfo.BuildInfo

getProjectName() - Method in class com.helger.photon.basic.buildinfo.BuildInfo

getProjectPackaging() - Method in class com.helger.photon.basic.buildinfo.BuildInfo

getProjectVersion() - Method in class com.helger.photon.basic.buildinfo.BuildInfo

getQueueLength() - Method in class com.helger.photon.basic.audit.AsynchronousAuditor

getRelativeAuditDirectory(LocalDate) - Static method in class com.helger.photon.basic.audit.AuditManager

getRelativeAuditDirectoryYear(int) - Static method in class com.helger.photon.basic.audit.AuditManager

getRelativeAuditFilename(LocalDate) - Static method in class com.helger.photon.basic.audit.AuditManager

getRequestParamNameLocale() - Method in class com.helger.photon.basic.app.request.AbstractRequestParameterHandlerNamed

getRequestParamNameMenuItem() - Method in class com.helger.photon.basic.app.request.AbstractRequestParameterHandlerNamed

getRequestState(IRequestWebScopeWithoutResponse) - Static method in class com.helger.photon.basic.app.appid.RequestSettings

getResource() - Method in class com.helger.photon.basic.configfile.ConfigurationFile

getResult() - Method in class com.helger.photon.basic.longrun.LongRunningJobData

getResultFile() - Method in class com.helger.photon.basic.longrun.LongRunningJobResult

getResultLink() - Method in class com.helger.photon.basic.longrun.LongRunningJobResult

getResultObject() - Method in class com.helger.photon.basic.longrun.LongRunningJobResult

getResultText() - Method in class com.helger.photon.basic.longrun.LongRunningJobResult

getResultXML() - Method in class com.helger.photon.basic.longrun.LongRunningJobResult

getRootItemDataOfItemWithID(String) - Method in interface com.helger.photon.basic.app.menu.IMenuTree

getRootItemDataOfItemWithID(String) - Method in class com.helger.photon.basic.app.menu.MenuTree

getRootItemOfItemWithID(String) - Method in interface com.helger.photon.basic.app.menu.IMenuTree

getRootItemOfItemWithID(String) - Method in class com.helger.photon.basic.app.menu.MenuTree

getRunningJobCount() - Method in class com.helger.photon.basic.longrun.LongRunningJobManager

getSeparator() - Method in class com.helger.photon.basic.app.request.RequestParameterHandlerURLPathNamed

getServletContextIO() - Static method in class com.helger.photon.basic.app.io.WebFileIO

getServletContextPath() - Method in class com.helger.photon.basic.mock.PhotonBasicTestRule

getServletContextPath() - Method in class com.helger.photon.basic.mock.PhotonBasicWebTestRule

getServletPath() - Method in class com.helger.photon.basic.app.appid.PhotonGlobalStatePerApp

getSize() - Method in class com.helger.photon.basic.favorites.FavoriteManager

getStartDateTime() - Method in class com.helger.photon.basic.longrun.LongRunningJobData

getStartingUserID() - Method in class com.helger.photon.basic.longrun.LongRunningJobData

getSuccess() - Method in class com.helger.photon.basic.audit.AuditItem

getSuccess() - Method in interface com.helger.photon.basic.audit.IAuditItem

getSyntaxHighlightLanguage() - Method in class com.helger.photon.basic.configfile.ConfigurationFile

getSystemMessage() - Method in class com.helger.photon.basic.app.systemmsg.SystemMessageManager

getSystemMessageMgr() - Static method in class com.helger.photon.basic.mgr.PhotonBasicManager

getSystemMigrationMgr() - Static method in class com.helger.photon.basic.mgr.PhotonBasicManager

getTarget() - Method in interface com.helger.photon.basic.app.menu.IMenuItem

getTarget() - Method in class com.helger.photon.basic.app.menu.MenuItemExternal

getTarget() - Method in class com.helger.photon.basic.app.menu.MenuItemPage

getType() - Method in class com.helger.photon.basic.audit.AuditItem

getType() - Method in interface com.helger.photon.basic.audit.IAuditItem

getType() - Method in class com.helger.photon.basic.longrun.LongRunningJobResult

getTypeID() - Method in interface com.helger.photon.basic.audit.IAuditItem

getURL() - Method in interface com.helger.photon.basic.app.menu.IMenuItemExternal

getURLProvider() - Method in interface com.helger.photon.basic.app.menu.IMenuItemExternal

getURLProvider() - Method in class com.helger.photon.basic.app.menu.MenuItemExternal

getUserID() - Method in class com.helger.photon.basic.audit.AuditItem

getUserID() - Method in class com.helger.photon.basic.favorites.Favorite

getValue(String) - Method in class com.helger.photon.basic.buildinfo.BuildInfo

Get a string property.

getVersion() - Method in class com.helger.photon.basic.buildinfo.BuildInfo

GlobalLocaleManager - Class in com.helger.photon.basic.app.locale

This class manages the available locales.

GlobalLocaleManager() - Constructor for class com.helger.photon.basic.app.locale.GlobalLocaleManager

Deprecated.

H

handleAuditItem(IAuditItem) - Method in class com.helger.photon.basic.audit.AbstractAuditor

Implement this method to handle the created audit items.

handleAuditItem(IAuditItem) - Method in class com.helger.photon.basic.audit.AsynchronousAuditor

handleAuditItem(IAuditItem) - Method in class com.helger.photon.basic.audit.DoNothingAuditor

handleAuditItem(IAuditItem) - Method in class com.helger.photon.basic.audit.LoggingAuditor

handleRequest(IRequestWebScopeWithoutResponse, UnifiedResponse) - Method in class com.helger.photon.basic.xservlet.ErrorXServletHandler

hasErrorMessage() - Method in class com.helger.photon.basic.migration.SystemMigrationResult

hashCode() - Method in class com.helger.photon.basic.app.menu.AbstractMenuObject

hashCode() - Method in class com.helger.photon.basic.app.menu.MenuItemExternal

hashCode() - Method in class com.helger.photon.basic.app.menu.MenuItemPage

hashCode() - Method in class com.helger.photon.basic.app.menu.MenuTree

hashCode() - Method in class com.helger.photon.basic.app.systemmsg.SystemMessageData

hashCode() - Method in class com.helger.photon.basic.audit.AuditItem

hashCode() - Method in class com.helger.photon.basic.audit.AuditItemList

hashCode() - Method in class com.helger.photon.basic.audit.AuditManager

hashCode() - Method in class com.helger.photon.basic.audit.SimpleAuditManager

hashCode() - Method in class com.helger.photon.basic.migration.SystemMigrationResult

hasLocale() - Method in class com.helger.photon.basic.app.request.PhotonRequestParameters

hasLocales() - Method in class com.helger.photon.basic.app.locale.GlobalLocaleManager

hasLocales() - Method in interface com.helger.photon.basic.app.locale.ILocaleManager

hasLocales() - Method in class com.helger.photon.basic.app.locale.LocaleManager

hasMenuItem() - Method in class com.helger.photon.basic.app.request.PhotonRequestParameters

hasMessage() - Method in interface com.helger.photon.basic.app.systemmsg.ISystemMessageData

hasSameContent(String, String, ICommonsMap<String, String>) - Method in class com.helger.photon.basic.favorites.Favorite

hasSameContent(String, String, ICommonsMap<String, String>) - Method in interface com.helger.photon.basic.favorites.IFavorite

hasSystemMessage() - Method in class com.helger.photon.basic.app.systemmsg.SystemMessageManager

hasTarget() - Method in interface com.helger.photon.basic.app.menu.IMenuItem

I

IAuditActionStringProvider - Interface in com.helger.photon.basic.audit

Interface that is used to convert audit parameters to an audit string

IAuditItem - Interface in com.helger.photon.basic.audit

Base interface for a single audit item

IAuditManager - Interface in com.helger.photon.basic.audit

Interface for a manager that can handle audit items.

IAuditor - Interface in com.helger.photon.basic.audit

Main interface for an auditing service.

IFavorite - Interface in com.helger.photon.basic.favorites

Base interface for a single favorite bookmark.

ILocaleManager - Interface in com.helger.photon.basic.app.locale

Base interface for an application Locale manager.

ILongRunningJob - Interface in com.helger.photon.basic.longrun

This is a marker interface that identifies long running background jobs.

IMenuItem - Interface in com.helger.photon.basic.app.menu

Base interface for a single menu item.

IMenuItemDeterminatorCallback - Interface in com.helger.photon.basic.app.menu

Base interface for MenuItemDeterminatorCallback.

IMenuItemExternal - Interface in com.helger.photon.basic.app.menu

Base interface for a single menu item referencing an arbitrary URL.

IMenuItemPage - Interface in com.helger.photon.basic.app.menu

Base interface for a single menu item referencing an internal page.

IMenuObject - Interface in com.helger.photon.basic.app.menu

Base interface for menu items and menu separators.

IMenuObjectFilter - Interface in com.helger.photon.basic.app.menu

Special menu item filter to determine the visibility of a menu item.

IMenuOperations - Interface in com.helger.photon.basic.app.menu

Contains all the menu-specific menu operations.

IMenuSeparator - Interface in com.helger.photon.basic.app.menu

Interface for a menu item separator.

IMenuTree - Interface in com.helger.photon.basic.app.menu

A combination of a tree and the menu operations

init(File, String) - Static method in class com.helger.photon.basic.mock.PhotonBasicTestInit

initPaths(File, String, boolean) - Static method in class com.helger.photon.basic.app.io.WebFileIO

INSTANCE - Static variable in class com.helger.photon.basic.xservlet.AuditingLongRunningRequestCallback

INSTANCE - Static variable in class com.helger.photon.basic.xservlet.AuditingParallelRunningRequestCallback

internalCreateChildItem(DefaultTreeItemWithID<String, IMenuObject>, T) - Static method in class com.helger.photon.basic.app.menu.MenuTree

IPage - Interface in com.helger.photon.basic.app.page

The base interface for a single page of content.

IRequestParameterHandler - Interface in com.helger.photon.basic.app.request

Interface for extracting parameters from URLs.

IRequestParameterManager - Interface in com.helger.photon.basic.app.request

Predefined request parameter manager

isDependencyOptional(int) - Method in class com.helger.photon.basic.buildinfo.BuildInfo

isEmpty() - Method in class com.helger.photon.basic.favorites.FavoriteManager

isEnded() - Method in class com.helger.photon.basic.longrun.LongRunningJobData

isExternal() - Method in enum com.helger.photon.basic.app.menu.EMenuObjectType

isFailure() - Method in class com.helger.photon.basic.migration.SystemMigrationResult

isFavorite(String, String, String, ICommonsMap<String, String>) - Method in class com.helger.photon.basic.favorites.FavoriteManager

Get a list favorites of the specified user ID

isInited() - Static method in class com.helger.photon.basic.app.io.WebFileIO

isInMemory() - Method in class com.helger.photon.basic.audit.AuditManager

isInMemory() - Method in interface com.helger.photon.basic.audit.IAuditManager

isMenuItemValidToBeDisplayed(IMenuObject) - Method in class com.helger.photon.basic.app.menu.MenuItemDeterminatorCallback

isNotEmpty() - Method in class com.helger.photon.basic.app.appid.PhotonSessionStatePerApp

isNotSeparator() - Method in enum com.helger.photon.basic.app.menu.EMenuObjectType

isPage() - Method in enum com.helger.photon.basic.app.menu.EMenuObjectType

isReloadable() - Method in class com.helger.photon.basic.app.dao.AbstractPhotonMapBasedWALDAO

isReloadable() - Method in class com.helger.photon.basic.app.systemmsg.SystemMessageManager

isReloadable() - Method in class com.helger.photon.basic.favorites.FavoriteManager

isSeparator() - Method in enum com.helger.photon.basic.app.menu.EMenuObjectType

isSuccess() - Method in interface com.helger.photon.basic.audit.IAuditItem

isSuccess() - Method in class com.helger.photon.basic.migration.SystemMigrationResult

isSupportedLocale(Locale) - Method in class com.helger.photon.basic.app.locale.GlobalLocaleManager

isSupportedLocale(Locale) - Method in interface com.helger.photon.basic.app.locale.ILocaleManager

Check if the passed locale is a supported locale.

isSupportedLocale(Locale) - Method in class com.helger.photon.basic.app.locale.LocaleManager

isValidParameterName(String) - Method in class com.helger.photon.basic.app.request.AbstractRequestParameterHandlerNamed

Check if the passed parameter name is valid according to the rules of this parameter handler.

isValidParameterName(String) - Method in class com.helger.photon.basic.app.request.RequestParameterHandlerURLParameter

isValidParameterName(String) - Method in class com.helger.photon.basic.app.request.RequestParameterHandlerURLPathNamed

ISystemMessageData - Interface in com.helger.photon.basic.app.systemmsg

System message data read-only interface.

iterateAllMenuObjects(Consumer<? super IMenuObject>) - Method in interface com.helger.photon.basic.app.menu.IMenuOperations

Iterate all menu objects and invoke the supplied callback.

iterateAllMenuObjects(Consumer<? super IMenuObject>) - Method in class com.helger.photon.basic.app.menu.MenuTree

J

JSON - Static variable in interface com.helger.photon.basic.audit.IAuditActionStringProvider

L

LocaleManager - Class in com.helger.photon.basic.app.locale

This class manages the locales available in the application.

LocaleManager() - Constructor for class com.helger.photon.basic.app.locale.LocaleManager

LoggingAuditor - Class in com.helger.photon.basic.audit

An implementation of IAuditor using SLF4J logging.

LoggingAuditor(ICurrentUserIDProvider) - Constructor for class com.helger.photon.basic.audit.LoggingAuditor

LoggingAuditor(ICurrentUserIDProvider, String) - Constructor for class com.helger.photon.basic.audit.LoggingAuditor

LONG_RUNNING_JOB_RESULTS_XML - Static variable in class com.helger.photon.basic.mgr.PhotonBasicManager

LongRunningJobData - Class in com.helger.photon.basic.longrun

This class contains the data for a single long running job.

LongRunningJobData(String, IMultilingualText, String) - Constructor for class com.helger.photon.basic.longrun.LongRunningJobData

LongRunningJobDataMicroTypeConverter - Class in com.helger.photon.basic.longrun

LongRunningJobDataMicroTypeConverter() - Constructor for class com.helger.photon.basic.longrun.LongRunningJobDataMicroTypeConverter

LongRunningJobManager - Class in com.helger.photon.basic.longrun

LongRunningJobManager(LongRunningJobResultManager) - Constructor for class com.helger.photon.basic.longrun.LongRunningJobManager

LongRunningJobResult - Class in com.helger.photon.basic.longrun

This class represents the result of a single long running job execution.

LongRunningJobResult(ELongRunningJobResultType, Serializable) - Constructor for class com.helger.photon.basic.longrun.LongRunningJobResult

LongRunningJobResultManager - Class in com.helger.photon.basic.longrun

LongRunningJobResultManager(String) - Constructor for class com.helger.photon.basic.longrun.LongRunningJobResultManager

M

matchesDisplayFilter() - Method in class com.helger.photon.basic.app.menu.AbstractMenuObject

matchesDisplayFilter() - Method in interface com.helger.photon.basic.app.menu.IMenuObject

MenuItemDeterminatorCallback - Class in com.helger.photon.basic.app.menu

Determine all menu items to show, depending on the currently selected menu item.

MenuItemDeterminatorCallback(IMenuTree, String) - Constructor for class com.helger.photon.basic.app.menu.MenuItemDeterminatorCallback

MenuItemExternal - Class in com.helger.photon.basic.app.menu

Default implementation of the IMenuItemExternal interface.

MenuItemExternal(String, IHasSimpleURL, IHasDisplayText) - Constructor for class com.helger.photon.basic.app.menu.MenuItemExternal

MenuItemPage - Class in com.helger.photon.basic.app.menu

Default implementation of the IMenuItemPage interface.

MenuItemPage(String, IPage) - Constructor for class com.helger.photon.basic.app.menu.MenuItemPage

MenuItemPage(String, IPage, IHasDisplayText) - Constructor for class com.helger.photon.basic.app.menu.MenuItemPage

MenuSeparator - Class in com.helger.photon.basic.app.menu

Default implementation of the IMenuSeparator interface.

MenuSeparator() - Constructor for class com.helger.photon.basic.app.menu.MenuSeparator

Deprecated.

MenuSeparator(String) - Constructor for class com.helger.photon.basic.app.menu.MenuSeparator

MenuTree - Class in com.helger.photon.basic.app.menu

Represents a single menu tree

MenuTree() - Constructor for class com.helger.photon.basic.app.menu.MenuTree

MicroTypeConverterRegistrar_ph_oton_basic - Class in com.helger.photon.basic.config

Special micro type converter for this project.

MicroTypeConverterRegistrar_ph_oton_basic() - Constructor for class com.helger.photon.basic.config.MicroTypeConverterRegistrar_ph_oton_basic

MockCurrentUserIDProvider - Class in com.helger.photon.basic.mock

Mock implementation of ICurrentUserIDProvider.

MockCurrentUserIDProvider() - Constructor for class com.helger.photon.basic.mock.MockCurrentUserIDProvider

MockCurrentUserIDProvider(String) - Constructor for class com.helger.photon.basic.mock.MockCurrentUserIDProvider

O

onAfterInstantiation(IScope) - Method in class com.helger.photon.basic.mgr.PhotonBasicManager

onAuditCreateFailure(ObjectType) - Static method in class com.helger.photon.basic.audit.AuditHelper

Deprecated.

onAuditCreateFailure(ObjectType, Object...) - Static method in class com.helger.photon.basic.audit.AuditHelper

onAuditCreateSuccess(ObjectType) - Static method in class com.helger.photon.basic.audit.AuditHelper

onAuditCreateSuccess(ObjectType, Object...) - Static method in class com.helger.photon.basic.audit.AuditHelper

onAuditDeleteFailure(ObjectType) - Static method in class com.helger.photon.basic.audit.AuditHelper

Deprecated.

onAuditDeleteFailure(ObjectType, Object...) - Static method in class com.helger.photon.basic.audit.AuditHelper

onAuditDeleteSuccess(ObjectType) - Static method in class com.helger.photon.basic.audit.AuditHelper

Deprecated.

onAuditDeleteSuccess(ObjectType, Object...) - Static method in class com.helger.photon.basic.audit.AuditHelper

onAuditExecuteFailure(String, Object...) - Static method in class com.helger.photon.basic.audit.AuditHelper

onAuditExecuteFailure(ObjectType, String, Object...) - Static method in class com.helger.photon.basic.audit.AuditHelper

onAuditExecuteSuccess(String, Object...) - Static method in class com.helger.photon.basic.audit.AuditHelper

onAuditExecuteSuccess(ObjectType, String, Object...) - Static method in class com.helger.photon.basic.audit.AuditHelper

onAuditModifyFailure(ObjectType, String) - Static method in class com.helger.photon.basic.audit.AuditHelper

Deprecated.

onAuditModifyFailure(ObjectType, String, Object...) - Static method in class com.helger.photon.basic.audit.AuditHelper

onAuditModifySuccess(ObjectType, String) - Static method in class com.helger.photon.basic.audit.AuditHelper

Deprecated.

onAuditModifySuccess(ObjectType, String, Object...) - Static method in class com.helger.photon.basic.audit.AuditHelper

onAuditUndeleteFailure(ObjectType) - Static method in class com.helger.photon.basic.audit.AuditHelper

Deprecated.

onAuditUndeleteFailure(ObjectType, Object...) - Static method in class com.helger.photon.basic.audit.AuditHelper

onAuditUndeleteSuccess(ObjectType) - Static method in class com.helger.photon.basic.audit.AuditHelper

Deprecated.

onAuditUndeleteSuccess(ObjectType, Object...) - Static method in class com.helger.photon.basic.audit.AuditHelper

onCreateFailure(ObjectType, Object...) - Method in interface com.helger.photon.basic.audit.IAuditor

The creation of an object failed.

onCreateSuccess(ObjectType, Object...) - Method in interface com.helger.photon.basic.audit.IAuditor

The creation of an object succeeded.

onDeleteFailure(ObjectType, Object...) - Method in interface com.helger.photon.basic.audit.IAuditor

The deletion of an object failed.

onDeleteSuccess(ObjectType, Object...) - Method in interface com.helger.photon.basic.audit.IAuditor

The deletion of an object succeeded.

onEndJob(String, ESuccess, LongRunningJobResult) - Method in class com.helger.photon.basic.longrun.LongRunningJobManager

End a job.

onExecuteFailure(String, Object...) - Method in interface com.helger.photon.basic.audit.IAuditor

The execution of something failed.

onExecuteFailure(ObjectType, String, Object...) - Method in interface com.helger.photon.basic.audit.IAuditor

The execution of something on an object failed.

onExecuteSuccess(String, Object...) - Method in interface com.helger.photon.basic.audit.IAuditor

The execution of something succeeded.

onExecuteSuccess(ObjectType, String, Object...) - Method in interface com.helger.photon.basic.audit.IAuditor

The execution of something on an object succeeded.

onFilenameChange(String, String) - Method in class com.helger.photon.basic.audit.AuditManager

onItemBeforeChildren(DefaultTreeItemWithID<String, IMenuObject>) - Method in class com.helger.photon.basic.app.menu.MenuItemDeterminatorCallback

onLongRunningRequest(String, IRequestWebScope, long) - Method in class com.helger.photon.basic.xservlet.AuditingLongRunningRequestCallback

onModifyFailure(ObjectType, String, Object...) - Method in interface com.helger.photon.basic.audit.IAuditor

The modification of an object failed.

onModifySuccess(ObjectType, String, Object...) - Method in interface com.helger.photon.basic.audit.IAuditor

The modification of an object succeeded.

onParallelRunningRequests(int, List<TrackedRequest>) - Method in class com.helger.photon.basic.xservlet.AuditingParallelRunningRequestCallback

onParallelRunningRequestsBelowLimit() - Method in class com.helger.photon.basic.xservlet.AuditingParallelRunningRequestCallback

onRead(IMicroDocument) - Method in class com.helger.photon.basic.app.systemmsg.SystemMessageManager

onRead(IMicroDocument) - Method in class com.helger.photon.basic.audit.AuditManager

onRead(IMicroDocument) - Method in class com.helger.photon.basic.audit.SimpleAuditManager

onRead(IMicroDocument) - Method in class com.helger.photon.basic.favorites.FavoriteManager

onRead(IMicroDocument) - Method in class com.helger.photon.basic.migration.SystemMigrationManager

onRecoveryCreate(AuditItem) - Method in class com.helger.photon.basic.audit.SimpleAuditManager

onRecoveryCreate(Favorite) - Method in class com.helger.photon.basic.favorites.FavoriteManager

onRecoveryDelete(AuditItem) - Method in class com.helger.photon.basic.audit.SimpleAuditManager

onRecoveryDelete(Favorite) - Method in class com.helger.photon.basic.favorites.FavoriteManager

onRecoveryUpdate(AuditItem) - Method in class com.helger.photon.basic.audit.SimpleAuditManager

onRecoveryUpdate(Favorite) - Method in class com.helger.photon.basic.favorites.FavoriteManager

onStartJob(ILongRunningJob, String) - Method in class com.helger.photon.basic.longrun.LongRunningJobManager

Start a long running job

onUndeleteFailure(ObjectType, Object...) - Method in interface com.helger.photon.basic.audit.IAuditor

The undeletion of an object failed.

onUndeleteSuccess(ObjectType, Object...) - Method in interface com.helger.photon.basic.audit.IAuditor

The undeletion of an object succeeded.

or(IMenuObjectFilter) - Method in interface com.helger.photon.basic.app.menu.IMenuObjectFilter

OT - Static variable in class com.helger.photon.basic.favorites.Favorite

OT_SYSTEM_MIGRATION_RESULT - Static variable in class com.helger.photon.basic.migration.SystemMigrationManager

P

performMigrationIfNecessary(String, Runnable) - Method in class com.helger.photon.basic.migration.SystemMigrationManager

Perform a migration if it was not performed yet.

performMigrationIfNecessary(String, Supplier<SuccessWithValue<String>>) - Method in class com.helger.photon.basic.migration.SystemMigrationManager

Perform a migration if it was not performed yet.

PhotonBasic - Class in com.helger.photon.basic

PhotonBasicManager - Class in com.helger.photon.basic.mgr

The meta system manager encapsulates all managers that are located in this project.

PhotonBasicManager() - Constructor for class com.helger.photon.basic.mgr.PhotonBasicManager

Deprecated.

PhotonBasicTestInit - Class in com.helger.photon.basic.mock

Static test init and shutdown code for this project

PhotonBasicTestRule - Class in com.helger.photon.basic.mock

Non-web scope aware test rule, with a defined storage root directory

PhotonBasicTestRule() - Constructor for class com.helger.photon.basic.mock.PhotonBasicTestRule

Ctor using the default storage path from ScopeTestRule

PhotonBasicTestRule(File) - Constructor for class com.helger.photon.basic.mock.PhotonBasicTestRule

Ctor with an arbitrary path

PhotonBasicTestRule(File, String) - Constructor for class com.helger.photon.basic.mock.PhotonBasicTestRule

Ctor with an arbitrary path

PhotonBasicWebTestRule - Class in com.helger.photon.basic.mock

Web scope aware test rule, with a defined storage root directory

PhotonBasicWebTestRule() - Constructor for class com.helger.photon.basic.mock.PhotonBasicWebTestRule

Ctor using the default storage path from ScopeTestRule

PhotonBasicWebTestRule(File) - Constructor for class com.helger.photon.basic.mock.PhotonBasicWebTestRule

Ctor with an arbitrary path

PhotonBasicWebTestRule(File, String) - Constructor for class com.helger.photon.basic.mock.PhotonBasicWebTestRule

Ctor with an arbitrary path

PhotonGlobalState - Class in com.helger.photon.basic.app.appid

This class contains all the objects that are hold "per application".

PhotonGlobalState() - Constructor for class com.helger.photon.basic.app.appid.PhotonGlobalState

Deprecated.

PhotonGlobalStatePerApp - Class in com.helger.photon.basic.app.appid

Single global state per app

PhotonGlobalStatePerApp() - Constructor for class com.helger.photon.basic.app.appid.PhotonGlobalStatePerApp

PhotonRequestParameters - Class in com.helger.photon.basic.app.request

Holder for the special ph-oton parameters

PhotonRequestParameters() - Constructor for class com.helger.photon.basic.app.request.PhotonRequestParameters

PhotonRequestState - Class in com.helger.photon.basic.app.appid

Request state

PhotonRequestState(PhotonSessionStatePerApp) - Constructor for class com.helger.photon.basic.app.appid.PhotonRequestState

PhotonRequestState(PhotonGlobalStatePerApp) - Constructor for class com.helger.photon.basic.app.appid.PhotonRequestState

PhotonRequestState(IMenuTree, IMenuItemPage, Locale) - Constructor for class com.helger.photon.basic.app.appid.PhotonRequestState

PhotonSessionState - Class in com.helger.photon.basic.app.appid

This class maintains the session state per application ID

PhotonSessionState() - Constructor for class com.helger.photon.basic.app.appid.PhotonSessionState

Deprecated.

PhotonSessionStatePerApp - Class in com.helger.photon.basic.app.appid

Single session state per app

PhotonSessionStatePerApp() - Constructor for class com.helger.photon.basic.app.appid.PhotonSessionStatePerApp

PLAIN_STRING - Static variable in interface com.helger.photon.basic.audit.IAuditActionStringProvider

R

readFromXML(IMicroDocument, Consumer<? super IAuditItem>) - Static method in class com.helger.photon.basic.audit.AuditManager

registerConfigurationFile(ConfigurationFile) - Method in class com.helger.photon.basic.configfile.ConfigurationFileManager

registerLocale(Locale) - Method in class com.helger.photon.basic.app.locale.GlobalLocaleManager

registerLocale(Locale) - Method in interface com.helger.photon.basic.app.locale.ILocaleManager

Register a new locale

registerLocale(Locale) - Method in class com.helger.photon.basic.app.locale.LocaleManager

registerMicroTypeConverter(IMicroTypeConverterRegistry) - Method in class com.helger.photon.basic.config.MicroTypeConverterRegistrar_ph_oton_basic

reload() - Method in class com.helger.photon.basic.app.dao.AbstractPhotonMapBasedWALDAO

reload() - Method in class com.helger.photon.basic.app.systemmsg.SystemMessageManager

reload() - Method in class com.helger.photon.basic.favorites.FavoriteManager

rememberMenuItemForDisplay(String, boolean) - Method in class com.helger.photon.basic.app.menu.MenuItemDeterminatorCallback

removeAllApplicationServletPathMappings() - Static method in class com.helger.photon.basic.app.appid.PhotonGlobalState

removeAllFavoritesOfUser(String) - Method in class com.helger.photon.basic.favorites.FavoriteManager

Remove all contained favorites objects of an user.

removeFavorite(String, String) - Method in class com.helger.photon.basic.favorites.FavoriteManager

Remove the favorites with the specified ID.

removeServletPath() - Method in class com.helger.photon.basic.app.appid.PhotonGlobalStatePerApp

replaceMenuItem(IPage) - Method in interface com.helger.photon.basic.app.menu.IMenuOperations

Replace an eventually existing menu item with the new one.

replaceMenuItem(IPage) - Method in class com.helger.photon.basic.app.menu.MenuTree

REQUEST_ATTR_APP_ID - Static variable in class com.helger.photon.basic.app.appid.RequestSettings

REQUEST_ATTR_STATE - Static variable in class com.helger.photon.basic.app.appid.RequestSettings

RequestParameterHandlerURLParameter - Class in com.helger.photon.basic.app.request

An implementation of IRequestParameterHandler that takes the request parameters from the URL parameters.

RequestParameterHandlerURLParameter() - Constructor for class com.helger.photon.basic.app.request.RequestParameterHandlerURLParameter

RequestParameterHandlerURLPathNamed - Class in com.helger.photon.basic.app.request

An implementation of IRequestParameterHandler that takes the request parameters from the URL path.

RequestParameterHandlerURLPathNamed() - Constructor for class com.helger.photon.basic.app.request.RequestParameterHandlerURLPathNamed

Default constructor using RequestParameterHandlerURLPathNamed.DEFAULT_SEPARATOR_CHAR as the separator.

RequestParameterHandlerURLPathNamed(String) - Constructor for class com.helger.photon.basic.app.request.RequestParameterHandlerURLPathNamed

Constructor with a custom separator.

RequestParameterHandlerURLPathOrdered - Class in com.helger.photon.basic.app.request

An implementation of IRequestParameterHandler that takes the request parameters from the URL path in the fixed order locale than menu item.

RequestParameterHandlerURLPathOrdered() - Constructor for class com.helger.photon.basic.app.request.RequestParameterHandlerURLPathOrdered

Default constructor

RequestParameterManager - Class in com.helger.photon.basic.app.request

This class holds the per-request configuration settings.

RequestParameterManager() - Constructor for class com.helger.photon.basic.app.request.RequestParameterManager

Deprecated.

RequestSettings - Class in com.helger.photon.basic.app.appid

This is a utility class to get the

resetPaths() - Static method in class com.helger.photon.basic.app.io.WebFileIO

Reset the base paths - no matter if they were initialized or not.

RootXServletHandler - Class in com.helger.photon.basic.xservlet

An IXServletSimpleHandler that does the necessary redirect for a ROOT servlet.

RootXServletHandler(String) - Constructor for class com.helger.photon.basic.xservlet.RootXServletHandler

S

setActionStringProvider(IAuditActionStringProvider) - Method in class com.helger.photon.basic.audit.AbstractAuditor

setAuditor(IAuditor) - Static method in class com.helger.photon.basic.audit.AuditHelper

Set the global auditor to use.

setCurrentUserIDProvider(ICurrentUserIDProvider) - Method in class com.helger.photon.basic.audit.AbstractAuditor

setDefaultApplicationID(String) - Method in class com.helger.photon.basic.app.appid.PhotonGlobalState

Set the default application ID of an application servlet.

setDefaultAuditor() - Static method in class com.helger.photon.basic.audit.AuditHelper

Set the default auditor again.

setDefaultCharset(Charset) - Method in class com.helger.photon.basic.configfile.ConfigurationFile

setDefaultLocale(Locale) - Method in class com.helger.photon.basic.app.locale.GlobalLocaleManager

setDefaultLocale(Locale) - Method in interface com.helger.photon.basic.app.locale.ILocaleManager

Set the default locale.

setDefaultLocale(Locale) - Method in class com.helger.photon.basic.app.locale.LocaleManager

setDefaultMenuItemID(String) - Method in interface com.helger.photon.basic.app.menu.IMenuOperations

Set the default menu item.

setDefaultMenuItemID(String) - Method in class com.helger.photon.basic.app.menu.MenuTree

setDefaultMenuItemIDs(String...) - Method in interface com.helger.photon.basic.app.menu.IMenuOperations

Set the default menu items in the priority order.

setDefaultMenuItemIDs(Iterable<String>) - Method in interface com.helger.photon.basic.app.menu.IMenuOperations

Set the default menu items in the priority order.

setDefaultMenuItemIDs(String...) - Method in class com.helger.photon.basic.app.menu.MenuTree

setDefaultMenuItemIDs(Iterable<String>) - Method in class com.helger.photon.basic.app.menu.MenuTree

setDeleteAllData(boolean) - Method in class com.helger.photon.basic.mock.PhotonBasicWebTestRule

Delete the directories with data and servlet context path before each iteration?

setDescription(String) - Method in class com.helger.photon.basic.app.menu.filter.AbstractMenuObjectFilter

setDescription(IMultilingualText) - Method in class com.helger.photon.basic.app.menu.filter.AbstractMenuObjectFilter

setDescription(IMultilingualText) - Method in class com.helger.photon.basic.app.page.AbstractPage

Set the description of the page.

setDescription(String) - Method in class com.helger.photon.basic.configfile.ConfigurationFile

Set the description to use.

setDisplayFilter(IMenuObjectFilter) - Method in class com.helger.photon.basic.app.menu.AbstractMenuObject

setDisplayFilter(IMenuObjectFilter) - Method in interface com.helger.photon.basic.app.menu.IMenuItemExternal

Set a new display filter for this menu object.

setDisplayFilter(IMenuObjectFilter) - Method in interface com.helger.photon.basic.app.menu.IMenuItemPage

Set a new display filter for this menu object.

setDisplayFilter(IMenuObjectFilter) - Method in interface com.helger.photon.basic.app.menu.IMenuObject

Set a new display filter for this menu object.

setDisplayFilter(IMenuObjectFilter) - Method in interface com.helger.photon.basic.app.menu.IMenuSeparator

Set a new display filter for this menu object.

setDisplayName(String) - Method in class com.helger.photon.basic.favorites.Favorite

setLastUpdate(LocalDateTime) - Method in class com.helger.photon.basic.app.systemmsg.SystemMessageData

setLocale(Locale) - Method in class com.helger.photon.basic.app.appid.PhotonSessionStatePerApp

setLocale(Locale) - Method in class com.helger.photon.basic.app.request.PhotonRequestParameters

Set the current locale

setLocaleFromString(ILocaleManager, String) - Method in class com.helger.photon.basic.app.request.PhotonRequestParameters

setMenuItem(IMenuItemPage) - Method in class com.helger.photon.basic.app.appid.PhotonSessionStatePerApp

setMenuItemFromString(IMenuTree, String) - Method in class com.helger.photon.basic.app.request.PhotonRequestParameters

setMenuTree(IMenuTree) - Method in class com.helger.photon.basic.app.appid.PhotonGlobalStatePerApp

setMenuTree(IMenuTree) - Method in class com.helger.photon.basic.app.appid.PhotonSessionStatePerApp

setName(IMultilingualText) - Method in class com.helger.photon.basic.app.page.AbstractPage

Set the name of the page.

setParameterHandler(IRequestParameterHandler) - Method in interface com.helger.photon.basic.app.request.IRequestParameterManager

setParameterHandler(IRequestParameterHandler) - Method in class com.helger.photon.basic.app.request.RequestParameterManager

setRequestParamNameLocale(String) - Method in class com.helger.photon.basic.app.request.AbstractRequestParameterHandlerNamed

setRequestParamNameMenuItem(String) - Method in class com.helger.photon.basic.app.request.AbstractRequestParameterHandlerNamed

setServletPath(String) - Method in class com.helger.photon.basic.app.appid.PhotonGlobalStatePerApp

setSyntaxHighlightLanguage(EConfigurationFileSyntax) - Method in class com.helger.photon.basic.configfile.ConfigurationFile

setSystemMessage(ESystemMessageType, String) - Method in class com.helger.photon.basic.app.systemmsg.SystemMessageData

Set the system message type and text, and update the last modification date.

setSystemMessage(ESystemMessageType, String) - Method in class com.helger.photon.basic.app.systemmsg.SystemMessageManager

setTarget(String) - Method in interface com.helger.photon.basic.app.menu.IMenuItem

Set the (HTML) target of the link.

setTarget(String) - Method in interface com.helger.photon.basic.app.menu.IMenuItemExternal

setTarget(String) - Method in interface com.helger.photon.basic.app.menu.IMenuItemPage

setTarget(String) - Method in class com.helger.photon.basic.app.menu.MenuItemExternal

setTarget(String) - Method in class com.helger.photon.basic.app.menu.MenuItemPage

shutdown() - Static method in class com.helger.photon.basic.PhotonBasic

SimpleAuditManager - Class in com.helger.photon.basic.audit

The class handles audit actions in a very simple way.

SimpleAuditManager(String, ICurrentUserIDProvider) - Constructor for class com.helger.photon.basic.audit.SimpleAuditManager

Constructor

startUp() - Static method in class com.helger.photon.basic.PhotonBasic

state(String) - Static method in class com.helger.photon.basic.app.appid.PhotonGlobalState

state(String) - Method in class com.helger.photon.basic.app.appid.PhotonSessionState

Get or create a new state for the provided app ID.

stateLastAppID() - Method in class com.helger.photon.basic.app.appid.PhotonSessionState

stop() - Method in class com.helger.photon.basic.audit.AsynchronousAuditor

When using this auditor, it is important to call this AsynchronousAuditor.stop() method before shutdown.

stop() - Method in class com.helger.photon.basic.audit.AuditManager

stop() - Method in interface com.helger.photon.basic.audit.IAuditManager

Stop taking new audits.

SYSTEM_MESSAGE_XML - Static variable in class com.helger.photon.basic.mgr.PhotonBasicManager

SYSTEM_MIGRATIONS_XML - Static variable in class com.helger.photon.basic.mgr.PhotonBasicManager

SystemMessageData - Class in com.helger.photon.basic.app.systemmsg

System message data used in SystemMessageManager.

SystemMessageData() - Constructor for class com.helger.photon.basic.app.systemmsg.SystemMessageData

SystemMessageData(ESystemMessageType, String) - Constructor for class com.helger.photon.basic.app.systemmsg.SystemMessageData

SystemMessageManager - Class in com.helger.photon.basic.app.systemmsg

This class manages global system messages.

SystemMessageManager(String) - Constructor for class com.helger.photon.basic.app.systemmsg.SystemMessageManager

SystemMigrationManager - Class in com.helger.photon.basic.migration

SystemMigrationManager(String) - Constructor for class com.helger.photon.basic.migration.SystemMigrationManager

SystemMigrationResult - Class in com.helger.photon.basic.migration

Represents the result of a single system migration.

SystemMigrationResult(String, LocalDateTime, boolean, String) - Constructor for class com.helger.photon.basic.migration.SystemMigrationResult

SystemMigrationResultMicroTypeConverter - Class in com.helger.photon.basic.migration

SystemMigrationResultMicroTypeConverter() - Constructor for class com.helger.photon.basic.migration.SystemMigrationResultMicroTypeConverter

T

toString() - Method in class com.helger.photon.basic.app.appid.PhotonGlobalStatePerApp

toString() - Method in class com.helger.photon.basic.app.appid.PhotonRequestState

toString() - Method in class com.helger.photon.basic.app.appid.PhotonSessionState

toString() - Method in class com.helger.photon.basic.app.appid.PhotonSessionStatePerApp

toString() - Method in class com.helger.photon.basic.app.locale.GlobalLocaleManager

toString() - Method in class com.helger.photon.basic.app.locale.LocaleManager

toString() - Method in class com.helger.photon.basic.app.menu.AbstractMenuObject

toString() - Method in class com.helger.photon.basic.app.menu.filter.AbstractMenuObjectFilter

toString() - Method in class com.helger.photon.basic.app.menu.MenuItemExternal

toString() - Method in class com.helger.photon.basic.app.menu.MenuItemPage

toString() - Method in class com.helger.photon.basic.app.menu.MenuTree

toString() - Method in class com.helger.photon.basic.app.page.AbstractPage

toString() - Method in class com.helger.photon.basic.app.request.AbstractRequestParameterHandlerNamed

toString() - Method in class com.helger.photon.basic.app.request.PhotonRequestParameters

toString() - Method in class com.helger.photon.basic.app.request.RequestParameterHandlerURLPathNamed

toString() - Method in class com.helger.photon.basic.app.request.RequestParameterHandlerURLPathOrdered

toString() - Method in class com.helger.photon.basic.app.request.RequestParameterManager

toString() - Method in class com.helger.photon.basic.app.systemmsg.SystemMessageData

toString() - Method in class com.helger.photon.basic.app.systemmsg.SystemMessageManager

toString() - Method in class com.helger.photon.basic.audit.AuditItem

toString() - Method in class com.helger.photon.basic.audit.AuditItemList

toString() - Method in class com.helger.photon.basic.audit.AuditManager

toString() - Method in class com.helger.photon.basic.audit.SimpleAuditManager

toString() - Method in class com.helger.photon.basic.buildinfo.BuildInfo

toString() - Method in class com.helger.photon.basic.configfile.ConfigurationFile

toString() - Method in class com.helger.photon.basic.configfile.ConfigurationFileManager

toString() - Method in class com.helger.photon.basic.favorites.Favorite

toString() - Method in class com.helger.photon.basic.favorites.FavoriteManager

toString() - Method in class com.helger.photon.basic.longrun.LongRunningJobData

toString() - Method in class com.helger.photon.basic.longrun.LongRunningJobResult

toString() - Method in class com.helger.photon.basic.migration.SystemMigrationManager

toString() - Method in class com.helger.photon.basic.migration.SystemMigrationResult

toString() - Method in class com.helger.photon.basic.xservlet.AuditingLongRunningRequestCallback

toString() - Method in class com.helger.photon.basic.xservlet.AuditingParallelRunningRequestCallback

U

updateFavorite(String, String, String) - Method in class com.helger.photon.basic.favorites.FavoriteManager

Update an existing favorite object.

V

VALUE_FAILURE - Static variable in class com.helger.photon.basic.audit.LoggingAuditor

VALUE_SUCCESS - Static variable in class com.helger.photon.basic.audit.LoggingAuditor

valueOf(String) - Static method in enum com.helger.photon.basic.app.menu.EMenuObjectType

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum com.helger.photon.basic.app.systemmsg.ESystemMessageType

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum com.helger.photon.basic.audit.EAuditActionType

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum com.helger.photon.basic.configfile.EConfigurationFileSyntax

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum com.helger.photon.basic.EPhotonBasicText

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum com.helger.photon.basic.longrun.ELongRunningJobResultType

Returns the enum constant of this type with the specified name.

values() - Static method in enum com.helger.photon.basic.app.menu.EMenuObjectType

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum com.helger.photon.basic.app.systemmsg.ESystemMessageType

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum com.helger.photon.basic.audit.EAuditActionType

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum com.helger.photon.basic.configfile.EConfigurationFileSyntax

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum com.helger.photon.basic.EPhotonBasicText

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum com.helger.photon.basic.longrun.ELongRunningJobResultType

Returns an array containing the constants of this enum type, in the order they are declared.

W

waitUntilAllJobsAreFinished() - Method in class com.helger.photon.basic.longrun.LongRunningJobManager

wasMigrationExecutedSuccessfully(String) - Method in class com.helger.photon.basic.migration.SystemMigrationManager

WebFileIO - Class in com.helger.photon.basic.app.io

Abstract for accessing files inside the web application.

WebIOIntIDFactory - Class in com.helger.photon.basic.app.io

A special FileIntIDFactory that uses WebFileIO to get the filename.

WebIOIntIDFactory(String) - Constructor for class com.helger.photon.basic.app.io.WebIOIntIDFactory

WebIOLongIDFactory - Class in com.helger.photon.basic.app.io

A special FileLongIDFactory that uses WebFileIO to get the filename.

WebIOLongIDFactory(String) - Constructor for class com.helger.photon.basic.app.io.WebIOLongIDFactory

X

XServletFilterAppIDExplicit - Class in com.helger.photon.basic.app.appid

XServlet filter responsible for remembering the application ID in the current request

XServletFilterAppIDExplicit(String) - Constructor for class com.helger.photon.basic.app.appid.XServletFilterAppIDExplicit

XServletFilterAppIDFromSessionID - Class in com.helger.photon.basic.app.appid

XServlet filter responsible for remembering the application ID in the current request based on the existing session data

XServletFilterAppIDFromSessionID() - Constructor for class com.helger.photon.basic.app.appid.XServletFilterAppIDFromSessionID

A B C D E F G H I J L M O P R S T U V W X