ISVContentManager (OpenText Process Suite Platform 10.8 Java SDK API)

java.lang.Object
- com.eibus.contentmanagement.ISVContentManager

Direct Known Subclasses:: ISVSOAPServiceManager

public abstract class ISVContentManager
extends java.lang.Object

ISVContentManager provides the prototype for handling the requests to manage the ISV Package content. Any class handling the ISV Content should be extending from this class. Default implementation is provided for rollback method which removes the ISV Package entries from the LDAP. Default implementation is also provided for unload method, which inturn invokes the rollback and also unloads XMLObjects, if any, in the ISV Content.

Any class extending the ISVContentManager should override the default implementation provided, to handle the custom content. The load method is called while loading the ISV Package. Similarly the unLoad method is invoked while unloading the same. The extending class is also required to handle the rollback method. Rollback is invoked once there's an exception during loading/unloading of the ISV Package. The expected behaviour is to undo the operation in process.

  // class that extends ISVContentManager to implement the custom
  // content which sets some system properties. This class implements only
  // load method other method have their default implementation
  //
  // content node looks like this
  // <SystemContent loader="com.eibus.contentmanagement.ISVSystemPropertyManager" desription="System Property Manager">
  //       <property>
  //           <key>key</key>
  //           <value>value</value>
  //       </property>
  // </SystemContent>

  public class MyContentManager extends ISVContentManager
  {
     // When this manager class is encountered it sets the system property taking values
     // from the specific content item node.
     public void load(ISVPackage isvPackage,int contentItemNode,int logContentItemNode) throws Exception
     {
         // implement the logic that is to be performed  while loading the Package
          int propertyNodes[] = Find.match(contentItemNode,"?<property>")
          for(int i=0;i<propertyNodes.length;i++)
          {
              String key = Node.getDataElement(Find.first(propertyNodes[i],"key"));
              String value = Node.getDataElement(Find.first(propertyNodes[i],"value"));
              System.setProperty(key,value);
              // write to the logfile
              Document document = Node.getDocument(logContentItemNode);
              int propNode = document.createElement("property",logContentItemNode);
              Node.setDataElement(propNode,"key",key);
              Node.setDataElement(propNode,"value",value);
          }
     }
  }

Field Summary

Fields
Modifier and Type	Field and Description
`protected static Connector`	`connector` Holds the connector of SOAP Processor
`protected java.lang.String`	`currentUserDN` Holds the DN of the current user
`protected java.lang.String`	`FILE_SEPARATOR` Holds the file seperator
`protected static boolean`	`isDeleteReferences` Tells whether references of the methodsets and roles have to be deleted or not
`boolean`	`isRolledBack` Holds the state of the content, if it's rolled back or not.
`protected boolean`	`isvPackExists`
`static CordysLogger`	`isvpLogger`
`protected int`	`oldISVPRegistryEntry`
`protected int`	`oldUninstallLogItem`
`protected static java.lang.String`	`origin` Holds the cn of the ISV Package
`protected static java.util.Hashtable<java.lang.Object,java.lang.Object>`	`reusableProperties` This hashtable can be used by other content managers(classes which are extending 'ISVContentManager') to exchange any data between different ISV Packages when they are being loaded by BCP Installer.
`protected static java.lang.String`	`root` Holds the ldap root
`protected SynchronousRequestResponseHandler`	`synchHandler`
`protected MultiVersionContentUpgrader`	`upgradeManager` Start of Code related to Upgrade of ISV Content manager

Constructor Summary

Constructors
Constructor and Description

ISVContentManager()

Constructors
Constructor and Description
`ISVContentManager()`

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`deleteRecursive(java.lang.String entryDN)` Recursively deletes the DN tree of entryDN from LDAP
`javax.swing.JPanel`	`getInstallerPanel(ISVPackage isvPackage, int contentItemNode, int promptsetReference)` Deprecated. From C3 onwards, ISV packages are not loaded by Cordys installer. Implementing this method is not required.
`protected int`	`getNumRegisteredInstances()` Deprecated.
`int`	`getOldISVPRegistryEntry()` Gets the loadingdetails node of the ISV package, only during an upgrade
`int`	`getOldUninstallLogItem()` This method would be used by all content managers to do actions with old content i.e., unloading or updating.
`java.lang.String`	`getPanelDescription(int contentItemNode, int promptsetReference)` The description returned by this method will be shown on the panel returned by 'getInstallerPanel()' method.
`java.lang.String`	`getPrompSetForKeyAsString(java.lang.String promptName, java.lang.String isvpName)` This method returns the promptset node in string format when specified the key of the promptset
`int`	`getPromptSetFromRequest(ISVPackage isvpackage)` Returns the promptset with values, for the current ISVP from the load request.
`java.util.Hashtable`	`getPromptsFromManager()` Deprecated. Individual content managers' defining prompts is not recommended. If the content manager class could not be loaded for any reason, these prompts will not be included in the ISV package definition. Instead, all prompts of an ISV package should be defined in the isv.xml file.
`int`	`getPromptsFromRequest(int contentItemNode, ISVPackage isvpackage)` Deprecated. Please Use the getPromptSetFromRequest API and search for the required prompts in the returned Node.
`int`	`getReusablePromptSetForKey(java.lang.String promptName, java.lang.String isvpName)` This method returns the promptset node when specified the key of the promptset
`static java.util.Hashtable`	`getReusableProperties()` Returns reusableProperties
`MultiVersionContentUpgrader`	`getUpgradeManager()` Provides the default Multi-version content Manager that provides the facility to upgrade.
`boolean`	`isIsvPackExists()` This method is used to check whether an ISVP is already loaded or not while upgrading the ISVP.
`protected boolean`	`isLastMemeber()` Deprecated. : Use the API isLastMember from ISVPackage.
`boolean`	`isPromptSetExistForKey(java.lang.String promptName, java.lang.String isvpName)` This method is used to check wether the promptset exist for the key passed as parameter
`abstract void`	`load(ISVPackage isvPackage, int contentItemNode, int logcontentItem)` Loads the isvp content from the contentItemNode
`java.util.Map<java.lang.String,ManifestEntry>`	`publishKeyInfo()` The method returns a hashmap with the URIs as the hashmap keys and their types as values.
`protected void`	`registerUpgradeHandler(Version version, int sequenceOfTheHandler, ContentUpgrader handler)` Provides the registration of the upgrade handlers.
`void`	`removeResuablePromptSet(java.lang.String promptName, java.lang.String isvpName)`
`void`	`rollback(java.lang.String isvpDN)` Rollback the current content loaded to retain the original state
`void`	`setConnector(Connector pconnector)` sets the connector for the content manager classes to use
`void`	`setCurrentUserDN(java.lang.String userDN)` sets the current user dn who initiated load/unload request
`static void`	`setIsDeleteReferences(boolean value)` sets isDeleteReferences to given value
`void`	`setIsvPackExists(boolean isvPackExists)` This method would be called by ISVP Framework while upgrading ISVP to check whether ISVP is already loaded or not.
`void`	`setISVPLogger(CordysLogger isvLogger)` This method sets CordysLogger (Logger for ISVP) for ISVP Loading / Unloading / Upgrading.
`void`	`setOldISVPRegistryEntry(int oldISVPRegistryEntry)` This method is invoked by the ISVP framework during the upgrade of an ISVPackage.
`void`	`setOldUninstallLogItem(int logItem)` This method would be called by ISVP Framework while upgrading ISVP to set the old uninstall log file before upgrading ISVP to unload the old content which is not used to new content
`void`	`setOrigin(java.lang.String originString)` sets origin of content manager to the string passed
`void`	`setReusablePromptSet(java.lang.String promptName, java.lang.String isvpName, int promptSet)` This method sets the promptset node as a reusable promptset node for other ISVPs to use.
`static void`	`setReusableProperties(java.util.Hashtable hashtable)` sets the the given hashtable as reusableProperties
`protected void`	`setReusableProperty(java.lang.String key, IStringResource message, java.lang.Object... insertions)`
`protected void`	`setReusableProperty(java.lang.String key, Message message, java.lang.Object... insertions)` Deprecated. Use `#setReusableProperty(String key, IStringResource message, Object...insertions)`
`void`	`setSynchHandler(SynchronousRequestResponseHandler handler)` This method sets SynchronousRequestResponseHandler for the content managers
`void`	`unload(ISVPackage isvPackage, int contentItemNode, int logcontentItem)` Unloads the content from the contentItemNode
`void`	`unload(ISVPackage isvPackage, int contentItemNode, int logcontentItem, boolean option)`
`boolean`	`updatePrompts(int promptsetReference, java.awt.Frame parent)` This method would be called by BCP Installer when the screen(returned by getInstallerPanel() method) is shown.
`void`	`updateUserDetails(int soapEnvelope)` Updates the user information in the header of the input SOAP Envelope
`void`	`upgrade(ISVPackage isvPackage, int contentItemNode, int logcontentItem)` Upgrades the isvp content from the contentItemNode Custom contents should override this method to implement / override default implementation of upgrade method.

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

- Field Detail
  - connector
```
protected static Connector connector
```
    Holds the connector of SOAP Processor
  - FILE_SEPARATOR
```
protected final java.lang.String FILE_SEPARATOR
```
    Holds the file seperator
  - currentUserDN
```
protected java.lang.String currentUserDN
```
    Holds the DN of the current user
  - isRolledBack
```
public boolean isRolledBack
```
    Holds the state of the content, if it's rolled back or not.
  - origin
```
protected static java.lang.String origin
```
    Holds the cn of the ISV Package
  - root
```
protected static final java.lang.String root
```
    Holds the ldap root
  - reusableProperties
```
protected static java.util.Hashtable<java.lang.Object,java.lang.Object> reusableProperties
```
    This hashtable can be used by other content managers(classes which are extending 'ISVContentManager') to exchange any data between different ISV Packages when they are being loaded by BCP Installer. For example, consider the case where two ISV Packages will be loaded by BCP Installer, one after the other and first ISV Package wants to pass some data to other ISV Packages which will be loaded consecutively. In such a case, content managers of first ISV Package can put some data in the 'resusableProperties' and content managers of other ISV Package can access this data from the same. When the keys are "load_status" and "webServerMsg", use method setReusableProperty(String, IStringResource, String ..insertions)
  - isDeleteReferences
```
protected static boolean isDeleteReferences
```
    Tells whether references of the methodsets and roles have to be deleted or not
  - isvPackExists
```
protected boolean isvPackExists
```
  - oldUninstallLogItem
```
protected int oldUninstallLogItem
```
  - oldISVPRegistryEntry
```
protected int oldISVPRegistryEntry
```
  - isvpLogger
```
public static CordysLogger isvpLogger
```
  - synchHandler
```
protected SynchronousRequestResponseHandler synchHandler
```
  - upgradeManager
```
protected MultiVersionContentUpgrader upgradeManager
```
    Start of Code related to Upgrade of ISV Content manager
- Constructor Detail
  - ISVContentManager
```
public ISVContentManager()
```
- Method Detail
  - load
```
public abstract void load(ISVPackage isvPackage,
                          int contentItemNode,
                          int logcontentItem)
                   throws java.lang.Exception
```
    Loads the isvp content from the contentItemNode
    
    Throws:
    
    java.lang.Exception
  - publishKeyInfo
```
public java.util.Map<java.lang.String,ManifestEntry> publishKeyInfo()
                                                             throws java.lang.Exception
```
    The method returns a hashmap with the URIs as the hashmap keys and their types as values.
    
    Throws:
    
    java.lang.Exception
  - setReusableProperty
```
@Deprecated
protected void setReusableProperty(java.lang.String key,
                                                Message message,
                                                java.lang.Object... insertions)
```
    Deprecated. Use #setReusableProperty(String key, IStringResource message, Object...insertions)
    
    Sets the reusable property based on current Locale
  - setReusableProperty
```
protected void setReusableProperty(java.lang.String key,
                                   IStringResource message,
                                   java.lang.Object... insertions)
```
  - unload
```
public void unload(ISVPackage isvPackage,
                   int contentItemNode,
                   int logcontentItem,
                   boolean option)
            throws java.lang.Exception
```
    Throws:
    
    java.lang.Exception
  - setISVPLogger
```
public void setISVPLogger(CordysLogger isvLogger)
```
    This method sets CordysLogger (Logger for ISVP) for ISVP Loading / Unloading / Upgrading.
    
    Parameters:
    
    isvLogger -
  - unload
```
public void unload(ISVPackage isvPackage,
                   int contentItemNode,
                   int logcontentItem)
            throws java.lang.Exception
```
    Unloads the content from the contentItemNode
    
    Throws:
    
    java.lang.Exception
  - upgrade
```
public void upgrade(ISVPackage isvPackage,
                    int contentItemNode,
                    int logcontentItem)
             throws java.lang.Exception
```
    Upgrades the isvp content from the contentItemNode Custom contents should override this method to implement / override default implementation of upgrade method.
    
    Parameters:
    
    isvPackage -
    
    contentItemNode -
    
    logcontentItem -
    
    Throws:
    
    java.lang.Exception
  - rollback
```
public void rollback(java.lang.String isvpDN)
```
    Rollback the current content loaded to retain the original state
  - deleteRecursive
```
public void deleteRecursive(java.lang.String entryDN)
```
    Recursively deletes the DN tree of entryDN from LDAP
  - setCurrentUserDN
```
public void setCurrentUserDN(java.lang.String userDN)
```
    sets the current user dn who initiated load/unload request
  - getReusableProperties
```
public static java.util.Hashtable getReusableProperties()
```
    Returns reusableProperties
  - setReusableProperties
```
public static void setReusableProperties(java.util.Hashtable hashtable)
```
    sets the the given hashtable as reusableProperties
  - setIsDeleteReferences
```
public static void setIsDeleteReferences(boolean value)
```
    sets isDeleteReferences to given value
  - setConnector
```
public void setConnector(Connector pconnector)
```
    sets the connector for the content manager classes to use
  - updateUserDetails
```
public void updateUserDetails(int soapEnvelope)
```
    Updates the user information in the header of the input SOAP Envelope
  - getPromptsFromManager
```
@Deprecated
public java.util.Hashtable getPromptsFromManager()
```
    Deprecated. Individual content managers' defining prompts is not recommended. If the content manager class could not be loaded for any reason, these prompts will not be included in the ISV package definition. Instead, all prompts of an ISV package should be defined in the isv.xml file.
    
    Returns the local prompts defined by the content manager as Hashtable
  - getPromptsFromRequest
```
public int getPromptsFromRequest(int contentItemNode,
                                 ISVPackage isvpackage)
```
    Deprecated. Please Use the getPromptSetFromRequest API and search for the required prompts in the returned Node.
    
    Returns the prompts with values, for the current component from the load request. If static prompts are not defined, it returns first child of promptset node. Note: The caller is responsible for deleting the parent of the returned Node.
  - getPromptSetFromRequest
```
public int getPromptSetFromRequest(ISVPackage isvpackage)
```
    Returns the promptset with values, for the current ISVP from the load request. Note: The caller is responsible for deleting the returned Node.
  - setOrigin
```
public void setOrigin(java.lang.String originString)
```
    sets origin of content manager to the string passed
  - getInstallerPanel
```
@Deprecated
public javax.swing.JPanel getInstallerPanel(ISVPackage isvPackage,
                                                         int contentItemNode,
                                                         int promptsetReference)
```
    Deprecated. From C3 onwards, ISV packages are not loaded by Cordys installer. Implementing this method is not required.
    
    If custom content needs to have any custom screens when ISV Package is being loaded by BCP Installer, it should overwrite this method and return 'JPanel' object. This method would be called by BCP Installer during loading of this ISV Package. The input parameters can be used in designing the panel.
  - updatePrompts
```
public boolean updatePrompts(int promptsetReference,
                             java.awt.Frame parent)
```
    This method would be called by BCP Installer when the screen(returned by getInstallerPanel() method) is shown. This method should first validate the inputs given (if required) and then update 'promptsetReference' node with the new prompts based on the content of the panel and as required for the custom loader. Care should be taken to see that the data is appended to 'promptsetReference' only once in the case where user goes back and enters this screen again. If this method returns 'true', user is allowed to go to next screen, otheriwse not. The input parameter 'Frame' can be used to validate user inputs and showing message to the user based on that.
  - getPanelDescription
```
public java.lang.String getPanelDescription(int contentItemNode,
                                            int promptsetReference)
```
    The description returned by this method will be shown on the panel returned by 'getInstallerPanel()' method. This description can be varied depending on the input parameters passed.
  - getReusablePromptSetForKey
```
public int getReusablePromptSetForKey(java.lang.String promptName,
                                      java.lang.String isvpName)
```
    This method returns the promptset node when specified the key of the promptset
    
    Parameters:
    
    promptName - - Name of the prompt node prepared.
    
    isvpName - - Name of ISV Package
    
    Returns:
    
    promptset node for the key.
  - getPrompSetForKeyAsString
```
public java.lang.String getPrompSetForKeyAsString(java.lang.String promptName,
                                                  java.lang.String isvpName)
```
    This method returns the promptset node in string format when specified the key of the promptset
    
    Parameters:
    
    promptName - - Name of the prompt node prepared in ISV Package.
    
    isvpName - - Name of the ISV Package.
    
    Returns:
    
    promptset node in String Format for the key.
  - isPromptSetExistForKey
```
public boolean isPromptSetExistForKey(java.lang.String promptName,
                                      java.lang.String isvpName)
```
    This method is used to check wether the promptset exist for the key passed as parameter
    
    Parameters:
    
    promptName - - Name of the prompt node Ex.: databaseConfig
    
    isvpName - - Name of the ISV Package.
    
    Returns:
    
    true - if promptset exist with key false - if doesn't exist
  - setReusablePromptSet
```
public void setReusablePromptSet(java.lang.String promptName,
                                 java.lang.String isvpName,
                                 int promptSet)
```
    This method sets the promptset node as a reusable promptset node for other ISVPs to use.
    
    Parameters:
    
    promptName - - Name of the prompt prepared in ISV Packagte.
    
    isvpName - - Name of the ISV Package.
    
    promptSet - - Node of the promptset
  - removeResuablePromptSet
```
public void removeResuablePromptSet(java.lang.String promptName,
                                    java.lang.String isvpName)
```
  - isIsvPackExists
```
public boolean isIsvPackExists()
```
    This method is used to check whether an ISVP is already loaded or not while upgrading the ISVP.
    
    Returns:
    
    - true
  - setIsvPackExists
```
public void setIsvPackExists(boolean isvPackExists)
```
    This method would be called by ISVP Framework while upgrading ISVP to check whether ISVP is already loaded or not.
    
    Parameters:
    
    isvPackExists -
  - setOldUninstallLogItem
```
public void setOldUninstallLogItem(int logItem)
```
    This method would be called by ISVP Framework while upgrading ISVP to set the old uninstall log file before upgrading ISVP to unload the old content which is not used to new content
    
    Parameters:
    
    logItem -
  - getOldUninstallLogItem
```
public int getOldUninstallLogItem()
```
    This method would be used by all content managers to do actions with old content i.e., unloading or updating. Please do not delete this node as all content managers will use it.
    
    Returns:
    
    - Old uninstallation content item node.
  - getOldISVPRegistryEntry
```
public int getOldISVPRegistryEntry()
```
    Gets the loadingdetails node of the ISV package, only during an upgrade
    
    Returns:
    
    loadingdetails node of the existing ISV package in the ISVP registry
  - setOldISVPRegistryEntry
```
public void setOldISVPRegistryEntry(int oldISVPRegistryEntry)
```
    This method is invoked by the ISVP framework during the upgrade of an ISVPackage.
    
    Parameters:
    
    oldISVPRegistryEntry - loadingdetails node of the existing ISV package in the ISVP registry
  - getUpgradeManager
```
public MultiVersionContentUpgrader getUpgradeManager()
```
    Provides the default Multi-version content Manager that provides the facility to upgrade.
    
    Returns:
    
    MultiVersionContentUpgrader
  - registerUpgradeHandler
```
protected void registerUpgradeHandler(Version version,
                                      int sequenceOfTheHandler,
                                      ContentUpgrader handler)
                               throws UpgradeException
```
    Provides the registration of the upgrade handlers.
    
    Parameters:
    
    version - The version the handler is applicable for.
    
    sequenceOfTheHandler - The sequence of the handler, when there are two or more handlers for a given version then the lower of the sequence number's is chosen first for execution
    
    handler - The handler that contains the actual application logic for upgrading.
    
    Throws:
    
    UpgradeException - When registration fails. E.g. the Content Manager does not implement the UpgradeManager exception.
  - isLastMemeber
```
protected boolean isLastMemeber()
```
    Deprecated. : Use the API isLastMember from ISVPackage.
    
    Returns:
    
    is the corresponding ISVP is the last one or not.
  - getNumRegisteredInstances
```
protected int getNumRegisteredInstances()
```
    Deprecated.
    
    Returns the number of instances for the current application present in the Registry While loading the first application the number of instance is already 1 and while unloading the last application the number of instance is still 1
    
    Returns:
    
    0 -- on error condition Greater than 0 -- otherwise
  - setSynchHandler
```
public void setSynchHandler(SynchronousRequestResponseHandler handler)
```
    This method sets SynchronousRequestResponseHandler for the content managers
    
    Parameters:
    
    handler -

Class ISVContentManager

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

connector

FILE_SEPARATOR

currentUserDN

isRolledBack

origin

root

reusableProperties

isDeleteReferences

isvPackExists

oldUninstallLogItem

oldISVPRegistryEntry

isvpLogger

synchHandler

upgradeManager

Constructor Detail

ISVContentManager

Method Detail

load

publishKeyInfo

setReusableProperty

setReusableProperty

unload

setISVPLogger

unload

upgrade

rollback

deleteRecursive

setCurrentUserDN

getReusableProperties

setReusableProperties

setIsDeleteReferences

setConnector

updateUserDetails

getPromptsFromManager

getPromptsFromRequest

getPromptSetFromRequest

setOrigin

getInstallerPanel

updatePrompts

getPanelDescription

getReusablePromptSetForKey

getPrompSetForKeyAsString

isPromptSetExistForKey

setReusablePromptSet

removeResuablePromptSet

isIsvPackExists

setIsvPackExists

setOldUninstallLogItem

getOldUninstallLogItem

getOldISVPRegistryEntry

setOldISVPRegistryEntry

getUpgradeManager

registerUpgradeHandler

isLastMemeber

getNumRegisteredInstances

setSynchHandler