MessagerConnector (Communote 3.5 API)

All Known Implementing Classes:

XMPPConnector
```
public interface MessagerConnector
```
Interface for integrating several instant messagers.

Author:

Communote GmbH - http://www.communote.com/

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`void`	`disableUser(String username)` This method is called if a user disables this connector.
`void`	`enableUser(String username)` This method is called if a user enables this connector.
`String`	`getBlogMessagerId(long blogId)` returns the blog in the messages format.
`String`	`getClientId(String client)`
`String`	`getClientMessagerId(String clientId)` Returns the client in the messagers format.
`String`	`getDescription()` Returns a description for this messager.
`String`	`getId()` Returns a unique messager id.
`String`	`getName()` Returns the connectors name.
`String`	`getUserAlias(String username)` This method extracts the correct user alias for this connector.
`String`	`getUserMessagerId(long userId)` Returns the user in the messagers format.
`boolean`	`isAvailable(String username)` This method checks if the user is available or not.
`boolean`	`isConnected()`
`void`	`sendMessage(Message message)` New messages are send to the connector via this method.
`void`	`start()` Call this to start the connector.
`void`	`stop()` Should be called before the connector is removed.

- Method Detail
  - disableUser
```
void disableUser(String username)
```
    This method is called if a user disables this connector.
  - enableUser
```
void enableUser(String username)
```
    This method is called if a user enables this connector.
  - getBlogMessagerId
```
String getBlogMessagerId(long blogId)
                  throws BlogNotFoundException,
                         BlogAccessException
```
    returns the blog in the messages format.
    
    Throws:
    
    BlogAccessException
    
    BlogNotFoundException
  - getClientId
```
String getClientId(String client)
```
  - getClientMessagerId
```
String getClientMessagerId(String clientId)
```
    Returns the client in the messagers format.
  - getDescription
```
String getDescription()
```
    Returns a description for this messager.
  - getId
```
String getId()
```
    Returns a unique messager id.
  - getName
```
String getName()
```
    Returns the connectors name.
  - getUserAlias
```
String getUserAlias(String username)
```
    This method extracts the correct user alias for this connector.
  - getUserMessagerId
```
String getUserMessagerId(long userId)
```
    Returns the user in the messagers format.
  - isAvailable
```
boolean isAvailable(String username)
```
    This method checks if the user is available or not.
  - isConnected
```
boolean isConnected()
```
    Returns:
    
    True, if this connector is connected.
  - sendMessage
```
void sendMessage(Message message)
          throws MessagerException
```
    New messages are send to the connector via this method.
    
    Throws:
    
    MessagerException
  - start
```
void start()
```
    Call this to start the connector.
  - stop
```
void stop()
```
    Should be called before the connector is removed.

Interface MessagerConnector

Method Summary

Method Detail

disableUser

enableUser

getBlogMessagerId

getClientId

getClientMessagerId

getDescription

getId

getName

getUserAlias

getUserMessagerId

isAvailable

isConnected

sendMessage

start

stop