com.bea.alsb.resources.ui

Interface ResourceUIBinding

public interface ResourceUIBinding

Designed for the resource provider to construct configuration page for provider specific configuration properties.

Method Summary

Modifier and Type	Method and Description
EditField[]	getEditPage(ResourceInstanceData config) Called when a resource is being created or edited to get provider-specific contents of the edit pane for resource configuration.
ResourceInstanceData	getProviderSpecificConfiguration(EditField[] fields) Creates the Resource Provider Specific configuration from the UI form.
ViewField[]	getViewPage(ResourceInstanceData config) Called when the resource details are being viewed in read-only mode to get the contents of the summary pane for resource configuration
EditField[]	updateEditPage(EditField[] fields, java.lang.String name) Called when a resource is being created or edited to get contents of the edit pane for the resource configuration.
UIError[]	validateProviderSpecificForm(EditField[] fields) Validate the provider specific parameters on the UI form.

Method Detail

getEditPage

EditField[] getEditPage(ResourceInstanceData config)
                 throws CustomResourceException

Called when a resource is being created or edited to get provider-specific contents of the edit pane for resource configuration. When configuration page is rendered for create, the config parameter is set to null; when the page is rendered for edit, the provider should use the config parameter to initialize the edit page.

Parameters:

config - The resource configuration

Returns:

array of edit fields along with their default values to be used by OSB console to render the provider-specific page

Throws:

CustomResourceException - in case of errors

updateEditPage

EditField[] updateEditPage(EditField[] fields,
                           java.lang.String name)
                    throws CustomResourceException

Called when a resource is being created or edited to get contents of the edit pane for the resource configuration. This method is called each time the event for the field of the given name is triggered. The rest of the fields can be updated accordingly.

Parameters:

fields - current set of edit fields for this page

name - name of the field being updated

Returns:

updated set of edit fields to be rendered

Throws:

CustomResourceException - in case of errors

getViewPage

ViewField[] getViewPage(ResourceInstanceData config)
                 throws CustomResourceException

Called when the resource details are being viewed in read-only mode to get the contents of the summary pane for resource configuration

Parameters:

config - the resource configuration

Returns:

array of viewable fields for rendering on the summary page

Throws:

CustomResourceException - in case of errors

validateProviderSpecificForm

UIError[] validateProviderSpecificForm(EditField[] fields)

Validate the provider specific parameters on the UI form.

Parameters:

fields - array of current edit fields with their respective values

Returns:

array of validation errors, if any

getProviderSpecificConfiguration

ResourceInstanceData getProviderSpecificConfiguration(EditField[] fields)
                                               throws CustomResourceException

Creates the Resource Provider Specific configuration from the UI form.

Parameters:

fields - array of edit fields along with their respective values

Returns:

ResourceInstanceData that represents the resource configuration

Throws:

CustomResourceException - in case of error