lumis.portal.util

Class 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: 19766 $ $Date: 2017-01-05 20:35:09 +0000 (Thu, 05 Jan 2017) $

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.

Constructor Summary

Constructors

Constructor and Description
PortalUtilInternal()

Method Summary

Modifier and Type	Method and Description
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 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

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