Skip navigation links

Oracle Fusion Middleware Java API Reference for Oracle Service Bus
11g Release 1 (11.1.1.5.0)

E15033-03


com.bea.wli.sb.transports
Interface TransportCustomBindingProvider


public interface TransportCustomBindingProvider

Represents a class responsible for facilitating in generating the extensible elements of SOAP binding or all the elements of custom BEA (OSB) binding used during generation of effective WSDL for WSDL-based transports.

The object can facilitate in generation of following information:

  1. transport attribute value (Transport URI) for <soap:binding> element of SOAP binding for all transports.
  2. location attribute value for <soap:address/> element of SOAP binding for all transports.
  3. All elements of <bea:binding/>.

This is an option interface to implement. Non WSDL transports need not implement it. Also WSDL transports may skip implementing it. In that case OSB will generate defaults for every element described above. Refer to OSB documentation for specifics on the defaults.

Just have your TransportProvider implementation class implement this interface as well. No separate registration needed.

Since:
3.0
See Also:
TransportProvider

Method Summary
 java.util.List<java.lang.String> getEndPointAddress(EndPointConfiguration endpoint, BindingTypeInfo.BindingTypeEnum bindingType, Ref serviceRef)
          Gets the end point address for the port configured for the given endpoint and binding type.
 java.lang.String getIdentifierURI(EndPointConfiguration endpoint, BindingTypeInfo.BindingTypeEnum bindingType, Ref serviceRef)
          Gets the unique transport URI for this transport.

 

Method Detail

getIdentifierURI

java.lang.String getIdentifierURI(EndPointConfiguration endpoint,
                                  BindingTypeInfo.BindingTypeEnum bindingType,
                                  Ref serviceRef)
Gets the unique transport URI for this transport. This method is called when generating effective wsdl per service using this transport.

The namespace could differ depending on the data format binding, e.g. SOAP or XML.

If the method does return null or the transport provider does not implement this interface then the system will use default using the following logic.

Parameters:
endpoint - the endpoint configuration for which the transport URI is required.
bindingType - metadata about the desired binding @return the unique transport URI. If null default value will be inserted.
serviceRef - service reference may be null. The system will pass in this value whenever avaialable. Sometimes (e.g. during offline design time) the service resource may not have been saved yet so this could be null. Be careful when using it.

getEndPointAddress

java.util.List<java.lang.String> getEndPointAddress(EndPointConfiguration endpoint,
                                                    BindingTypeInfo.BindingTypeEnum bindingType,
                                                    Ref serviceRef)
Gets the end point address for the port configured for the given endpoint and binding type. This method is responsible to evaluate any expressions in the end point address of the service configured and return the final absolute end point address. This method is called when generating effecrive wsdl per service using this transport.

For proxy service ONLY the first address of the list is used. OSB will generate one port address element under the service element using the first address of the list for the proxy service.

For business service the method can return more than one end point address. OSB will generate one port address element under service element per address returned by this method for business service.

If the method does return null or the transport provider does not implement this interface then the system will use defaults.
For proxy service the system just uses the first end point uri on the end point configuration. For business service the system uses all the end point uris on the end point configuration.

Parameters:
endpoint - the endpoint configuration for which the URI is to be generated.
bindingType - metadata about the desired binding
serviceRef - service reference may be null. The system will pass in this value whenever avaialable. Sometimes (e.g. during offline design time) the service resource may not have been saved yet so this could be null. Be careful when using it.
Returns:
List of string contain the end point address. For proxy service only the first element is used and for business service list can be of size >= 1. If return is null or empty defaults will be applied.

Skip navigation links

Oracle Fusion Middleware Java API Reference for Oracle Service Bus
11g Release 1 (11.1.1.5.0)

E15033-03


Copyright © 2008, 2011, Oracle. All rights reserved.