Package com.webmethods.portal.system

Interface IComponentProvider

All Superinterfaces:

IComponent, IInitializable, IURIResolver

All Known Subinterfaces:

IAuditManager, IAuthManager, IBizPolicyManager, IBundleManager, ICacheManager, IClassManager, IClusterPartitionProvider, IClusterProvider, ICommandManager, IContentManager, IContextProvider, IDirSystem, IDispatchManager, IErrorManager, IGdprConfigService, IGlobalProvider, IInstallProvider, ILanguagePackManager, ILicenseProvider, IMailUtil, IManager, IMechanicsManager, IMetaContext, IMetaManager, IPhaseProvider, IPortletApplication, IPortletContainer, IPortletProvider, IPortletWebManager, IPresentationManager, IPropertyEditorManager, ISessionManager, ITaskSystem, IThingComponentProvider, ITOTPConfigService, IUserPrivacyService, IVersionProvider, IWebApplication, IWebAppRuntimeConfigManager

public interface IComponentProvider
extends IComponent, IURIResolver

The IComponentProvider interfaces manages IComponents

An IComponentProvider is an IComponent but unique in a couple of ways: First, IComponentProvider are NOT dynamically deployable. But IComponents are dynamically deployable. Second, IComponentProvider are exposed via PortalSystem.getComponentProvider(java.lang.String). IComponents are only exposed by their IComponentProvider.

Typically, only system level developers will write new IComponentProviders.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ATTR_APP_NAME	Attr for component data to specify the application name
static final String	ATTR_BEG_QUERY
static final String	ATTR_END_QUERY
static final String	ATTR_MID_QUERY
static final String	BIZPOLICY_MANAGER	Deprecated. use IComponentNames instead
static final String	CACHE_PROVIDER	Deprecated. use IComponentNames instead
static final String	COMMAND_PROVIDER	Deprecated. use IComponentNames instead
static final String	COMPONENTS_QUERY	Some common named constants for IComponentProvider
static final String	INSTALL_PROVIDER	Deprecated. use IComponentNames instead
static final String	MECH_PROVIDER	Deprecated. use IComponentNames instead
static final String	METACONTEXT_PROVIDER	Deprecated. use IComponentNames instead
static final String	PHASE_PROVIDER
static final String	POLICY_PROVIDER	Deprecated. use IComponentNames instead
static final String	SEARCH_PROVIDER	Deprecated. use IComponentNames instead

Method Summary

Modifier and Type	Method	Description
boolean	exists(IURI objectURI)	Checks if the specific component exists
IComponent	getComponent(IComponentData componentData)	Retrieve an IComponent based on the data that describes it.
IComponent	getComponent(IInitializableComponentData initializableComponentData)	Retrieve an IComponent from an IInitializableComponentData
IComponent	getComponent(String componentName)	Retrieve an IComponent by name.
String	getComponentQueryString()	Should only be overriden when implmenting a custom IComponentProvider and not called externally.
Map<String,? extends IComponent>	getComponents()	Get the currently registered components
IComponent	getDefaultComponent()	Retrieve the default IComponent.
default org.slf4j.Logger	getLogger()	Deprecated.
void	initDeferredWebAppComponents(String webAppName)	This component should initialize components for the specified webapp that were deferred during server startup.
Object	lookup(IURI objectURI)	Lookup an object in this provider namespace.
IComponent	registerComponent(IInitializableComponentData initializableComponentData, boolean shouldFireEvents)	Register a new component with this IComponentProvider
IComponent	reloadComponent(IComponentData componentData, boolean shouldFireEvents)	Reloads the component based upon the componentData.
IComponent	reloadComponent(String componentClassName, boolean shouldFireEvents)	Reloads the component.
void	unregisterComponent(IComponentData componentData, boolean shouldFireEvents)	Unregister the component and remove its IComponentData
void	upgradeComponentDataFromBootstrapComponentData()	This is a special function that is only called at initial portal bootstrap time.

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

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

acquireURI, acquireURI

Field Details

ATTR_BEG_QUERY

static final String ATTR_BEG_QUERY

See Also:

• Constant Field Values

ATTR_MID_QUERY

static final String ATTR_MID_QUERY

See Also:

• Constant Field Values

ATTR_END_QUERY

static final String ATTR_END_QUERY

See Also:

• Constant Field Values

COMPONENTS_QUERY

static final String COMPONENTS_QUERY

Some common named constants for IComponentProvider

See Also:

• Constant Field Values

PHASE_PROVIDER

static final String PHASE_PROVIDER

See Also:

• IPhaseProvider
• Constant Field Values

ATTR_APP_NAME

static final String ATTR_APP_NAME

Attr for component data to specify the application name

See Also:

• Constant Field Values

METACONTEXT_PROVIDER

@Deprecated
static final String METACONTEXT_PROVIDER

Deprecated.

use IComponentNames instead

See Also:

• Constant Field Values

MECH_PROVIDER

@Deprecated
static final String MECH_PROVIDER

Deprecated.

use IComponentNames instead

See Also:

• Constant Field Values

CACHE_PROVIDER

@Deprecated
static final String CACHE_PROVIDER

Deprecated.

use IComponentNames instead

See Also:

• Constant Field Values

INSTALL_PROVIDER

@Deprecated
static final String INSTALL_PROVIDER

Deprecated.

use IComponentNames instead

See Also:

• Constant Field Values

SEARCH_PROVIDER

@Deprecated
static final String SEARCH_PROVIDER

Deprecated.

use IComponentNames instead

See Also:

• Constant Field Values

POLICY_PROVIDER

@Deprecated
static final String POLICY_PROVIDER

Deprecated.

use IComponentNames instead

See Also:

• Constant Field Values

COMMAND_PROVIDER

@Deprecated
static final String COMMAND_PROVIDER

Deprecated.

use IComponentNames instead

See Also:

• Constant Field Values

BIZPOLICY_MANAGER

@Deprecated
static final String BIZPOLICY_MANAGER

Deprecated.

use IComponentNames instead

See Also:

• Constant Field Values

Method Details

getComponent

IComponent getComponent(String componentName)

Retrieve an IComponent by name. This certainly won't be adequate for all IComponentProviders. Different IComponentProviders should provide more specific lookup mechanisms.

Parameters:

componentName - identifies the component

Returns:

the IComponent if found, NULL otherwise

getComponent

IComponent getComponent(IComponentData componentData)
                 throws PortalException

Retrieve an IComponent based on the data that describes it.

Parameters:

componentData -

Returns:

the IComponent if found, NULL otherwise

Throws:

PortalException

getComponent

IComponent getComponent(IInitializableComponentData initializableComponentData)
                 throws PortalException

Retrieve an IComponent from an IInitializableComponentData

Parameters:

initializableComponentData -

Returns:

the IComponent if found, NULL otherwise

Throws:

PortalException

getDefaultComponent

IComponent getDefaultComponent()
                        throws PortalException

Retrieve the default IComponent. Note, this might not be valid for all IComponentProviders

Returns:

the default IComponent for this IComponentProvider. Maybe NULL

Throws:

PortalException

getComponents

Map<String,? extends IComponent> getComponents()

Get the currently registered components

Returns:

a map of IComponents

lookup

Object lookup(IURI objectURI)
       throws PortalException

Lookup an object in this provider namespace.

Parameters:

objectURI - the IURI of a portal resource.

Returns:

a reference to the object in the system, or null if such object exists

Throws:

PortalException

exists

boolean exists(IURI objectURI)
        throws PortalException

Checks if the specific component exists

Parameters:

objectURI -

Returns:

Throws:

PortalException

registerComponent

IComponent registerComponent(IInitializableComponentData initializableComponentData,
 boolean shouldFireEvents)
                      throws PortalException

Register a new component with this IComponentProvider

Parameters:

initializableComponentData - is enough data needed to register a new component, but doesn't describe a valid component

Returns:

the new IComponent

Throws:

PortalException

unregisterComponent

void unregisterComponent(IComponentData componentData,
 boolean shouldFireEvents)
                  throws PortalException

Unregister the component and remove its IComponentData

Parameters:

componentData -

Throws:

PortalException

reloadComponent

IComponent reloadComponent(IComponentData componentData,
 boolean shouldFireEvents)
                    throws PortalException

Reloads the component based upon the componentData.

Parameters:

componentData - is the IComponentData

shouldFireEvents - true if you want events to be fired. Should be false if you are already handling an event

Returns:

the reloaded IComponent

Throws:

PortalException

reloadComponent

IComponent reloadComponent(String componentClassName,
 boolean shouldFireEvents)
                    throws PortalException

Reloads the component. This typically occurrs in response to a ClassUpdateEvent

Parameters:

componentClassName - is the className of the new component

shouldFireEvents - true if you want events to be fired. Should be false if you are already handling an event

Returns:

the reloaded IComponent

Throws:

PortalException

getLogger

@Deprecated
default org.slf4j.Logger getLogger()

Deprecated.

upgradeComponentDataFromBootstrapComponentData

void upgradeComponentDataFromBootstrapComponentData()
                                             throws PortalException

This is a special function that is only called at initial portal bootstrap time.

We've transitioned from PortalSystem.BOOTSTRAP_STATE to PortalSystem.INITIALIZING_STATE. Some IComponentProvider's need to upgrade their IComponent's to IComponentData

Throws:

PortalException

getComponentQueryString

String getComponentQueryString()

Should only be overriden when implmenting a custom IComponentProvider and not called externally.

Override this for a different xml queryString This is important when loading your IComponents from an xml file. However this only applies at bootstrap mode, or if your IComponentProvider isn't derived from IThingComponentProvider. It also applies if we're installing new components

Returns:

a xpath like COMPONENTS_QUERY

initDeferredWebAppComponents

void initDeferredWebAppComponents(String webAppName)
                           throws InitializationException

This component should initialize components for the specified webapp that were deferred during server startup.

Throws:

InitializationException

See Also:

• InitializationException.RECOVERABLE_ERROR
• InitializationException.NON_RECOVERABLE_ERROR