Record Class AdapterSemanticProfile

java.lang.Object

java.lang.Record

org.j7m.middleware.adapter.spi.AdapterSemanticProfile

Record Components:

name - stable profile name

type - J7M service family

requiredCapabilities - immutable required capability set

optionalCapabilities - immutable optional capability set

public record AdapterSemanticProfile(String name, AdapterType type, Set<AdapterCapability> requiredCapabilities, Set<AdapterCapability> optionalCapabilities)
extends Record

Set of required and optional J7M semantics for one adapter service family.

The record is immutable and thread-safe. Required capabilities must pass TCK scenarios for the adapter to be accepted for the profile. Optional capabilities may be unsupported, but limitations must be recorded truthfully.

Constructor Summary

Constructors

Constructor	Description
AdapterSemanticProfile(String name, AdapterType type, Set<AdapterCapability> requiredCapabilities, Set<AdapterCapability> optionalCapabilities)	Creates a semantic profile.

Method Summary

Modifier and Type	Method	Description
static AdapterSemanticProfile	consensus()	Returns the consensus semantic profile.
static AdapterSemanticProfile	coordination()	Returns the coordination semantic profile.
static AdapterSemanticProfile	durableLog()	Returns the durable log semantic profile.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
final int	hashCode()	Returns a hash code value for this object.
static AdapterSemanticProfile	isolation()	Returns the isolation semantic profile.
static AdapterSemanticProfile	messaging()	Returns the durable queue, outbox, and inbox semantic profile.
String	name()	Returns the value of the name record component.
Set<AdapterCapability>	optionalCapabilities()	Returns the value of the optionalCapabilities record component.
static AdapterSemanticProfile	repositoryReplication()	Returns the repository replication semantic profile.
Set<AdapterCapability>	requiredCapabilities()	Returns the value of the requiredCapabilities record component.
static AdapterSemanticProfile	saga()	Returns the saga semantic profile.
final String	toString()	Returns a string representation of this record class.
AdapterType	type()	Returns the value of the type record component.

Methods inherited from class Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

AdapterSemanticProfile

public AdapterSemanticProfile(String name,
 AdapterType type,
 Set<AdapterCapability> requiredCapabilities,
 Set<AdapterCapability> optionalCapabilities)

Creates a semantic profile.

Throws:

IllegalArgumentException - if profile name is blank or a capability is both required and optional

Method Details

durableLog

public static AdapterSemanticProfile durableLog()

Returns the durable log semantic profile.

Returns:

durable log profile

messaging

public static AdapterSemanticProfile messaging()

Returns the durable queue, outbox, and inbox semantic profile.

Returns:

messaging profile

coordination

public static AdapterSemanticProfile coordination()

Returns the coordination semantic profile.

Returns:

coordination profile

consensus

public static AdapterSemanticProfile consensus()

Returns the consensus semantic profile.

Returns:

consensus profile

repositoryReplication

public static AdapterSemanticProfile repositoryReplication()

Returns the repository replication semantic profile.

Returns:

repository replication profile

saga

public static AdapterSemanticProfile saga()

Returns the saga semantic profile.

Returns:

saga profile

isolation

public static AdapterSemanticProfile isolation()

Returns the isolation semantic profile.

Returns:

isolation profile

toString

public final String toString()

Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.

Specified by:

toString in class Record

Returns:

a string representation of this object

hashCode

public final int hashCode()

Returns a hash code value for this object. The value is derived from the hash code of each of the record components.

Specified by:

hashCode in class Record

Returns:

a hash code value for this object

equals

public final boolean equals(Object o)

Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).

Specified by:

equals in class Record

Parameters:

o - the object with which to compare

Returns:

true if this object is the same as the o argument; false otherwise.

name

public String name()

Returns the value of the name record component.

Returns:

the value of the name record component

type

public AdapterType type()

Returns the value of the type record component.

Returns:

the value of the type record component

requiredCapabilities

public Set<AdapterCapability> requiredCapabilities()

Returns the value of the requiredCapabilities record component.

Returns:

the value of the requiredCapabilities record component

optionalCapabilities

public Set<AdapterCapability> optionalCapabilities()

Returns the value of the optionalCapabilities record component.

Returns:

the value of the optionalCapabilities record component