The gadget registry is holds information about each gadget in a portal. This file resides in the WEB-INF folder of the portal's web application.
Each gadget must be registered in the registry before it can be used.
| Name | Type | Required | Description |
| id | attribute | yes | The ID for the gadget. This must be unqiue to the gadget. Used throught the engine to identify the gadget. |
| requires_authentication | attribute | yes | If this is set to "true" then a user must be logged into to see this gadget. |
| removable | attribute | no | If this is set to "true" then the gadget can be removed by a user. Defaults to "false" and is only valid if requires_authentication is set to "true". |
| minimisable | attribute | no | If this is set to "true" then the gadget can be minimised by the user. Defaults to "false" and is only valid if requires_authentication is set to "true". |
| title | element | yes | The title of the gadget display on the portal page |
| content_url | element | yes | The URL to where JSP page that makes up the body of the gadget. Must start with a / and be relative to the root of the portal's web application. |
| layout_constraint | element | yes | The default layout contsriant for the gadget. Thsi is used by the layout manager to position the gadget on the user's page. |
| action_url | element | yes (if auth required) | This is the URL that all the icons on the gadgets title bar link to. These links pass in the gadget ID (gadgetId) and the either minimise, maximise or remove. |
| required_resource | element | yes (if auth required) | This is the resource that is required by the user before then can see this gadget. |
The following is a sample gadget registry.
<?xml version="1.0"?> <gadgets> <gadget id="login" requires_authentication="false"> <title>Login</title> <content_url>/gadget/login.jsp</content_url> <layout_constraint>0 0</layout_constraint> </gadget> <gadget id="info" requires_authentication="true" removable="false" minimisable="true"> <title>Information</title> <content_url>/gadget/info.jsp</content_url> <action_url>gadget_action.jsp</action_url> <layout_constraint>0 0</layout_constraint> <required_resource>gadget.info</required_resource> </gadget> </gadgets>