org.ten60.netkernel.layer1.nkf
Interface INKFConvenienceHelper

All Superinterfaces:

INKFBasicHelper

All Known Implementing Classes:

NKFAccessorHelperImpl, NKFComponentHelperImpl, NKFHelperImpl, NKFTransportHelperImpl, NKFTransreptorHelperImpl

public interface INKFConvenienceHelper
extends INKFBasicHelper

Convenience helper methods for sourcing and sinking resources. Implemented over INKFBasicHelper

Method Summary

IURRepresentation	createIntermediateRepresentationForAspect(IURAspect aAspect, java.lang.String aMimeType) Create a representation around one aspect that has been internally created and give it the specified mimetype.
boolean	delete(java.lang.String aURI) Delete a resource for the given URI
boolean	exists(java.lang.String aURI) Check for the existence of a resource for the given URI
IURAspect	fragment(IURAspect aSource, java.lang.String aFragment, java.lang.String aMimeType, java.lang.Class aAspectClass) Apply a fragment identifier to an internally created resource.
java.lang.String	requestNew(java.lang.String aURIBase, IURAspect aOptionalSource) Request the creation of a new resource
void	sinkAspect(java.lang.String aURI, IURAspect aAspect) Sink an aspect to the resource at a URI
IURRepresentation	source(java.lang.String aURI) Source a resource from its URI
IURRepresentation	source(java.lang.String aURI, java.lang.Class aAspectClass) Source a resource from its URI
IURAspect	sourceAspect(java.lang.String aURI, java.lang.Class aAspectClass) Source a specific aspect of a resource from its URI
IURAspect	transrept(IURAspect aSource, java.lang.Class aAspectClass) Transrept a internally created resource into alternative aspect.
IURAspect	transrept(IURRepresentation aSource, java.lang.Class aAspectClass) Transrept a internally created resource into alternative aspect.

Methods inherited from interface org.ten60.netkernel.layer1.nkf.INKFBasicHelper

createResponseFrom, createResponseFrom, createSubRequest, createSubRequest, getCWU, getKernelHelper, getThisRequest, issueAsyncSubRequest, issueSubRequest, issueSubRequestForAspect, setCWU, setResponse

Method Detail

source

IURRepresentation source(java.lang.String aURI)
                         throws NKFException

Source a resource from its URI

Parameters:

aURI -

Throws:

NKFException

source

IURRepresentation source(java.lang.String aURI,
                         java.lang.Class aAspectClass)
                         throws NKFException

Source a resource from its URI

Parameters:

aURI -

aAspectClass -

Throws:

NKFException

sourceAspect

IURAspect sourceAspect(java.lang.String aURI,
                       java.lang.Class aAspectClass)
                       throws NKFException

Source a specific aspect of a resource from its URI

Parameters:

aURI -

aAspectClass -

Throws:

NKFException

sinkAspect

void sinkAspect(java.lang.String aURI,
                IURAspect aAspect)
                throws NKFException

Sink an aspect to the resource at a URI

Parameters:

aURI -

aAspect -

Throws:

NKFException

exists

boolean exists(java.lang.String aURI)
               throws NKFException

Check for the existence of a resource for the given URI

Throws:

NKFException

delete

boolean delete(java.lang.String aURI)
               throws NKFException

Delete a resource for the given URI

Returns:

true if it was deleted

Throws:

NKFException

transrept

IURAspect transrept(IURAspect aSource,
                    java.lang.Class aAspectClass)
                    throws NKFException

Transrept a internally created resource into alternative aspect. There must be a registered Transreptor capable of performing the transrepresentation. - Do not use to transrept external resources source these using one of the methods which take an aspect class parameter.

Parameters:

aSource - An internally generated resource

aAspectClass - The class of the desired aspect for the resource

Returns:

An aspect of class aAspectClass for resource aSource

Throws:

NKFException - thrown if no transreptor available or transreptor fails

transrept

IURAspect transrept(IURRepresentation aSource,
                    java.lang.Class aAspectClass)
                    throws NKFException

Transrept a internally created resource into alternative aspect. There must be a registered Transreptor capable of performing the transrepresentation. - Do not use to transrept external resources source these using one of the methods which take an aspect class parameter.

Parameters:

aSource - An internally generated resource

aAspectClass - The class of the desired aspect for the resource

Returns:

An aspect of class aAspectClass for resource aSource

Throws:

NKFException - thrown if no transreptor available or transreptor fails

requestNew

java.lang.String requestNew(java.lang.String aURIBase,
                            IURAspect aOptionalSource)
                            throws NKFException

Request the creation of a new resource

Parameters:

aURIBase - A base URI that can identify which accessor to target the request at

aOptionalSource - Optional resource aspect that the accessor can use to seed the state of the new resource.

Returns:

The URI of the created resource

Throws:

NKFException - Thrown if no accessor could be located or it didn't support the NEW operation or the failed for some other accessor specific reason.

fragment

IURAspect fragment(IURAspect aSource,
                   java.lang.String aFragment,
                   java.lang.String aMimeType,
                   java.lang.Class aAspectClass)
                   throws NKFException

Apply a fragment identifier to an internally created resource. There must be a registered Fragmentor capable of performing the fragmentation. - Do not use to transrept external resources source these with a fragment identifier on the URI

Parameters:

aSource - An internally generated resource

aFragment - A valid fragment identifier string

aMimeType - The mimetype of the resource

aAspectClass - The class of the desired aspect for the resource

Returns:

An aspect of class aAspectClass for resource aSource

Throws:

NKFException - thrown if no transreptor available or transreptor fails

createIntermediateRepresentationForAspect

IURRepresentation createIntermediateRepresentationForAspect(IURAspect aAspect,
                                                            java.lang.String aMimeType)

Create a representation around one aspect that has been internally created and give it the specified mimetype. The created representation is not expired but has no dependencies.

Parameters:

aAspect - the single aspect it should contain

aMimeType - the mimetype of the representation