|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Completely describes the behavior of a sharedlet during deployment. This is essentially the deployment configuration file for the sharedlet and will be converted into an XML based configuration file in the near future.
The info file describes how the sharedlet is to be run in the environment and will be instantiated by sharedlet containers first. After the container examines the info files, it will then proceed to instantiate sharedlet instances according to the parameters specified within the SharedletInfo structure.
All sharedlet info classes must have the same name as the sharedlet + "Info" if the developers are implementing their own sharedlet instance. For example, a WhiteboardSharedlet must have a WhiteboardSharedletInfo class.
During the packaging of a sharedlet into a jar file, the MANIFEST file must contain the entry:
Name: <Sharedlet Info class name>
Sharedlet: true
for the sharedlet to be recognized by the container.
Method Summary | |
java.util.Vector |
getCapabilities()
A complete list of capabilities that this sharedlet supports. |
java.lang.String |
getDescription()
Contains a short description of the sharedlet. |
java.util.Vector |
getLogicInfos()
A complete list of the sharedlet session logic info instances. |
java.lang.String |
getMIMEType()
Each sharedlet must have a unique MIME type that differentiate itself from other sharedlets. |
java.util.Vector |
getModeratableInfos()
A complete list of moderatable elements that are configured for a particular deployment. |
java.util.Vector |
getRoleInfos()
A complete list of roles that this sharedlet support. |
java.lang.String[] |
getSupportedDocumentTypes()
The list of document types that this sharedlet supports. |
double |
getVersion()
The version number of this sharedlet. |
java.util.Vector |
getViewInfos()
A complete list of sharedlet view info classes. |
Method Detail |
public java.lang.String getMIMEType()
application/x-sharedlet-
public java.lang.String getDescription()
public double getVersion()
public java.util.Vector getViewInfos()
SharedletViewInfo
public java.util.Vector getLogicInfos()
public java.util.Vector getCapabilities()
Each sharedlet would then check with the CapabiliitesManager during run time to see if a particular capability is enabled in the currently inocation and handle permissions accordingly.
Capabilities are used hand in hand with ModeratableElement's and Role's.
Capabilities should be of type String.
public java.util.Vector getRoleInfos()
When a sharedlet is invoked for a particular, one of the roles will be assigned to the sharedlet by the framework. The sharedlet developer only has to worry about checking with the CapabilitiesManager to see which underlying capabilities are enabled and disabled.
public java.util.Vector getModeratableInfos()
This information is used primarily to automatically generate a list of moderatable commands that a user has access to. Another sharedlet or framework service will provide automatic moderation capabilities based on this set of moderatable elements.
public java.lang.String[] getSupportedDocumentTypes()
Are all valid document types. The Sharedlet's Sharedlet.loadDocument(URL) will be invoked by the framework if the document referred to URL is supported by this sharedlet and another program/sharedlet has requested the document be launched using the LauncherService.launchDocument(URL).
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |