Package dev.le_app.mcss_api_java

Class MCSSApi

java.lang.Object

dev.le_app.mcss_api_java.MCSSApi

public class MCSSApi
extends Object

The main class of the API.

Field Summary

Fields

Modifier and Type	Field	Description
protected Boolean	allowUnsafeSSL
protected String	expectedVersion
protected String	IP
protected String	token
protected String	version

Constructor Summary

Constructors

Constructor	Description
MCSSApi(String IP, String token)	Create a new MCSSApi object
MCSSApi(String IP, String token, Boolean allowUnsafeSSL)	Get the API object

Method Summary

Modifier and Type	Method	Description
Info	getInfo()	Get general information about the MCSS install
int	getServerCount()	Get the number of servers.
int	getServerCount(ServerFilter filter)	Get the number of servers.
int	getServerCount(ServerFilter filter, String serverTypeID)	Get the number of servers.
ArrayList<Server>	getServers()	Get the list of servers

Methods inherited from class java.lang.Object

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

Field Details

IP

protected String IP

token

protected String token

version

protected String version

expectedVersion

protected String expectedVersion

allowUnsafeSSL

protected Boolean allowUnsafeSSL

Constructor Details

MCSSApi

public MCSSApi(String IP,
 String token)
        throws APIUnauthorizedException,
APIVersionMismatchException,
IOException

Create a new MCSSApi object

Parameters:

IP - The IP of the MCSS server

token - The token of the MCSS server

Throws:

APIUnauthorizedException - If the token is invalid

APIVersionMismatchException - If the API version of the MCSS server is not the same as the expected version

IOException - If there is an error connecting to the MCSS server

MCSSApi

public MCSSApi(String IP,
 String token,
 Boolean allowUnsafeSSL)
        throws APIUnauthorizedException,
APIVersionMismatchException,
IOException,
NoSuchAlgorithmException,
KeyManagementException

Get the API object

Parameters:

IP - The IP of the MCSS server

token - The token of the MCSS server

allowUnsafeSSL - True if you want to avoid checking the SSL certificate

Throws:

APIUnauthorizedException - If the token is invalid

APIVersionMismatchException - If the API version is not the same as the expected version

IOException - If there is an error while connecting to the API

KeyManagementException - If there is an error with the KeyManagment

NoSuchAlgorithmException - If there is an error with the SSLContext

Method Details

getInfo

public Info getInfo()
             throws IOException,
APIUnauthorizedException

Get general information about the MCSS install

Returns:

Info object containing the information

Throws:

IOException - General IO error

APIUnauthorizedException - API token is invalid/expired

getServers

public ArrayList<Server> getServers()
                             throws APIUnauthorizedException,
APINotFoundException,
IOException,
APINoServerAccessException

Get the list of servers

Returns:

ArrayList of servers

Throws:

APIUnauthorizedException - API token is invalid/expired

APINotFoundException - API not found

IOException - General IO error

APINoServerAccessException - API does not have access to any server

getServerCount

public int getServerCount()
                   throws APIUnauthorizedException,
IOException

Get the number of servers.

Returns:

number of servers

Throws:

APIUnauthorizedException - if the APIKey is invalid

IOException - if there is an error with the connection

getServerCount

public int getServerCount(ServerFilter filter)
                   throws APIUnauthorizedException,
IOException

Get the number of servers.

Parameters:

filter - the filter to use

Returns:

number of servers

Throws:

APIUnauthorizedException - if the APIKey is invalid

IOException - if there is an error with the connection

getServerCount

public int getServerCount(ServerFilter filter,
 String serverTypeID)
                   throws APIUnauthorizedException,
IOException

Get the number of servers. Only used for the servertype filter.

Parameters:

filter - the ServerFilter to use

serverTypeID - Only required if the filter is FILTER

Returns:

number of servers

Throws:

APIUnauthorizedException - if the APIKey is invalid

IOException - if there is an error with the connection