Class ActorRdfMetadataExtractHydraControls

An RDF Metadata Extract Actor that extracts all Hydra controls from the metadata stream.

Hierarchy (View Summary)

ActorRdfMetadataExtract
- ActorRdfMetadataExtractHydraControls

Constructors

constructor

new ActorRdfMetadataExtractHydraControls(
args: IActorRdfMetadataExtractArgs,
): ActorRdfMetadataExtractHydraControls
Parameters
- args: IActorRdfMetadataExtractArgs
Returns ActorRdfMetadataExtractHydraControls
Overrides ActorRdfMetadataExtract.constructor
- Defined in actor-rdf-metadata-extract-hydra-controls/lib/ActorRdfMetadataExtractHydraControls.ts:25

Properties

`Readonly`beforeActors

beforeActors: Actor<
    IActionRdfMetadataExtract,
    IActorTest,
    IActorRdfMetadataExtractOutput,
    undefined,
>[] = []

Actor that must be registered in the bus before this actor.

`Readonly`bus

bus: Bus<
    Actor<
        IActionRdfMetadataExtract,
        IActorTest,
        IActorRdfMetadataExtractOutput,
        undefined,
    >,
    IActionRdfMetadataExtract,
    IActorTest,
    IActorRdfMetadataExtractOutput,
    undefined,
>

The bus this actor subscribes to.

`Readonly`name

name: string

The name for this actor.

Default

{<rdf:subject>}

`Protected` `Readonly`parsedUriTemplateCache

parsedUriTemplateCache: Record<string, UriTemplate> = {}

`Static` `Readonly`HYDRA

HYDRA: string = 'http://www.w3.org/ns/hydra/core#'

`Static` `Readonly`LINK_TYPES

LINK_TYPES: string[] = ...

Methods

correctProtocolMismatches

correctProtocolMismatches(
    pageUrl: string,
    hydraProperties: Record<string, Record<string, string[]>>,
    context: IActionContext,
): Record<string, Record<string, string[]>>
Correct all URLs within the given Hydra properties that are exposed under the http protocol, while the page they were retrieved from is hosted over https.

Occasionally, TPF servers are hosted over https, while their base URL is configured as http. This causes all URLs in their metadata to be exposed under the http protocol, which makes the Hydra controls unusable, as they can not be linked to the current page anymore. Since this is a common problem, we detect it, correct the invalid URLs, and emit a warning.

Only URLs on the host of the page are corrected, as the controls legitimately refer to http URLs elsewhere, such as the rdf:subject, rdf:predicate and rdf:object values of hydra:property.
Parameters
- pageUrl: string
  The page URL in which the Hydra properties are defined.
- hydraProperties: Record<string, Record<string, string[]>>
  The collected Hydra properties.
- context: IActionContext
  The action context, in which a warning will be logged upon detecting an invalid protocol.
Returns Record<string, Record<string, string[]>>
The Hydra properties, with all invalidly exposed URLs corrected.
- Defined in actor-rdf-metadata-extract-hydra-controls/lib/ActorRdfMetadataExtractHydraControls.ts:85

`Protected`getDefaultLogData

getDefaultLogData(context: IActionContext, data?: () => any): any
Parameters
- context: IActionContext
- Optionaldata: () => any
Returns any
Inherited from ActorRdfMetadataExtract.getDefaultLogData
- Defined in core/lib/Actor.ts:101

getHydraProperties

getHydraProperties(
metadata: Stream,
): Promise<Record<string, Record<string, string[]>>>
Collect all hydra properties from a given metadata stream in a nice convenient nested hash (property / subject / objects).
Parameters
- metadata: Stream
Returns Promise<Record<string, Record<string, string[]>>>
The collected Hydra properties.
- Defined in actor-rdf-metadata-extract-hydra-controls/lib/ActorRdfMetadataExtractHydraControls.ts:203

getInvalidUrlPrefix

getInvalidUrlPrefix(pageUrl: string): string | undefined
Determine the URL prefix under which servers with an invalidly configured base URL expose the controls of the given page.

Concretely, this is the origin of the page URL with the https protocol replaced by http, including the trailing slash, so that only URLs on the host of the page are matched.
Parameters
- pageUrl: string
  The page URL in which the Hydra properties are defined.
Returns string | undefined
The invalid URL prefix, or undefined if the page URL is not an https URL with a path.
- Defined in actor-rdf-metadata-extract-hydra-controls/lib/ActorRdfMetadataExtractHydraControls.ts:58

getLinks

getLinks(
pageUrl: string,
hydraProperties: Record<string, Record<string, string[]>>,
): Record<string, any>
Collect all Hydra page links from the given Hydra properties object.
Parameters
- pageUrl: string
  The page URL in which the Hydra properties are defined.
- hydraProperties: Record<string, Record<string, string[]>>
  The collected Hydra properties.
Returns Record<string, any>
The Hydra links
- Defined in actor-rdf-metadata-extract-hydra-controls/lib/ActorRdfMetadataExtractHydraControls.ts:39

getSearchForms

getSearchForms(
hydraProperties: Record<string, Record<string, string[]>>,
): ISearchForms
Collect all search forms from the given Hydra properties object.
Parameters
- hydraProperties: Record<string, Record<string, string[]>>
  The collected Hydra properties.
Returns ISearchForms
The search forms.
- Defined in actor-rdf-metadata-extract-hydra-controls/lib/ActorRdfMetadataExtractHydraControls.ts:156

`Protected`hasInvalidUrl

hasInvalidUrl(
hydraProperties: Record<string, Record<string, string[]>>,
invalidPrefix: string,
): boolean
Check if any URL within the given Hydra properties starts with the given prefix.
Parameters
- hydraProperties: Record<string, Record<string, string[]>>
  The collected Hydra properties.
- invalidPrefix: string
  The URL prefix of invalidly exposed controls.
Returns boolean
- Defined in actor-rdf-metadata-extract-hydra-controls/lib/ActorRdfMetadataExtractHydraControls.ts:122

`Protected`logDebug

logDebug(context: IActionContext, message: string, data?: () => any): void
Parameters
- context: IActionContext
- message: string
- Optionaldata: () => any
Returns void
Inherited from ActorRdfMetadataExtract.logDebug
- Defined in core/lib/Actor.ts:114

`Protected`logError

logError(context: IActionContext, message: string, data?: () => any): void
Parameters
- context: IActionContext
- message: string
- Optionaldata: () => any
Returns void
Inherited from ActorRdfMetadataExtract.logError
- Defined in core/lib/Actor.ts:135

`Protected`logFatal

logFatal(context: IActionContext, message: string, data?: () => any): void
Parameters
- context: IActionContext
- message: string
- Optionaldata: () => any
Returns void
Inherited from ActorRdfMetadataExtract.logFatal
- Defined in core/lib/Actor.ts:142

`Protected`logInfo

logInfo(context: IActionContext, message: string, data?: () => any): void
Parameters
- context: IActionContext
- message: string
- Optionaldata: () => any
Returns void
Inherited from ActorRdfMetadataExtract.logInfo
- Defined in core/lib/Actor.ts:121

`Protected`logTrace

logTrace(context: IActionContext, message: string, data?: () => any): void
Parameters
- context: IActionContext
- message: string
- Optionaldata: () => any
Returns void
Inherited from ActorRdfMetadataExtract.logTrace
- Defined in core/lib/Actor.ts:107

`Protected`logWarn

logWarn(context: IActionContext, message: string, data?: () => any): void
Parameters
- context: IActionContext
- message: string
- Optionaldata: () => any
Returns void
Inherited from ActorRdfMetadataExtract.logWarn
- Defined in core/lib/Actor.ts:128

parseUriTemplateCached

parseUriTemplateCached(template: string): UriTemplate
Parse a URI template, or retrieve it from a cache.
Parameters
- template: string
  A URI template string.
Returns UriTemplate
A parsed URI template object.
- Defined in actor-rdf-metadata-extract-hydra-controls/lib/ActorRdfMetadataExtractHydraControls.ts:142

run

run(action: IActionRdfMetadataExtract): Promise<IActorRdfMetadataExtractOutput>
Run the given action on this actor.

In most cases, this method should not be called directly. Instead, #runObservable should be called.
Parameters
- action: IActionRdfMetadataExtract
  The action to run.
Returns Promise<IActorRdfMetadataExtractOutput>
A promise that resolves to the run result.
Overrides ActorRdfMetadataExtract.run
- Defined in actor-rdf-metadata-extract-hydra-controls/lib/ActorRdfMetadataExtractHydraControls.ts:222

runObservable

runObservable(
action: IActionRdfMetadataExtract,
sideData: undefined,
): Promise<IActorRdfMetadataExtractOutput>
Run the given action on this actor AND invokes the Bus#onRun method.
Parameters
- action: IActionRdfMetadataExtract
  The action to run.
- sideData: undefined
Returns Promise<IActorRdfMetadataExtractOutput>
A promise that resolves to the run result.
Inherited from ActorRdfMetadataExtract.runObservable
- Defined in core/lib/Actor.ts:93

test

test(_action: IActionRdfMetadataExtract): Promise<TestResult<IActorTest>>
Check if this actor can run the given action, without actually running it.
Parameters
- _action: IActionRdfMetadataExtract
  The action to test.
Returns Promise<TestResult<IActorTest>>
A promise that resolves to the test result.
Overrides ActorRdfMetadataExtract.test
- Defined in actor-rdf-metadata-extract-hydra-controls/lib/ActorRdfMetadataExtractHydraControls.ts:29

`Static`getContextLogger

getContextLogger(context: IActionContext): Logger | undefined
Get the logger from the given context.
Parameters
- context: IActionContext
  An optional context.
Returns Logger | undefined
The logger or undefined.
Inherited from ActorRdfMetadataExtract.getContextLogger
- Defined in core/lib/Actor.ts:62

Class ActorRdfMetadataExtractHydraControls

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns ActorRdfMetadataExtractHydraControls

Properties

ReadonlybeforeActors

Readonlybus

Readonlyname

Default

Protected ReadonlyparsedUriTemplateCache

Static ReadonlyHYDRA

Static ReadonlyLINK_TYPES

Methods

correctProtocolMismatches

Parameters

Returns Record<string, Record<string, string[]>>

ProtectedgetDefaultLogData

Parameters

Returns any

getHydraProperties

Parameters

Returns Promise<Record<string, Record<string, string[]>>>

getInvalidUrlPrefix

Parameters

Returns string | undefined

getLinks

Parameters

Returns Record<string, any>

getSearchForms

Parameters

Returns ISearchForms

ProtectedhasInvalidUrl

Parameters

Returns boolean

ProtectedlogDebug

Parameters

Returns void

ProtectedlogError

Parameters

Returns void

ProtectedlogFatal

Parameters

Returns void

ProtectedlogInfo

Parameters

Returns void

ProtectedlogTrace

Parameters

Returns void

ProtectedlogWarn

Parameters

Returns void

parseUriTemplateCached

Parameters

Returns UriTemplate

run

Parameters

Returns Promise<IActorRdfMetadataExtractOutput>

runObservable

Parameters

Returns Promise<IActorRdfMetadataExtractOutput>

test

Parameters

Returns Promise<TestResult<IActorTest>>

StaticgetContextLogger

Parameters

Returns Logger | undefined

Settings

On This Page

`Readonly`beforeActors

`Readonly`bus

`Readonly`name

`Protected` `Readonly`parsedUriTemplateCache

`Static` `Readonly`HYDRA

`Static` `Readonly`LINK_TYPES

`Protected`getDefaultLogData

`Protected`hasInvalidUrl

`Protected`logDebug

`Protected`logError

`Protected`logFatal

`Protected`logInfo

`Protected`logTrace

`Protected`logWarn

`Static`getContextLogger