org.ten60.netkernel.layer1.nkf
Interface INKFKernelHelper

All Known Implementing Classes:

NKFAccessorHelperImpl, NKFComponentHelperImpl, NKFHelperImpl, NKFTransportHelperImpl, NKFTransreptorHelperImpl

public interface INKFKernelHelper

Advanced Methods which provide Low-level access to the NetKernel kernel APIs. Generally not necessary when implementing an accessor but can be valuable for advanced development.

Method Summary

Container	getKernel() Advanced Return a reference to the Kernel Container.
ModuleDefinition	getOwningModule() Advanced Return the owning module of this accessor
URRequest	getThisKernelRequest() Advanced Return the request which initiated this invocation of the accessor
IURRepresentation	issueRequest(URRequest aRequest) Advanced Issue a resource request to the kernel using a URRequest.
void	setResponse(IURRepresentation aResponse) Advanced Sets the response that will be issued as the result of this invocation of the accessor.

Method Detail

getThisKernelRequest

URRequest getThisKernelRequest()
                               throws NKFException

Advanced Return the request which initiated this invocation of the accessor

Throws:

NKFException - thrown if no parent request initiated this invocation

issueRequest

IURRepresentation issueRequest(URRequest aRequest)
                               throws NetKernelException

Advanced Issue a resource request to the kernel using a URRequest. All higher-level NKF methods will use this to issue kernel requests. Requests are Sychnoronous.

Parameters:

aRequest -

Returns:

a representation which is the response from the request

Throws:

NetKernelException

setResponse

void setResponse(IURRepresentation aResponse)

Advanced Sets the response that will be issued as the result of this invocation of the accessor. All accessors should use this method to set a response before completion.

Parameters:

aResponse - an IURRepresentation

getKernel

Container getKernel()

Advanced Return a reference to the Kernel Container. From this the Scheduler and other kernel components may be accessed.

getOwningModule

ModuleDefinition getOwningModule()

Advanced Return the owning module of this accessor