|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
public interface SecureChannel
Client's SecureChannel connection.
If the connection fails, and the transport channel is stateful (TCP), and the secure channel has pending service requests, it attempts to reconnect the transport channel. If the reconnect fails there is a timeout sequence of the following wait periods { 0, 1, 2, 4, 8, 16, 32, 64, 120, 120, ... }.
If error recovery mode fails to re-establish new security token before the old expires, the secure channel will be closed.
| Method Summary | |
|---|---|
void |
close()
Close the secure channel. |
AsyncResult<SecureChannel> |
closeAsync()
Close the secure channel. |
void |
dispose()
Close and dispose. |
ServerConnection |
getConnection()
Get current socket connection if applicable for the binding type. |
String |
getConnectURL()
Return the URL of the connection. |
EndpointConfiguration |
getEndpointConfiguration()
getEndpointConfiguration. |
EndpointDescription |
getEndpointDescription()
getEndpointDescription. |
EncoderContext |
getMessageContext()
getMessageContext. |
MessageSecurityMode |
getMessageSecurityMode()
Get message security mode. |
int |
getOperationTimeout()
Get operation timeout |
int |
getSecureChannelId()
Get secure channel ID |
SecurityPolicy |
getSecurityPolicy()
Get security policy |
void |
initialize(String connectUrl,
TransportChannelSettings settings,
EncoderContext ctx)
Initialize a secure channel with endpoint identified by the URL. |
void |
initialize(TransportChannelSettings settings,
EncoderContext ctx)
Initialize a secure channel with endpoint identified by the URL. |
boolean |
isOpen()
Is the secure channel open. |
void |
open()
Open the secure channel with the endpoint identified by the URL. |
AsyncResult<SecureChannel> |
openAsync()
Open the secure channel asynchronously. |
ServiceResponse |
serviceRequest(ServiceRequest request)
Sends a request over the secure channel. |
AsyncResult<ServiceResponse> |
serviceRequestAsync(ServiceRequest request)
Asynchronous operation to send a request over the secure channel. |
void |
setOperationTimeout(int timeout)
Set operation timeout |
| Method Detail |
|---|
void initialize(String connectUrl,
TransportChannelSettings settings,
EncoderContext ctx)
throws ServiceResultException
connectUrl - connect urlsettings - a TransportChannelSettings object.ctx - a EncoderContext object.
ServiceResultException - if any.
void initialize(TransportChannelSettings settings,
EncoderContext ctx)
throws ServiceResultException
settings - a TransportChannelSettings object.ctx - a EncoderContext object.
ServiceResultException - if any.
void open()
throws ServiceResultException
StatusCodes.Bad_Timeout.
ServiceResultException - if any.AsyncResult<SecureChannel> openAsync()
ServiceResponse serviceRequest(ServiceRequest request)
throws ServiceResultException
If the operation timeouts or the thread is interrupted a
ServiceResultException is thrown with StatusCodes.Bad_Timeout.
Sends a request over the secure channel.
If the operation timeouts or the thread is interrupted a
ServiceResultException is thrown with StatusCodes.Bad_Timeout.
serviceRequest in interface RequestChannelrequest - the request
ServiceResultException - if errorAsyncResult<ServiceResponse> serviceRequestAsync(ServiceRequest request)
serviceRequestAsync in interface RequestChannelrequest - the request
int getSecureChannelId()
ServerConnection getConnection()
MessageSecurityMode getMessageSecurityMode()
SecurityPolicy getSecurityPolicy()
String getConnectURL()
boolean isOpen()
void close()
This method sends CloseSecureChannelRequest to the server and closes the socket connection. If sending of the message fails and thus the servers never receives notification about closed secure channel, then there is no resend attempt. The secure channel will eventually time out in the server.
All pending requests will fault with Bad_SecureChannelClosed
AsyncResult<SecureChannel> closeAsync()
This method sends CloseSecureChannelRequest to the server and closes the socket connection. If sending of the message fails and thus the servers never receives notification about closed secure channel, then there is no resend attempt. The secure channel will eventually time out in the server.
All pending requests will fault with Bad_SecureChannelClosed
void dispose()
EndpointDescription getEndpointDescription()
getEndpointDescription.
EndpointDescription object.EndpointConfiguration getEndpointConfiguration()
getEndpointConfiguration.
EndpointConfiguration object.EncoderContext getMessageContext()
getMessageContext.
EncoderContext object.void setOperationTimeout(int timeout)
timeout - in millisecondsint getOperationTimeout()
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||