Class DittoConnectionRequest

java.lang.Object

com.ditto.java.DittoConnectionRequest

public final class DittoConnectionRequest
extends Object

Contains information about a remote peer that has requested a connection.

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
@NonNull DittoConnectionType	getConnectionType()	Returns the connection type used to establish this particular connection.
@NonNull Map<@NonNull String,@Nullable ?>	getIdentityServiceMetadata()	Deprecated. use getIdentityServiceMetadataObject() with DittoJsonSerializable.ObjectValue.toMap() on the returned value.
@NonNull String	getIdentityServiceMetadataJson()	Returns a JSON string of metadata for the remote peer provided by the identity service.
@NonNull DittoJsonSerializable.ObjectValue	getIdentityServiceMetadataObject()	Returns metadata for the remote peer provided by the identity service.
@NonNull String	getPeerKey()	The unique peer key of the remote peer.
@NonNull Map<@NonNull String,@Nullable ?>	getPeerMetadata()	Deprecated. use getPeerMetadataObject() with DittoJsonSerializable.ObjectValue.toMap() on the returned value.
@NonNull String	getPeerMetadataJson()	Returns a JSON string of metadata associated with the remote peer.
@NonNull DittoJsonSerializable.ObjectValue	getPeerMetadataObject()	Returns metadata associated with the remote peer.
int	hashCode()

Methods inherited from class java.lang.Object

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

Method Details

getPeerKey

public @NonNull String getPeerKey()

The unique peer key of the remote peer.

See Also:

• More information on peer keys.

getPeerMetadata

@Deprecated
public @NonNull Map<@NonNull String,@Nullable ?> getPeerMetadata()

Deprecated.

use getPeerMetadataObject() with DittoJsonSerializable.ObjectValue.toMap() on the returned value.

Returns metadata associated with the remote peer.

Returns an empty dictionary if the remote peer has not set any metadata.

Set peer metadata for the local peer using DittoPresence.setPeerMetadata(DittoJsonSerializable.ObjectValue) or DittoPresence.setPeerMetadataJsonString(String).

This is a convenience method that wraps getPeerMetadataObject().

Returns:

an unmodifiable map of peer metadata.

getPeerMetadataObject

public @NonNull DittoJsonSerializable.ObjectValue getPeerMetadataObject()

Returns metadata associated with the remote peer.

Returns an empty dictionary if the remote peer has not set any metadata.

Set peer metadata for the local peer using DittoPresence.setPeerMetadata(DittoJsonSerializable.ObjectValue) or DittoPresence.setPeerMetadataJsonString(String).

This is a convenience method that wraps getPeerMetadataJson().

To convert the value to a plain Map, call DittoJsonSerializable.ObjectValue.toMap() on the returned value.

Returns:

a DittoJsonSerializable.ObjectValue containing the peer metadata.

getPeerMetadataJson

public @NonNull String getPeerMetadataJson()

Returns a JSON string of metadata associated with the remote peer.

Returns a JSON string representing an empty dictionary if the remote peer has not set any metadata.

Set peer metadata for the local peer using DittoPresence.setPeerMetadata(DittoJsonSerializable.ObjectValue) or DittoPresence.setPeerMetadataJsonString(String).

Returns:

the peer metadata as a JSON string.

getIdentityServiceMetadata

@Deprecated
public @NonNull Map<@NonNull String,@Nullable ?> getIdentityServiceMetadata()

Deprecated.

use getIdentityServiceMetadataObject() with DittoJsonSerializable.ObjectValue.toMap() on the returned value.

Returns metadata for the remote peer provided by the identity service.

Use an authentication webhook to set this value. See Ditto's online documentation for more information on how to configure an authentication webhook.

This is a convenience method that wraps getIdentityServiceMetadataObject().

Returns:

an unmodifiable map of identity service metadata.

getIdentityServiceMetadataObject

public @NonNull DittoJsonSerializable.ObjectValue getIdentityServiceMetadataObject()

Returns metadata for the remote peer provided by the identity service.

Use an authentication webhook to set this value. See Ditto's online documentation for more information on how to configure an authentication webhook.

This is a convenience method that wraps getIdentityServiceMetadataJson().

To convert the value to a plain Map, call DittoJsonSerializable.ObjectValue.toMap() on the returned value.

Returns:

a DittoJsonSerializable.ObjectValue containing the identity service metadata.

getIdentityServiceMetadataJson

public @NonNull String getIdentityServiceMetadataJson()

Returns a JSON string of metadata for the remote peer provided by the identity service.

Use an authentication webhook to set this value. See Ditto's online documentation for more information on how to configure an authentication webhook.

Returns:

the identity service metadata as a JSON string.

getConnectionType

public @NonNull DittoConnectionType getConnectionType()

Returns the connection type used to establish this particular connection.

Use this to allow or deny only specific types of connections.

Returns:

the DittoConnectionType for this connection.

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object