com.bea.alsb.resources.custom
Interface ResourceProvider

public interface ResourceProvider

Represents the central point for management of custom resource configuration. It is used to handle provider specific information of the resource.

Method Summary

String	getDisplayName(Locale locale) This method returns the localized display name for the resource identifier is the specified locale.
ResourceProviderConfiguration	getProviderConfiguration() Method used to get the provider configuration for a resource provider.
String	getTypeId() This method returns a unique string identifying this resource.
ResourceUIBinding	getUIBinding(Locale locale) Called when a resource is being created or edited to get the provider-specific UI binding object for the specified locale.The UI binding object is used to render the resource provider configuration page.
ResourceInstanceData	parse(byte[] binary) Construct an instance of ResourceInstanceData from its binary representation.

Method Detail

getTypeId

String getTypeId()

This method returns a unique string identifying this resource.

Returns:

a unique string identifying this resource, like “myResource”

getDisplayName

String getDisplayName(Locale locale)

This method returns the localized display name for the resource identifier is the specified locale.

Parameters:

locale - the desired locale to display the resource name

Returns:

a localized display name for this resource, like “My Resource”

getProviderConfiguration

ResourceProviderConfiguration getProviderConfiguration()
                                                       throws CustomResourceException

Method used to get the provider configuration for a resource provider. The provider configuration is an XL document that conforms to a schema published by ALSB to supply provider-specific static configuration attributes like environment values, search-keys etc.Please refer to the ResourceConfiguration.xsd file for details.

Returns:

ResourceProviderConfiguration containing the provider configuration data

Throws:

CustomResourceException - on error

getUIBinding

ResourceUIBinding getUIBinding(Locale locale)
                               throws CustomResourceException

Called when a resource is being created or edited to get the provider-specific UI binding object for the specified locale.The UI binding object is used to render the resource provider configuration page.

Parameters:

locale - the locale information

Returns:

a ResourceUIBinding object

Throws:

CustomResourceException - in case of any errors

parse

ResourceInstanceData parse(byte[] binary)
                           throws CustomResourceException

Construct an instance of ResourceInstanceData from its binary representation.

Parameters:

binary - the binary representation of the ResourceInstanceData

Returns:

the constructed ResourceInstanceData object

Throws:

CustomResourceException - in case of errors