gs.mclo.java

Class MclogsAPI

java.lang.Object

gs.mclo.java.MclogsAPI

public class MclogsAPI
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	mcversion
static java.lang.String	userAgent
static java.lang.String	version

Constructor Summary

Constructors

Constructor and Description
MclogsAPI()

Method Summary

Modifier and Type	Method and Description
static java.lang.String	get(java.lang.String id) get the raw log contents
static java.lang.String	getApiHost()
static java.lang.String	getProtocol()
static java.lang.String[]	listCrashReports(java.lang.String directory) list crash reports in a directory
static java.lang.String[]	listLogs(java.lang.String directory) list logs in a directory
static void	setApiHost(java.lang.String apiHost)
static void	setProtocol(java.lang.String protocol)
static APIResponse	share(Log log) share a log to the mclogs API
static APIResponse	share(java.nio.file.Path logFile) share a log to the mclogs API
static APIResponse	share(java.lang.String dir, java.lang.String file) Deprecated. Use share(Log) or share(Path) instead

Methods inherited from class java.lang.Object

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

Field Detail

mcversion

public static java.lang.String mcversion

userAgent

public static java.lang.String userAgent

version

public static java.lang.String version

Constructor Detail

MclogsAPI

public MclogsAPI()

Method Detail

share

public static APIResponse share(Log log)
                         throws java.io.IOException

share a log to the mclogs API

Parameters:

log - The Log to share

Returns:

mclogs APIResponse

Throws:

java.io.IOException - error sharing the log content

share

public static APIResponse share(java.nio.file.Path logFile)
                         throws java.io.IOException

share a log to the mclogs API

Parameters:

logFile - The log file, which must have a file extension of '.log'. The file extension may be suffixed by both `.0` and `.gz`

Returns:

mclogs APIResponse

Throws:

java.io.IOException - error reading/sharing file

share

@Deprecated
public static APIResponse share(java.lang.String dir,
                                            java.lang.String file)
                                     throws java.io.IOException

Deprecated. Use share(Log) or share(Path) instead

share a log to the mclogs API

Parameters:

dir - The parent directory of the log file

file - The log file, which must have a file extension of '.log'. The file extension may be suffixed by both `.0` and `.gz`

Returns:

mclogs APIResponse

Throws:

java.io.IOException - error reading/sharing file

get

public static java.lang.String get(java.lang.String id)
                            throws java.io.IOException

get the raw log contents

Parameters:

id - log id

Returns:

log content

Throws:

java.io.IOException - connection error

listLogs

public static java.lang.String[] listLogs(java.lang.String directory)

list logs in a directory

Parameters:

directory - server/client directory

Returns:

log file names

listCrashReports

public static java.lang.String[] listCrashReports(java.lang.String directory)

list crash reports in a directory

Parameters:

directory - server/client directory

Returns:

log file names

getApiHost

public static java.lang.String getApiHost()

Returns:

api host URL

setApiHost

public static void setApiHost(java.lang.String apiHost)

Parameters:

apiHost - api host url

getProtocol

public static java.lang.String getProtocol()

Returns:

protocol

setProtocol

public static void setProtocol(java.lang.String protocol)

Parameters:

protocol - protocol