org.adroitlogic.x.api

Interface XProject

All Superinterfaces:

Initializable, Startable, XEnvironmentListener

All Known Implementing Classes:

Project

public interface XProject
extends Initializable, Startable, XEnvironmentListener

The interface that represents the project, which is the main artifact that can be deployed into a Project-X runtime

Since:

17.01

Author:

Ruwan Linton

Method Summary

Modifier and Type	Method and Description
void	addTransportListener(TransportListener transportListener)
void	addTransportSender(TransportSender transportSender)
ClassLoader	getClassLoader()
<T> T	getFeature(Class<T> clazz)
List<XIntegrationFlow>	getIntegrationFlows()
XMetricsEngine	getMetricsEngine()
XProjectConfig	getProjectConfig()
XServerConfig	getServerConfig()
Status	getStatus() Returns the current status of this Project
List<TransportListener>	getTransportListeners()
List<TransportSender>	getTransportSenders()
void	pauseProject() This method can be used to pause the project.
CompletableFuture<Boolean>	readyForShutdown() This method can be used to instruct the project to get ready for a shutdown operation.
void	resumeProject() This method can be used to resume the project from a paused state

Methods inherited from interface org.adroitlogic.x.api.dec.Initializable

destroy, init

Methods inherited from interface org.adroitlogic.x.api.dec.Startable

start, stop

Methods inherited from interface org.adroitlogic.x.api.XEnvironmentListener

environmentChanged

Method Detail

getServerConfig

XServerConfig getServerConfig()

getProjectConfig

XProjectConfig getProjectConfig()

getMetricsEngine

XMetricsEngine getMetricsEngine()

getIntegrationFlows

List<XIntegrationFlow> getIntegrationFlows()

getTransportListeners

List<TransportListener> getTransportListeners()

getTransportSenders

List<TransportSender> getTransportSenders()

addTransportListener

void addTransportListener(TransportListener transportListener)

addTransportSender

void addTransportSender(TransportSender transportSender)

getFeature

<T> T getFeature(Class<T> clazz)

getClassLoader

ClassLoader getClassLoader()

getStatus

Status getStatus()

Returns the current status of this Project

Returns:

Status

resumeProject

void resumeProject()

This method can be used to resume the project from a paused state

pauseProject

void pauseProject()

This method can be used to pause the project. Once the project is paused, it will cease to accept new messages through the ingress connectors, but will continue to process any messages that have been already accepted.

readyForShutdown

CompletableFuture<Boolean> readyForShutdown()

This method can be used to instruct the project to get ready for a shutdown operation. When this is triggered, the project will cease to accept new messages through the ingress connectors, but will continue to process any messages that have been already accepted. Once all the accepted messages have been finished processing, the returned completable future will be completed.

Returns:

instance of CompletableFuture which will be completed when the project becomes idle and ready to be shutdown