|
NetKernel APIs |
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
High-level helper methods for implementing accessors. This Interface provides methods that will cover 80% of Accessor development cases. For additional convenience methods to source/sink resources see INKFConvenienceHelper
Method Summary | |
INKFResponse |
createResponseFrom(IURAspect aAspect)
Create a response which should then be configured before being set as the overall response for the accessor. |
INKFResponse |
createResponseFrom(IURRepresentation aRepresentation)
Create a response which should then be configured before being set as the overall response for the accessor. |
INKFRequest |
createSubRequest()
Create a subrequest which can then be configured with target URI, arguments, type etc before being issued to the kernel for scheduling. |
INKFRequest |
createSubRequest(String aURI)
Create a subrequest with a given base URI. |
String |
getCWU()
Gets the current working URI for created subrequests. |
INKFKernelHelper |
getKernelHelper()
Advanced Return the kernel helper API for a set of low-level APIs for advanced use. |
INKFRequestReadOnly |
getThisRequest()
Return a wrapper around the request which initiated the invocation of this accessor |
boolean |
isResponseSet()
Test if the response has been set. |
INKFAsyncRequestHandle |
issueAsyncSubRequest(INKFRequest aRequest)
Issue an asynchronous subrequest. |
IURRepresentation |
issueSubRequest(INKFRequest aRequest)
Issue a subrequest. |
IURAspect |
issueSubRequestForAspect(INKFRequest aRequest)
Issue a subrequest. |
void |
setCWU(String aCWU)
Set the current working URI for created subrequests |
void |
setResponse(INKFResponse aResponse)
Set the response to be returned as the result for the invocation of this accessor |
Method Detail |
public INKFRequestReadOnly getThisRequest() throws NKFException
NKFException
- thrown if no parent request initiated this invocationpublic INKFRequest createSubRequest()
public INKFRequest createSubRequest(String aURI) throws NKFException
aURI
-
NKFException
- thrown if aURI is relative and cwu not inherited from parentpublic IURRepresentation issueSubRequest(INKFRequest aRequest) throws NKFException
aRequest
-
NKFException
- if there is a failure executing the requestpublic IURAspect issueSubRequestForAspect(INKFRequest aRequest) throws NKFException
aRequest
-
NKFException
- if there is a failure executing the requestpublic INKFAsyncRequestHandle issueAsyncSubRequest(INKFRequest aRequest) throws NKFException
aRequest
-
NKFException
public void setCWU(String aCWU)
aCWU
- the new current working URI, may be null
so signify that relative URIs cannot be resolved.public String getCWU()
public INKFResponse createResponseFrom(IURRepresentation aRepresentation)
aRepresentation
- a representation who aspects and metadata
should be used as the basis for the responsepublic INKFResponse createResponseFrom(IURAspect aAspect)
aAspect
- an aspect which should be used as the basis for the responsepublic void setResponse(INKFResponse aResponse)
aResponse
- a response object as created by createResponseFrom methods.
If no response is set then a default Void aspect result is returned. It is an error
to set the response to null for anything other than an accessor - in this case it
has the effect of causing the accessor to not issue a response (this must be used
with care in combination with INFKAsyncRequestListener.)public INKFKernelHelper getKernelHelper()
public boolean isResponseSet()
|
NetKernel APIs |
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |