Jump to: navigation, search

Aperi Extension Point: org.eclipse.aperi.agent.data.requestHandler

Request Handler

=== Identifier: === org.eclipse.aperi.agent.data.requestHandler

=== Since: === 0.2

=== Description: === The Request Handler extension point allows third party plug-ins to respond to requests from the Aperi server.

Configuration Markup:

<!ELEMENT requestHandler EMPTY>
<!ATTLIST requestHandler impl CDATA #REQUIRED>

  • impl - a fully qualified name of a Java class that implements the interface org.eclipse.aperi.agent.handler.IAgentRequestHandler

<\!ELEMENT extension (requestHandler)>
<\!ATTLIST extension point CDATA
#REQUIRED id    CDATA
#REQUIRED name  CDATA #IMPLIED>

  • point - a fully qualified identifier of the target extension point
  • id - a unique identifier of the extension instance
  • name - an optional name of the extension instance

=== API Information: === Value of the attribute impl must be a fully qualified name of a Java class that implements the interface org.eclipse.aperi.agent.handler.IAgentRequestHandler.

Supplied Implementation:

HandlerExtensionMgr
public Object getExtensionImpl(String extensionId, boolean useCache);

This method should be called when attempting to obtain a reference to an extension implementation. Extensions will not be loaded until this method is called. If the useCache argument is true, this method will first check the cache associated with the extension manager. If either the useCache argument is false, or an implementation object could not be found in the extension manager, the extension registry will be searched. Once found, the reference will be cached if the useCache argument is true.

If the extension is removed from the runtime environment (extending plug-in is removed), the cache will be updated to reflect the removal.

Aperi Storage Manager (C) Copyright IBM Corp. 2006 All rights reserved. This program and the accompanying materials are made available under the terms of the Eclipse Public License v1.0 which accompanies this distribution, and is available at http://www.eclipse.org/legal/epl-v10.html