jenkins.plugins.smilehubnotifier.rocket

Class RocketChatClientImpl

java.lang.Object

jenkins.plugins.smilehubnotifier.rocket.RocketChatClientImpl

All Implemented Interfaces:

RocketChatClient

public class RocketChatClientImpl
extends Object
implements RocketChatClient

Client for Rocket.Chat which relies on the REST API v1.

Please note, this client does not cache any of the results.

Since:

0.0.1

Version:

0.1.0

Constructor Summary

Constructors

Constructor and Description
RocketChatClientImpl(String serverUrl, boolean trustSSL, String webhookToken) Initialize a new instance of the client providing the server's url along with webhook for posting notifications.
RocketChatClientImpl(String serverUrl, boolean trustSSL, String user, String password) Initialize a new instance of the client providing the server's url along with username and password to use.

Method Summary

Modifier and Type	Method and Description
Room[]	getChannels()
String	getInfo() Retrieves server information
User	getUser(String userId) Retrieves a User from the Rocket.Chat server.
User[]	getUsers() Gets all of the users from a Rocket.Chat server, if you have a ton this will take some time.
void	send(Room room, String message) sends a message to a channel
void	send(String channelName, String message) sends a message to a channel
void	send(String channelName, String message, String emoji, String avatar) sends a message to a channel.
void	send(String channelName, String message, String emoji, String avatar, List<Map<String,Object>> attachments) sends a message to a channel.

Methods inherited from class java.lang.Object

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

Constructor Detail

RocketChatClientImpl

public RocketChatClientImpl(String serverUrl,
                            boolean trustSSL,
                            String user,
                            String password)
                     throws RocketClientException

Initialize a new instance of the client providing the server's url along with username and password to use.

Parameters:

serverUrl - of the Rocket.Chat server, with or without it ending in "/api/"

trustSSL - if set set the SSL certificate of the rpcket server will not be checked

user - which to authenticate with

password - of the user to authenticate with

Throws:

RocketClientException

RocketChatClientImpl

public RocketChatClientImpl(String serverUrl,
                            boolean trustSSL,
                            String webhookToken)
                     throws RocketClientException

Initialize a new instance of the client providing the server's url along with webhook for posting notifications.

Parameters:

serverUrl - of the Rocket.Chat server, with or without it ending in "/api/"

trustSSL - if set set the SSL certificate of the rocket server will not be checked

webhookToken - authentication token or URL

Throws:

RocketClientException

Method Detail

getUsers

public User[] getUsers()
                throws RocketClientException

Description copied from interface: RocketChatClient

Gets all of the users from a Rocket.Chat server, if you have a ton this will take some time.

Specified by:

getUsers in interface RocketChatClient

Returns:

an array of Users

Throws:

RocketClientException - is thrown if there was a problem connecting, including if the result wasn't successful

getUser

public User getUser(String userId)
             throws RocketClientException

Description copied from interface: RocketChatClient

Retrieves a User from the Rocket.Chat server.

Specified by:

getUser in interface RocketChatClient

Parameters:

userId - of the user to retrieve

Returns:

an instance of the User

Throws:

RocketClientException - is thrown if there was a problem connecting, including if the result wasn't successful or there is no user

getChannels

public Room[] getChannels()
                   throws RocketClientException

Specified by:

getChannels in interface RocketChatClient

Returns:

an array of channels as room object

Throws:

RocketClientException - in case of communication errors with the RocketChat server backend

getInfo

public String getInfo()
               throws RocketClientException

Description copied from interface: RocketChatClient

Retrieves server information

Specified by:

getInfo in interface RocketChatClient

Returns:

Version info

Throws:

RocketClientException - in case of communications errors

send

public void send(Room room,
                 String message)
          throws CertificateException,
                 RocketClientException

Description copied from interface: RocketChatClient

sends a message to a channel

Specified by:

send in interface RocketChatClient

Parameters:

room - to use (aka channel)

message - to send

Throws:

CertificateException - in case of SSL errors

RocketClientException - in case of communication errors with the RocketChat server backend

send

public void send(String channelName,
                 String message)
          throws CertificateException,
                 RocketClientException

Description copied from interface: RocketChatClient

sends a message to a channel

Specified by:

send in interface RocketChatClient

Parameters:

channelName - to use

message - to send

Throws:

CertificateException - in case of SSL errors

RocketClientException - in case of communication errors with the RocketChat server backend

send

public void send(String channelName,
                 String message,
                 String emoji,
                 String avatar)
          throws CertificateException,
                 RocketClientException

Description copied from interface: RocketChatClient

sends a message to a channel. If emoji and avatar are difined, only emoji will be displayed

Specified by:

send in interface RocketChatClient

Parameters:

channelName - to use

message - to send

emoji - to display

avatar - to display

Throws:

CertificateException - in case of SSL errors

RocketClientException - in case of communication errors with the RocketChat server backend

send

public void send(String channelName,
                 String message,
                 String emoji,
                 String avatar,
                 List<Map<String,Object>> attachments)
          throws CertificateException,
                 RocketClientException

Description copied from interface: RocketChatClient

sends a message to a channel. If emoji and avatar are difined, only emoji will be displayed

Specified by:

send in interface RocketChatClient

Parameters:

channelName - to use

message - to send

emoji - to display

avatar - to display

attachments - to send

Throws:

CertificateException - in case of SSL errors

RocketClientException - in case of communication errors with the RocketChat server backend