Package com.linecorp.centraldogma.server

Class CentralDogma

java.lang.Object

com.linecorp.centraldogma.server.CentralDogma

All Implemented Interfaces:

AutoCloseable

public class CentralDogma
extends Object
implements AutoCloseable

Central Dogma server.

See Also:

• CentralDogmaBuilder

Method Summary

Modifier and Type	Method	Description
ServerPort	activePort()	Returns the primary port of the server.
Map<InetSocketAddress,ServerPort>	activePorts()	Returns the ports of the server.
void	close()
CentralDogmaConfig	config()	Returns the configuration of the server.
static CentralDogma	forConfig(File configFile)	Creates a new instance from the given configuration file.
Optional<MeterRegistry>	meterRegistry()	Returns the MeterRegistry that contains the stats related with the server.
MirroringService	mirroringService()	Returns the MirroringService of the server.
List<Plugin>	plugins(PluginTarget target)	Returns the Plugins which have been loaded.
ProjectManager	projectManager()	Returns the ProjectManager of the server if the server is started.
CompletableFuture<Void>	start()	Starts the server.
CompletableFuture<Void>	stop()	Stops the server.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

forConfig

public static CentralDogma forConfig(File configFile)
                              throws IOException

Creates a new instance from the given configuration file.

Throws:

IOException - if failed to load the configuration from the specified file

config

public CentralDogmaConfig config()

Returns the configuration of the server.

Returns:

the CentralDogmaConfig instance which is used for configuring this CentralDogma.

activePort

@Nullable
public ServerPort activePort()

Returns the primary port of the server.

Returns:

the primary ServerPort if the server is started. Optional.empty() otherwise.

activePorts

public Map<InetSocketAddress,ServerPort> activePorts()

Returns the ports of the server.

Returns:

the Map which contains the pairs of local InetSocketAddress and ServerPort is the server is started. Optional.empty() otherwise.

projectManager

@Nullable
public ProjectManager projectManager()

Returns the ProjectManager of the server if the server is started. null is returned, otherwise.

mirroringService

@Nullable
public MirroringService mirroringService()

Returns the MirroringService of the server.

Returns:

the MirroringService if the server is started and mirroring is enabled. null otherwise.

plugins

public List<Plugin> plugins(PluginTarget target)

Returns the Plugins which have been loaded.

Parameters:

target - the PluginTarget of the Plugins to be returned

meterRegistry

public Optional<MeterRegistry> meterRegistry()

Returns the MeterRegistry that contains the stats related with the server.

start

public CompletableFuture<Void> start()

Starts the server.

stop

public CompletableFuture<Void> stop()

Stops the server. This method does nothing if the server is stopped already.

close

public void close()

Specified by:

close in interface AutoCloseable