org.ten60.netkernel.layer1.nkf
Interface INKFRequest

All Known Implementing Classes:

NKFRequestImpl

public interface INKFRequest

Wrapper around the construction of a sub-request from within an accessor

Method Summary

void	addArgument(java.lang.String aName, IURAspect aValue) Adds a named pass-by-value argument to the request from an aspect which has been created from internal processing of the accessor.
void	addArgument(java.lang.String aName, IURRepresentation aValue) Adds a named pass-by-value argument to the request (a unique internal URI will be dynamically generated for the argument).
void	addArgument(java.lang.String aName, java.lang.String aURI) Adds a named pass-by-reference argument to the request.
void	addSystemArgument(IURAspect aValue) Adds a system argument (for use in transrept and sink requests.
void	addSystemArgument(IURRepresentation aValue) Adds a system argument (for use in transrept and sink requests.
void	setAspectClass(java.lang.Class aAspectClass) Sets the class of aspect that is expected as a response to the request, will default to IURAspect which is the baseclass of all aspects and will allow anything to be returned
void	setCWU(java.lang.String aCWU) Sets the current working URI of the request, defaults to the same CWU as the parent request
void	setFragment(java.lang.String aFragment) Set a fragment identifier on to the request URI
void	setRequestType(int aType) Sets the type of the request, defaults to RQT_SOURCE
void	setURI(java.lang.String aURI) Sets the base URI of the request, defaults to nothing and using it will fail if not set.

Method Detail

setRequestType

void setRequestType(int aType)

Sets the type of the request, defaults to RQT_SOURCE

Parameters:

aType -

setURI

void setURI(java.lang.String aURI)
            throws NKFException

Sets the base URI of the request, defaults to nothing and using it will fail if not set.

Parameters:

aURI -

Throws:

NKFException - thrown if aURI is relative and cwu not set

setCWU

void setCWU(java.lang.String aCWU)

Sets the current working URI of the request, defaults to the same CWU as the parent request

Parameters:

aCWU -

Throws:

NKFException - thrown if uri is relative and cannot be resolved

setAspectClass

void setAspectClass(java.lang.Class aAspectClass)

Sets the class of aspect that is expected as a response to the request, will default to IURAspect which is the baseclass of all aspects and will allow anything to be returned

Parameters:

aAspectClass - if null it will default to IURAspect, and allow any aspect to be returned (i.e. no transreption will occur)

addArgument

void addArgument(java.lang.String aName,
                 java.lang.String aURI)
                 throws NKFException

Adds a named pass-by-reference argument to the request. A pass by reference argument is simply a URI to the resource.

Parameters:

aName - the name of the argument

aURI - the URI of the argument, if this is relative it will be resolved

Throws:

NKFException - thrown if relative URI cannot be resolved

addArgument

void addArgument(java.lang.String aName,
                 IURRepresentation aValue)

Adds a named pass-by-value argument to the request (a unique internal URI will be dynamically generated for the argument). The argument is passed by value.

Parameters:

aName -

aValue -

addArgument

void addArgument(java.lang.String aName,
                 IURAspect aValue)

Adds a named pass-by-value argument to the request from an aspect which has been created from internal processing of the accessor. (a unique internal URI will be dynamically generated for the argument). The argument is passed by value. The aspect is wrapped in a representation and is given metadata with zero cost, a mimetype of content/unknown and with a validity period of 1 day (assume infinite).

Parameters:

aName -

aValue -

addSystemArgument

void addSystemArgument(IURRepresentation aValue)

Adds a system argument (for use in transrept and sink requests.

Parameters:

aValue -

addSystemArgument

void addSystemArgument(IURAspect aValue)

Adds a system argument (for use in transrept and sink requests.

Parameters:

aValue -

setFragment

void setFragment(java.lang.String aFragment)

Set a fragment identifier on to the request URI

Parameters:

aFragment -