public interface IComponentProvider extends IComponent, IURIResolver
The IComponentProvider interfaces manages IComponent
s
An IComponentProvider is an IComponent
but unique in a couple of ways:
First, IComponentProvider are NOT dynamically deployable. But IComponent
s are dynamically deployable.
Second, IComponentProvider are exposed via PortalSystem.getComponentProvider(java.lang.String)
. IComponent
s are only
exposed by their IComponentProvider.
Typically, only system level developers will write new IComponentProvider
s.
Modifier and Type | Field and Description |
---|---|
static String |
ATTR_APP_NAME
Attr for component data to specify the application name
|
static String |
ATTR_BEG_QUERY |
static String |
ATTR_END_QUERY |
static String |
ATTR_MID_QUERY |
static String |
BIZPOLICY_MANAGER
Deprecated.
use
IComponentNames instead |
static String |
CACHE_PROVIDER
Deprecated.
use
IComponentNames instead |
static String |
COMMAND_PROVIDER
Deprecated.
use
IComponentNames instead |
static String |
COMPONENTS_QUERY
Some common named constants for
IComponentProvider |
static String |
INSTALL_PROVIDER
Deprecated.
use
IComponentNames instead |
static String |
MECH_PROVIDER
Deprecated.
use
IComponentNames instead |
static String |
METACONTEXT_PROVIDER
Deprecated.
use
IComponentNames instead |
static String |
PHASE_PROVIDER |
static String |
POLICY_PROVIDER
Deprecated.
use
IComponentNames instead |
static String |
SEARCH_PROVIDER
Deprecated.
use
IComponentNames instead |
Modifier and Type | Method and 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 . |
Category |
getLogCategory()
Returns logging category of the service provider.
|
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.
|
getComponentData, getComponentName, getComponentProvider, getURI, isInitialized, setComponentData, setComponentProvider
init, shutdown
acquireURI, acquireURI
static final String ATTR_BEG_QUERY
static final String ATTR_MID_QUERY
static final String ATTR_END_QUERY
static final String COMPONENTS_QUERY
IComponentProvider
static final String PHASE_PROVIDER
IPhaseProvider
,
Constant Field Valuesstatic final String ATTR_APP_NAME
@Deprecated static final String METACONTEXT_PROVIDER
IComponentNames
instead@Deprecated static final String MECH_PROVIDER
IComponentNames
instead@Deprecated static final String CACHE_PROVIDER
IComponentNames
instead@Deprecated static final String INSTALL_PROVIDER
IComponentNames
instead@Deprecated static final String SEARCH_PROVIDER
IComponentNames
instead@Deprecated static final String POLICY_PROVIDER
IComponentNames
instead@Deprecated static final String COMMAND_PROVIDER
IComponentNames
instead@Deprecated static final String BIZPOLICY_MANAGER
IComponentNames
insteadIComponent getComponent(String componentName)
IComponent
by name. This certainly won't be adequate for all IComponentProvider
s.
Different IComponentProvider
s should provide more specific lookup mechanisms.componentName
- identifies the componentIComponent
if found, NULL otherwiseIComponent getComponent(IComponentData componentData) throws PortalException
IComponent
based on the data that describes it.componentData
- IComponent
if found, NULL otherwisePortalException
IComponent getComponent(IInitializableComponentData initializableComponentData) throws PortalException
IComponent
from an IInitializableComponentDatainitializableComponentData
- IComponent
if found, NULL otherwisePortalException
IComponent getDefaultComponent() throws PortalException
IComponent
. Note, this might not be valid for all IComponentProvidersIComponent
for this IComponentProvider. Maybe NULLPortalException
Map<String,? extends IComponent> getComponents()
IComponent
sObject lookup(IURI objectURI) throws PortalException
objectURI
- the IURI
of a portal resource.PortalException
boolean exists(IURI objectURI) throws PortalException
objectURI
- PortalException
IComponent registerComponent(IInitializableComponentData initializableComponentData, boolean shouldFireEvents) throws PortalException
initializableComponentData
- is enough data needed to register a new component, but doesn't describe a valid componentIComponent
PortalException
void unregisterComponent(IComponentData componentData, boolean shouldFireEvents) throws PortalException
IComponentData
componentData
- PortalException
IComponent reloadComponent(IComponentData componentData, boolean shouldFireEvents) throws PortalException
componentData
- is the IComponentData
shouldFireEvents
- true if you want events to be fired. Should be false if you are already handling an eventIComponent
PortalException
IComponent reloadComponent(String componentClassName, boolean shouldFireEvents) throws PortalException
com.webmethods.portal.event.impl.ClassUpdateEvent
componentClassName
- is the className of the new componentshouldFireEvents
- true if you want events to be fired. Should be false if you are already handling an eventIComponent
PortalException
Category getLogCategory()
com.webmethods.rtl.util.Debug
to get the appropriate log category.Category
is returned.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
PortalException
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 IComponent
s 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
COMPONENTS_QUERY
void initDeferredWebAppComponents(String webAppName) throws InitializationException