com.webmethods.portal.mech.install

Interface IInstallMechanics

All Superinterfaces:

IComponent, IInitializable, IMechanics, ISystemHandler

public interface IInstallMechanics
extends IMechanics

Base interface for all install mechanics.

Field Summary

Fields

Modifier and Type	Field and Description
static String	CONTEXT_COMPONENT_PROPERTIES
static String	FOLDER_INSTALL
static String	FOLDER_INSTALL_COMPONENTS_DATA

Method Summary

Modifier and Type	Method and Description
boolean	canInstallComponent(IThingID userId, String componentLocation, Map<?,?> capabilities) Returns true if the component can be installed, false if cannot be
boolean	canInstallComponents(IThingID userId, Map<?,?> capabilities) Returns true if the specified user can install components.
boolean	canUninstallComponent(IURI componentURI, IThingID userId, Map<?,?> capabilities) Returns true if the specified user can uninstall a specified component.
void	checkInstallComponent(IThingID userId, String componentLocation, Map<?,?> capabilities) Checks the user can install this component.
void	checkInstallComponents(IThingID userId, Map<?,?> capabilities) Checks the user has rights to install components.
void	checkUninstallComponent(IURI componentURI, IThingID userId, Map<?,?> capabilities) Checks the user has rights to uninstall a specified component.
void	fireDeployComponentEvent(IThingID userId, String componentName, String componentLocation)
void	fireInstallComponentEvent(IThingID userId, int status, IURI componentUri) Fires an install component event.
void	fireUndeployComponentEvent(IThingID userId, String componentName, String componentLocation)
void	fireUninstallComponentEvent(IThingID userId, int status, IURI componentUri, IURI containerUri) Fires an uninstall component event.
String	getComponentLocation(IURI componentUri) Returns component location based on uri
Map<String,Object>	getComponentProperties(String componentLocation) Extracts map of properties out of component package file
IURI	getComponentURI(String componentName) Returns registered component uri from the given component name
Map<String,String>	getDeployMap() Returns current deploy folder name/time
void	initInstallContext(String componentLocation, Map<String,Object> installProperties)
void	installComponent(String componentLocation, IThingID userId, Map<String,Object> properties) Installs new component from a specfied component file location
void	installComponentSafe(String componentLocation, IThingID userId, Map<String,Object> properties) Installs new component the same way as installComponent(java.lang.String, com.webmethods.portal.service.meta2.thing.IThingID, java.util.Map<java.lang.String, java.lang.Object>), but if the installation fails it tries to clean up the system using the following approach: If it was fresh install, it tries to uninstall the failed component If if was upgrade, it tries to reinstall previously installed version Then it throws original install failure exception
boolean	isUptodate(String componentFileNameInDeployFolder) Deprecated. Use IInstallMechanics#isUptodate(String, File)
boolean	isUptodate(String componentFileNameInDeployFolder, File deployDir, String deployMap) Checks whether the component file in the deploy folder is up-to-date
IThingID	registerComponent(String componentLocation, IThingID userId) Registers component in the content store and returns content thing id
void	reinstallComponent(IURI componentUri, IThingID userId, Map<String,Object> properties) Reinstalls (repairs) a specified component
void	releaseInstallContext(String componentLocation)
void	uninstallComponent(String componentLocation, IThingID userId, Map<String,Object> properties) Uninstalls a specified component
void	unregisterComponent(String componentName) Unregisters component from the content store

Methods inherited from interface com.webmethods.portal.system.IComponent

getComponentData, getComponentName, getComponentProvider, getURI, isInitialized, setComponentData, setComponentProvider

Methods inherited from interface com.webmethods.portal.system.init.IInitializable

init, shutdown

Field Detail

FOLDER_INSTALL

static final String FOLDER_INSTALL

See Also:

Constant Field Values

FOLDER_INSTALL_COMPONENTS_DATA

static final String FOLDER_INSTALL_COMPONENTS_DATA

See Also:

Constant Field Values

CONTEXT_COMPONENT_PROPERTIES

static final String CONTEXT_COMPONENT_PROPERTIES

See Also:

Constant Field Values

Method Detail

canInstallComponents

boolean canInstallComponents(IThingID userId,
                             Map<?,?> capabilities)
                      throws PortalException

Returns true if the specified user can install components.

Parameters:

userId - the user

capabilities - the capabilites map

Throws:

PortalException

checkInstallComponents

void checkInstallComponents(IThingID userId,
                            Map<?,?> capabilities)
                     throws PortalException,
                            PortalAccessException

Checks the user has rights to install components. Throws PortalAccessException if the user has no rights

Parameters:

userId - the user

capabilities - the capabilites map

Throws:

PortalException

PortalAccessException

canInstallComponent

boolean canInstallComponent(IThingID userId,
                            String componentLocation,
                            Map<?,?> capabilities)
                     throws PortalException

Returns true if the component can be installed, false if cannot be

Parameters:

componentLocation - the component name

Returns:

true if the component can be installed

Throws:

PortalException

checkInstallComponent

void checkInstallComponent(IThingID userId,
                           String componentLocation,
                           Map<?,?> capabilities)
                    throws PortalException,
                           PortalAccessException

Checks the user can install this component.

Parameters:

componentLocation -

Throws:

PortalException

PortalAccessException

canUninstallComponent

boolean canUninstallComponent(IURI componentURI,
                              IThingID userId,
                              Map<?,?> capabilities)
                       throws PortalException

Returns true if the specified user can uninstall a specified component.

Parameters:

componentURI - the component item uri

userId - the user

capabilities - the capabilites map

Throws:

PortalException

checkUninstallComponent

void checkUninstallComponent(IURI componentURI,
                             IThingID userId,
                             Map<?,?> capabilities)
                      throws PortalException,
                             PortalAccessException

Checks the user has rights to uninstall a specified component. Throws PortalAccessException if the user has no rights

Parameters:

componentURI - the component item uri

userId - the user

capabilities - the capabilites map

Throws:

PortalException

PortalAccessException

installComponent

void installComponent(String componentLocation,
                      IThingID userId,
                      Map<String,Object> properties)
               throws PortalException

Installs new component from a specfied component file location

Parameters:

componentLocation - the component file location

userId - the user

properties - deployment properties, may be null

Throws:

PortalException

installComponentSafe

void installComponentSafe(String componentLocation,
                          IThingID userId,
                          Map<String,Object> properties)
                   throws PortalException,
                          UnsatisfiedComponentDependencyException,
                          InstallationFailedException,
                          InstallationWarningException

Installs new component the same way as installComponent(java.lang.String, com.webmethods.portal.service.meta2.thing.IThingID, java.util.Map<java.lang.String, java.lang.Object>), but if the installation fails it tries to clean up the system using the following approach:

1. If it was fresh install, it tries to uninstall the failed component
2. If if was upgrade, it tries to reinstall previously installed version

Then it throws original install failure exception

Parameters:

componentLocation - the component file location

userId - the user

properties - deployment properties, may be null

Throws:

PortalException

UnsatisfiedComponentDependencyException

InstallationFailedException

InstallationWarningException

uninstallComponent

void uninstallComponent(String componentLocation,
                        IThingID userId,
                        Map<String,Object> properties)
                 throws PortalException,
                        InstallationFailedException,
                        InstallationWarningException

Uninstalls a specified component

Parameters:

componentLocation - the component file location

userId - the user

properties - deployment properties, may be null

Throws:

PortalException

InstallationFailedException

InstallationWarningException

getComponentLocation

String getComponentLocation(IURI componentUri)
                     throws PortalException

Returns component location based on uri

Parameters:

componentUri -

Returns:

component file location

Throws:

PortalException

getComponentURI

IURI getComponentURI(String componentName)
              throws PortalException

Returns registered component uri from the given component name

Parameters:

componentName - the name of the component

Returns:

uri or null if not found

Throws:

PortalException

reinstallComponent

void reinstallComponent(IURI componentUri,
                        IThingID userId,
                        Map<String,Object> properties)
                 throws PortalException

Reinstalls (repairs) a specified component

Parameters:

componentUri - the component to reinstall

userId - the user

properties - deployment properties, may be null

Throws:

PortalException

fireDeployComponentEvent

void fireDeployComponentEvent(IThingID userId,
                              String componentName,
                              String componentLocation)
                       throws PortalException

Throws:

PortalException

fireUndeployComponentEvent

void fireUndeployComponentEvent(IThingID userId,
                                String componentName,
                                String componentLocation)
                         throws PortalException

Throws:

PortalException

fireInstallComponentEvent

void fireInstallComponentEvent(IThingID userId,
                               int status,
                               IURI componentUri)
                        throws PortalException

Fires an install component event.

Parameters:

userId - the user.

status - Status of the event (sucessful, denied, error).

componentUri - installed component uri.

Throws:

PortalException

fireUninstallComponentEvent

void fireUninstallComponentEvent(IThingID userId,
                                 int status,
                                 IURI componentUri,
                                 IURI containerUri)
                          throws PortalException

Fires an uninstall component event.

Parameters:

userId - the user

status - Status of the event (sucessful, denied, error).

componentUri - uninstalled component uri.

Throws:

PortalException

registerComponent

IThingID registerComponent(String componentLocation,
                           IThingID userId)
                    throws PortalException

Registers component in the content store and returns content thing id

Parameters:

componentLocation - component location

userId - current user

Returns:

thing id of the created content item

Throws:

PortalException

unregisterComponent

void unregisterComponent(String componentName)
                  throws PortalException

Unregisters component from the content store

Parameters:

componentName - the previously registered component name

Throws:

PortalException

releaseInstallContext

void releaseInstallContext(String componentLocation)

initInstallContext

void initInstallContext(String componentLocation,
                        Map<String,Object> installProperties)
                 throws PortalException

Throws:

PortalException

getComponentProperties

Map<String,Object> getComponentProperties(String componentLocation)
                                   throws PortalException

Extracts map of properties out of component package file

Parameters:

componentLocation - the component file location

Returns:

map with properties

Throws:

PortalException

isUptodate

boolean isUptodate(String componentFileNameInDeployFolder)
            throws PortalException

Deprecated. Use IInstallMechanics#isUptodate(String, File)

Checks whether the component file in the deploy folder is up-to-date

Parameters:

componentFileNameInDeployFolder -

Returns:

false if not uptodate and needs redeployment

Throws:

PortalException

isUptodate

boolean isUptodate(String componentFileNameInDeployFolder,
                   File deployDir,
                   String deployMap)
            throws PortalException

Checks whether the component file in the deploy folder is up-to-date

Parameters:

componentFileNameInDeployFolder -

deployDir -

deployMap -

Returns:

Throws:

PortalException

getDeployMap

Map<String,String> getDeployMap()
                         throws PortalException

Returns current deploy folder name/time

Returns:

Throws:

PortalException