com.bea.wli.sb.transports.ui

Interface TransportUIBinding

All Known Subinterfaces:

SelfDescribedTransportUIBinding

public interface TransportUIBinding

Represents an object responsible for rendering provider-specific UI pages used during the service definition, summary, as well as validation of provider-specific endpoint configuration.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	PARAM_LOAD_BALANCING
static java.lang.String	PARAM_URI

Method Summary

Methods

Modifier and Type	Method and Description
TransportEditField[]	getEditPage(EndPointConfiguration config, BindingTypeInfo binding) Called at service definition time to get provider-specific contents of the edit pane for endpoint configuration.
TransportUIGenericInfo	getGenericInfo() Called at service definition time to provide information that is provider specific for the main transport page.
XmlObject	getProviderSpecificConfiguration(TransportEditField[] fields) creates the Transport Provider Specific configuration from the UI form.
TransportViewField[]	getViewPage(EndPointConfiguration config) Called at the time the service details are viewed in read-only mode to get the contents of the summary pane for endpoint configuration
boolean	isServiceTypeSupported(BindingTypeInfo binding) Called at service definition time by OSB console to determine whether or not this provider supports the given type of service (SOAP, Messaging, XML, etc.)
TransportEditField[]	updateEditPage(TransportEditField[] fields, java.lang.String name) Called at service definition time to get contents of the edit pane for endpoint configuration.
TransportUIError[]	validateMainForm(TransportEditField[] fields) validate the generic transport endpoint parameters in the request, such as URI and report any validation error on the UI form.
TransportUIError[]	validateProviderSpecificForm(TransportEditField[] fields) validate the provider-specific transport endpoint parameters in the request, such as URI and report any validation error on the UI form.

Field Detail

PARAM_URI

static final java.lang.String PARAM_URI

See Also:

Constant Field Values

PARAM_LOAD_BALANCING

static final java.lang.String PARAM_LOAD_BALANCING

See Also:

Constant Field Values

Method Detail

isServiceTypeSupported

boolean isServiceTypeSupported(BindingTypeInfo binding)

Called at service definition time by OSB console to determine whether or not this provider supports the given type of service (SOAP, Messaging, XML, etc.)

Parameters:

binding - the type of service

Returns:

whether or not this provider supports this service binding type

getGenericInfo

TransportUIGenericInfo getGenericInfo()

Called at service definition time to provide information that is provider specific for the main transport page. This includes information like URI hints and autofill field data.

Returns:

a set of generic properties for this transport provider to be used by OSB console when rendering the generic transport page

getEditPage

TransportEditField[] getEditPage(EndPointConfiguration config,
                               BindingTypeInfo binding)
                                 throws TransportException

Called at service definition time to get provider-specific contents of the edit pane for endpoint configuration. This method is called when the transport configuration page is first rendered.

Parameters:

config - service endpoint configuration

binding - service binding type

Returns:

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

Throws:

TransportException

updateEditPage

TransportEditField[] updateEditPage(TransportEditField[] fields,
                                  java.lang.String name)
                                    throws TransportException

Called at service definition time to get contents of the edit pane for endpoint configuration. This method is called each time the event for the field of the given name is triggered. The set of field 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:

TransportException

getViewPage

TransportViewField[] getViewPage(EndPointConfiguration config)
                                 throws TransportException

Called at the time the service details are viewed in read-only mode to get the contents of the summary pane for endpoint configuration

Parameters:

config - service endpoint configuration

Returns:

array of viewable fields for rendering on the summary page

Throws:

TransportException

validateMainForm

TransportUIError[] validateMainForm(TransportEditField[] fields)

validate the generic transport endpoint parameters in the request, such as URI and report any validation error on the UI form.

Parameters:

fields - array of current edit fields with their respective values

Returns:

array of validation errors, if any

validateProviderSpecificForm

TransportUIError[] validateProviderSpecificForm(TransportEditField[] fields)

validate the provider-specific transport endpoint parameters in the request, such as URI and report any validation error on the UI form.

Parameters:

fields - array of current edit fields with their respective values

Returns:

array of validation errors, if any

getProviderSpecificConfiguration

XmlObject getProviderSpecificConfiguration(TransportEditField[] fields)
                                           throws TransportException

creates the Transport Provider Specific configuration from the UI form. This methods will be called only upon a successfull call to validateMainForm(com.bea.wli.sb.transports.ui.TransportEditField[]) and validateProviderSpecificForm(com.bea.wli.sb.transports.ui.TransportEditField[])

Parameters:

fields - array of edit fields along with their respective values

Returns:

XMLBean that represents provider specific portion of the service endpoint configuration.

Throws:

TransportException