Package xyz.brandonfl.firedeamon.fusion.api

Class FiredeamonFusionApi

java.lang.Object

xyz.brandonfl.firedeamon.fusion.api.FiredeamonFusionApi

public class FiredeamonFusionApi
extends java.lang.Object

Firedeamon Fusion API for Java.

Author:

brandon fontany-legall

Field Summary

Fields

Modifier and Type	Field	Description
protected java.lang.String	password
protected java.lang.String	url
protected java.lang.String	username

Constructor Summary

Constructors

Constructor	Description
FiredeamonFusionApi(java.lang.String url, java.lang.String username, java.lang.String password)	Open a new connection with a FireDaemon Fusion instance

Method Summary

Modifier and Type	Method	Description
ServiceInformation	getService(java.lang.String serviceName)	Fetch information of a specific service
java.util.List<ServiceInformation>	getServices()	Fetch FireDaemon services
void	updateServiceStatus(java.lang.String serviceName, ServiceAction serviceAction)	Update the status of a specific service.

Methods inherited from class java.lang.Object

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

Field Detail

url

protected final java.lang.String url

username

protected final java.lang.String username

password

protected final java.lang.String password

Constructor Detail

FiredeamonFusionApi

public FiredeamonFusionApi(java.lang.String url,
                           java.lang.String username,
                           java.lang.String password)

Open a new connection with a FireDaemon Fusion instance

Parameters:

url - url of the FireDaemon Fusion instance. For example https://localhost:20604

username - the name of the FireDaemon user

password - the password for the FireDaemon user

Since:

6.0.0

Method Detail

getServices

public java.util.List<ServiceInformation> getServices()
                                               throws AuthenticationException,
                                                      ApiException

Fetch FireDaemon services

Returns:

List of ServiceInformation

Throws:

AuthenticationException - In case of authentication exception

ApiException - If the api return an error

Since:

6.0.0

getService

public ServiceInformation getService(java.lang.String serviceName)
                              throws AuthenticationException,
                                     ApiException

Fetch information of a specific service

Parameters:

serviceName - service name as String

Returns:

ServiceInformation of the service

Throws:

AuthenticationException - In case of authentication exception

ApiException - If the api return an error

Since:

6.0.0

updateServiceStatus

public void updateServiceStatus(java.lang.String serviceName,
                                ServiceAction serviceAction)
                         throws AuthenticationException,
                                ApiException

Update the status of a specific service. We can :

• Start the service with ServiceAction.START
• Restart the service with ServiceAction.RESTART
• Stop the service with ServiceAction.STOP

Parameters:

serviceName - service name as String

serviceAction - the ServiceAction to perform on the service

Throws:

AuthenticationException - In case of authentication exception

ApiException - If the api return an error

Since:

6.0.0