TelemeeJavaClient (TelemeeJavaClient 0.01 API)

java.lang.Object
- de.strullerbaumann.telemeejavaclient.boundary.TelemeeJavaClient

All Implemented Interfaces:

Serializable
```
public class TelemeeJavaClient
extends Object
implements Serializable
```
TelemeeJavaClient is the client to communicate from a java-application to the telemee-server.
Example usage:
TelemeeJavaClient tj = new TelemeeJavaClient(); tj.init(); tj.setLogLevel(TelemeeJavaClient.INFO); TelemeeApp TEST_APP_01 = new TelemeeApp("Testapp 01"); Channel TEST_CHANNEL_01 = new Channel("Testchannel 01"); ChannelAttribute TEST_CHANNELATTRIBUTE_X = new ChannelAttribute("X"); ChannelAttribute TEST_CHANNELATTRIBUTE_Y = new ChannelAttribute("Y"); tj.forTelemeeApp(TEST_APP_01) .forChannel(TEST_CHANNEL_01) .forChannelAttribute(TEST_CHANNELATTRIBUTE_X) .log(123) .forChannelAttribute(TEST_CHANNELATTRIBUTE_Y) .log(456) .endLogEntry() .send();

Since:

0.01

Version:

0.01

Author:

Thomas Struller-Baumann

See Also:
Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`ALL`
`static int`	`FINE`
`static int`	`FINER`
`static int`	`FINEST`
`static int`	`INFO`
`static int`	`OFF`
`static int`	`SEVERE`
`static int`	`WARNING`

Constructor Summary

Constructors
Constructor and Description

TelemeeJavaClient()

Constructors
Constructor and Description
`TelemeeJavaClient()`

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`clearCache()` Clear internal cache of TelemeeJavaClient.
`void`	`deleteChannel(Channel channelToDelete)` Deletes a Channel on the server.
`void`	`deleteChannelAttribute(ChannelAttribute channelAttributeToDelete)` Deletes a ChannelAttribute on the server.
`void`	`deleteLogEntries(Channel channel)` Deletes a LogEntries of a given channel on the server.
`void`	`deleteTelemeeApp(TelemeeApp telemeeAppToDelete)` Deletes a TelemeeApp on the server.
`void`	`destroy()` Destroy client for cleanup.
`TelemeeJavaClient`	`endLogEntry()` Define the end of a logEntry.
`TelemeeJavaClient`	`forChannel(Channel channel)` Define the current channel.
`TelemeeJavaClient`	`forChannelAttribute(ChannelAttribute channelAttribute)` Define the current channelAttribute.
`TelemeeJavaClient`	`forTelemeeApp(TelemeeApp telemeeApp)` Define the current telemeeApp.
`String`	`getBaseURI()` Get base URI to server.
`Channel`	`getChannel(String name)` Get Channel by name.
`Collection<ChannelAttribute>`	`getChannelAttributes()` Get all ChannelAttributes.
`Collection<Channel>`	`getChannels()` Get all Channels.
`Long`	`getLogEntriesCount(Channel channel)` Get count of logEntries of a channel.
`int`	`getLogLevel()` Get logLevel.
`Collection<TelemeeApp>`	`getTelemeeApps()` Get all TelemeeApps from the TelemeeJavaClient-Chache.
`int`	`getThreadPoolSize()` Get the threadpoolsize in the restclient (for asynchronous creation of logEntries).
`void`	`init()` Initializes TelemeeJavaClient with the default base-URI http://localhost:8080.
`void`	`init(String baseURI)` Initializes TelemeeJavaClient with the given base-URI.
`TelemeeJavaClient`	`log(boolean value)` Create a logValue of type boolean for a started logEntry.
`TelemeeJavaClient`	`log(char value)` Create a logValue of type char for a started logEntry.
`TelemeeJavaClient`	`log(char[] value)` Create a logValue of type char[] for a started logEntry.
`TelemeeJavaClient`	`log(double value)` Create a logValue of type double for a started logEntry.
`TelemeeJavaClient`	`log(float value)` Create a logValue of type float for a started logEntry.
`TelemeeJavaClient`	`log(int value)` Create a logValue of type int for a started logEntry.
`TelemeeJavaClient`	`log(long value)` Create a logValue of type long for a started logEntry.
`TelemeeJavaClient`	`log(Object value)` Create a logValue of type String for a started logEntry.
`TelemeeJavaClient`	`log(String value)` Create a logValue of type String for a started logEntry.
`void`	`send()` Send all TelemeeApps, Channels, ChannelAttributes, Bindings and LogEntries to the Server.
`void`	`sendAsync()` Send all TelemeeApps, Channels, ChannelAttributes, Bindings and LogEntries to the Server.
`void`	`setBaseURI(String baseURI)` Set base URI to server.
`void`	`setLogLevel(int logLevel)` Set logLevel.
`void`	`setThreadPoolSize(int threadPoolSize)` Set the threadpoolsize in the restclient (for asynchronous creation of logEntries).
`TelemeeJavaClient`	`startLogEntry(String description, int logLevel)` Define the start of an new logEntry.
`void`	`waitTillAllIsDone()` Wait until all asynchronous sended logEntries are done.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - OFF
```
public static final int OFF
```
    See Also:
    Constant Field Values
  - SEVERE
```
public static final int SEVERE
```
    See Also:
    Constant Field Values
  - WARNING
```
public static final int WARNING
```
    See Also:
    Constant Field Values
  - INFO
```
public static final int INFO
```
    See Also:
    Constant Field Values
  - FINE
```
public static final int FINE
```
    See Also:
    Constant Field Values
  - FINER
```
public static final int FINER
```
    See Also:
    Constant Field Values
  - FINEST
```
public static final int FINEST
```
    See Also:
    Constant Field Values
  - ALL
```
public static final int ALL
```
    See Also:
    Constant Field Values
- Constructor Detail
  - TelemeeJavaClient
```
public TelemeeJavaClient()
```
- Method Detail
  - init
```
public void init()
```
    Initializes TelemeeJavaClient with the default base-URI http://localhost:8080.
  - init
```
public void init(String baseURI)
```
    Initializes TelemeeJavaClient with the given base-URI.
    
    Parameters:
    baseURI -
  - getThreadPoolSize
```
public int getThreadPoolSize()
```
    Get the threadpoolsize in the restclient (for asynchronous creation of logEntries). Defaultvalue is 5.
    
    Returns:
    int
  - setThreadPoolSize
```
public void setThreadPoolSize(int threadPoolSize)
```
    Set the threadpoolsize in the restclient (for asynchronous creation of logEntries). Defaultvalue is 5.
    
    Parameters:
    threadPoolSize -
  - destroy
```
public void destroy()
```
    Destroy client for cleanup.
  - getBaseURI
```
public String getBaseURI()
```
    Get base URI to server.
    
    Returns:
    String
  - setBaseURI
```
public void setBaseURI(String baseURI)
```
    Set base URI to server.
    
    Parameters:
    baseURI -
  - getLogLevel
```
public int getLogLevel()
```
    Get logLevel.
    
    Returns:
    int
  - setLogLevel
```
public void setLogLevel(int logLevel)
```
    Set logLevel.
    
    Parameters:
    logLevel -
  - deleteTelemeeApp
```
public void deleteTelemeeApp(TelemeeApp telemeeAppToDelete)
```
    Deletes a TelemeeApp on the server.
    
    Parameters:
    telemeeAppToDelete -
  - deleteChannel
```
public void deleteChannel(Channel channelToDelete)
```
    Deletes a Channel on the server.
    
    Parameters:
    channelToDelete -
  - deleteChannelAttribute
```
public void deleteChannelAttribute(ChannelAttribute channelAttributeToDelete)
```
    Deletes a ChannelAttribute on the server.
    
    Parameters:
    channelAttributeToDelete -
  - deleteLogEntries
```
public void deleteLogEntries(Channel channel)
```
    Deletes a LogEntries of a given channel on the server.
    
    Parameters:
    channel -
  - getTelemeeApps
```
public Collection<TelemeeApp> getTelemeeApps()
```
    Get all TelemeeApps from the TelemeeJavaClient-Chache. TelemeeApps from other applications could be not in this collection, because it is only synchronized with the server on the instantiation of TelemeeJavaClient.
    
    Returns:
    Collection
  - getChannels
```
public Collection<Channel> getChannels()
```
    Get all Channels. Channels from other applications could be not in this collection, because it is only synchronized with the server on the instantiation of TelemeeJavaClient.
    
    Returns:
    Collection
  - getChannelAttributes
```
public Collection<ChannelAttribute> getChannelAttributes()
```
    Get all ChannelAttributes. ChannelAttributes from other applications could be not in this collection, because it is only synchronized with the server on the instantiation of TelemeeJavaClient.
    
    Returns:
    Collection
  - forTelemeeApp
```
public TelemeeJavaClient forTelemeeApp(TelemeeApp telemeeApp)
```
    Define the current telemeeApp.
    
    Parameters:
    telemeeApp - the telemeeApp
    
    Returns:
    TelemeeJavaClient for fluent-API
  - forChannel
```
public TelemeeJavaClient forChannel(Channel channel)
```
    Define the current channel.
    
    Parameters:
    channel -
    
    Returns:
    TelemeeJavaClient for fluent-API
  - forChannelAttribute
```
public TelemeeJavaClient forChannelAttribute(ChannelAttribute channelAttribute)
```
    Define the current channelAttribute.
    
    Parameters:
    channelAttribute -
    
    Returns:
    TelemeeJavaClient for fluent-API
  - getLogEntriesCount
```
public Long getLogEntriesCount(Channel channel)
```
    Get count of logEntries of a channel.
    
    Parameters:
    channel -
    
    Returns:
    Long
  - startLogEntry
```
public TelemeeJavaClient startLogEntry(String description,
                              int logLevel)
```
    Define the start of an new logEntry.
    
    Parameters:
    description -
    logLevel -
    
    Returns:
    TelemeeJavaClient for fluent-API
  - log
```
public TelemeeJavaClient log(String value)
```
    Create a logValue of type String for a started logEntry.
    
    Parameters:
    value -
    
    Returns:
    TelemeeJavaClient for fluent-API
  - log
```
public TelemeeJavaClient log(Object value)
```
    Create a logValue of type String for a started logEntry.
    
    Parameters:
    value -
    
    Returns:
    TelemeeJavaClient for fluent-API
  - log
```
public TelemeeJavaClient log(boolean value)
```
    Create a logValue of type boolean for a started logEntry.
    
    Parameters:
    value -
    
    Returns:
    TelemeeJavaClient for fluent-API
  - log
```
public TelemeeJavaClient log(char value)
```
    Create a logValue of type char for a started logEntry.
    
    Parameters:
    value -
    
    Returns:
    TelemeeJavaClient for fluent-API
  - log
```
public TelemeeJavaClient log(char[] value)
```
    Create a logValue of type char[] for a started logEntry.
    
    Parameters:
    value -
    
    Returns:
    TelemeeJavaClient for fluent-API
  - log
```
public TelemeeJavaClient log(double value)
```
    Create a logValue of type double for a started logEntry.
    
    Parameters:
    value -
    
    Returns:
    TelemeeJavaClient for fluent-API
  - log
```
public TelemeeJavaClient log(float value)
```
    Create a logValue of type float for a started logEntry.
    
    Parameters:
    value -
    
    Returns:
    TelemeeJavaClient for fluent-API
  - log
```
public TelemeeJavaClient log(int value)
```
    Create a logValue of type int for a started logEntry.
    
    Parameters:
    value -
    
    Returns:
    TelemeeJavaClient for fluent-API
  - log
```
public TelemeeJavaClient log(long value)
```
    Create a logValue of type long for a started logEntry.
    
    Parameters:
    value -
    
    Returns:
    TelemeeJavaClient for fluent-API
  - endLogEntry
```
public TelemeeJavaClient endLogEntry()
```
    Define the end of a logEntry.
    
    Returns:
    TelemeeJavaClient for fluent-API
  - getChannel
```
public Channel getChannel(String name)
```
    Get Channel by name.
    
    Parameters:
    name -
    
    Returns:
    Channel
  - clearCache
```
public void clearCache()
```
    Clear internal cache of TelemeeJavaClient.
  - waitTillAllIsDone
```
public void waitTillAllIsDone()
```
    Wait until all asynchronous sended logEntries are done.
  - send
```
public void send()
```
    Send all TelemeeApps, Channels, ChannelAttributes, Bindings and LogEntries to the Server. LogEntries are sended synchronously.
  - sendAsync
```
public void sendAsync()
```
    Send all TelemeeApps, Channels, ChannelAttributes, Bindings and LogEntries to the Server. LogEntries are sended asynchronously.

Class TelemeeJavaClient

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

OFF

SEVERE

WARNING

INFO

FINE

FINER

FINEST

ALL

Constructor Detail

TelemeeJavaClient

Method Detail

init

init

getThreadPoolSize

setThreadPoolSize

destroy

getBaseURI

setBaseURI

getLogLevel

setLogLevel

deleteTelemeeApp

deleteChannel

deleteChannelAttribute

deleteLogEntries

getTelemeeApps

getChannels

getChannelAttributes

forTelemeeApp

forChannel

forChannelAttribute

getLogEntriesCount

startLogEntry

log

log

log

log

log

log

log

log

log

endLogEntry

getChannel

clearCache

waitTillAllIsDone

send

sendAsync