Package io.helidon.common.http

Interface ContextualRegistry

All Superinterfaces:

Context

public interface ContextualRegistry
extends Context

A registry for context objects. Enables instance localization between several services / components / ... integrated in a particular known scope. ContextualRegistry instance is intended to be associated with a scope aware object such as WebServer, ServerRequest or ClientRequest.

Context contains also a notion of classifiers. Classifier is any object defining additional key for registered objects. To obtain such registered object, the same classifier (precisely, any equal object) has to be used.

Classifiers can be used as follows:

1. As an additional identifier for registered objects of common types, like a String, ...
   

   
    // User detail provider service
    registry.register("NAME_PARAM_ID", "Smith");
    registry.register("GENDER_PARAM_ID", "male");
    ...
    // User consumer service
    String name = registry.get("name", String.class);
    

2. As an access control mechanism where only owners of the classifier can retrieve such contextual instance.
   

   
    // In some central security service.
    registry.register(securityFrameworkInternalInstance, new AuthenticatedInternalIdentity(...));
    ...
    // In some authorization filter known by a central security service
    AuthenticatedInternalIdentity auth = registry.get(securityFrameworkInternalInstance, AuthenticatedInternalIdentity.class);
    

Nested Class Summary

Nested classes/interfaces inherited from interface io.helidon.common.context.Context

Context.Builder

Method Summary

Modifier and Type	Method and Description
static ContextualRegistry	create() Creates a new empty instance.
static ContextualRegistry	create(Context parent) Creates a new empty instance backed by its parent read-through ContextualRegistry.

Methods inherited from interface io.helidon.common.context.Context

builder, get, get, id, register, register, supply, supply

Method Detail

create

static ContextualRegistry create()

Creates a new empty instance.

Specified by:

create in interface Context

Returns:

new instance

create

static ContextualRegistry create(Context parent)

Creates a new empty instance backed by its parent read-through ContextualRegistry.

Parent registry is used only for get methods and only if this registry doesn't have registered required type.

Specified by:

create in interface Context

Parameters:

parent - a parent registry

Returns:

new instance