Package one.x1f.sip.foundation.core.declarative

Interface DeclarationsRegistryApi

All Known Implementing Classes:

DeclarationsRegistry

public sealed interface DeclarationsRegistryApi
permits DeclarationsRegistry

API interface for DeclarationsRegistry used within the framework structure.

Method Summary

Modifier and Type	Method	Description
List<IntegrationScenarioDefinition>	getCompositeProcessConsumerDefinitions(String compositeProcessID)	Returns consumers of the composite process as defined in the annotation CompositeProcess
List<CompositeProcessDefinition>	getCompositeProcessConsumersForScenario(IntegrationScenarioDefinition integrationScenario)	Returns all the processes that are consumers from a scenario.
IntegrationScenarioDefinition	getCompositeProcessProviderDefinition(String compositeProcessID)	Returns provider of the composite process as defined in the annotation CompositeProcess
List<CompositeProcessDefinition>	getCompositeProcessProvidersForScenario(IntegrationScenarioDefinition integrationScenario)	Returns all the processes that are providers for a scenario.
Optional<ConnectorDefinition>	getConnectorById(String connectorId)	Get ConnectorDefinition by its id.
List<IntegrationScenarioConsumerDefinition>	getConsumersForScenario(IntegrationScenarioDefinition integrationScenario)	Returns all the consumers for a scenario, they can be either CompositeProcessDefinition or OutboundConnectorDefinition
List<InboundConnectorDefinition>	getInboundConnectors()	Get list of all InboundConnectorDefinition.
List<InboundConnectorDefinition>	getInboundConnectorsByScenarioId(String scenarioId)	Get list of InboundConnectorDefinition by id of IntegrationScenarioDefinition.
IntegrationScenarioBase	getIntegrationScenarioBase(String compositeProcessID)
List<OutboundConnectorDefinition>	getOutboundConnectors()	Get list of all OutboundConnectorDefinition.
List<OutboundConnectorDefinition>	getOutboundConnectorsByScenarioId(String scenarioId)	Get list of OutboundConnectorDefinition by id of IntegrationScenarioDefinition.
List<IntegrationScenarioProviderDefinition>	getProvidersForScenario(IntegrationScenarioDefinition integrationScenario)	Returns all the providers for a scenario, they can be either CompositeProcessDefinition or InboundConnectorDefinition
IntegrationScenarioDefinition	getScenarioById(String scenarioId)	Get IntegrationScenarioDefinition by its id.
void	registerClassForOnException(org.apache.camel.model.OnExceptionDefinition key, String className)	Registers the class with given className for onException handling

Method Details

getScenarioById

IntegrationScenarioDefinition getScenarioById(String scenarioId)

Get IntegrationScenarioDefinition by its id.

Parameters:

scenarioId - is its id

Returns:

Integration scenario

getConnectorById

Optional<ConnectorDefinition> getConnectorById(String connectorId)

Get ConnectorDefinition by its id.

Parameters:

connectorId - is its id

Returns:

Optional connector

getInboundConnectors

List<InboundConnectorDefinition> getInboundConnectors()

Get list of all InboundConnectorDefinition.

Returns:

all inbound connectors

getOutboundConnectors

List<OutboundConnectorDefinition> getOutboundConnectors()

Get list of all OutboundConnectorDefinition.

Returns:

all outbound connectors

getInboundConnectorsByScenarioId

List<InboundConnectorDefinition> getInboundConnectorsByScenarioId(String scenarioId)

Get list of InboundConnectorDefinition by id of IntegrationScenarioDefinition.

Parameters:

scenarioId - is its id

Returns:

inbound connectors

getOutboundConnectorsByScenarioId

List<OutboundConnectorDefinition> getOutboundConnectorsByScenarioId(String scenarioId)

Get list of OutboundConnectorDefinition by id of IntegrationScenarioDefinition.

Parameters:

scenarioId - is its id

Returns:

outbound connectors

getCompositeProcessConsumerDefinitions

List<IntegrationScenarioDefinition> getCompositeProcessConsumerDefinitions(String compositeProcessID)

Returns consumers of the composite process as defined in the annotation CompositeProcess

Parameters:

compositeProcessID - id of the process

Returns:

List of IntegrationScenarioDefinition

getCompositeProcessProviderDefinition

IntegrationScenarioDefinition getCompositeProcessProviderDefinition(String compositeProcessID)

Returns provider of the composite process as defined in the annotation CompositeProcess

Parameters:

compositeProcessID - id of the process

Returns:

IntegrationScenarioDefinition

getIntegrationScenarioBase

IntegrationScenarioBase getIntegrationScenarioBase(String compositeProcessID)

getCompositeProcessProvidersForScenario

List<CompositeProcessDefinition> getCompositeProcessProvidersForScenario(IntegrationScenarioDefinition integrationScenario)

Returns all the processes that are providers for a scenario.

Parameters:

integrationScenario - that the processes provide to

Returns:

List of CompositeProcessDefinition

getCompositeProcessConsumersForScenario

List<CompositeProcessDefinition> getCompositeProcessConsumersForScenario(IntegrationScenarioDefinition integrationScenario)

Returns all the processes that are consumers from a scenario.

Parameters:

integrationScenario - that the processes consumes from

Returns:

List of CompositeProcessDefinition

getProvidersForScenario

List<IntegrationScenarioProviderDefinition> getProvidersForScenario(IntegrationScenarioDefinition integrationScenario)

Returns all the providers for a scenario, they can be either CompositeProcessDefinition or InboundConnectorDefinition

Parameters:

integrationScenario - that are being provided to

Returns:

List of IntegrationScenarioProviderDefinition

getConsumersForScenario

List<IntegrationScenarioConsumerDefinition> getConsumersForScenario(IntegrationScenarioDefinition integrationScenario)

Returns all the consumers for a scenario, they can be either CompositeProcessDefinition or OutboundConnectorDefinition

Parameters:

integrationScenario - that are being consumed from

Returns:

List of IntegrationScenarioProviderDefinition

registerClassForOnException

void registerClassForOnException(org.apache.camel.model.OnExceptionDefinition key,
 String className)

Registers the class with given className for onException handling

Parameters:

key - Exception definition key

className - Class to register