org.exoplatform.moxtra.client

Class MoxtraClient

java.lang.Object

org.exoplatform.moxtra.client.MoxtraClient

public class MoxtraClient
extends Object

Created by The eXo Platform SAS

Version:

$Id: MoxtraClient.java 00000 Feb 25, 2015 pnedonosko $

Author:

Peter Nedonosko

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	MoxtraClient.AuthProblemException
protected class	MoxtraClient.HeaderValue
class	MoxtraClient.OAuth2Authorizer Builder-style helper for Moxtra authorization via OAuth2.
protected class	MoxtraClient.RESTClient Oltu HTTP client implementation using Apache HTTP Client.
protected class	MoxtraClient.RESTError
protected class	MoxtraClient.RESTResponse

Field Summary

Fields

Modifier and Type	Field and Description
protected ReadWriteLock	accessLock
static String	API_BINDER
static String	API_BINDER_INVITEUSER
static String	API_BINDER_REMOVEUSER
static String	API_MEETS_INVITEUSER
static String	API_MEETS_RECORDINGS
static String	API_MEETS_SCHEDULE
static String	API_MEETS_SESSION
static String	API_MEETS_STATUS
static String	API_OAUTH_AUTHORIZE
static String	API_USER
static String	API_USER_CONTACTS
static String	API_USER_MEETS
static String	API_V1
protected Lock	authLock
protected MoxtraClient.OAuth2Authorizer	authorizer
protected org.apache.http.protocol.HttpContext	context
static int	DAY_MILLISECONDS
protected static String	EMPTY
static int	GET_MEETS_LIST_MAX_DAYS
protected static Pattern	HTML_ERROR_EXTRACT
protected org.apache.http.client.HttpClient	httpClient
protected static org.exoplatform.services.log.Log	LOG
static String	MOXTRA_URL
static String	MOXTRA_USER_ME
protected org.apache.oltu.oauth2.client.OAuthClient	oAuthClient
protected String	oAuthClientHost
protected String	oAuthClientId
protected String	oAuthClientSchema
protected String	oAuthClientSecret
protected AccessToken	oAuthToken
static String	REQUEST_ACCEPT
static String	REQUEST_CONTENT_TYPE_BINARY
static String	REQUEST_CONTENT_TYPE_JSON
static String	RESPONSE_ALLOW
static String	RESPONSE_ERROR_NOT_FOUND
static String	RESPONSE_SUCCESS

Constructor Summary

Constructors

Constructor and Description
MoxtraClient(String oauthClientId, String oauthClientSecret, String oauthClientSchema, String oauthClientHost) Moxtra client using OAuth2 authentication.

Method Summary

Methods

Modifier and Type	Method and Description
protected String	accessToken()
MoxtraClient.OAuth2Authorizer	authorizer() Authorize via OAuth2 flow.
protected void	checkError(MoxtraClient.RESTResponse resp)
void	createMeet(MoxtraMeet meet) Create new Moxtra meet and join its users as participants.
void	deleteBinder(MoxtraBinder binder) Delete Moxtra binder.
void	deleteMeet(MoxtraMeet meet) Delete Moxtra meet by its session key (meet id).
MoxtraMeet	findMeet(String binderId, Date date) Deprecated.
MoxtraBinder	getBinder(String binderId)
List<MoxtraUser>	getContacts(MoxtraUser user)
protected List<MoxtraUser>	getContacts(String userId)
MoxtraUser	getCurrentUser()
MoxtraMeet	getMeet(String sessionKey) Get meet info from Moxtra. Don't use this remote for getting meet's all metadata as Moxtra doesn't return such fields as agenda, auto_recording, startmeet_url.
MoxtraMeet	getMeetBinder(String binderId) Deprecated.
List<MoxtraMeetRecording>	getMeetRecordings(MoxtraMeet meet)
List<MoxtraMeet>	getMeets(Date from, Integer toDays) Find current user meets in given time period.
List<MoxtraMeet>	getMeets(String moxtraUserId, Date startsFrom, Integer days) Get meets for given user (by id) and time period.
protected String	getMeetStatus(String sessionKey)
protected AccessToken	getOAuthToken()
MoxtraMeet	getUpdateMeet(String sessionKey) Deprecated.
MoxtraUser	getUser(String userId)
protected void	initOAuthToken(AccessToken newToken)
boolean	inviteMeetUsers(MoxtraMeet meet) Invite users from given MoxtraMeet to the remote meet.
boolean	inviteUsers(MoxtraBinder binder) Invite users from MoxtraBinder to the remote binder.
boolean	isAuthorized() Checks if this client is already authorized to access Moxtra services.
protected boolean	isNull(org.exoplatform.ws.frameworks.json.value.JsonValue json)
protected MoxtraClient.RESTError	readError(MoxtraClient.RESTResponse resp)
protected MoxtraMeet	readMeet(org.exoplatform.ws.frameworks.json.value.JsonValue vmeet)
void	refreshMeet(MoxtraMeet meet) Refresh given (local) meet with recent information from Moxtra.
void	removeUsers(MoxtraBinder binder) Remove given users from the binder.
void	renameBinder(MoxtraBinder binder) Rename Moxtra binder.
void	renameMeet(MoxtraMeet meet) Deprecated.
InputStream	requestGet(String url, String contentType) Raw GET request to given URL with OAuth2 access token.
protected MoxtraClient.RESTResponse	restRequest(String url, String method)
protected MoxtraClient.RESTResponse	restRequest(String url, String method, String body)
protected MoxtraClient.RESTResponse	restRequest(String url, String method, String contentType, String body)
void	updateMeet(MoxtraMeet meet) Update Moxtra meet and join/remove its users as participants.

Methods inherited from class java.lang.Object

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

Field Detail

MOXTRA_USER_ME

public static final String MOXTRA_USER_ME

See Also:

Constant Field Values

MOXTRA_URL

public static final String MOXTRA_URL

See Also:

Constant Field Values

API_V1

public static final String API_V1

See Also:

Constant Field Values

API_OAUTH_AUTHORIZE

public static final String API_OAUTH_AUTHORIZE

See Also:

Constant Field Values

API_USER

public static final String API_USER

See Also:

Constant Field Values

API_USER_CONTACTS

public static final String API_USER_CONTACTS

See Also:

Constant Field Values

API_USER_MEETS

public static final String API_USER_MEETS

See Also:

Constant Field Values

API_MEETS_SCHEDULE

public static final String API_MEETS_SCHEDULE

See Also:

Constant Field Values

API_MEETS_SESSION

public static final String API_MEETS_SESSION

See Also:

Constant Field Values

API_MEETS_INVITEUSER

public static final String API_MEETS_INVITEUSER

See Also:

Constant Field Values

API_MEETS_RECORDINGS

public static final String API_MEETS_RECORDINGS

See Also:

Constant Field Values

API_MEETS_STATUS

public static final String API_MEETS_STATUS

See Also:

Constant Field Values

API_BINDER

public static final String API_BINDER

See Also:

Constant Field Values

API_BINDER_INVITEUSER

public static final String API_BINDER_INVITEUSER

See Also:

Constant Field Values

API_BINDER_REMOVEUSER

public static final String API_BINDER_REMOVEUSER

See Also:

Constant Field Values

RESPONSE_SUCCESS

public static final String RESPONSE_SUCCESS

See Also:

Constant Field Values

REQUEST_CONTENT_TYPE_JSON

public static final String REQUEST_CONTENT_TYPE_JSON

REQUEST_CONTENT_TYPE_BINARY

public static final String REQUEST_CONTENT_TYPE_BINARY

REQUEST_ACCEPT

public static final String REQUEST_ACCEPT

RESPONSE_ALLOW

public static final String RESPONSE_ALLOW

GET_MEETS_LIST_MAX_DAYS

public static final int GET_MEETS_LIST_MAX_DAYS

See Also:

Constant Field Values

DAY_MILLISECONDS

public static final int DAY_MILLISECONDS

See Also:

Constant Field Values

RESPONSE_ERROR_NOT_FOUND

public static final String RESPONSE_ERROR_NOT_FOUND

HTML_ERROR_EXTRACT

protected static final Pattern HTML_ERROR_EXTRACT

EMPTY

protected static final String EMPTY

LOG

protected static final org.exoplatform.services.log.Log LOG

httpClient

protected final org.apache.http.client.HttpClient httpClient

oAuthClient

protected final org.apache.oltu.oauth2.client.OAuthClient oAuthClient

context

protected final org.apache.http.protocol.HttpContext context

oAuthClientId

protected final String oAuthClientId

oAuthClientSecret

protected final String oAuthClientSecret

oAuthClientSchema

protected final String oAuthClientSchema

oAuthClientHost

protected final String oAuthClientHost

authLock

protected final Lock authLock

accessLock

protected final ReadWriteLock accessLock

oAuthToken

protected AccessToken oAuthToken

authorizer

protected MoxtraClient.OAuth2Authorizer authorizer

Constructor Detail

MoxtraClient

public MoxtraClient(String oauthClientId,
            String oauthClientSecret,
            String oauthClientSchema,
            String oauthClientHost)

Moxtra client using OAuth2 authentication.

Throws:

MoxtraConfigurationException

Method Detail

authorizer

public MoxtraClient.OAuth2Authorizer authorizer()

Authorize via OAuth2 flow.

Returns:

MoxtraClient.OAuth2Authorizer

isAuthorized

public boolean isAuthorized()

Checks if this client is already authorized to access Moxtra services.

Returns:

true if client is authorized to access Moxtra services, false otherwise

getCurrentUser

public MoxtraUser getCurrentUser()
                          throws MoxtraAuthenticationException,
                                 MoxtraException

Throws:

MoxtraAuthenticationException

MoxtraException

getUser

public MoxtraUser getUser(String userId)
                   throws MoxtraAuthenticationException,
                          MoxtraException

Throws:

MoxtraAuthenticationException

MoxtraException

getContacts

public List<MoxtraUser> getContacts(MoxtraUser user)
                             throws MoxtraAuthenticationException,
                                    MoxtraException

Throws:

MoxtraAuthenticationException

MoxtraException

getContacts

protected List<MoxtraUser> getContacts(String userId)
                                throws MoxtraAuthenticationException,
                                       MoxtraException

Throws:

MoxtraAuthenticationException

MoxtraException

getMeetBinder

@Deprecated
public MoxtraMeet getMeetBinder(String binderId)
                         throws org.apache.oltu.oauth2.common.exception.OAuthSystemException,
                                org.apache.oltu.oauth2.common.exception.OAuthProblemException,
                                MoxtraException,
                                MoxtraClientException

Deprecated.

Throws:

org.apache.oltu.oauth2.common.exception.OAuthSystemException

org.apache.oltu.oauth2.common.exception.OAuthProblemException

MoxtraException

MoxtraClientException

getUpdateMeet

@Deprecated
public MoxtraMeet getUpdateMeet(String sessionKey)
                         throws org.apache.oltu.oauth2.common.exception.OAuthSystemException,
                                org.apache.oltu.oauth2.common.exception.OAuthProblemException,
                                MoxtraException,
                                MoxtraClientException

Deprecated.

DO NOT USE IT!

Parameters:

sessionKey -

Returns:

Throws:

org.apache.oltu.oauth2.common.exception.OAuthSystemException

org.apache.oltu.oauth2.common.exception.OAuthProblemException

MoxtraException

MoxtraClientException

getMeet

public MoxtraMeet getMeet(String sessionKey)
                   throws org.apache.oltu.oauth2.common.exception.OAuthSystemException,
                          org.apache.oltu.oauth2.common.exception.OAuthProblemException,
                          MoxtraException,
                          MoxtraClientException

Get meet info from Moxtra.
Don't use this remote for getting meet's all metadata as Moxtra doesn't return such fields as agenda, auto_recording, startmeet_url. Use refreshMeet(MoxtraMeet) instead to refresh available fields of existing meet. In other cases this method can work only to get actual state of some field or users (w/ hoster) of the meet, e.g. on meet creation when finally updating local nodes.

Parameters:

sessionKey -

Returns:

Throws:

org.apache.oltu.oauth2.common.exception.OAuthSystemException

org.apache.oltu.oauth2.common.exception.OAuthProblemException

MoxtraException

MoxtraClientException

refreshMeet

public void refreshMeet(MoxtraMeet meet)
                 throws org.apache.oltu.oauth2.common.exception.OAuthSystemException,
                        org.apache.oltu.oauth2.common.exception.OAuthProblemException,
                        MoxtraException,
                        MoxtraClientException

Refresh given (local) meet with recent information from Moxtra.

Parameters:

meet - MoxtraMeet meet object to refresh

Throws:

org.apache.oltu.oauth2.common.exception.OAuthSystemException

org.apache.oltu.oauth2.common.exception.OAuthProblemException

MoxtraException

MoxtraClientException

getMeets

public List<MoxtraMeet> getMeets(String moxtraUserId,
                        Date startsFrom,
                        Integer days)
                          throws org.apache.oltu.oauth2.common.exception.OAuthSystemException,
                                 org.apache.oltu.oauth2.common.exception.OAuthProblemException,
                                 MoxtraException,
                                 MoxtraClientException

Get meets for given user (by id) and time period.

Parameters:

moxtraUserId - String

startsFrom - Date from this date

days - Integer for number of days, but not more that 30 (will be cut if more)

Returns:

list of MoxtraMeet

Throws:

org.apache.oltu.oauth2.common.exception.OAuthSystemException

org.apache.oltu.oauth2.common.exception.OAuthProblemException

MoxtraException

MoxtraClientException

getMeets

public List<MoxtraMeet> getMeets(Date from,
                        Integer toDays)
                          throws org.apache.oltu.oauth2.common.exception.OAuthSystemException,
                                 org.apache.oltu.oauth2.common.exception.OAuthProblemException,
                                 MoxtraException,
                                 MoxtraClientException

Find current user meets in given time period.

Parameters:

from - Date from date

toDays - Integer days since the from date, max 30 or it will be cut to the maximum

Returns:

list of MoxtraMeet, if nothing found it will be empty

Throws:

org.apache.oltu.oauth2.common.exception.OAuthSystemException

org.apache.oltu.oauth2.common.exception.OAuthProblemException

MoxtraException

MoxtraClientException

findMeet

@Deprecated
public MoxtraMeet findMeet(String binderId,
                             Date date)
                    throws org.apache.oltu.oauth2.common.exception.OAuthSystemException,
                           org.apache.oltu.oauth2.common.exception.OAuthProblemException,
                           MoxtraException,
                           MoxtraClientException

Deprecated.

Find current user meet by given binder id in given date. This method will search in range minus 7 days from the date and for next 30 days.
XXX this method is a workaround to find a single meet data by its ID. Use getMeet(String) instead.

Parameters:

binderId - String scheduled binder id

date - Date date where the meet should have a place

Returns:

MoxtraMeet of null if nothing found

Throws:

org.apache.oltu.oauth2.common.exception.OAuthSystemException

org.apache.oltu.oauth2.common.exception.OAuthProblemException

MoxtraException

MoxtraClientException

getBinder

public MoxtraBinder getBinder(String binderId)
                       throws org.apache.oltu.oauth2.common.exception.OAuthSystemException,
                              org.apache.oltu.oauth2.common.exception.OAuthProblemException,
                              MoxtraException,
                              MoxtraClientException

Throws:

org.apache.oltu.oauth2.common.exception.OAuthSystemException

org.apache.oltu.oauth2.common.exception.OAuthProblemException

MoxtraException

MoxtraClientException

createMeet

public void createMeet(MoxtraMeet meet)
                throws org.apache.oltu.oauth2.common.exception.OAuthSystemException,
                       org.apache.oltu.oauth2.common.exception.OAuthProblemException,
                       MoxtraException,
                       MoxtraClientException

Create new Moxtra meet and join its users as participants. If users is null or empty then no users will be added explicitly. If start time is null then it will be set to a next minute. If end time is null or before the start time, then it will be adjusted for 30 min since the start.

Parameters:

meet - MoxtraMeet

Throws:

org.apache.oltu.oauth2.common.exception.OAuthSystemException

org.apache.oltu.oauth2.common.exception.OAuthProblemException

MoxtraException

MoxtraClientException

getMeetRecordings

public List<MoxtraMeetRecording> getMeetRecordings(MoxtraMeet meet)
                                            throws org.apache.oltu.oauth2.common.exception.OAuthSystemException,
                                                   org.apache.oltu.oauth2.common.exception.OAuthProblemException,
                                                   MoxtraException,
                                                   MoxtraClientException

Throws:

org.apache.oltu.oauth2.common.exception.OAuthSystemException

org.apache.oltu.oauth2.common.exception.OAuthProblemException

MoxtraException

MoxtraClientException

getMeetStatus

protected String getMeetStatus(String sessionKey)
                        throws MoxtraException,
                               MoxtraClientException,
                               MoxtraAuthenticationException

Throws:

MoxtraException

MoxtraClientException

MoxtraAuthenticationException

requestGet

public InputStream requestGet(String url,
                     String contentType)
                       throws org.apache.oltu.oauth2.common.exception.OAuthSystemException,
                              org.apache.oltu.oauth2.common.exception.OAuthProblemException,
                              MoxtraException,
                              MoxtraClientException

Raw GET request to given URL with OAuth2 access token.

Parameters:

url -

contentType -

Returns:

Throws:

org.apache.oltu.oauth2.common.exception.OAuthSystemException

org.apache.oltu.oauth2.common.exception.OAuthProblemException

MoxtraException

MoxtraClientException

renameMeet

@Deprecated
public void renameMeet(MoxtraMeet meet)
                throws org.apache.oltu.oauth2.common.exception.OAuthSystemException,
                       org.apache.oltu.oauth2.common.exception.OAuthProblemException,
                       MoxtraException,
                       MoxtraClientException

Deprecated.

Rename existing Moxtra meet. This method also will check if the meet have added/removed users and invite/remove them respectively. If start/end time, agenda or auto recording flag changed then these changes will be propagated to the meet.
Method is deprecated, use updateMeet(MoxtraMeet) instead.

Parameters:

meet - MoxtraMeet

Throws:

org.apache.oltu.oauth2.common.exception.OAuthSystemException

org.apache.oltu.oauth2.common.exception.OAuthProblemException

MoxtraException

MoxtraClientException

See Also:

updateMeet(MoxtraMeet)

updateMeet

public void updateMeet(MoxtraMeet meet)
                throws org.apache.oltu.oauth2.common.exception.OAuthSystemException,
                       org.apache.oltu.oauth2.common.exception.OAuthProblemException,
                       MoxtraException,
                       MoxtraClientException

Update Moxtra meet and join/remove its users as participants. If users is null or empty then no users will be added explicitly. If start time is null then it will be set to a next minute. If end time is null or before the start time, then it will be adjusted for 30 min since the start.

Parameters:

meet - MoxtraMeet

Throws:

org.apache.oltu.oauth2.common.exception.OAuthSystemException

org.apache.oltu.oauth2.common.exception.OAuthProblemException

MoxtraException

MoxtraClientException

deleteMeet

public void deleteMeet(MoxtraMeet meet)
                throws org.apache.oltu.oauth2.common.exception.OAuthSystemException,
                       org.apache.oltu.oauth2.common.exception.OAuthProblemException,
                       MoxtraException,
                       MoxtraClientException

Delete Moxtra meet by its session key (meet id).

Parameters:

meet - MoxtraMeet

Throws:

org.apache.oltu.oauth2.common.exception.OAuthSystemException

org.apache.oltu.oauth2.common.exception.OAuthProblemException

MoxtraException

MoxtraClientException

deleteBinder

public void deleteBinder(MoxtraBinder binder)
                  throws org.apache.oltu.oauth2.common.exception.OAuthSystemException,
                         org.apache.oltu.oauth2.common.exception.OAuthProblemException,
                         MoxtraException,
                         MoxtraClientException

Delete Moxtra binder.

Parameters:

binder - MoxtraBinder

Throws:

org.apache.oltu.oauth2.common.exception.OAuthSystemException

org.apache.oltu.oauth2.common.exception.OAuthProblemException

MoxtraException

MoxtraClientException

renameBinder

public void renameBinder(MoxtraBinder binder)
                  throws org.apache.oltu.oauth2.common.exception.OAuthSystemException,
                         org.apache.oltu.oauth2.common.exception.OAuthProblemException,
                         MoxtraException,
                         MoxtraClientException

Rename Moxtra binder.

Parameters:

binder - MoxtraBinder

Throws:

org.apache.oltu.oauth2.common.exception.OAuthSystemException

org.apache.oltu.oauth2.common.exception.OAuthProblemException

MoxtraException

MoxtraClientException

inviteMeetUsers

public boolean inviteMeetUsers(MoxtraMeet meet)
                        throws org.apache.oltu.oauth2.common.exception.OAuthSystemException,
                               org.apache.oltu.oauth2.common.exception.OAuthProblemException,
                               MoxtraException,
                               MoxtraClientException

Invite users from given MoxtraMeet to the remote meet.

Parameters:

meet - MoxtraMeet

inviteList -

Throws:

org.apache.oltu.oauth2.common.exception.OAuthSystemException

org.apache.oltu.oauth2.common.exception.OAuthProblemException

MoxtraException

MoxtraClientException

inviteUsers

public boolean inviteUsers(MoxtraBinder binder)
                    throws org.apache.oltu.oauth2.common.exception.OAuthSystemException,
                           org.apache.oltu.oauth2.common.exception.OAuthProblemException,
                           MoxtraException,
                           MoxtraClientException

Invite users from MoxtraBinder to the remote binder.

Parameters:

binder - MoxtraBinder

Throws:

org.apache.oltu.oauth2.common.exception.OAuthSystemException

org.apache.oltu.oauth2.common.exception.OAuthProblemException

MoxtraException

MoxtraClientException

removeUsers

public void removeUsers(MoxtraBinder binder)
                 throws org.apache.oltu.oauth2.common.exception.OAuthSystemException,
                        org.apache.oltu.oauth2.common.exception.OAuthProblemException,
                        MoxtraException,
                        MoxtraClientException

Remove given users from the binder.

Parameters:

binder - MoxtraBinder

Throws:

org.apache.oltu.oauth2.common.exception.OAuthSystemException

org.apache.oltu.oauth2.common.exception.OAuthProblemException

MoxtraException

MoxtraClientException

readError

protected MoxtraClient.RESTError readError(MoxtraClient.RESTResponse resp)

initOAuthToken

protected void initOAuthToken(AccessToken newToken)

getOAuthToken

protected AccessToken getOAuthToken()

accessToken

protected String accessToken()

checkError

protected void checkError(MoxtraClient.RESTResponse resp)
                   throws MoxtraException

Throws:

MoxtraException

restRequest

protected MoxtraClient.RESTResponse restRequest(String url,
                                    String method)
                                         throws org.apache.oltu.oauth2.common.exception.OAuthSystemException,
                                                org.apache.oltu.oauth2.common.exception.OAuthProblemException,
                                                MoxtraException,
                                                MoxtraClientException

Throws:

org.apache.oltu.oauth2.common.exception.OAuthSystemException

org.apache.oltu.oauth2.common.exception.OAuthProblemException

MoxtraException

MoxtraClientException

restRequest

protected MoxtraClient.RESTResponse restRequest(String url,
                                    String method,
                                    String body)
                                         throws org.apache.oltu.oauth2.common.exception.OAuthSystemException,
                                                org.apache.oltu.oauth2.common.exception.OAuthProblemException,
                                                MoxtraException,
                                                MoxtraClientException

Throws:

org.apache.oltu.oauth2.common.exception.OAuthSystemException

org.apache.oltu.oauth2.common.exception.OAuthProblemException

MoxtraException

MoxtraClientException

restRequest

protected MoxtraClient.RESTResponse restRequest(String url,
                                    String method,
                                    String contentType,
                                    String body)
                                         throws org.apache.oltu.oauth2.common.exception.OAuthSystemException,
                                                org.apache.oltu.oauth2.common.exception.OAuthProblemException,
                                                MoxtraException,
                                                MoxtraClientException

Throws:

org.apache.oltu.oauth2.common.exception.OAuthSystemException

org.apache.oltu.oauth2.common.exception.OAuthProblemException

MoxtraException

MoxtraClientException

isNull

protected boolean isNull(org.exoplatform.ws.frameworks.json.value.JsonValue json)

readMeet

protected MoxtraMeet readMeet(org.exoplatform.ws.frameworks.json.value.JsonValue vmeet)
                       throws MoxtraException,
                              org.apache.oltu.oauth2.common.exception.OAuthSystemException,
                              org.apache.oltu.oauth2.common.exception.OAuthProblemException,
                              ParseException

Throws:

MoxtraException

org.apache.oltu.oauth2.common.exception.OAuthSystemException

org.apache.oltu.oauth2.common.exception.OAuthProblemException

ParseException