evanwong / hipchat-java

Java client for the HipChat v2 API

hipchat-java

Java client for the HipChat V2 API. The implementation is base on this doc.

Requirements:

Java 8

Quick Start:

To add this client into your project:

• maven

<dependency>
    <groupId>io.evanwong.oss</groupId>
    <artifactId>hipchat-java</artifactId>
    <version>0.4.3</version>
</dependency>

• gradle

compile 'io.evanwong.oss:hipchat-java:0.4.3'

If you are using Java 7, there is a temporary workaround using retrolambda.

• maven

<dependency>
    <groupId>io.evanwong.oss</groupId>
    <artifactId>hipchat-java7</artifactId>
    <version>0.4.0</version>
</dependency>

• gradle

compile 'io.evanwong.oss:hipchat-java7:0.4.0'

To send a notification

String defaultAccessToken = "abcd1234";
HipChatClient client = new HipChatClient(defaultAccessToken);
SendRoomNotificationRequestBuilder builder = client.prepareSendRoomNotificationRequestBuilder("myRoom", "hello world!");
Future<NoContent> future = builder.setColor(MessageColor.YELLOW).setNotify(true).build().execute();
//optional... if you want/need to inspect the result:
NoContent noContent = future.get();

• Javadoc: Link

Methods

CAPABILITIES

• Get capabilities

EMOTICONS

• Get emoticon
• Get all emoticons

OAUTH SESSIONS

• Generate token
• Get session
• Delete session

ROOMS

• Get all rooms
• Create room
• Get room
• Update room
• Delete room
• View room history
• Get room message
• Send room message
• View recent room history
• Invite user
• Add member
• Remove member
• Get all members
• Send room notification redirect
• Send room notification
• Get all participants
• Reply to message
• Share file with room
• Share link with room
• Get room statistics
• Set topic
• Get all webhooks
• Create webhook
• Get webhook
• Delete webhook

USERS

• Get all users
• Create user
• View user
• Update user
• Delete user
• Get privatechat message
• View recent privatechat history
• Private message user
• Update photo
• Delete photo
• Get auto join rooms
• Share file with user
• Share link with user

License

The MIT License (MIT)

Copyright (c) 2014 Evan Wong

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

hipchat-java's Issues

Compilation errors in the provided sample code

Tried your sample code in the readme file.

String defaultAccessToken = "22222-mytoken";
HipChatClient client = new HipChatClient(defaultAccessToken);
SendRoomNotificationRequestBuilder builder = client.prepareSendRoomNotificationRequestBuilder("room-test-1","this is my first message");
java.util.concurrent.Future future;
future = builder.setColor(MessageColor.YELLOW).setNotify(true).build().execute();

and got the following compilation errors in the last line of code;
- The type io.evanwong.oss.hipchat.v2.commons.Request cannot be resolved. It is indirectly referenced from
required .class files
- The method execute() is undefined for the type SendRoomNotificationRequest

quick reply is much appreciated.
thanks in advance.

Unrecognized fields should be ignored.

In Request.java, this line should be added in order to prevent the client from failing if Atlassian adds new fields:

this.objectMapper.configure(DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES, false);

Currently I am getting this exception:

com.fasterxml.jackson.databind.exc.UnrecognizedPropertyException: Unrecognized field "version" (class io.evanwong.oss.hipchat.v2.rooms.RoomItem), not marked as ignorable (3 known properties: "links", "id", "name"])

Java7 release of 0.4.2?

Hi,
first of all thank you for maintaining a backwards compatible version of the API.
We could use the User API which the 0.4.0 of the Java 7 release does not provide yet.
Could you please release the new version to Maven central?

Thanks and cheers,
Michael

Add api/usage documentation

Java 7 support?!

Many of us still uses Java 7, especially in old projects. Would be possible to make a Java 7 compatible jar?

Add methods for the emotions APIs

1. https://www.hipchat.com/docs/apiv2/method/get_emoticon
2. https://www.hipchat.com/docs/apiv2/method/get_all_emoticons

Memory leaks (threads)

I recently integrated this library (v0.3.0) in an existing project, where I was using v1 hipchat API. Here is more or less how I use it : I have a static HipChat object in method in MyClass

private static final HipChatClient hcc = new HipChatClient("mytoken") ;
private static void sendMessageImpl(String message, MessageColor color,boolean critical) {
    //some stuff then prepare the query
    SendRoomNotificationRequestBuilder builder = hcc.prepareSendRoomNotificationRequestBuilder("myroomId", "message to send");
    Future<NoContent> future = builder.setColor(colorToUse).setNotify(notify).build().execute();
            NoContent noContent = future.get();

I have a timer that calls MyCalls.sendMessageImpl(...) every two minutes, multiple times.

I recently started to receive reports of memory leaks happening. A further investigation with JProfiler revealed that I had a steadily growing number of new threads (blocked) .

After some hours the number of threads was in the order of thousands, and in 48 hours, boom.

Interestingly enough, when turning hipchat off, the number of threads is steady , as it should be : 6.

Am I doing something wrong? is this a known problem? am I using an old version? It consumed one day of work finding this.

Add method for remove room member

https://www.hipchat.com/docs/apiv2/method/remove_member

Add an option to control verbosity

I wish I can avoid DEBUG and INFO level log messages.

Setting the URL of the HipChat server

Is there a method for setting the URL of the HipChat server? (I want to send a message to a room)

The example given in the README does not work

hi!

I am using the example in the readme, but it does not work:

        try {
            String defaultAccessToken = "xxxxx";
            HipChatClient client = new HipChatClient(defaultAccessToken);

            SendRoomNotificationRequestBuilder builder = client.prepareSendRoomNotificationRequestBuilder("test", "hello world!");


            Future<NoContent> future = builder.setColor(MessageColor.YELLOW).setNotify(true).build().execute();
//optional... if you want/need to inspect the result:
            NoContent noContent = future.get();
        } catch(Exception e) {
            LOG.error("exception", e);
        }

this is returning:

2015-03-13 14:11:29,821 ERROR [-1:?] [io.evanwong.oss.hipchat.v2.commons.PostRequest] Invalid response status: 401, content: {
  "error": {
    "code": 401,
    "message": "Invalid OAuth session",
    "type": "Unauthorized"
  }
}

And I do not see any OAUTH related methods on the HipChat client.

how do I get this to work? What am I doing wrong?

Support on-premise HipChat installations.

There seems to be no way to provide HipChat server URL for on premise HipChat installations.

Add methods for the oauth sessions APIs

1. https://www.hipchat.com/docs/apiv2/method/generate_token
2. https://www.hipchat.com/docs/apiv2/method/get_session
3. https://www.hipchat.com/docs/apiv2/method/delete_session

Add method for add room member

https://www.hipchat.com/docs/apiv2/method/add_member

Add more methods for Rooms APIs

Add method for the capabilities API

https://www.hipchat.com/docs/apiv2/method/get_capabilities

Infinite recursion in HipChatClient.prepareGetEmoticonRequestBuilder(String)

Just a typo, but the method is calling itself instead of its homonym:

hipchat-java/src/main/java/io/evanwong/oss/hipchat/v2/HipChatClient.java

Lines 94 to 96 in b263fec

	public GetEmoticonRequestBuilder prepareGetEmoticonRequestBuilder(String idOrShortcut) {
	return prepareGetEmoticonRequestBuilder(idOrShortcut);
	}