Connection | PrivMX Docs

Manages a connection between the Endpoint and the Bridge server.

Static Methods

connect

Connects to PrivMX Bridge server.

Params

userPrivKey

String

user's private key

solutionId

String

ID of the Solution

bridgeUrl

String

Bridge's Endpoint URL

public static Connection connect(
String userPrivKey,
String solutionId,
String bridgeUrl
)

Returns

Connection · Connection object

connectPublic

Connects to PrivMX Bridge server as a guest user.

Params

solutionId

String

ID of the Solution

bridgeUrl

String

Bridge's Endpoint URL

public static Connection connectPublic(
String solutionId,
String bridgeUrl
)

Returns

Connection · Connection object

platformConnect

Connects to PrivMX Bridge server.

Params

userPrivKey

String

user's private key

solutionId

String

ID of the Solution

platformUrl

String

Platform's Endpoint URL

public static Connection platformConnect(
String userPrivKey,
String solutionId,
String platformUrl
)

Returns

Connection · Connection object

platformConnectPublic

Connects to PrivMX Bridge server as a guest user.

Params

solutionId

String

ID of the Solution

platformUrl

String

Platform's Endpoint URL

public static Connection platformConnectPublic(
String solutionId,
String platformUrl
)

Returns

Connection · Connection object

setCertsPath

Allows to set path to the SSL certificate file.

Params

certsPath

String

path to file

public static void setCertsPath(
String certsPath
)

Methods

close

If there is an active connection then it disconnects from PrivMX Bridge and frees memory making this instance not reusable.

public void close()

disconnect

Disconnects from PrivMX Bridge server.

public void disconnect()

getConnectionId

Gets the ID of the current connection.

public Long getConnectionId()

Returns

Long · ID of the connection

listContexts

Gets a list of Contexts available for the user.

Params

skip

long

skip number of elements to skip from result

limit

long

limit of elements to return for query

sortOrder

String

order of elements in result ("asc" for ascending, "desc" for descending)

public PagingList<Context> listContexts(
long skip,
long limit,
String sortOrder
)

Returns

PagingList<Context> · list of Contexts

listContexts

Gets a list of Contexts available for the user.

Params

skip

long

skip number of elements to skip from result

limit

long

limit of elements to return for query

sortOrder

String

order of elements in result ("asc" for ascending, "desc" for descending)

lastId

String

ID of the element from which query results should start

public PagingList<Context> listContexts(
long skip,
long limit,
String sortOrder,
String lastId
)

Returns

PagingList<Context> · list of Contexts