public static interface DOFRequest.Session extends DOFRequest
DOFObject.Provider.session(org.opendof.core.oal.DOFOperation.Provide, org.opendof.core.oal.DOFRequest.Session, org.opendof.core.oal.DOFObject, org.opendof.core.oal.DOFInterfaceID, org.opendof.core.oal.DOFObjectID, org.opendof.core.oal.DOFInterfaceID)
via one of the respond
methods.DOFRequest.Get, DOFRequest.Invoke, DOFRequest.Register, DOFRequest.Session, DOFRequest.Set, DOFRequest.Subscribe, DOFRequest.SubscribeGet, DOFRequest.Type
Modifier and Type | Method and Description |
---|---|
void |
respond()
Respond with a result for this request.
|
void |
respond(DOFErrorException exception)
Respond with an error exception for this request.
|
void |
respond(DOFProviderException exception)
Respond with a provider exception for this request.
|
void |
setDataTransform(DOFOperation.Session.DataTransform dataTransform)
Set the Provider's data transform on all application data (parameters and values) exchanged in a Session.
|
getConnectionState, getObjectID, getRequestorAddress, getRequestorID, getRequestType, getSecurityScope, getTimeRemaining
void respond()
respond
methods is not called the request will timeout.
NOTE: Often a call to respond()
should be immediately followed by return
in
order to maintain the execution flow of a native return
statement.void respond(DOFProviderException exception)
respond(...)
should be immediately followed by return
in
order to maintain the execution flow of a native throw
statement.exception
- The exception. Must not be null.DOFOperation
void respond(DOFErrorException exception)
DOFObject.Provider.session(org.opendof.core.oal.DOFOperation.Provide, org.opendof.core.oal.DOFRequest.Session, org.opendof.core.oal.DOFObject, org.opendof.core.oal.DOFInterfaceID, org.opendof.core.oal.DOFObjectID, org.opendof.core.oal.DOFInterfaceID)
:
DOFErrorException.NOT_SUPPORTED
DOFErrorException.INSUFFICIENT_RESOURCES
DOFErrorException.NOT_FOUND
DOFErrorException.DUPLICATE
DOFErrorException.TOO_MANY
DOFErrorException.APPLICATION_ERROR
respond(...)
should be immediately followed by return
in
order to maintain the execution flow of a native throw
statement.exception
- The exception. Must not be null.DOFOperation
void setDataTransform(DOFOperation.Session.DataTransform dataTransform)
dataTransform
- The data transform for the Provider Session to use.