org.igniterealtime.restclient

Class RestApiClient

java.lang.Object

org.igniterealtime.restclient.RestApiClient

public class RestApiClient
extends Object

The Class RestApiClient.

Constructor Summary

Constructors

Constructor and Description
RestApiClient(String url, int port, AuthenticationToken authenticationToken) Instantiates a new rest api client.
RestApiClient(String url, int port, AuthenticationToken authenticationToken, int connectionTimeout) Instantiates a new rest api client.
RestApiClient(String url, int port, AuthenticationToken authenticationToken, int connectionTimeout, SupportedMediaType mediaType) Instantiates a new rest api client.
RestApiClient(String url, int port, AuthenticationToken authenticationToken, SupportedMediaType mediaType) Instantiates a new rest api client.

Method Summary

Modifier and Type	Method and Description
javax.ws.rs.core.Response	addAdmin(String roomName, String jid) Adds the admin.
javax.ws.rs.core.Response	addAdminGroup(String roomName, String groupName) Adds the group admin.
javax.ws.rs.core.Response	addMember(String roomName, String jid) Adds the member.
javax.ws.rs.core.Response	addMemberGroup(String roomName, String groupName) Adds the group member.
javax.ws.rs.core.Response	addOutcast(String roomName, String jid) Adds the outcast.
javax.ws.rs.core.Response	addOutcastGroup(String roomName, String groupName) Adds the group outcast.
javax.ws.rs.core.Response	addOwner(String roomName, String jid) Adds the owner.
javax.ws.rs.core.Response	addOwnerGroup(String roomName, String groupName) Adds the owner group.
javax.ws.rs.core.Response	addRosterEntry(String username, RosterItemEntity rosterItemEntity) Adds the roster entry.
javax.ws.rs.core.Response	addUserToGroup(String username, String groupName) Adds the user to group.
javax.ws.rs.core.Response	addUserToGroups(String username, UserGroupsEntity userGroupsEntity) Adds the user to groups.
javax.ws.rs.core.Response	createChatRoom(MUCRoomEntity chatRoom) Creates the chat room.
javax.ws.rs.core.Response	createGroup(GroupEntity group) Creates the group.
javax.ws.rs.core.Response	createSystemProperty(SystemProperty property) Creates the system property.
javax.ws.rs.core.Response	createUser(UserEntity userEntity) Creates the user.
javax.ws.rs.core.Response	deleteAdmin(String roomName, String jid) Delete admin from chatroom.
javax.ws.rs.core.Response	deleteAdminGroup(String roomName, String groupName) Delete admin group from chatroom.
javax.ws.rs.core.Response	deleteChatRoom(String roomName) Delete chat room.
javax.ws.rs.core.Response	deleteGroup(String groupName) Delete group.
javax.ws.rs.core.Response	deleteMember(String roomName, String jid) Delete member from chatroom.
javax.ws.rs.core.Response	deleteMemberGroup(String roomName, String groupName) Delete member group from chatroom.
javax.ws.rs.core.Response	deleteOutcast(String roomName, String jid) Delete outcast from chatroom.
javax.ws.rs.core.Response	deleteOutcastGroup(String roomName, String groupName) Delete outcast group from chatroom.
javax.ws.rs.core.Response	deleteOwner(String roomName, String jid) Delete owner from chatroom.
javax.ws.rs.core.Response	deleteOwnerGroup(String roomName, String groupName) Delete owner group from chatroom.
javax.ws.rs.core.Response	deleteRosterEntry(String username, String jid) Delete roster entry.
javax.ws.rs.core.Response	deleteSessions(String username) Close all user sessions.
javax.ws.rs.core.Response	deleteSystemProperty(String propertyName) Delete system property.
javax.ws.rs.core.Response	deleteUser(String username) Delete user.
javax.ws.rs.core.Response	deleteUserFromGroup(String username, String groupName) Delete user from group.
MUCRoomEntity	getChatRoom(String roomName) Gets the chat room.
ParticipantEntities	getChatRoomParticipants(String roomName) Gets the chat room participants.
MUCRoomEntities	getChatRooms() Gets the chat rooms.
MUCRoomEntities	getChatRooms(Map<String,String> queryParams) Gets the chat rooms.
GroupEntity	getGroup(String groupName) Gets the group.
GroupEntities	getGroups() Gets the groups.
RestClient	getRestClient() Gets the rest client.
RosterEntities	getRoster(String username) Gets the roster.
SessionEntities	getSessions() Gets the sessions.
SessionEntities	getSessions(String username) Gets the sessions.
SystemProperties	getSystemProperties() Gets the system properties.
SystemProperty	getSystemProperty(String propertyName) Gets the system property.
UserEntity	getUser(String username) Gets the user.
UserGroupsEntity	getUserGroups(String username) Gets the user groups.
UserEntities	getUsers() Gets the users.
UserEntities	getUsers(Map<String,String> queryParams) Gets the users.
javax.ws.rs.core.Response	lockoutUser(String username) Lockout user.
javax.ws.rs.core.Response	unlockUser(String username) Unlock user.
javax.ws.rs.core.Response	updateChatRoom(MUCRoomEntity chatRoom) Update chat room.
javax.ws.rs.core.Response	updateGroup(GroupEntity group) Update group.
javax.ws.rs.core.Response	updateRosterEntry(String username, RosterItemEntity rosterItemEntity) Update roster entry.
javax.ws.rs.core.Response	updateSystemProperty(SystemProperty property) Update system property.
javax.ws.rs.core.Response	updateUser(UserEntity userEntity) Update user.

Methods inherited from class java.lang.Object

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

Constructor Detail

RestApiClient

public RestApiClient(String url,
                     int port,
                     AuthenticationToken authenticationToken)

Instantiates a new rest api client.

Parameters:

url - the url

port - the port

authenticationToken - the authentication token

RestApiClient

public RestApiClient(String url,
                     int port,
                     AuthenticationToken authenticationToken,
                     SupportedMediaType mediaType)

Instantiates a new rest api client.

Parameters:

url - the url

port - the port

authenticationToken - the authentication token

mediaType - the media to send/accept

RestApiClient

public RestApiClient(String url,
                     int port,
                     AuthenticationToken authenticationToken,
                     int connectionTimeout)

Instantiates a new rest api client.

Parameters:

url - the url

port - the port

authenticationToken - the authentication token

connectionTimeout - the connection timeout

RestApiClient

public RestApiClient(String url,
                     int port,
                     AuthenticationToken authenticationToken,
                     int connectionTimeout,
                     SupportedMediaType mediaType)

Instantiates a new rest api client.

Parameters:

url - the url

port - the port

authenticationToken - the authentication token

connectionTimeout - the connection timeout

mediaType - the media to send/accept

Method Detail

getUsers

public UserEntities getUsers()

Gets the users.

Returns:

the users

getUsers

public UserEntities getUsers(Map<String,String> queryParams)

Gets the users.

Parameters:

queryParams - the query params

Returns:

the users

getUser

public UserEntity getUser(String username)

Gets the user.

Parameters:

username - the username

Returns:

the user

createUser

public javax.ws.rs.core.Response createUser(UserEntity userEntity)

Creates the user.

Parameters:

userEntity - the user entity

Returns:

the response

updateUser

public javax.ws.rs.core.Response updateUser(UserEntity userEntity)

Update user.

Parameters:

userEntity - the user entity

Returns:

the response

deleteUser

public javax.ws.rs.core.Response deleteUser(String username)

Delete user.

Parameters:

username - the username

Returns:

the response

getChatRooms

public MUCRoomEntities getChatRooms()

Gets the chat rooms.

Returns:

the chat rooms

getChatRooms

public MUCRoomEntities getChatRooms(Map<String,String> queryParams)

Gets the chat rooms.

Parameters:

queryParams - the query params

Returns:

the chat rooms

getChatRoom

public MUCRoomEntity getChatRoom(String roomName)

Gets the chat room.

Parameters:

roomName - the room name

Returns:

the chat room

createChatRoom

public javax.ws.rs.core.Response createChatRoom(MUCRoomEntity chatRoom)

Creates the chat room.

Parameters:

chatRoom - the chat room

Returns:

the response

updateChatRoom

public javax.ws.rs.core.Response updateChatRoom(MUCRoomEntity chatRoom)

Update chat room.

Parameters:

chatRoom - the chat room

Returns:

the response

deleteChatRoom

public javax.ws.rs.core.Response deleteChatRoom(String roomName)

Delete chat room.

Parameters:

roomName - the room name

Returns:

the response

getChatRoomParticipants

public ParticipantEntities getChatRoomParticipants(String roomName)

Gets the chat room participants.

Parameters:

roomName - the room name

Returns:

the chat room participants

addOwner

public javax.ws.rs.core.Response addOwner(String roomName,
                                          String jid)

Adds the owner.

Parameters:

roomName - the room name

jid - the jid

Returns:

the response

deleteOwner

public javax.ws.rs.core.Response deleteOwner(String roomName,
                                             String jid)

Delete owner from chatroom.

Parameters:

roomName - the room name

jid - the jid

Returns:

the response

addAdmin

public javax.ws.rs.core.Response addAdmin(String roomName,
                                          String jid)

Adds the admin.

Parameters:

roomName - the room name

jid - the jid

Returns:

the response

deleteAdmin

public javax.ws.rs.core.Response deleteAdmin(String roomName,
                                             String jid)

Delete admin from chatroom.

Parameters:

roomName - the room name

jid - the jid

Returns:

the response

addMember

public javax.ws.rs.core.Response addMember(String roomName,
                                           String jid)

Adds the member.

Parameters:

roomName - the room name

jid - the jid

Returns:

the response

deleteMember

public javax.ws.rs.core.Response deleteMember(String roomName,
                                              String jid)

Delete member from chatroom.

Parameters:

roomName - the room name

jid - the jid

Returns:

the response

addOutcast

public javax.ws.rs.core.Response addOutcast(String roomName,
                                            String jid)

Adds the outcast.

Parameters:

roomName - the room name

jid - the jid

Returns:

the response

deleteOutcast

public javax.ws.rs.core.Response deleteOutcast(String roomName,
                                               String jid)

Delete outcast from chatroom.

Parameters:

roomName - the room name

jid - the jid

Returns:

the response

addOwnerGroup

public javax.ws.rs.core.Response addOwnerGroup(String roomName,
                                               String groupName)

Adds the owner group.

Parameters:

roomName - the room name

groupName - the groupName

Returns:

the response

deleteOwnerGroup

public javax.ws.rs.core.Response deleteOwnerGroup(String roomName,
                                                  String groupName)

Delete owner group from chatroom.

Parameters:

roomName - the room name

groupName - the groupName

Returns:

the response

addAdminGroup

public javax.ws.rs.core.Response addAdminGroup(String roomName,
                                               String groupName)

Adds the group admin.

Parameters:

roomName - the room name

groupName - the groupName

Returns:

the response

deleteAdminGroup

public javax.ws.rs.core.Response deleteAdminGroup(String roomName,
                                                  String groupName)

Delete admin group from chatroom.

Parameters:

roomName - the room name

groupName - the groupName

Returns:

the response

addMemberGroup

public javax.ws.rs.core.Response addMemberGroup(String roomName,
                                                String groupName)

Adds the group member.

Parameters:

roomName - the room name

groupName - the groupName

Returns:

the response

deleteMemberGroup

public javax.ws.rs.core.Response deleteMemberGroup(String roomName,
                                                   String groupName)

Delete member group from chatroom.

Parameters:

roomName - the room name

groupName - the groupName

Returns:

the response

addOutcastGroup

public javax.ws.rs.core.Response addOutcastGroup(String roomName,
                                                 String groupName)

Adds the group outcast.

Parameters:

roomName - the room name

groupName - the groupName

Returns:

the response

deleteOutcastGroup

public javax.ws.rs.core.Response deleteOutcastGroup(String roomName,
                                                    String groupName)

Delete outcast group from chatroom.

Parameters:

roomName - the room name

groupName - the groupName

Returns:

the response

getSessions

public SessionEntities getSessions()

Gets the sessions.

Returns:

the sessions

getSessions

public SessionEntities getSessions(String username)

Gets the sessions.

Parameters:

username - the username

Returns:

the sessions

deleteSessions

public javax.ws.rs.core.Response deleteSessions(String username)

Close all user sessions.

Parameters:

username - the username

Returns:

the response

getUserGroups

public UserGroupsEntity getUserGroups(String username)

Gets the user groups.

Parameters:

username - the username

Returns:

the user groups

addUserToGroups

public javax.ws.rs.core.Response addUserToGroups(String username,
                                                 UserGroupsEntity userGroupsEntity)

Adds the user to groups.

Parameters:

username - the username

userGroupsEntity - the user groups entity

Returns:

the response

addUserToGroup

public javax.ws.rs.core.Response addUserToGroup(String username,
                                                String groupName)

Adds the user to group.

Parameters:

username - the username

groupName - the group name

Returns:

the response

deleteUserFromGroup

public javax.ws.rs.core.Response deleteUserFromGroup(String username,
                                                     String groupName)

Delete user from group.

Parameters:

username - the username

groupName - the group name

Returns:

the response

lockoutUser

public javax.ws.rs.core.Response lockoutUser(String username)

Lockout user.

Parameters:

username - the username

Returns:

the response

unlockUser

public javax.ws.rs.core.Response unlockUser(String username)

Unlock user.

Parameters:

username - the username

Returns:

the response

getSystemProperties

public SystemProperties getSystemProperties()

Gets the system properties.

Returns:

the system properties

getSystemProperty

public SystemProperty getSystemProperty(String propertyName)

Gets the system property.

Parameters:

propertyName - the property name

Returns:

the system property

createSystemProperty

public javax.ws.rs.core.Response createSystemProperty(SystemProperty property)

Creates the system property.

Parameters:

property - the property

Returns:

the response

updateSystemProperty

public javax.ws.rs.core.Response updateSystemProperty(SystemProperty property)

Update system property.

Parameters:

property - the property

Returns:

the response

deleteSystemProperty

public javax.ws.rs.core.Response deleteSystemProperty(String propertyName)

Delete system property.

Parameters:

propertyName - the property name

Returns:

the response

getGroups

public GroupEntities getGroups()

Gets the groups.

Returns:

the groups

getGroup

public GroupEntity getGroup(String groupName)

Gets the group.

Parameters:

groupName - the group name

Returns:

the group

createGroup

public javax.ws.rs.core.Response createGroup(GroupEntity group)

Creates the group.

Parameters:

group - the group

Returns:

the response

updateGroup

public javax.ws.rs.core.Response updateGroup(GroupEntity group)

Update group.

Parameters:

group - the group

Returns:

the response

deleteGroup

public javax.ws.rs.core.Response deleteGroup(String groupName)

Delete group.

Parameters:

groupName - the group name

Returns:

the response

getRoster

public RosterEntities getRoster(String username)

Gets the roster.

Parameters:

username - the username

Returns:

the roster

addRosterEntry

public javax.ws.rs.core.Response addRosterEntry(String username,
                                                RosterItemEntity rosterItemEntity)

Adds the roster entry.

Parameters:

username - the username

rosterItemEntity - the roster item entity

Returns:

the response

updateRosterEntry

public javax.ws.rs.core.Response updateRosterEntry(String username,
                                                   RosterItemEntity rosterItemEntity)

Update roster entry.

Parameters:

username - the username

rosterItemEntity - the roster item entity

Returns:

the response

deleteRosterEntry

public javax.ws.rs.core.Response deleteRosterEntry(String username,
                                                   String jid)

Delete roster entry.

Parameters:

username - the username

jid - the jid

Returns:

the response

getRestClient

public RestClient getRestClient()

Gets the rest client.

Returns:

the rest client