com.eibus.contentmanagement

Class ISVSOAPServiceManager

java.lang.Object

com.eibus.contentmanagement.ISVContentManager

com.eibus.contentmanagement.ISVSOAPServiceManager

public class ISVSOAPServiceManager
extends ISVContentManager

Author:

bjoseph Sep 23, 2006 This class can be used by an ISV Package to create a SOAP node (now referred to as Service Group), Processor (now Service Container) and Connection Point when loading the ISV Package (now Application). Instead of writing a custom handler to create all these and preparing the bussoapprocessorconfiguration, these details can be provided statically in the isv.xml as a contentItemNode. This content manager will parse the contentItemNode and of the appropriate configuration. But, the bussoapprocessorconfiguration has some runtime parameters. For this, the getBusSOAPPorcessorConfiguration() method has to be overridden by a custom content handler. The static configuration will be passed. The custom handler simply has to find and replace the runtime parameters. For upgrade, the upgrade method has to be overridden and implemented by the custom content manager. Any configuration specific changes during upgrades are to be handled in the overridden upgrade method.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	localHostName

Fields inherited from class com.eibus.contentmanagement.ISVContentManager

connector, currentUserDN, FILE_SEPARATOR, isDeleteReferences, isRolledBack, isvPackExists, isvpLogger, oldISVPRegistryEntry, oldUninstallLogItem, origin, reusableProperties, root, synchHandler, upgradeManager

Constructor Summary

Constructors

Constructor and Description
ISVSOAPServiceManager()

Method Summary

Modifier and Type	Method and Description
protected boolean	createConnectionPoint() This method will create the ConnectionPoint as specified in the contentItemNode.
protected boolean	createSOAPNode() This method will create the SOAP Node as specified in the contentItemNode.
protected boolean	createSOAPProcessor() This method will create the SOAP Processor as specified in the contentItemNode.
protected int	getBusConnectionPointEntry(int entry) Subclasses can override this method to modify the static SOAP Connection Point Entry.
protected int	getBusSOAPNodeConfiguration(int staticConfiguration) Subclasses can override this method to provide a different configuration.
protected int	getBusSOAPNodeEntry(int entry) Subclasses can override this method to modify the static SOAP Node Entry.
protected int	getBusSOAPProcessorConfiguration(int staticConfiguration) Subclasses can override this method to provide a different configuration.
protected int	getBusSOAPProcessorEntry(int entry) Subclasses can override this method to modify the static SOAP Processor Entry.
java.lang.String	getMessage()
void	load(ISVPackage isvPackage, int contentItemNode, int logcontentItem) This method is responsible for loading the soap service content manager.
protected void	setOrganization(java.lang.String organization) This method will set the organization to given organization.
void	unload(ISVPackage isvPackage, int contentItemNode, int logcontentItem) This method takes care of removing the Service Group , Service Container and Connection Point configurations

Methods inherited from class com.eibus.contentmanagement.ISVContentManager

deleteRecursive, getInstallerPanel, getNumRegisteredInstances, getOldISVPRegistryEntry, getOldUninstallLogItem, getPanelDescription, getPrompSetForKeyAsString, getPromptSetFromRequest, getPromptsFromManager, getPromptsFromRequest, getReusablePromptSetForKey, getReusableProperties, getUpgradeManager, isIsvPackExists, isLastMemeber, isPromptSetExistForKey, publishKeyInfo, registerUpgradeHandler, removeResuablePromptSet, rollback, setConnector, setCurrentUserDN, setIsDeleteReferences, setIsvPackExists, setISVPLogger, setOldISVPRegistryEntry, setOldUninstallLogItem, setOrigin, setReusablePromptSet, setReusableProperties, setReusableProperty, setReusableProperty, setSynchHandler, unload, updatePrompts, updateUserDetails, upgrade

Methods inherited from class java.lang.Object

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

Field Detail

localHostName

protected java.lang.String localHostName

Constructor Detail

ISVSOAPServiceManager

public ISVSOAPServiceManager()

Method Detail

createSOAPNode

protected boolean createSOAPNode()
                          throws LDAPException

This method will create the SOAP Node as specified in the contentItemNode. Uses com.eibus.configure.service.SOAPNode internally

Returns:

true if the Node creation succeeds

Throws:

LDAPException

createSOAPProcessor

protected boolean createSOAPProcessor()
                               throws LDAPException

This method will create the SOAP Processor as specified in the contentItemNode. Uses com.eibus.configure.service.SOAPProcessor internally

Returns:

true if the processor creation succeeds

Throws:

LDAPException

createConnectionPoint

protected boolean createConnectionPoint()
                                 throws LDAPException

This method will create the ConnectionPoint as specified in the contentItemNode. Uses com.eibus.configure.service.ConnectionPoint internally

Returns:

true if the ConnectionPoint creation succeeds

Throws:

LDAPException

load

public void load(ISVPackage isvPackage,
                 int contentItemNode,
                 int logcontentItem)
          throws java.lang.Exception

This method is responsible for loading the soap service content manager. As part of loading, this content manager creates service group, service container and connection point. The contentItemNode contains the Service Group and Service Container configuration which can be bundled as part of isv.xml A example of this is given below: For connection point no specific configuration xml is to be provided.

 <serviceloader loader="com.cordys.SampleLoader"  description="Sample Service" url="">            
                <bussoapnode namespace="http://schemas.cordys.com/Sample/1.0">
                        <tuple>
                        <new>
                                <methodset>cn=Method Set Sample Server 1.0,cn=Cordys Sample Server,$ldaproot</methodset>                
                                <labeleduri>http://schemas.cordys.com/SampleServer/1.0</labeleduri>
                        </new>
                        </tuple>
                </bussoapnode>                    
                <bussoapprocessor namespace="http://schemas.cordys.com/Sample/1.0" implementationClass="com.cordys.Sample.connector">
                        <configuration implementation="com.cordys.Sample.connector">
                        <classpath>
                                <location>components/Sample/Sample.jar</location>
                             </classpath>
                                    <component name="SampleDBConnectionPool">
                                <datasource>
                                <type></type>
                                <name></name>
                                </datasource>
                         </component>
                                </configuration>
            </bussoapprocessor>
         </serviceloader>
         

Specified by:

load in class ISVContentManager

Throws:

java.lang.Exception

unload

public void unload(ISVPackage isvPackage,
                   int contentItemNode,
                   int logcontentItem)
            throws java.lang.Exception

This method takes care of removing the Service Group , Service Container and Connection Point configurations

Overrides:

unload in class ISVContentManager

Throws:

java.lang.Exception

getMessage

public java.lang.String getMessage()

getBusSOAPNodeConfiguration

protected int getBusSOAPNodeConfiguration(int staticConfiguration)

Subclasses can override this method to provide a different configuration. The default implementation is to return the staticConfiguration itself, ie, whatever is specified in the isv content.

Parameters:

staticConfiguration -

Returns:

busSOAPNodeConfiguration node

getBusSOAPProcessorConfiguration

protected int getBusSOAPProcessorConfiguration(int staticConfiguration)

Subclasses can override this method to provide a different configuration. The default implementation is to return the staticConfiguration itself, ie, whatever is specified in the isv content.

Parameters:

staticConfiguration -

Returns:

busSOAPProcessorConfiguration node

getBusSOAPNodeEntry

protected int getBusSOAPNodeEntry(int entry)

Subclasses can override this method to modify the static SOAP Node Entry. The default implementation is to return the static entry itself, ie, whatever is the LDAP entry in xml for the bussoapnode.

Parameters:

entry -

Returns:

bussoapnode entry entry

getBusSOAPProcessorEntry

protected int getBusSOAPProcessorEntry(int entry)

Subclasses can override this method to modify the static SOAP Processor Entry. The default implementation is to return the static entry itself, ie, whatever is the LDAP entry in xml for the bussoapprocessor.

Parameters:

entry -

Returns:

bussoapprocessor entry

getBusConnectionPointEntry

protected int getBusConnectionPointEntry(int entry)

Subclasses can override this method to modify the static SOAP Connection Point Entry. The default implementation is to return the static entry itself, ie, whatever is the LDAP entry in xml for the busconnectionpoint.

Parameters:

staticConfiguration -

Returns:

busconnectionpoint node

setOrganization

protected void setOrganization(java.lang.String organization)

This method will set the organization to given organization. For example "system" is the organization name.

Parameters:

organization - name of the organization , not complete DN.