Package ca.cdr.api.security.permission

Interface PermissionArgumentFormat<F extends PermissionArgumentValue>

Type Parameters:

F - The type this format parses/formats

public interface PermissionArgumentFormat<F extends PermissionArgumentValue>

Public interface for the various permission argument formats.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	PermissionArgumentFormat.ICodeInValueSetRestriction
static interface	PermissionArgumentFormat.ICompartmentRestriction	the permission is scoped to a compartment
static interface	PermissionArgumentFormat.ICompartmentsRestriction
static interface	PermissionArgumentFormat.ICompartmentsWithExportResourceTypesRestriction
static interface	PermissionArgumentFormat.ICompartmentWithExportResourceTypesRestriction
static interface	PermissionArgumentFormat.IExportResourceTypesRestriction
static interface	PermissionArgumentFormat.IInstanceRestriction	The permission is scoped to a single instance
static interface	PermissionArgumentFormat.INodeAndModuleIdRestriction
static interface	PermissionArgumentFormat.IOperationRestriction
static interface	PermissionArgumentFormat.IOptionalFilterRestriction	The permission has an optional FHIR filter
static interface	PermissionArgumentFormat.IPermissionComponent	Empty marker for facets of permission arguments
static interface	PermissionArgumentFormat.IResourceTypeRestriction	The permission is scoped to only apply to a type
static interface	PermissionArgumentFormat.IRoleNameRestriction

Field Summary

Fields

Modifier and Type	Field	Description
static final char	FILTER_DELIMITER
static final Pattern	ID_FORMAT	format for resource ids - used for compartments.
static final String	RESOURCE_TYPE_LIST_DELIMITER
static final String	RESOURCE_TYPE_PATTERN
static final char	TYPE_COMPARTMENT_DELIMITER

Method Summary

Modifier and Type	Method	Description
static GrantedAuthorityJson	buildAuthority(PermissionEnum thePermissionEnum, PermissionArgumentValue theArgumentValue)	Typesafe authority builder.
String	format(F theArgument)	format the value back into a string for persistence.
default <T extends PermissionArgumentValue> String	formatIfValid(T theArgument)
default String	getDescription(ILocalizer theLocalizer)
default String	getName(ILocalizer theLocalizer)
Class<F>	getType()
Optional<F>	parse(String theArgumentString, ca.cdr.api.security.permission.IdBuilder theIdBuilder)	Parse a permission argument string.

Field Details

FILTER_DELIMITER

static final char FILTER_DELIMITER

See Also:

• Constant Field Values

TYPE_COMPARTMENT_DELIMITER

static final char TYPE_COMPARTMENT_DELIMITER

See Also:

• Constant Field Values

RESOURCE_TYPE_LIST_DELIMITER

static final String RESOURCE_TYPE_LIST_DELIMITER

See Also:

• Constant Field Values

RESOURCE_TYPE_PATTERN

static final String RESOURCE_TYPE_PATTERN

See Also:

• Constant Field Values

ID_FORMAT

static final Pattern ID_FORMAT

format for resource ids - used for compartments. The spec says [a-zA-Z0-9.\-]{1,36}, but hybrid might do any crazy thing, so we only verify we don't have any of our permission-format chars.

See Also:

• IdDt

Method Details

buildAuthority

static GrantedAuthorityJson buildAuthority(@Nonnull
 PermissionEnum thePermissionEnum,
 @Nonnull
 PermissionArgumentValue theArgumentValue)

Typesafe authority builder. Validates the argument format against the declared format for thePermissionEnum

Parameters:

thePermissionEnum - the permission

theArgumentValue - the concrete parsed argument type - use NoArgument.INSTANCE for no-arg.

parse

@Nonnull
Optional<F> parse(@Nullable
 String theArgumentString,
 @Nonnull
 ca.cdr.api.security.permission.IdBuilder theIdBuilder)

Parse a permission argument string.

Parameters:

theArgumentString - The string to parse. null is treated as empty.

theIdBuilder - factory for parsing IIdType types

Returns:

the parsed arg value if the input matches this format

formatIfValid

@Nonnull
default <T extends PermissionArgumentValue> String formatIfValid(@Nonnull
 T theArgument)

getType

Class<F> getType()

Returns:

the type of the value bean we parse

format

@Nonnull
String format(@Nonnull
 F theArgument)

format the value back into a string for persistence.

Parameters:

theArgument - the arg value bean

Returns:

the formatted string - empty will be the empty string, not null

getName

default String getName(ILocalizer theLocalizer)

Returns:

the name of the argument format

getDescription

default String getDescription(ILocalizer theLocalizer)

Returns:

A description of the argument format that users can use to properly format arguments