com.prosysopc.ua.stack.transport.endpoint

Class EndpointServiceRequest<Request extends ServiceRequest<Response>,Response extends ServiceResponse>

java.lang.Object

com.prosysopc.ua.stack.transport.endpoint.EndpointServiceRequest<Request,Response>

Direct Known Subclasses:

PendingRequest, UaLoopbackClient.InternalEndpointServiceRequest

public abstract class EndpointServiceRequest<Request extends ServiceRequest<Response>,Response extends ServiceResponse>
extends Object

Asynchronous message exchange. A service request to be processed by a server (as opposed to service request queried by a client).

To send service error use sendResponse(new ServiceFault());

Field Summary

Fields

Modifier and Type	Field and Description
protected Endpoint	endpoint
protected DateTime	receiveTimestamp
protected Request	request
static boolean	sendServiceFaultsForBadServiceLevelOpcHttpsResponses Toggles is a ServiceFault sent in opc.https instead of a full response if the service level status is bad.
static boolean	sendServiceFaultsForBadServiceLevelResponses Toggles is a ServiceFault sent in opc.tcp instead of a full response if the service level status is bad.
protected Server	server

Constructor Summary

Constructors

Constructor and Description
EndpointServiceRequest(Request request, Server server, Endpoint endpoint) Constructor for EndpointServiceRequest.

Method Summary

Modifier and Type	Method and Description
abstract ServerSecureChannel	getChannel() getChannel.
Endpoint	getEndpoint() Get endpoint
DateTime	getReceiveTimestamp() Server-side timestamp when the getRequest() was obtained.
Request	getRequest() Get Request.
abstract SecurityMode	getSecurityMode() A SecurityMode.
Server	getServer() Get server
void	sendException(Throwable e) Convert Throwable into an Service fault and send that to the client.
AsyncWrite	sendFault(ServiceFault fault) Send a service fault
abstract void	sendResponse(AsyncWrite response) Send response.
abstract AsyncWrite	sendResponse(Response response, List<Locale> locales) Send a response.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

sendServiceFaultsForBadServiceLevelResponses

public static boolean sendServiceFaultsForBadServiceLevelResponses

Toggles is a ServiceFault sent in opc.tcp instead of a full response if the service level status is bad. By default true, some future SDK version will remove this flag.

sendServiceFaultsForBadServiceLevelOpcHttpsResponses

public static boolean sendServiceFaultsForBadServiceLevelOpcHttpsResponses

Toggles is a ServiceFault sent in opc.https instead of a full response if the service level status is bad. By default false, some future SDK version will remove this flag.

server

protected Server server

endpoint

protected Endpoint endpoint

request

protected Request extends ServiceRequest<Response> request

receiveTimestamp

protected DateTime receiveTimestamp

Constructor Detail

EndpointServiceRequest

public EndpointServiceRequest(Request request,
                              Server server,
                              Endpoint endpoint)

Constructor for EndpointServiceRequest.

Parameters:

request - a Request object.

server - a Server object.

endpoint - a Endpoint object.

Method Detail

getChannel

public abstract ServerSecureChannel getChannel()

getChannel.

Returns:

a ServerSecureChannel object.

getEndpoint

public Endpoint getEndpoint()

Get endpoint

Returns:

endpoint

getReceiveTimestamp

public DateTime getReceiveTimestamp()

Server-side timestamp when the getRequest() was obtained.

getRequest

public Request getRequest()

Get Request. The request is in Complete state.

Returns:

read request

getSecurityMode

public abstract SecurityMode getSecurityMode()

A SecurityMode. Only relevant when as part of the CreateSessionRequest/Response.

getServer

public Server getServer()

Get server

Returns:

server

sendException

public void sendException(Throwable e)

Convert Throwable into an Service fault and send that to the client. NOTE! This is a convenience method that exposes stack trace to the client. Use with care!

Parameters:

e - ServiceResultException or other

sendFault

public AsyncWrite sendFault(ServiceFault fault)

Send a service fault

Parameters:

fault - error

Returns:

sendResponse

public abstract void sendResponse(AsyncWrite response)

Send response.

Parameters:

response - async write wrapping response or ServiceFault

sendResponse

public abstract AsyncWrite sendResponse(Response response,
                                        List<Locale> locales)

Send a response.

Parameters:

response - to send, either ServiceFault or ServiceResult

locales - a list of locale preferences (or null if none)

Returns:

monitor for write status