org.symphonyoss.symphony.clients.impl

Class ConnectionsClientImpl

java.lang.Object

org.symphonyoss.symphony.clients.impl.ConnectionsClientImpl

All Implemented Interfaces:

ConnectionsClient

public class ConnectionsClientImpl
extends java.lang.Object
implements ConnectionsClient

Client for accessing connections functions.

Constructor Summary

Constructors

Constructor and Description
ConnectionsClientImpl(SymAuth symAuth, SymphonyClientConfig config) Init
ConnectionsClientImpl(SymAuth symAuth, SymphonyClientConfig config, javax.ws.rs.client.Client httpClient) If you need to override HttpClient.

Method Summary

Modifier and Type	Method and Description
SymUserConnection	acceptConnectionRequest(SymUserConnection symUserConnection) Accept a connection request
SymUserConnection	acceptConnectionRequest(SymUserConnectionRequest symUserConnectionRequest) Accept a connection request
java.util.List<SymUserConnection>	getAcceptedRequests() Retrieve accepted connection requests
java.util.List<SymUserConnection>	getAllConnections() Retrieve all connection requests with all states
java.util.List<SymUserConnection>	getIncomingRequests() Retrieve incoming connection requests
java.util.List<SymUserConnection>	getPendingRequests() Retrieve pending incoming connection requests
java.util.List<SymUserConnection>	getRejectedRequests() Retrieve rejected connection requests
SymUserConnection	getUserConnection(java.lang.String userId) Deprecated. please use getUserConnection(SymUser)
SymUserConnection	getUserConnection(SymUser symUser) Retrieve a user connection request by SymUser
SymUserConnection	rejectConnectionRequest(SymUserConnectionRequest symUserConnectionRequest) Reject a connection request
void	removeConnectionRequest(SymUser symUser) Remove an existing user connection
SymUserConnection	sendConnectionRequest(SymUserConnectionRequest symUserConnectionRequest) Send a connection request

Methods inherited from class java.lang.Object

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

Constructor Detail

ConnectionsClientImpl

public ConnectionsClientImpl(SymAuth symAuth,
                             SymphonyClientConfig config)

Init

Parameters:

symAuth - Syphony Authorization tokens

config - Symphony Client config

ConnectionsClientImpl

public ConnectionsClientImpl(SymAuth symAuth,
                             SymphonyClientConfig config,
                             javax.ws.rs.client.Client httpClient)

If you need to override HttpClient. Important for handling individual client certs.

Parameters:

symAuth - Authorization model containing session and key tokens

config - Config updated with pod url

httpClient - Custom HTTP Client to use

Method Detail

getIncomingRequests

public java.util.List<SymUserConnection> getIncomingRequests()
                                                      throws ConnectionsException

Description copied from interface: ConnectionsClient

Retrieve incoming connection requests

Specified by:

getIncomingRequests in interface ConnectionsClient

Returns:

List of SymUserConnectionRequest

Throws:

ConnectionsException - from underlying API exceptions.

getPendingRequests

public java.util.List<SymUserConnection> getPendingRequests()
                                                     throws ConnectionsException

Description copied from interface: ConnectionsClient

Retrieve pending incoming connection requests

Specified by:

getPendingRequests in interface ConnectionsClient

Returns:

List of SymUserConnectionRequest

Throws:

ConnectionsException - from underlying API exceptions.

getRejectedRequests

public java.util.List<SymUserConnection> getRejectedRequests()
                                                      throws ConnectionsException

Description copied from interface: ConnectionsClient

Retrieve rejected connection requests

Specified by:

getRejectedRequests in interface ConnectionsClient

Returns:

List of SymUserConnectionRequest

Throws:

ConnectionsException - from underlying API exceptions.

getAcceptedRequests

public java.util.List<SymUserConnection> getAcceptedRequests()
                                                      throws ConnectionsException

Description copied from interface: ConnectionsClient

Retrieve accepted connection requests

Specified by:

getAcceptedRequests in interface ConnectionsClient

Returns:

List of SymUserConnectionRequest

Throws:

ConnectionsException - from underlying API exceptions.

getAllConnections

public java.util.List<SymUserConnection> getAllConnections()
                                                    throws ConnectionsException

Description copied from interface: ConnectionsClient

Retrieve all connection requests with all states

Specified by:

getAllConnections in interface ConnectionsClient

Returns:

List of SymUserConnectionRequest

Throws:

ConnectionsException - from underlying API exceptions.

removeConnectionRequest

public void removeConnectionRequest(SymUser symUser)
                             throws ConnectionsException

Remove an existing user connection

Specified by:

removeConnectionRequest in interface ConnectionsClient

Parameters:

symUser - Symphony user to remove connection with

Throws:

ConnectionsException - thrown by underlying API or not providing a valid SymUser

sendConnectionRequest

public SymUserConnection sendConnectionRequest(SymUserConnectionRequest symUserConnectionRequest)
                                        throws ConnectionsException

Description copied from interface: ConnectionsClient

Send a connection request

Specified by:

sendConnectionRequest in interface ConnectionsClient

Parameters:

symUserConnectionRequest - User connection request

Returns:

The result of the connection inclusive of state

Throws:

ConnectionsException - from underlying API exceptions.

acceptConnectionRequest

public SymUserConnection acceptConnectionRequest(SymUserConnectionRequest symUserConnectionRequest)
                                          throws ConnectionsException

Description copied from interface: ConnectionsClient

Accept a connection request

Specified by:

acceptConnectionRequest in interface ConnectionsClient

Parameters:

symUserConnectionRequest - User connection request

Returns:

The result of the connection inclusive of state

Throws:

ConnectionsException - from underlying API exceptions.

acceptConnectionRequest

public SymUserConnection acceptConnectionRequest(SymUserConnection symUserConnection)
                                          throws ConnectionsException

Description copied from interface: ConnectionsClient

Accept a connection request

Specified by:

acceptConnectionRequest in interface ConnectionsClient

Parameters:

symUserConnection - User connection request

Returns:

The result of the connection inclusive of state

Throws:

ConnectionsException - from underlying API exceptions.

rejectConnectionRequest

public SymUserConnection rejectConnectionRequest(SymUserConnectionRequest symUserConnectionRequest)
                                          throws ConnectionsException

Description copied from interface: ConnectionsClient

Reject a connection request

Specified by:

rejectConnectionRequest in interface ConnectionsClient

Parameters:

symUserConnectionRequest - User connection request

Returns:

The result of the connection inclusive of state

Throws:

ConnectionsException - from underlying API exceptions.

getUserConnection

@Deprecated
public SymUserConnection getUserConnection(java.lang.String userId)
                                                throws ConnectionsException

Deprecated. please use getUserConnection(SymUser)

Specified by:

getUserConnection in interface ConnectionsClient

Parameters:

userId - Symphony user ID

Returns:

Symphony User connection

Throws:

ConnectionsException - from underlying API

getUserConnection

public SymUserConnection getUserConnection(SymUser symUser)
                                    throws ConnectionsException

Description copied from interface: ConnectionsClient

Retrieve a user connection request by SymUser

Specified by:

getUserConnection in interface ConnectionsClient

Parameters:

symUser - The Symphony user

Returns:

The connection

Throws:

ConnectionsException - from underlying API exceptions