org.mythtv.services.api.myth
Interface MythOperations

All Known Implementing Classes:

MythTemplate

public interface MythOperations

Author:

Daniel Frey

Method Summary

org.springframework.http.ResponseEntity<Bool>	addStorageGroupDir(String groupName, String directoryName, String hostName) - POST
org.springframework.http.ResponseEntity<Bool>	backupDatabase() - POST
org.springframework.http.ResponseEntity<Bool>	changePassword(String username, String oldPassword, String newPassword) - POST
org.springframework.http.ResponseEntity<Bool>	checkDatabase(boolean repair) - POST
org.springframework.http.ResponseEntity<ConnectionInfo>	getConnectionInfo(String pin, ETagInfo etag) - GET
org.springframework.http.ResponseEntity<String>	getHostName() - GET
org.springframework.http.ResponseEntity<StringList>	getHosts(ETagInfo etag) - GET
org.springframework.http.ResponseEntity<StringList>	getKeys(ETagInfo etag) - GET
org.springframework.http.ResponseEntity<LogMessageList>	getLogs(String hostname, String application, int pid, int tid, String thread, String filename, int line, String function, org.joda.time.DateTime from, org.joda.time.DateTime to, String level, String messageContains, ETagInfo etag) - GET
org.springframework.http.ResponseEntity<SettingList>	getSetting(String hostname, String key, String defaultValue, ETagInfo etag) - GET
org.springframework.http.ResponseEntity<StorageGroupDirectoryList>	getStoreageGroupDirectories(String groupName, String hostname, ETagInfo etag) - GET
org.springframework.http.ResponseEntity<TimeZoneInfo>	getTimeZoneInfo() - GET
org.springframework.http.ResponseEntity<Bool>	profileDelete() - POST
org.springframework.http.ResponseEntity<Bool>	profileSubmit() - POST
org.springframework.http.ResponseEntity<String>	profileText() - GET
org.springframework.http.ResponseEntity<String>	profileUpdated() - GET
org.springframework.http.ResponseEntity<String>	profileUrl() - GET
org.springframework.http.ResponseEntity<Bool>	putSetting(String hostname, String key, String value) - POST
org.springframework.http.ResponseEntity<Bool>	removeStorageGroupDirectory(String groupName, String directoryName, String hostname) - POST
org.springframework.http.ResponseEntity<Bool>	sendMessage(String message, String address, int udpPort, int timeout) - GET
org.springframework.http.ResponseEntity<Bool>	testDatabaseSettings(String hostname, String username, String password, String databaseName, int databasePort) - POST

Method Detail

addStorageGroupDir

org.springframework.http.ResponseEntity<Bool> addStorageGroupDir(String groupName,
                                                                 String directoryName,
                                                                 String hostName)
                                                                 throws MythServiceApiRuntimeException

- POST

Parameters:

groupName -

directoryName -

hostName -

Returns:

Throws:

MythServiceApiRuntimeException

backupDatabase

org.springframework.http.ResponseEntity<Bool> backupDatabase()
                                                             throws MythServiceApiRuntimeException

- POST

Returns:

Throws:

MythServiceApiRuntimeException

changePassword

org.springframework.http.ResponseEntity<Bool> changePassword(String username,
                                                             String oldPassword,
                                                             String newPassword)
                                                             throws MythServiceApiRuntimeException

- POST

Parameters:

username -

oldPassword -

newPassword -

Returns:

Throws:

MythServiceApiRuntimeException

checkDatabase

org.springframework.http.ResponseEntity<Bool> checkDatabase(boolean repair)
                                                            throws MythServiceApiRuntimeException

- POST

Parameters:

repair -

Returns:

Throws:

MythServiceApiRuntimeException

getConnectionInfo

org.springframework.http.ResponseEntity<ConnectionInfo> getConnectionInfo(String pin,
                                                                          ETagInfo etag)
                                                                          throws MythServiceApiRuntimeException

- GET

Parameters:

pin -

Returns:

Throws:

MythServiceApiRuntimeException

getHostName

org.springframework.http.ResponseEntity<String> getHostName()
                                                            throws MythServiceApiRuntimeException

- GET

Returns:

Throws:

MythServiceApiRuntimeException

getHosts

org.springframework.http.ResponseEntity<StringList> getHosts(ETagInfo etag)
                                                             throws MythServiceApiRuntimeException

- GET

Returns:

Throws:

MythServiceApiRuntimeException

getKeys

org.springframework.http.ResponseEntity<StringList> getKeys(ETagInfo etag)
                                                            throws MythServiceApiRuntimeException

- GET

Returns:

Throws:

MythServiceApiRuntimeException

getLogs

org.springframework.http.ResponseEntity<LogMessageList> getLogs(String hostname,
                                                                String application,
                                                                int pid,
                                                                int tid,
                                                                String thread,
                                                                String filename,
                                                                int line,
                                                                String function,
                                                                org.joda.time.DateTime from,
                                                                org.joda.time.DateTime to,
                                                                String level,
                                                                String messageContains,
                                                                ETagInfo etag)
                                                                throws MythServiceApiRuntimeException

- GET

Parameters:

hostname -

application -

pid -

tid -

thread -

filename -

line -

function -

from -

to -

level -

messageContains -

Returns:

Throws:

MythServiceApiRuntimeException

getSetting

org.springframework.http.ResponseEntity<SettingList> getSetting(String hostname,
                                                                String key,
                                                                String defaultValue,
                                                                ETagInfo etag)
                                                                throws MythServiceApiRuntimeException

- GET

Parameters:

hostname -

key -

defaultValue -

Returns:

Throws:

MythServiceApiRuntimeException

getStoreageGroupDirectories

org.springframework.http.ResponseEntity<StorageGroupDirectoryList> getStoreageGroupDirectories(String groupName,
                                                                                               String hostname,
                                                                                               ETagInfo etag)
                                                                                               throws MythServiceApiRuntimeException

- GET

Parameters:

groupName -

hostname -

Returns:

Throws:

MythServiceApiRuntimeException

getTimeZoneInfo

org.springframework.http.ResponseEntity<TimeZoneInfo> getTimeZoneInfo()
                                                                      throws MythServiceApiRuntimeException

- GET

Returns:

Throws:

MythServiceApiRuntimeException

profileDelete

org.springframework.http.ResponseEntity<Bool> profileDelete()
                                                            throws MythServiceApiRuntimeException

- POST

Returns:

Throws:

MythServiceApiRuntimeException

profileSubmit

org.springframework.http.ResponseEntity<Bool> profileSubmit()
                                                            throws MythServiceApiRuntimeException

- POST

Returns:

Throws:

MythServiceApiRuntimeException

profileText

org.springframework.http.ResponseEntity<String> profileText()
                                                            throws MythServiceApiRuntimeException

- GET

Returns:

Throws:

MythServiceApiRuntimeException

profileUrl

org.springframework.http.ResponseEntity<String> profileUrl()
                                                           throws MythServiceApiRuntimeException

- GET

Returns:

Throws:

MythServiceApiRuntimeException

profileUpdated

org.springframework.http.ResponseEntity<String> profileUpdated()
                                                               throws MythServiceApiRuntimeException

- GET

Returns:

Throws:

MythServiceApiRuntimeException

putSetting

org.springframework.http.ResponseEntity<Bool> putSetting(String hostname,
                                                         String key,
                                                         String value)
                                                         throws MythServiceApiRuntimeException

- POST

Parameters:

hostname -

key -

value -

Returns:

Throws:

MythServiceApiRuntimeException

removeStorageGroupDirectory

org.springframework.http.ResponseEntity<Bool> removeStorageGroupDirectory(String groupName,
                                                                          String directoryName,
                                                                          String hostname)
                                                                          throws MythServiceApiRuntimeException

- POST

Parameters:

groupName -

directoryName -

hostname -

Returns:

Throws:

MythServiceApiRuntimeException

sendMessage

org.springframework.http.ResponseEntity<Bool> sendMessage(String message,
                                                          String address,
                                                          int udpPort,
                                                          int timeout)
                                                          throws MythServiceApiRuntimeException

- GET

Parameters:

message -

address -

udpPort -

timeout -

Returns:

Throws:

MythServiceApiRuntimeException

testDatabaseSettings

org.springframework.http.ResponseEntity<Bool> testDatabaseSettings(String hostname,
                                                                   String username,
                                                                   String password,
                                                                   String databaseName,
                                                                   int databasePort)
                                                                   throws MythServiceApiRuntimeException

- POST

Parameters:

hostname -

username -

password -

databaseName -

databasePort -

Returns:

Throws:

MythServiceApiRuntimeException