|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface TransportProvider
Represents the central point for management of transport protocol-specific configuration and runtime properties. There is a single instance of TransportProvider object for every supported protocol, e.g. there is a single instance of HTTP Transport Provider, JMS Transport Provider, etc.
Method Summary | |
---|---|
void |
activationComplete(EndPointOperations.CommonOperation context)
called once per every create/update/delete/suspend/resume call to signal that the activate action has completed with respect to the corresponding endpoint object Does not imply success or failure of the overall session activation! The provider is not allowed to throw exceptions as there is no way to recover at this point. |
TransportEndPoint |
createEndPoint(EndPointOperations.Create context)
Create and deploy an outbound or inbound endpoint on this server The semantics of this operation is as follows: prepare whatever is necessary for this endpoint to be operational, but it cannot process messages on this until a activationComplete() call has been received. |
void |
deleteEndPoint(EndPointOperations.Delete context)
Delete an endpoint associated with the given service reference |
Map<String,String> |
getBusinessServicePropertiesForProxy(Ref ref)
Given a proxy service reference returns a map of string properties that contains name/value pairs which are all the necessary provider-specific attributes for a business service object to be instantiated (on a different ALSB domain) that can invoke this proxy service. |
TransportEndPoint |
getEndPoint(Ref ref)
|
org.apache.xmlbeans.SchemaType |
getEndPointConfigurationSchemaType()
|
Collection<? extends TransportEndPoint> |
getEndPoints()
|
Collection<NonQualifiedEnvValue> |
getEnvValues(Ref ref,
EndPointConfiguration epConfig)
Transport providers return any environment dependent values via this call. |
Collection<Ref> |
getExternalReferences(EndPointConfiguration epConfig)
Returns a collection of external references for a given end point configuration This is called by the configuration framework |
String |
getId()
|
TransportProviderConfiguration |
getProviderConfiguration()
|
org.apache.xmlbeans.XmlObject |
getProviderSpecificConfiguration(Ref ref,
Map<String,String> props)
Given a map of properties object from one ALSB domain returns a transport endpoint configuration that can be used to instantiate a business service on another ALSB domain. |
org.apache.xmlbeans.SchemaType |
getRequestHeadersSchemaType()
|
org.apache.xmlbeans.SchemaType |
getRequestMetaDataSchemaType()
|
org.apache.xmlbeans.SchemaType |
getResponseHeadersSchemaType()
|
org.apache.xmlbeans.SchemaType |
getResponseMetaDataSchemaType()
|
TransportUIBinding |
getUIBinding(TransportUIContext context)
Called at service definition time to get the provider-specific binding object that validates provider-specific properties are present in the UI context. |
void |
resumeEndPoint(EndPointOperations.Resume context)
Resumes (Re-enables) a previously suspended endpoint with the given service reference |
void |
sendMessageAsync(TransportSender sender,
TransportSendListener listener,
TransportOptions options)
Sends an outbound message to an external service. |
void |
setEnvValues(Ref ref,
EndPointConfiguration epConfig,
Collection<NonQualifiedEnvValue> envValues)
Sets the given collection of environment values in the data. |
void |
setExternalReferences(Map<Ref,Ref> mapRefs,
EndPointConfiguration epConfig)
Sets the external references for a given endpoint configuration in place. |
void |
shutdown()
Called by the TransportManager when the server is shutting down |
void |
suspendEndPoint(EndPointOperations.Suspend context)
Suspends (disables) the endpoint with the given service reference |
TransportEndPoint |
updateEndPoint(EndPointOperations.Update context)
Updates the existing endpoint with new configuration. |
void |
validateEndPointConfiguration(TransportValidationContext context)
Provides syntactic and semantic validation of endpoint configuration according to a given transport provider-specific logic. |
Method Detail |
---|
String getId()
void validateEndPointConfiguration(TransportValidationContext context)
context
- context for validation. Providers can use this to extract
locale, service information and diagnostics objectTransportEndPoint createEndPoint(EndPointOperations.Create context) throws TransportException
context
- context for create operation. Providers can use this to
extract endpoint configuration, service reference, etc.
TransportException
TransportEndPoint updateEndPoint(EndPointOperations.Update context) throws TransportException
context
- context for update operation. Providers can use this to
extract endpoint configuration, service reference, etc.
TransportException
void suspendEndPoint(EndPointOperations.Suspend context) throws TransportException
context
- context for suspend operation. Providers can use this to
extract endpoint configuration, service reference, etc.
TransportException
void resumeEndPoint(EndPointOperations.Resume context) throws TransportException
context
- context for resume operation. Providers can use this to
extract endpoint configuration, service reference, etc.
TransportException
void deleteEndPoint(EndPointOperations.Delete context) throws TransportException
context
- context for delete operation. Providers can use this to
extract service reference, etc.
TransportException
void activationComplete(EndPointOperations.CommonOperation context)
context
- context for operation that has been performed. Providers
can use this to extract endpoint configuration, service reference, etc.Collection<? extends TransportEndPoint> getEndPoints() throws TransportException
TransportException
TransportEndPoint getEndPoint(Ref ref) throws TransportException
TransportException
void sendMessageAsync(TransportSender sender, TransportSendListener listener, TransportOptions options) throws TransportException
sender
- an instance of either ServiceTransportSender or
NoServiceTransportSender interface will be providedlistener
- a callback object the transport provider needs to
invoke asynchronously when the send operation is completed (for
one-way requests) or when the response has been received
(for request-response requests)options
- various options having to do with desired quality of
service, the mode, etc on the outbound request
TransportException
org.apache.xmlbeans.SchemaType getEndPointConfigurationSchemaType() throws TransportException
TransportException
org.apache.xmlbeans.SchemaType getRequestMetaDataSchemaType() throws TransportException
TransportException
org.apache.xmlbeans.SchemaType getRequestHeadersSchemaType() throws TransportException
TransportException
org.apache.xmlbeans.SchemaType getResponseMetaDataSchemaType() throws TransportException
TransportException
org.apache.xmlbeans.SchemaType getResponseHeadersSchemaType() throws TransportException
TransportException
TransportProviderConfiguration getProviderConfiguration() throws TransportException
TransportException
TransportUIBinding getUIBinding(TransportUIContext context) throws TransportException
context
- context for UI binding. Providers can use this to
extract locale, proxy information, etc.
TransportException
void shutdown() throws TransportException
TransportException
Collection<NonQualifiedEnvValue> getEnvValues(Ref ref, EndPointConfiguration epConfig) throws TransportException
ref
- service referenceepConfig
- service endpoint configuration
TransportException
void setEnvValues(Ref ref, EndPointConfiguration epConfig, Collection<NonQualifiedEnvValue> envValues) throws TransportException
ref
- service referenceepConfig
- service endpoint configurationenvValues
- collection of environment values to set
TransportException
Collection<Ref> getExternalReferences(EndPointConfiguration epConfig) throws TransportException
epConfig
- service endpoint configuration
TransportException
void setExternalReferences(Map<Ref,Ref> mapRefs, EndPointConfiguration epConfig) throws TransportException
mapRefs
- map of referencesepConfig
- service endpoint configuration
TransportException
Map<String,String> getBusinessServicePropertiesForProxy(Ref ref) throws TransportException
ref
- service reference
TransportException
org.apache.xmlbeans.XmlObject getProviderSpecificConfiguration(Ref ref, Map<String,String> props) throws TransportException
ref
- if not null, it is assumed that there already exists a service
endpoint with a given ref, and the result of the method will be a
merge of existing configuration and passed in properties.props
- map of name/value properties to be used when creating service
endpoint configuration
TransportException
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |