com.ihr.xbrl.om.start

Class OnAPIStart

java.lang.Object

com.ihr.xbrl.om.start.OnAPIStart

public class OnAPIStart
extends java.lang.Object

This class is used to register actions that must be performed the next time the API starts. Actions registered here are actions that cannot be executed on an already initialized DTSContainer. One example is the action to rename a file that is already opened such as a taxonomy catalog file.

when the DTSContainer is created, the database associated is opened and actions are executed before

Author:

Ignacio

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	OnAPIStart.ActionCode All actions that can be stored into the database OnAPIStart.ActionCode.RENAME .

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	IGNOREALLREQUESTS If this property is set to "true" this catalog will be disabled and no requests about the StaticCatalog file will be ever sent.

Method Summary

Modifier and Type	Method and Description
void	addAction(OnAPIStart.ActionCode action, java.lang.Object... params) This is the entry point to add an action to be executed at API initialization.
static OnAPIStart	getInstance() Gets the single instance of OnAPIStart.
void	runPendingActions() When the DTSContainer is created this method is called.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

IGNOREALLREQUESTS

public static java.lang.String IGNOREALLREQUESTS

If this property is set to "true" this catalog will be disabled and no requests about the StaticCatalog file will be ever sent. The default value for this property is "false"

Method Detail

getInstance

public static OnAPIStart getInstance()

Gets the single instance of OnAPIStart.

Returns:

single instance of OnAPIStart

addAction

public void addAction(OnAPIStart.ActionCode action,
                      java.lang.Object... params)

This is the entry point to add an action to be executed at API initialization.

This method checks if the service is enabled and only if the service is enabled the action is written to the database

Parameters:

action - the action code form the OnAPIStart.ActionCode enumeration

params - action parameters

runPendingActions

public void runPendingActions()

When the DTSContainer is created this method is called. This method locks the execution of this method to any other JVM and attempts to execute pending actions stored in the database. When an action is executed it is dropped from the database. When all actions are executed the lock is released.