PortalUtilInternal

java.lang.Object
- lumis.portal.util.PortalUtilInternal

```
public class PortalUtilInternal
extends Object
```
General utility class for portal internal use.

Since:

6.0.0

Version:

$Revision: 23034 $ $Date: 2019-08-05 19:52:47 +0000 (Mon, 05 Aug 2019) $

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static interface`	`PortalUtilInternal.ISessionConfigAware<T>` Piece of code that runs with a session config.
`static interface`	`PortalUtilInternal.ITransactionAware<T>` Piece of code that runs with a transaction.

Field Summary

Fields
Modifier and Type Field and Description

static String BYPASS_PROPERTYBAG_LOAD
Transaction attribute name of an object to avoid property bag loading.

Fields
Modifier and Type	Field and Description
`static String`	`BYPASS_PROPERTYBAG_LOAD` Transaction attribute name of an object to avoid property bag loading.

Constructor Summary

Constructors
Constructor and Description

PortalUtilInternal()

Constructors
Constructor and Description
`PortalUtilInternal()`

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static boolean`	`allNotNull(Object... objects)` Returns `false` if some of the given objects is `null` or `true` otherwise.
`static boolean`	`allNull(Object... objects)` Returns `false` if any of the given objects is not `null` or `true` otherwise.
`static boolean`	`anyNull(Object... objects)` Returns `true` if some of the given objects is `null` or `false` otherwise.
`static void`	`checkAndClearThreadData()` Verifies if any LumisXP related data is leaked in the current thread and clears it and logs warns about it if it happened.
`static void`	`clearThreadLocals()` Clears the thread locals of current thread.
`static <T> T`	`execWithSessionConfig(PortalUtilInternal.ISessionConfigAware<T> code)` Executes the given code with the current session config.
`static <T> T`	`execWithSessionConfigWithSilentThrow(PortalUtilInternal.ISessionConfigAware<T> code)` Executes the given code with the current session config.
`static <T> T`	`execWithSilentThrow(Callable<T> c)` Executes the given code with no exception.
`static <T> T`	`execWithTransaction(boolean createIfNeeded, PortalUtilInternal.ITransactionAware<T> code)` Executes the given code with the given transaction.
`static <T> T`	`execWithTransaction(PortalUtilInternal.ITransactionAware<T> code)` Executes the given code using the current transaction.
`static <T> T`	`execWithTransactionWithSilentThrow(boolean createTransactionIfRequired, PortalUtilInternal.ITransactionAware<T> code)` Executes the given code with the given transaction.
`static <T> T`	`execWithTransactionWithSilentThrow(PortalUtilInternal.ITransactionAware<T> code)` Executes the given code using the current transaction.
`static Document`	`getDefinitionDocument(String relativePath)` Returns the XML Document for a definition file.
`static org.jsoup.nodes.Element`	`getPageHolderHtmlByServiceInterfaceInstance(String lumServiceInterfaceInstance)` Returns the service interface instance pageholder HTML fragment, if there is any.
`static String`	`getStackTrace()` Returns a String representation of current stack trace, one entry per line.
`static String`	`getStackTrace(int tabCount)` Returns a String representation of current stack trace, one entry per line.
`static String`	`getStackTrace(String eachLinePrefix)` Returns a String representation of current stack trace, one entry per line.
`static boolean`	`isInstall()` Returns whether this is an install process.
`static boolean`	`isInstallOrUpgrade()` Returns whether this is an install or upgrade process.
`static boolean`	`isTestMode()` Returns whether the portal is running in test mode.
`static boolean`	`isUpgrade()` Returns whether this is an upgrade process.
`static <T> T`	`orNull(Callable<T> code)` Returns the given code result.
`static void`	`throwUncheckedly(Throwable t)` Throws uncheckedly checked exceptions

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

- Field Detail
  - BYPASS_PROPERTYBAG_LOAD
```
public static final String BYPASS_PROPERTYBAG_LOAD
```
    Transaction attribute name of an object to avoid property bag loading.
    
    Since:
    
    11.0.0
- Constructor Detail
  - PortalUtilInternal
```
public PortalUtilInternal()
```
- Method Detail
  - getDefinitionDocument
```
public static Document getDefinitionDocument(String relativePath)
                                      throws PortalException
```
    Returns the XML Document for a definition file.
    
    Parameters:
    
    relativePath - the relative path of the file. Must not start with '/'.
    
    Throws:
    
    PortalException - if the document could not be read.
    
    Since:
    
    6.0.0
  - getPageHolderHtmlByServiceInterfaceInstance
```
public static org.jsoup.nodes.Element getPageHolderHtmlByServiceInterfaceInstance(String lumServiceInterfaceInstance)
                                                                           throws PortalException
```
    Returns the service interface instance pageholder HTML fragment, if there is any.
    
    Parameters:
    
    lumServiceInterfaceInstance - a lumis servince interface instance
    
    Returns:
    
    the service interface instance pageholder HTML fragment.
    
    Throws:
    
    PortalException
    
    Since:
    
    9.0.0
  - throwUncheckedly
```
public static void throwUncheckedly(Throwable t)
```
    Throws uncheckedly checked exceptions
    
    Parameters:
    
    t - the checked exception.
    
    Since:
    
    9.0.0
  - execWithSilentThrow
```
public static <T> T execWithSilentThrow(Callable<T> c)
```
    Executes the given code with no exception. If an exception occur, it will be throw uncheckedly.
    
    Parameters:
    
    c - the code.
    
    Returns:
    
    the code result.
    
    Since:
    
    9.0.0
  - execWithTransaction
```
public static <T> T execWithTransaction(PortalUtilInternal.ITransactionAware<T> code)
                                 throws Exception
```
    Executes the given code using the current transaction.
    
    Parameters:
    
    code - the code.
    
    Returns:
    
    the code result.
    
    Throws:
    
    Exception
    
    Since:
    
    9.0.0
  - execWithTransaction
```
public static <T> T execWithTransaction(boolean createIfNeeded,
                                        PortalUtilInternal.ITransactionAware<T> code)
                                 throws Exception
```
    Executes the given code with the given transaction. If createIfNeeded parameter is true and no transaction is available, a new transaction will be created.
    
    Parameters:
    
    createIfNeeded - indicates whether a transaction should be created if no current transaction is available.
    
    code - the code.
    
    Returns:
    
    the code result.
    
    Throws:
    
    Exception
    
    Since:
    
    9.0.0
  - execWithTransactionWithSilentThrow
```
public static <T> T execWithTransactionWithSilentThrow(boolean createTransactionIfRequired,
                                                       PortalUtilInternal.ITransactionAware<T> code)
```
    Executes the given code with the given transaction. If createIfNeeded parameter is true and no transaction is available, a new transaction will be created. Unlike execWithTransaction(boolean, ITransactionAware), this method does not declare any throw.
    
    Parameters:
    
    createIfNeeded - indicates whether a transaction should be created if no current transaction is available.
    
    code - the code.
    
    Returns:
    
    the code result.
    
    Since:
    
    10.0.0
  - execWithTransactionWithSilentThrow
```
public static <T> T execWithTransactionWithSilentThrow(PortalUtilInternal.ITransactionAware<T> code)
```
    Executes the given code using the current transaction. Unlike execWithTransaction(ITransactionAware), this method does not declare any throw.
    
    Parameters:
    
    code - the code.
    
    Returns:
    
    the code result.
    
    Since:
    
    10.0.0
  - execWithSessionConfigWithSilentThrow
```
public static <T> T execWithSessionConfigWithSilentThrow(PortalUtilInternal.ISessionConfigAware<T> code)
```
    Executes the given code with the current session config. Unlike execWithSessionConfig(ISessionConfigAware), this method does not declare any throw.
    
    Parameters:
    
    code - the code.
    
    Returns:
    
    the code result.
    
    Since:
    
    10.0.0
  - execWithSessionConfig
```
public static <T> T execWithSessionConfig(PortalUtilInternal.ISessionConfigAware<T> code)
                                   throws Exception
```
    Executes the given code with the current session config.
    
    Parameters:
    
    code - the code.
    
    Returns:
    
    the code result.
    
    Throws:
    
    Exception
    
    Since:
    
    9.0.0
  - orNull
```
public static <T> T orNull(Callable<T> code)
```
    Returns the given code result. In case of a NullPointerException occurs when executing the given code, null will be returned. In case of other exception, it will not be catched.
    
    Parameters:
    
    code - the code.
    
    Returns:
    
    the code result or null if a NullPointerException occurs when executing the given code.
    
    Since:
    
    10.2.0
  - isInstall
```
public static boolean isInstall()
```
    Returns whether this is an install process. Only searches the current thread stack trace to determine it.
    
    Returns:
    
    whether this is an install process.
    
    Since:
    
    10.3.0
  - isUpgrade
```
public static boolean isUpgrade()
```
    Returns whether this is an upgrade process. Only searches the current thread stack trace to determine it.
    
    Returns:
    
    whether this is an upgrade process.
    
    Since:
    
    10.3.0
  - isInstallOrUpgrade
```
public static boolean isInstallOrUpgrade()
```
    Returns whether this is an install or upgrade process. Only searches the current thread stack trace to determine it.
    
    Returns:
    
    whether this is an install or upgrade process.
    
    Since:
    
    10.3.0
  - getStackTrace
```
public static String getStackTrace()
```
    Returns a String representation of current stack trace, one entry per line.
    
    Returns:
    
    a String representation of current stack trace, one entry per line.
    
    Since:
    
    10.3.0
  - getStackTrace
```
public static String getStackTrace(int tabCount)
```
    Returns a String representation of current stack trace, one entry per line. Prepends a String of tabCount tab characters.
    
    Parameters:
    
    tabCount - the tab characters count.
    
    Returns:
    
    a String representation of current stack trace, one entry per line.
    
    Since:
    
    10.3.0
  - getStackTrace
```
public static String getStackTrace(String eachLinePrefix)
```
    Returns a String representation of current stack trace, one entry per line. Prepends the given prefix in each line.
    
    Parameters:
    
    eachLinePrefix - the prefix.
    
    Returns:
    
    a String representation of current stack trace, one entry per line.
    
    Since:
    
    10.3.0
  - checkAndClearThreadData
```
public static void checkAndClearThreadData()
```
    Verifies if any LumisXP related data is leaked in the current thread and clears it and logs warns about it if it happened.
    
    Since:
    
    11.0.0
  - clearThreadLocals
```
public static void clearThreadLocals()
```
    Clears the thread locals of current thread.
    
    Since:
    
    11.0.0
  - allNull
```
public static boolean allNull(Object... objects)
```
    Returns false if any of the given objects is not null or true otherwise.
    
    Parameters:
    
    objects - the objects
    
    Returns:
    
    false if any of the given objects is not null or true otherwise.
    
    Since:
    
    12.0.0
  - anyNull
```
public static boolean anyNull(Object... objects)
```
    Returns true if some of the given objects is null or false otherwise.
    
    Parameters:
    
    objects - the objects
    
    Returns:
    
    true if some of the given objects is null or false otherwise.
    
    Since:
    
    12.0.0
  - allNotNull
```
public static boolean allNotNull(Object... objects)
```
    Returns false if some of the given objects is null or true otherwise.
    
    Parameters:
    
    objects - the objects
    
    Returns:
    
    false if some of the given objects is null or true otherwise.
    
    Since:
    
    12.0.0
  - isTestMode
```
public static boolean isTestMode()
```
    Returns whether the portal is running in test mode.
    
    Returns:
    
    whether the portal is running in test mode.
    
    Since:
    
    12.0.0

Class PortalUtilInternal

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

BYPASS_PROPERTYBAG_LOAD

Constructor Detail

PortalUtilInternal

Method Detail

getDefinitionDocument

getPageHolderHtmlByServiceInterfaceInstance

throwUncheckedly

execWithSilentThrow

execWithTransaction

execWithTransaction

execWithTransactionWithSilentThrow

execWithTransactionWithSilentThrow

execWithSessionConfigWithSilentThrow

execWithSessionConfig

orNull

isInstall

isUpgrade

isInstallOrUpgrade

getStackTrace

getStackTrace

getStackTrace

checkAndClearThreadData

clearThreadLocals

allNull

anyNull

allNotNull

isTestMode