|
WebLogic Integration | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--com.bea.wlpi.common.plugin.InfoObject
Abstract base class for all plugin metadata objects. Applications, and the
server-side plugin runtime framework request plugin metadata for a specified
locale, enabling a plugin to localize display strings and other resources
appropriately. Every plugin is required to provide a globally unique
internal identifier for itself, formed by appending one or more
dot-separated strings to the vendor's reverse DNS name (for example,
com.somedomain.someproduct.WLPIPlugin
). InfoObject
subclasses of which a plugin can provide multiple instances require a
plugin-assigned identifier, which must be unique within the plugin/subclass
combination. Plugins provide localized names and descriptions for the
features they offer. They also specify the names of plugin-provided classes
that implement the design-time and run-time behavior of these features.
Field Summary | |
protected java.lang.String[] |
classNames
An array containing the fully qualified Java class names of the plugin-provided implementation classes and customizers for this object type. |
protected java.lang.String |
description
The localized description of this InfoObject . |
protected int |
ID
The plugin-assigned ID for this InfoObject (unique within
this plugin and subclass). |
protected java.lang.String |
name
The localized name of this InfoObject . |
protected java.lang.String |
pluginName
The unique name of the plugin providing this InfoObject . |
Constructor Summary | |
protected |
InfoObject(java.lang.String pluginName,
int ID,
java.lang.String name,
java.lang.String description,
java.lang.String[] classNames)
Create a new InfoObject . |
Method Summary | |
int |
compareTo(java.lang.Object o)
Compare two InfoObject objects. |
boolean |
equals(java.lang.Object obj)
Test two InfoObject objects for equality. |
java.lang.String |
getClassName(int key)
Return the fully qualified name of a plugin-supplied Java class or resource. |
java.lang.String |
getDescription()
Return the localized description. |
int |
getID()
Return the unique plugin-supplied identifier for this InfoObject. |
java.lang.String |
getName()
Return the localized name for this information. |
java.lang.String |
getPluginName()
Return the name of the plugin providing this information. |
static byte[] |
imageStreamToByteArray(java.io.InputStream inputStream)
Construct a byte array from an InputStream, that represents an image file. |
java.lang.String |
toString()
Return a string representation of this InfoObject. |
Methods inherited from class java.lang.Object |
clone,
finalize,
getClass,
hashCode,
notify,
notifyAll,
wait,
wait,
wait |
Field Detail |
protected java.lang.String pluginName
InfoObject
.protected int ID
InfoObject
(unique within
this plugin and subclass).protected java.lang.String name
InfoObject
.protected java.lang.String description
InfoObject
.protected java.lang.String[] classNames
Constructor Detail |
protected InfoObject(java.lang.String pluginName, int ID, java.lang.String name, java.lang.String description, java.lang.String[] classNames)
InfoObject
.
pluginName
- The reverse-DNS name of the plugin supplying this
InfoObject
.ID
- The unique plugin-supplied identifier for this
InfoObject
.name
- The localized name of this InfoObject
.description
- A localized descriptive note about this
InfoObject
.classNames
- Array to identify plugin-supplied classes related to
this InfoObject
. The array contains one entry for each of
the KEY_*
values listed in the subclass. The value for each
entry is the corresponding fully qualified Java class name. Some
subclasses use this array for filenames rather than class names.Method Detail |
public final java.lang.String getPluginName()
public final int getID()
public final java.lang.String getName()
public final java.lang.String getDescription()
public final java.lang.String getClassName(int key)
PluginData
interface
(read/write support as required by design-time clients), and objects
that implement the PluginObject
interface (read-only support as
required by the runtime engine).
Plugins require no client-side installation or configuration - these
classes and their instances are all downloaded dynamically using the RMI
ClassLoader. The design-time client and run-time engine call the
PluginManager.getPluginObject(java.lang.String, java.lang.String, java.util.Locale)
method
to retrieve instances of the implementation/customizer/serializer
classes described by the corresponding InfoObject.
key
- Classname key, defined by subclasses of InfoObject.key
parameter
lies outside the range supported by this information type.public java.lang.String toString()
public boolean equals(java.lang.Object obj)
InfoObject
objects for equality.
obj
- Object with which to compare this one.true
if obj
is an instance of
InfoObject
with the same description as this one.compareTo(java.lang.Object)
public int compareTo(java.lang.Object o)
InfoObject
objects.
o
- Object with which to compare this one.description
members using the String.compareTo(Object)
method.o
parameter is not
of a compatible class.equals(java.lang.Object)
public static final byte[] imageStreamToByteArray(java.io.InputStream inputStream) throws java.io.IOException
inputStream
- An InputStream object to construct from.
|
WebLogic Integration | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |