Package com.webmethods.portal.bizPolicy.biz.install

Interface IInstallPolicy

All Superinterfaces:

IBizPolicy, IComponent, IInitializable, ISystemHandler

public interface IInstallPolicy
extends IBizPolicy

Business policy for installing and uninstalling deployable components.

Field Summary

Fields

Modifier and Type	Field	Description
static final int	INSTALL_FLAG_FIRE_EVENTS	Flag indicates that invalidation events needs to be fired during install
static final int	INSTALL_FLAG_REGISTER_COMPONENT	Flag indicates that installed component needs to be registered
static final int	INSTALL_FLAG_REMOTE_DEPLOYMENT	Flag that indicates remote deployment from Designer
static final int	INSTALL_SUPPRESS_LANGUAGE_PACK_DEPLOYMENT	Flag indicates that Language Pack installation should not be performed.

Method Summary

Modifier and Type	Method	Description
String[]	getSupportedComponentTypes(IContext context)	Returns supported component type that can be installed into the system
void	installBootstrapComponentsWithDependencies(IContext context, String components)	Deploys a bootstrap component with dependencies
IURI	installComponent(IContext context, String componentLocation)
IURI	installComponent(IContext context, String componentLocation, boolean register)	Installs a component from a given location
IURI	installComponent(IContext context, String componentLocation, int flags)	Installs a component from a given location
void	installComponents(IContext context, String folderLocation)	Installs all components from a given folder
void	syncDeployFolder(IContext context, boolean flushCache)	Runs deploy folder sync
void	uninstallComponent(IContext context, IURI componentUri)
void	uninstallComponent(IContext context, IURI componentUri, boolean unregister)	Uninstalled previously installed component
void	uninstallComponent(IContext context, String componentLocation)
void	uninstallComponent(IContext context, String componentLocation, boolean unregister)	Uninstalled previously installed component

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 Details

INSTALL_FLAG_REMOTE_DEPLOYMENT

static final int INSTALL_FLAG_REMOTE_DEPLOYMENT

Flag that indicates remote deployment from Designer

See Also:

• Constant Field Values

INSTALL_FLAG_REGISTER_COMPONENT

static final int INSTALL_FLAG_REGISTER_COMPONENT

Flag indicates that installed component needs to be registered

See Also:

• Constant Field Values

INSTALL_FLAG_FIRE_EVENTS

static final int INSTALL_FLAG_FIRE_EVENTS

Flag indicates that invalidation events needs to be fired during install

See Also:

• Constant Field Values

INSTALL_SUPPRESS_LANGUAGE_PACK_DEPLOYMENT

static final int INSTALL_SUPPRESS_LANGUAGE_PACK_DEPLOYMENT

Flag indicates that Language Pack installation should not be performed. Use this it tell the installer that your method will handle the language pack installation/deployment.

See Also:

• Constant Field Values

Method Details

installComponent

IURI installComponent(IContext context,
 String componentLocation,
 int flags)
               throws BizException

Installs a component from a given location

Parameters:

context - current context

componentLocation - the location of the component deployment file

Returns:

uri to the installed component

Throws:

BizException

installComponent

IURI installComponent(IContext context,
 String componentLocation,
 boolean register)
               throws BizException

Installs a component from a given location

Parameters:

context - current context

componentLocation - the location of the component deployment file

Returns:

uri to the installed component

Throws:

BizException

installComponent

IURI installComponent(IContext context,
 String componentLocation)
               throws BizException

Throws:

BizException

uninstallComponent

void uninstallComponent(IContext context,
 IURI componentUri,
 boolean unregister)
                 throws BizException

Uninstalled previously installed component

Parameters:

context - current context

componentUri - the component uri

Throws:

BizException

uninstallComponent

void uninstallComponent(IContext context,
 IURI componentUri)
                 throws BizException

Throws:

BizException

uninstallComponent

void uninstallComponent(IContext context,
 String componentLocation,
 boolean unregister)
                 throws BizException

Uninstalled previously installed component

Parameters:

context - current context

componentLocation - the location of the component deployment file

Throws:

BizException

uninstallComponent

void uninstallComponent(IContext context,
 String componentLocation)
                 throws BizException

Throws:

BizException

installComponents

void installComponents(IContext context,
 String folderLocation)
                throws BizException

Installs all components from a given folder

Parameters:

context - current context

folderLocation - the folder with components to install

Throws:

BizException

getSupportedComponentTypes

String[] getSupportedComponentTypes(IContext context)
                             throws BizException

Returns supported component type that can be installed into the system

Returns:

list of component types

Throws:

BizException

syncDeployFolder

void syncDeployFolder(IContext context,
 boolean flushCache)
               throws BizException

Runs deploy folder sync

Parameters:

context -

Throws:

BizException

installBootstrapComponentsWithDependencies

void installBootstrapComponentsWithDependencies(IContext context,
 String components)
                                         throws BizException

Deploys a bootstrap component with dependencies

Parameters:

components -

context -

Throws:

BizException