Package com.webmethods.portal.framework

Class Handler

java.lang.Object

com.webmethods.portal.system.BaseComponent

com.webmethods.portal.framework.Handler

All Implemented Interfaces:

IHandler, IComponent, IConstants, IInitializable, ISystemHandler

public class Handler
extends BaseComponent
implements IHandler

Base implementation of IHandler

Field Summary

Fields

Modifier and Type	Field	Description
protected Object	m_perfToken
static final String	PERF_CAT_HANDLER

Fields inherited from class com.webmethods.portal.system.BaseComponent

m_componentData, m_componentProvider, m_isInitialized, m_uri

Fields inherited from interface com.webmethods.portal.system.IConstants

ALL_CRITERIA, CATEGORY_TAG, CLASS, COMPONENT_TAG, COMPONENTS_TAG, CONFIG, CONFIG_FILE, CONFIG_TAG, CRITERION, DATACHANNEL_NONE, DEFAULT, DEFAULT_JAVA_HEAP_SIZE, DELIV_METHOD, DESCRIPTION, EMPTY_STRING, ENABLED, FALSE, FOLDER_TYPE, FORWARD_SLASH, FRAMEWORK_ACCESS_MODEL, FRAMEWORK_DEV_MODE, FRAMEWORK_EDITOR_CONFIG, FRAMEWORK_JAVA_COMMAND_LINE, FRAMEWORK_JAVA_COMPILER, FRAMEWORK_JAVA_HEAP_SIZE, GROUPID, ID_NAME, INFO, INIT_FILE, INIT_FILE_ENABLED, INIT_ONLY_MODE, LIBRARY_MODE, NAME, NOTIFICATION_IDS, OWNERID, PAGE_SIZE, PARAM_STRING, PERMISSIVE_MODEL, PHASE_TAG, PHASEINFO_TAG, PHASES_TAG, PROVIDER_TAG, PROVIDERS_TAG, REMOTE_OBJECT_BODY, RESOURCE_URI, RESTRICTIVE_MODEL, SPACE, START_INDEX, SYSTEM_PATH_CLASSES, SYSTEM_PATH_CONFIG, SYSTEM_PATH_DATA, SYSTEM_PATH_DEPLOY, SYSTEM_PATH_HOME, SYSTEM_PATH_INSTALL, SYSTEM_PATH_LIB, SYSTEM_PATH_LOGS, SYSTEM_PATH_PREFIX, SYSTEM_PATH_SCRIPTS, SYSTEM_PATH_SYSTEMLIB, SYSTEM_PATH_TEMPCLASSES, SYSTEM_PATH_WEBINF, SYSTEM_PATH_WEBROOT, TAG_BR, TEXT_HTML, TEXT_IPL, TEXT_PLAIN, TEXT_XML, TRUE, TYPE, URL_NAME, VALUE, XTYPE_NAME

Constructor Summary

Constructors

Constructor	Description
Handler()

Method Summary

Modifier and Type	Method	Description
protected void	createPerfToken(IComponentData componentData)
Element	getConfigElem()	Deprecated. instead use BaseComponent.getComponentData()
IHandlerBean	getHandlerBean()
String	getName()	Deprecated. instead use BaseComponent.getComponentName()
Object	getPerfToken()
void	initialize(IManager manager, Element configElem, String name)	Deprecated. You should override standard component init() method instead.
void	postInitialize()	This allows various managers and handlers get references to each other
void	setComponentProvider(IComponentProvider componentProvider)	This should only be used by IComponentProviders and only under extreme caution
void	shutdown()	Allows your component to shutdown This will clear the data structures, so do your work first

Methods inherited from class com.webmethods.portal.system.BaseComponent

activate, bindGlobalProvider, deactivate, getComponentData, getComponentName, getComponentProvider, getGlobalProvider, getURI, init, isInitialized, setComponentData

Methods inherited from class java.lang.Object

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

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

getComponentData, getComponentName, getComponentProvider, getURI, isInitialized, setComponentData

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

init

Field Details

PERF_CAT_HANDLER

public static final String PERF_CAT_HANDLER

See Also:

• Constant Field Values

m_perfToken

protected Object m_perfToken

Constructor Details

Handler

public Handler()

Method Details

createPerfToken

protected void createPerfToken(IComponentData componentData)

Parameters:

componentData -

Throws:

InitializationException

setComponentProvider

public void setComponentProvider(IComponentProvider componentProvider)

Description copied from class: BaseComponent

This should only be used by IComponentProviders and only under extreme caution

Specified by:

setComponentProvider in interface IComponent

Overrides:

setComponentProvider in class BaseComponent

initialize

public void initialize(IManager manager,
 Element configElem,
 String name)
                throws FrameworkInitException

Deprecated.

You should override standard component init() method instead.

initialize this handler

Specified by:

initialize in interface IHandler

Parameters:

manager - is the manager for this particular handler

configElem - is the configuration element for this handler NB: should only be called internally

Throws:

FrameworkInitException

shutdown

public void shutdown()

Description copied from class: BaseComponent

Allows your component to shutdown This will clear the data structures, so do your work first

Specified by:

shutdown in interface IHandler

Specified by:

shutdown in interface IInitializable

Overrides:

shutdown in class BaseComponent

See Also:

• IInitializable.shutdown()

postInitialize

public void postInitialize()
                    throws InitializationException

This allows various managers and handlers get references to each other

Specified by:

postInitialize in interface IHandler

Throws:

InitializationException

getConfigElem

public Element getConfigElem()

Deprecated.

instead use BaseComponent.getComponentData()

Gets the config element for this handler

Specified by:

getConfigElem in interface IHandler

getName

public String getName()

Deprecated.

instead use BaseComponent.getComponentName()

returns this IHandler's name

Specified by:

getName in interface IHandler

getPerfToken

public Object getPerfToken()

Specified by:

getPerfToken in interface IHandler

See Also:

• PerfUtil

getHandlerBean

public IHandlerBean getHandlerBean()
                            throws FrameworkException

Specified by:

getHandlerBean in interface IHandler

Returns:

IHandlerBean for this Handler if valid, NULL otherwise

Throws:

FrameworkException