Package com.webmethods.portal.system

Class PortalSystem

java.lang.Object

com.webmethods.portal.system.PortalSystem

All Implemented Interfaces:

IURIResolver

public abstract class PortalSystem
extends Object
implements IURIResolver

The entry point into the Portal server.

PortalSystem is a singleton. It exposes the main(java.lang.String[]) method which initializes Portal. Initialization leverages the DefaultPhaseProvider to initialize all of the IPhaseProviders registered in the system. Upon successful initialization, all IComponentProviders will be available as well as their IComponents.

PortalSystem also defines many constants that can be passed into acquireURI(java.lang.String) to find common portal resources. This includes: TOPIC_ROOT, FOLDER_ROOT, FOLDER_SYSTEM and many others.

PortalSystem also defines the various states that the system can be in. These vary from UNINITIALIZED_STATE to SHUTDOWN_STATE and a few in between.

PortalSystem also exposes all of the registered IComponentProviders. When requiring a specific IComponentProvider invoke an API like getCommandProvider() and cast it to the appropriate implementation, in this instance: ICommandManager.

Field Summary

Fields

Modifier and Type	Field	Description
static final int	BOOTSTRAP_STATE	The system is in a pre-initialized 'bootstrap' state.
static final String	CURRENT_RESOURCE	The current resource.
static final String	CURRENT_RESOURCE_ANCESTOR	The current resource's ancestor to the specified step (current.resource.ancestor.1=parent, current.resource.ancestor.2=grandparent).
static final String	CURRENT_RESOURCE_PARENT	The current resource's parent.
static final String	CURRENT_RESOURCE_TYPE
protected static final String	DEFAULT_PROPERTY
static final String	FOLDER_CONTENT_SERVICE	The content service folder.
static final String	FOLDER_DIRECTORY_SERVICE	The directory service folder.
static final String	FOLDER_HELP	The Help folder.
static final String	FOLDER_PORTLET_INSTANCES	The portlet instances folder.
static final String	FOLDER_PORTLETS	The XTypes Portlet folder.
static final String	FOLDER_PUBLIC	The public folder.
static final String	FOLDER_ROOT	The Root folder.
static final String	FOLDER_SKINS	The skins folder.
static final String	FOLDER_SYSTEM	The System folder.
static final String	FOLDER_TEMPLATES	The templates folder.
static final String	FOLDER_TEMPLATES_MANAGEMENT	The templates management folder.
static final String	FOLDER_THEMES	The themes folder.
static final String	FOLDER_USERS	The users folder.
static final String	FOLDER_XTYPE	The xtype folder.
static final String	FOLDER_XTYPES	The XTypes folder.
static final String	IN_MEMORY_INIT_MODE
static final int	INITIALIZING_STATE	The system is initializing and the MetaManager is available.
protected static Set<String>	m_componentProviderNames
protected static Map<String,IComponentProvider>	m_componentProviders	This is the map of managers that implement the IComponentProvider interface
protected IPhaseProvider	m_phaseProvider	This is what initializes us through the various phases of the product.
protected static PortalSystem	m_portalSystem	A static singleton
protected int	m_state
protected List<IURIResolver>	m_uriResolverList	A storage of IURIResolver
protected IURIResolver[]	m_uriResolvers	This is the IURIResolver that always gets first crack at calls to acquireURI(java.lang.String)
protected IURIResolver[]	m_uriResolverServices	This is the IURIResolver that always gets first crack at calls to acquireURI(java.lang.String)
protected static String	m_VMID
protected static final String	PERF_CAT_MANAGER
static final String	PERSISTENT_SYSTEM_PROPERTIES_DEFAULT	Where the persistent properties are stored.
static final String	PERSISTENT_SYSTEM_PROPERTIES_KEY	The key identifying persistent property storage.
static final String	PHASE_PROVIDER_CLASS	This is the phase provider that manages initializing the various phases of the product.
static final String	PORTAL_HOME
protected static final String	PORTAL_PROPERTY
static long	PORTAL_START_TIME
static final String	PORTAL_SYSTEM_CLASS	Identifies which PortalSystem to use.
static final String	PORTLET_DEFAULT_ADMIN_PAGE	Alias for the default admin page portlet.
static final String	PORTLET_DEFAULT_PAGE	Alias for the default page portlet.
static final String	PORTLET_DIRECTORY	Alias for the directory portlet.
static final String	PORTLET_ERROR_REPORT	Alias for the error report portlet.
static final String	PORTLET_FOLDERVIEW	Alias for the folderview portlet.
static final String	PORTLET_HEAD	Alias for the head portlet.
static final String	PORTLET_LEFTNAV	Alias for the leftnav (Content Manager) portlet.
static final String	PORTLET_LOCATIONS	Alias for the locations portlet.
static final String	PORTLET_LOGOUT	Alias for the logout portlet.
static final String	PORTLET_PERMISSIONS	Alias for the permissions portlet.
static final String	PORTLET_PROPERTIES	Alias for the properties portlet.
static final String	PORTLET_PUBLISH	Alias for the publish portlet.
static final String	PORTLET_STREAMING_CONTENT_VIEWER	Alias for the streaming content viewer portlet.
static final String	PORTLET_TITLEBAR	Alias for the titlebar portlet.
static final String	PORTLET_UNI_PICKER	Alias for the unipicker (Universal Picker) portlet.
static final String	PORTLET_USER_PROFILE	Alias for the user profile portlet.
static final int	PRE_META_STATE	This is the point during initialization when no IMetaManager is available yet, because the PortalSystem is still initializing.
static final int	READY_STATE	The system is ready and initialized.
static final String	SERVER_HOME
static final int	SHUTDOWN_STATE	The system is shutting down.
static final String	TASK_ENGINE_LIBRARY_MODE	System property indicating IBM webMethods BPM Task Engine is enabled in library mode
static final String	TEMPLATE_BASIC	The basic template.
static final String	TEMPLATE_EMPTY	The "empty" template.
static final String	TEMPLATE_THREE_COL	The three column template.
static final String	TEMPLATE_USECORPGOV	The Corporate Governance template.
static final String	TOPIC_ADMIN	The Admin topic.
static final String	TOPIC_HELP	The Help topic.
static final String	TOPIC_ROOT	The root topic.
static final String	TOPIC_SYSTEM	The System topic.
static final int	UNINITIALIZED_STATE	The system hasn't begun initializing yet.
static final String	USER_CURRENT	Alias for the current user.
static final String	USER_CURRENT_FAVORITES	Alias for the current user's scrapbook.
static final String	USER_CURRENT_HOME	Alias for the current user's home folder.
static final String	USER_CURRENT_PROFILE	Alias for the current user's profile.
static final String	USER_CURRENT_ROOT	Alias for the current user's root folder (contains user home and scrapbook).
static final String	USER_CURRENT_SAVED_SEARCHES	Alias for the current user's saved search page.
static final String	USER_CURRENT_START_PAGE	Alias for the current user's start page.

Constructor Summary

Constructors

Constructor	Description
PortalSystem()	Default constructor used for reflection

Method Summary

Modifier and Type	Method	Description
IURI	acquireURI(String uri)	Retrieve the provider-specific implementation of IURI based on the URI information.
IURI	acquireURI(String uri, boolean lookup)	Retrieve the provider-specific implementation of IURI based on the URI information.
protected abstract void	actionEnd(Object token)	End an action to be tracked using the supplied perf token
protected abstract Object	actionInit(String category, String actionName)	Create action token to be used for perf monitoring
protected abstract void	actionStart(Object token)	Begin an action to be tracked using the supplied perf token
static void	addComponentProvider(String name, IComponentProvider cp)	Updates the map that holds the IComponentProviders.
void	addURIResolver(IURIResolver newUriResolver)	Allows the acquireURI(java.lang.String) to be 'hooked' by other resolvers
static void	doStartup(IPhaseProvider phaseProvider)	Perform the portalSystem startup logic
boolean	exists(IURI objectURI)	Checks if an items specified by objectURI exists in the system
static String	fixClientSideURI(String uri)	adds mws root context path to uri
static String	fixMWSURI(String uri)	removes context path from uri to be processed by other MWS apis.
static IComponentProvider	getAppServerProvider()	Deprecated. unsupported
static IComponentProvider	getAuditManager()	Deprecated. use getComponentProvider(Class) or getComponentProvider(Class, String) instead
static IComponentProvider	getBizPolicyProvider()	Deprecated. use getComponentProvider(Class) or getComponentProvider(Class, String) instead
static IComponentProvider	getBundleManager()	Deprecated. use getComponentProvider(Class) or getComponentProvider(Class, String) instead
static IComponentProvider	getCacheProvider()	Deprecated. use getComponentProvider(Class) or getComponentProvider(Class, String) instead
static IComponentProvider	getClassManager()	Deprecated. use getComponentProvider(Class) or getComponentProvider(Class, String) instead
static IComponentProvider	getClusterProvider()	Deprecated. use getComponentProvider(Class) or getComponentProvider(Class, String) instead
static IComponentProvider	getCommandProvider()	Deprecated. use getComponentProvider(Class) or getComponentProvider(Class, String) instead
static <T extends IComponentProvider> T	getComponentProvider(Class<T> componentProviderInterface)	Retrieves the registered IComponentProvider
static <T extends IComponentProvider> T	getComponentProvider(Class<T> componentProviderInterface, String name)	Retrieves the registered IComponentProvider
static IComponentProvider	getComponentProvider(String componentProvider)	Deprecated. use getComponentProvider(Class, String) instead
static Set<String>	getComponentProviderNames()
static Map<String,IComponentProvider>	getComponentProviders()	Gets the map of all registered by name IComponentProviders.
static ContainerMetaInfo	getContainerConfig()
static IComponentProvider	getContentProvider()	Deprecated. use getComponentProvider(Class) or getComponentProvider(Class, String) instead
static String	getContextPath()
static IComponentProvider	getContextProvider()	Deprecated. use getComponentProvider(Class) or getComponentProvider(Class, String) instead
static IComponentProvider	getDirectoryProvider()	Deprecated. use getComponentProvider(Class) or getComponentProvider(Class, String) instead
static IComponentProvider	getGlobalProvider()	Deprecated. use getComponentProvider(Class) or getComponentProvider(Class, String) instead
static IComponentProvider	getInstallProvider()	Deprecated. use getComponentProvider(Class) or getComponentProvider(Class, String) instead
static IComponentProvider	getMechanicsProvider()	Deprecated. use getComponentProvider(Class) or getComponentProvider(Class, String) instead
static IComponentProvider	getMetaProvider()	Deprecated. use getComponentProvider(Class) or getComponentProvider(Class, String) instead
static IComponentProvider	getNoodleProvider()	Deprecated. use getComponentProvider(Class) or getComponentProvider(Class, String) instead
static IPhaseProvider	getPhaseProvider()
static PortalSystem	getPortalSystem()	Get the singleton instance of the PortalSystem.
static IComponentProvider	getPortletProvider()	Deprecated. use getComponentProvider(Class) or getComponentProvider(Class, String) instead
static int	getState()	Get the state of the PortalSystem.
static String	getSystemProperty(String propertyName, String defaultValue)	Retrieve a system property.
static IComponentProvider	getTaskProvider()	Deprecated. use getComponentProvider(Class) or getComponentProvider(Class, String) instead
IURIResolver[]	getUriResolvers()	Get the array of currently registered IURIResolvers.
static IComponentProvider	getVersionProvider()	Deprecated. use getComponentProvider(Class) or getComponentProvider(Class, String) instead
static String	getVMID()
static IComponentProvider	getWebAppProvider()	Deprecated. use getComponentProvider(Class) or getComponentProvider(Class, String) instead
static IComponentProvider	getWebServiceProvider()	Deprecated. unsupported
static boolean	inDevMode()	Returns true if system is in development mode
protected void	init(String configLocation, IPhaseProvider phaseProvider)	The main startup for the PortalSystem.
static void	initGuestUser()
static boolean	inPreviewServerMode()
static boolean	isContainer()
static Boolean	isLibraryMode()
static boolean	isReady()
static boolean	isTELibrary()
static String	localizeMessage(Class<? extends ResourceBundle> resourceBundle, String messageKey, Object[] args, boolean includeMessageKeyPrefix)	Helper method to retrieve a localized message from a resource bundle
Object	lookup(IURI objectURI)	Look up an object in the system.
static void	main(String[] args)	The arg identifies the portal.properties (configLocation) for example: java com.webmethods.portal.system.PortalSystem file:/c:/portalminder/config/portal.properties
protected abstract void	persistSystemProperty(String key, String value)	Persist the property value to the long term storage
protected abstract void	registerAsService()
static void	removeComponentProvider(IComponentProvider provider)	Removes an IComponentProvider from the internal map.
static void	removeComponentProvider(String name)	Removes an IComponentProvider from the internal map.
void	removeURIResolver(IURIResolver newUriResolver)	Allows the acquireURI(java.lang.String) to be 'hooked' by other resolvers
IURI	resolveURIByPath(String value)	Attempts to resolve URI by given path to the object.
static void	setState(int state)	Set the state of the PortalSystem.
static void	setSystemProperty(String key, String value)	Set a system property.
void	setURIResolverServices(IURIResolver[] uriResolvers)	Sets the set of IURIResolver instances that were registered as OSGi services
void	shutdown()
static void	waitUntilReady(Runnable runnable)

Methods inherited from class java.lang.Object

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

Field Details

PORTAL_PROPERTY

protected static final String PORTAL_PROPERTY

See Also:

• Constant Field Values

DEFAULT_PROPERTY

protected static final String DEFAULT_PROPERTY

See Also:

• Constant Field Values

PERF_CAT_MANAGER

protected static final String PERF_CAT_MANAGER

See Also:

• Constant Field Values

UNINITIALIZED_STATE

public static final int UNINITIALIZED_STATE

The system hasn't begun initializing yet.

See Also:

• Constant Field Values

PRE_META_STATE

public static final int PRE_META_STATE

This is the point during initialization when no IMetaManager is available yet, because the PortalSystem is still initializing.

See Also:

• Constant Field Values

BOOTSTRAP_STATE

public static final int BOOTSTRAP_STATE

The system is in a pre-initialized 'bootstrap' state. This only occurs at one moment in the lifetime of a PortalSystem. This is the first time the PortalSystem ever starts, after the IMetaManager is initialized, but prior to the bootstrap Phase being executed.

See Also:

• Constant Field Values

INITIALIZING_STATE

public static final int INITIALIZING_STATE

The system is initializing and the MetaManager is available. This also assumes that we are not in the rare BOOTSTRAP_STATE.

See Also:

• Constant Field Values

READY_STATE

public static final int READY_STATE

The system is ready and initialized.

See Also:

• Constant Field Values

SHUTDOWN_STATE

public static final int SHUTDOWN_STATE

The system is shutting down.

See Also:

• Constant Field Values

PORTAL_SYSTEM_CLASS

public static final String PORTAL_SYSTEM_CLASS

Identifies which PortalSystem to use.

See Also:

• Constant Field Values

PHASE_PROVIDER_CLASS

public static final String PHASE_PROVIDER_CLASS

This is the phase provider that manages initializing the various phases of the product.

See Also:

• Constant Field Values

PERSISTENT_SYSTEM_PROPERTIES_KEY

public static final String PERSISTENT_SYSTEM_PROPERTIES_KEY

The key identifying persistent property storage.

See Also:

• Constant Field Values

PERSISTENT_SYSTEM_PROPERTIES_DEFAULT

public static final String PERSISTENT_SYSTEM_PROPERTIES_DEFAULT

Where the persistent properties are stored.

See Also:

• Constant Field Values

TOPIC_ROOT

public static final String TOPIC_ROOT

The root topic.

See Also:

• Constant Field Values

TOPIC_ADMIN

public static final String TOPIC_ADMIN

The Admin topic.

See Also:

• Constant Field Values

TOPIC_SYSTEM

public static final String TOPIC_SYSTEM

The System topic.

See Also:

• Constant Field Values

TOPIC_HELP

public static final String TOPIC_HELP

The Help topic.

See Also:

• Constant Field Values

FOLDER_ROOT

public static final String FOLDER_ROOT

The Root folder.

See Also:

• Constant Field Values

FOLDER_SYSTEM

public static final String FOLDER_SYSTEM

The System folder.

See Also:

• Constant Field Values

FOLDER_HELP

public static final String FOLDER_HELP

The Help folder.

See Also:

• Constant Field Values

FOLDER_XTYPES

public static final String FOLDER_XTYPES

The XTypes folder.

See Also:

• Constant Field Values

FOLDER_PORTLETS

public static final String FOLDER_PORTLETS

The XTypes Portlet folder.

See Also:

• Constant Field Values

FOLDER_PORTLET_INSTANCES

public static final String FOLDER_PORTLET_INSTANCES

The portlet instances folder.

See Also:

• Constant Field Values

FOLDER_TEMPLATES_MANAGEMENT

public static final String FOLDER_TEMPLATES_MANAGEMENT

The templates management folder.

See Also:

• Constant Field Values

FOLDER_USERS

public static final String FOLDER_USERS

The users folder.

See Also:

• Constant Field Values

FOLDER_XTYPE

public static final String FOLDER_XTYPE

The xtype folder.

See Also:

• Constant Field Values

FOLDER_THEMES

public static final String FOLDER_THEMES

The themes folder.

See Also:

• Constant Field Values

FOLDER_SKINS

public static final String FOLDER_SKINS

The skins folder.

See Also:

• Constant Field Values

FOLDER_DIRECTORY_SERVICE

public static final String FOLDER_DIRECTORY_SERVICE

The directory service folder.

See Also:

• Constant Field Values

FOLDER_CONTENT_SERVICE

public static final String FOLDER_CONTENT_SERVICE

The content service folder.

See Also:

• Constant Field Values

FOLDER_TEMPLATES

public static final String FOLDER_TEMPLATES

The templates folder.

See Also:

• Constant Field Values

FOLDER_PUBLIC

public static final String FOLDER_PUBLIC

The public folder.

See Also:

• Constant Field Values

TEMPLATE_BASIC

public static final String TEMPLATE_BASIC

The basic template.

See Also:

• Constant Field Values

TEMPLATE_EMPTY

public static final String TEMPLATE_EMPTY

The "empty" template.

See Also:

• Constant Field Values

TEMPLATE_THREE_COL

public static final String TEMPLATE_THREE_COL

The three column template.

See Also:

• Constant Field Values

TEMPLATE_USECORPGOV

public static final String TEMPLATE_USECORPGOV

The Corporate Governance template.

See Also:

• Constant Field Values

USER_CURRENT

public static final String USER_CURRENT

Alias for the current user. Only available if the webApplication is running.

See Also:

• Constant Field Values

USER_CURRENT_ROOT

public static final String USER_CURRENT_ROOT

Alias for the current user's root folder (contains user home and scrapbook). Only available if the webApplication is running.

See Also:

• Constant Field Values

USER_CURRENT_HOME

public static final String USER_CURRENT_HOME

Alias for the current user's home folder. Only available if the webApplication is running.

See Also:

• Constant Field Values

USER_CURRENT_START_PAGE

public static final String USER_CURRENT_START_PAGE

Alias for the current user's start page. Only available if the webApplication is running.

See Also:

• Constant Field Values

USER_CURRENT_FAVORITES

public static final String USER_CURRENT_FAVORITES

Alias for the current user's scrapbook. Only available if the webApplication is running.

See Also:

• Constant Field Values

USER_CURRENT_SAVED_SEARCHES

public static final String USER_CURRENT_SAVED_SEARCHES

Alias for the current user's saved search page. Only available if the webApplication is running.

See Also:

• Constant Field Values

USER_CURRENT_PROFILE

public static final String USER_CURRENT_PROFILE

Alias for the current user's profile. Only available if the webApplication is running.

See Also:

• Constant Field Values

CURRENT_RESOURCE

public static final String CURRENT_RESOURCE

The current resource. This is only valid in the context of the webApplication.

See Also:

• Constant Field Values

CURRENT_RESOURCE_TYPE

public static final String CURRENT_RESOURCE_TYPE

See Also:

• Constant Field Values

CURRENT_RESOURCE_PARENT

public static final String CURRENT_RESOURCE_PARENT

The current resource's parent. Note that some resources do not have parents. This is only valid in the context of the webApplication.

See Also:

• Constant Field Values

CURRENT_RESOURCE_ANCESTOR

public static final String CURRENT_RESOURCE_ANCESTOR

The current resource's ancestor to the specified step (current.resource.ancestor.1=parent, current.resource.ancestor.2=grandparent). This is only valid in the context of the webApplication.

See Also:

• Constant Field Values

PORTLET_PERMISSIONS

public static final String PORTLET_PERMISSIONS

Alias for the permissions portlet.

See Also:

• Constant Field Values

PORTLET_DEFAULT_ADMIN_PAGE

public static final String PORTLET_DEFAULT_ADMIN_PAGE

Alias for the default admin page portlet.

See Also:

• Constant Field Values

PORTLET_DEFAULT_PAGE

public static final String PORTLET_DEFAULT_PAGE

Alias for the default page portlet.

See Also:

• Constant Field Values

PORTLET_HEAD

public static final String PORTLET_HEAD

Alias for the head portlet.

See Also:

• Constant Field Values

PORTLET_DIRECTORY

public static final String PORTLET_DIRECTORY

Alias for the directory portlet.

See Also:

• Constant Field Values

PORTLET_FOLDERVIEW

public static final String PORTLET_FOLDERVIEW

Alias for the folderview portlet.

See Also:

• Constant Field Values

PORTLET_LEFTNAV

public static final String PORTLET_LEFTNAV

Alias for the leftnav (Content Manager) portlet.

See Also:

• Constant Field Values

PORTLET_LOCATIONS

public static final String PORTLET_LOCATIONS

Alias for the locations portlet.

See Also:

• Constant Field Values

PORTLET_LOGOUT

public static final String PORTLET_LOGOUT

Alias for the logout portlet.

See Also:

• Constant Field Values

PORTLET_PROPERTIES

public static final String PORTLET_PROPERTIES

Alias for the properties portlet.

See Also:

• Constant Field Values

PORTLET_PUBLISH

public static final String PORTLET_PUBLISH

Alias for the publish portlet.

See Also:

• Constant Field Values

PORTLET_TITLEBAR

public static final String PORTLET_TITLEBAR

Alias for the titlebar portlet.

See Also:

• Constant Field Values

PORTLET_UNI_PICKER

public static final String PORTLET_UNI_PICKER

Alias for the unipicker (Universal Picker) portlet.

See Also:

• Constant Field Values

PORTLET_USER_PROFILE

public static final String PORTLET_USER_PROFILE

Alias for the user profile portlet.

See Also:

• Constant Field Values

PORTLET_STREAMING_CONTENT_VIEWER

public static final String PORTLET_STREAMING_CONTENT_VIEWER

Alias for the streaming content viewer portlet.

See Also:

• Constant Field Values

PORTLET_ERROR_REPORT

public static final String PORTLET_ERROR_REPORT

Alias for the error report portlet.

See Also:

• Constant Field Values

TASK_ENGINE_LIBRARY_MODE

public static final String TASK_ENGINE_LIBRARY_MODE

System property indicating IBM webMethods BPM Task Engine is enabled in library mode

See Also:

• Constant Field Values

SERVER_HOME

public static final String SERVER_HOME

PORTAL_HOME

public static final String PORTAL_HOME

IN_MEMORY_INIT_MODE

public static final String IN_MEMORY_INIT_MODE

m_portalSystem

protected static PortalSystem m_portalSystem

A static singleton

m_componentProviders

protected static Map<String,IComponentProvider> m_componentProviders

This is the map of managers that implement the IComponentProvider interface

m_componentProviderNames

protected static Set<String> m_componentProviderNames

m_uriResolverList

protected List<IURIResolver> m_uriResolverList

A storage of IURIResolver

m_uriResolvers

protected IURIResolver[] m_uriResolvers

This is the IURIResolver that always gets first crack at calls to acquireURI(java.lang.String)

m_uriResolverServices

protected IURIResolver[] m_uriResolverServices

This is the IURIResolver that always gets first crack at calls to acquireURI(java.lang.String)

m_phaseProvider

protected IPhaseProvider m_phaseProvider

This is what initializes us through the various phases of the product.

m_state

protected int m_state

See Also:

• getState()

PORTAL_START_TIME

public static long PORTAL_START_TIME

m_VMID

protected static String m_VMID

Constructor Details

PortalSystem

public PortalSystem()

Default constructor used for reflection

Method Details

isContainer

public static boolean isContainer()

getContainerConfig

public static ContainerMetaInfo getContainerConfig()

getPortalSystem

public static PortalSystem getPortalSystem()

Get the singleton instance of the PortalSystem.

Returns:

the static instance of PortalSystem

getComponentProviders

public static Map<String,IComponentProvider> getComponentProviders()

Gets the map of all registered by name IComponentProviders. The map's keys are the names (java.lang.String) of the IComponentProvider. The map's values are the instances of IComponentProvider. Typically, you should use the convenience functions like getMechanicsProvider() instead of retrieving the map directly.

Returns:

a map of registered IComponentProviders.

See Also:

• m_componentProviders

getUriResolvers

public IURIResolver[] getUriResolvers()

Get the array of currently registered IURIResolvers.

Returns:

the m_uriResolvers

getComponentProvider

@Deprecated
public static IComponentProvider getComponentProvider(String componentProvider)

Deprecated.

use getComponentProvider(Class, String) instead

Retrieves the registered IComponentProvider after which you should cast to the specific interface requested.

Parameters:

componentProvider - the name of a registered IComponentProvider. It is highly recommended to use a named constant from IComponentProvider.

Returns:

the IComponentProvider or null if not found

getComponentProvider

public static <T extends IComponentProvider> T getComponentProvider(Class<T> componentProviderInterface)

Retrieves the registered IComponentProvider

Parameters:

componentProviderInterface - the interface of a registered IComponentProvider.

Returns:

the IComponentProvider or null if not found

getComponentProvider

public static <T extends IComponentProvider> T getComponentProvider(Class<T> componentProviderInterface,
 String name)

Retrieves the registered IComponentProvider

Parameters:

componentProviderInterface - the interface of a registered IComponentProvider.

Returns:

the IComponentProvider or null if not found

addComponentProvider

public static void addComponentProvider(String name,
 IComponentProvider cp)

Updates the map that holds the IComponentProviders. No other logic is performed.

Parameters:

name - The name of the component provider

cp - The IComponentProvider

See Also:

• getComponentProviders()
• removeComponentProvider(java.lang.String)

removeComponentProvider

public static void removeComponentProvider(String name)

Removes an IComponentProvider from the internal map.

Parameters:

name - The name of the component provider.

See Also:

• getComponentProviders()
• addComponentProvider(java.lang.String, com.webmethods.portal.system.IComponentProvider)

removeComponentProvider

public static void removeComponentProvider(IComponentProvider provider)

Removes an IComponentProvider from the internal map.

Parameters:

provider - The component provider.

See Also:

• getComponentProviders()
• addComponentProvider(java.lang.String, com.webmethods.portal.system.IComponentProvider)

getDirectoryProvider

@Deprecated
public static IComponentProvider getDirectoryProvider()

Deprecated.

use getComponentProvider(Class) or getComponentProvider(Class, String) instead

See Also:

• IDirSystem

getMetaProvider

@Deprecated
public static IComponentProvider getMetaProvider()

Deprecated.

use getComponentProvider(Class) or getComponentProvider(Class, String) instead

See Also:

• IMetaManager

getMechanicsProvider

@Deprecated
public static IComponentProvider getMechanicsProvider()

Deprecated.

use getComponentProvider(Class) or getComponentProvider(Class, String) instead

See Also:

• IMechanicsManager

getCommandProvider

@Deprecated
public static IComponentProvider getCommandProvider()

Deprecated.

use getComponentProvider(Class) or getComponentProvider(Class, String) instead

See Also:

• ICommandManager

getBizPolicyProvider

@Deprecated
public static IComponentProvider getBizPolicyProvider()

Deprecated.

use getComponentProvider(Class) or getComponentProvider(Class, String) instead

See Also:

• IBizPolicyManager

getContentProvider

@Deprecated
public static IComponentProvider getContentProvider()

Deprecated.

use getComponentProvider(Class) or getComponentProvider(Class, String) instead

See Also:

• IContentManager

getCacheProvider

@Deprecated
public static IComponentProvider getCacheProvider()

Deprecated.

use getComponentProvider(Class) or getComponentProvider(Class, String) instead

See Also:

• ICacheManager

getInstallProvider

@Deprecated
public static IComponentProvider getInstallProvider()

Deprecated.

use getComponentProvider(Class) or getComponentProvider(Class, String) instead

See Also:

• IInstallProvider

getPortletProvider

@Deprecated
public static IComponentProvider getPortletProvider()

Deprecated.

use getComponentProvider(Class) or getComponentProvider(Class, String) instead

See Also:

• IPortletProvider

getClassManager

@Deprecated
public static IComponentProvider getClassManager()

Deprecated.

use getComponentProvider(Class) or getComponentProvider(Class, String) instead

See Also:

• IClassManager

getAuditManager

@Deprecated
public static IComponentProvider getAuditManager()

Deprecated.

use getComponentProvider(Class) or getComponentProvider(Class, String) instead

See Also:

• com.webmethods.portal.service.classmanager.IAuditManager

getBundleManager

@Deprecated
public static IComponentProvider getBundleManager()

Deprecated.

use getComponentProvider(Class) or getComponentProvider(Class, String) instead

See Also:

• com.webmethods.portal.service.bundle.BundleManager

getTaskProvider

@Deprecated
public static IComponentProvider getTaskProvider()

Deprecated.

use getComponentProvider(Class) or getComponentProvider(Class, String) instead

getWebAppProvider

@Deprecated
public static IComponentProvider getWebAppProvider()

Deprecated.

use getComponentProvider(Class) or getComponentProvider(Class, String) instead

See Also:

• IWebApplication

getWebServiceProvider

@Deprecated
public static IComponentProvider getWebServiceProvider()

Deprecated.

unsupported

See Also:

• IWebService

getAppServerProvider

@Deprecated
public static IComponentProvider getAppServerProvider()

Deprecated.

unsupported

getClusterProvider

@Deprecated
public static IComponentProvider getClusterProvider()

Deprecated.

use getComponentProvider(Class) or getComponentProvider(Class, String) instead

See Also:

• IClusterProvider

getVersionProvider

@Deprecated
public static IComponentProvider getVersionProvider()

Deprecated.

use getComponentProvider(Class) or getComponentProvider(Class, String) instead

See Also:

• IVersionProvider

getContextProvider

@Deprecated
public static IComponentProvider getContextProvider()

Deprecated.

use getComponentProvider(Class) or getComponentProvider(Class, String) instead

See Also:

• IContextProvider

getGlobalProvider

@Deprecated
public static IComponentProvider getGlobalProvider()

Deprecated.

use getComponentProvider(Class) or getComponentProvider(Class, String) instead

See Also:

• IGlobalProvider

getNoodleProvider

@Deprecated
public static IComponentProvider getNoodleProvider()

Deprecated.

use getComponentProvider(Class) or getComponentProvider(Class, String) instead

See Also:

• com.webmethods.portal.noodle.INdlComponentProvider

getPhaseProvider

public static IPhaseProvider getPhaseProvider()

See Also:

• IPhaseProvider

localizeMessage

public static String localizeMessage(Class<? extends ResourceBundle> resourceBundle,
 String messageKey,
 Object[] args,
 boolean includeMessageKeyPrefix)

Helper method to retrieve a localized message from a resource bundle

Parameters:

resourceBundle - the bundle to get the message from

messageKey - the key of the message to retrieve

args - any args needed to complete the message (may be null)

includeMessageKeyPrefix - true to include the message key in the returned message, false otherwise

Returns:

a localized message

getState

public static int getState()

Get the state of the PortalSystem.

See Also:

• setState(int)
• UNINITIALIZED_STATE
• BOOTSTRAP_STATE
• INITIALIZING_STATE
• READY_STATE
• SHUTDOWN_STATE

setState

public static void setState(int state)

Set the state of the PortalSystem.

Parameters:

state - The state to set.

See Also:

• getState()
• UNINITIALIZED_STATE
• BOOTSTRAP_STATE
• INITIALIZING_STATE
• READY_STATE
• SHUTDOWN_STATE

lookup

public Object lookup(IURI objectURI)
              throws PortalException

Look up an object in the system. Determines which provider can handle this lookup request and delegates the call appropriately.

Parameters:

objectURI - the URI to the object

Returns:

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

Throws:

PortalException

exists

public boolean exists(IURI objectURI)
               throws PortalException

Checks if an items specified by objectURI exists in the system

Parameters:

objectURI - the URI to of an object

Returns:

Throws:

PortalException

acquireURI

public IURI acquireURI(String uri)
                throws PortalException

Retrieve the provider-specific implementation of IURI based on the URI information.

Specified by:

acquireURI in interface IURIResolver

Parameters:

uri - the String version of the URI

Returns:

the provider specific implementation of IURI

Throws:

PortalException - if the URI cannot be constructed or if the URI has an invalid syntax

acquireURI

public IURI acquireURI(String uri,
 boolean lookup)
                throws PortalException

Retrieve the provider-specific implementation of IURI based on the URI information.

Specified by:

acquireURI in interface IURIResolver

Parameters:

uri - the String version of the URI

lookup - boolean flag to enable lookup.

Returns:

the provider specific implementation of IURI

Throws:

PortalException - if the URI cannot be constructed or if the URI has an invalid syntax

actionInit

protected abstract Object actionInit(String category,
 String actionName)

Create action token to be used for perf monitoring

Parameters:

category - the action category

actionName - the action name

Returns:

the action token, or null if it could not be created

actionStart

protected abstract void actionStart(Object token)

Begin an action to be tracked using the supplied perf token

Parameters:

token - the perf token returned from actionInit(String, String)

actionEnd

protected abstract void actionEnd(Object token)

End an action to be tracked using the supplied perf token

Parameters:

token - the perf token returned from actionInit(String, String)

resolveURIByPath

public IURI resolveURIByPath(String value)
                      throws PortalException

Attempts to resolve URI by given path to the object. Path could be in a form:
/alias
/alias/ContainerName/.../ResourceName

Parameters:

value -

Returns:

the provider specific implementation of IURI

Throws:

PortalException - if the URI cannot be constructed or if the URI has an invalid syntax

addURIResolver

public void addURIResolver(IURIResolver newUriResolver)

Allows the acquireURI(java.lang.String) to be 'hooked' by other resolvers

Parameters:

newUriResolver -

See Also:

• acquireURI(java.lang.String)

removeURIResolver

public void removeURIResolver(IURIResolver newUriResolver)

Allows the acquireURI(java.lang.String) to be 'hooked' by other resolvers

Parameters:

newUriResolver -

See Also:

• acquireURI(java.lang.String)

setURIResolverServices

public void setURIResolverServices(IURIResolver[] uriResolvers)

Sets the set of IURIResolver instances that were registered as OSGi services

Parameters:

uriResolvers - the array of IURIResolver services to use

main

public static void main(String[] args)
                 throws Exception

The arg identifies the portal.properties (configLocation) for example: java com.webmethods.portal.system.PortalSystem file:/c:/portalminder/config/portal.properties

Parameters:

args - portal.properties

Throws:

Exception

doStartup

public static void doStartup(IPhaseProvider phaseProvider)
                      throws Exception

Perform the portalSystem startup logic

Parameters:

phaseProvider - (optional) existing phase provider to use instead of creating a new one

Throws:

Exception

initGuestUser

public static void initGuestUser()

registerAsService

protected abstract void registerAsService()

init

protected void init(String configLocation,
 IPhaseProvider phaseProvider)
             throws InitializationException

The main startup for the PortalSystem. Instantiates the correct initialization manager and initializes.

Parameters:

configLocation - The location of the bootstrap config stuff.

Throws:

InitializationException

shutdown

public void shutdown()

getSystemProperty

public static String getSystemProperty(String propertyName,
 String defaultValue)

Retrieve a system property. If it's not found then display a helpful message so people will know what they might have been looking for.

Parameters:

propertyName - The system property name to find.

defaultValue - The default value to return if the property isn't found.

Returns:

The value of the property if found, defaultValue otherwise

setSystemProperty

public static void setSystemProperty(String key,
 String value)
                              throws IOException

Set a system property. This will perform a couple of operations:

 1) It will set the system property: System.setProperty(java.lang.String, java.lang.String)
 2) It will persist the property to the registry
 3) It will fire an event
 

Parameters:

key - The name of the property to set.

value - The value to set the property to.

Throws:

IOException - if it can't save to the persistent system properties file.

persistSystemProperty

protected abstract void persistSystemProperty(String key,
 String value)
                                       throws IOException

Persist the property value to the long term storage

Parameters:

key - system property key

value - system property value

Throws:

IOException

inDevMode

public static boolean inDevMode()

Returns true if system is in development mode

Returns:

true if in development mode, false otherwise

inPreviewServerMode

public static boolean inPreviewServerMode()

getVMID

public static String getVMID()

waitUntilReady

public static void waitUntilReady(Runnable runnable)

isReady

public static boolean isReady()

fixMWSURI

public static String fixMWSURI(String uri)

removes context path from uri to be processed by other MWS apis.

Parameters:

uri -

Returns:

String

fixClientSideURI

public static String fixClientSideURI(String uri)

adds mws root context path to uri

Parameters:

uri -

Returns:

String

getContextPath

public static String getContextPath()

getComponentProviderNames

public static Set<String> getComponentProviderNames()

isLibraryMode

public static Boolean isLibraryMode()

isTELibrary

public static boolean isTELibrary()