Package io.getstream.chat.java.models

Class App

java.lang.Object

io.getstream.chat.java.models.framework.StreamResponseObject

io.getstream.chat.java.models.App

All Implemented Interfaces:

StreamResponse, StreamResponseWithRateLimit

public class App
extends StreamResponseObject

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	App.APNConfig
static class	App.APNConfigRequestObject
static class	App.AppCheckPushRequestData
static class	App.AppCheckPushResponse
static class	App.AppCheckSnsRequestData
static class	App.AppCheckSnsResponse
static class	App.AppCheckSqsRequestData
static class	App.AppCheckSqsResponse
static class	App.AppConfig
static class	App.AppGetRateLimitsRequest
static class	App.AppGetRateLimitsResponse
static class	App.AppGetRequest
static class	App.AppRevokeTokensRequest
static class	App.AppUpdateRequestData
static class	App.AsyncModerationCallback
static class	App.AsyncModerationConfigRequestObject
static class	App.AuthenticationType
static class	App.AuthType
static class	App.CallbackMode
static class	App.DeletePushProviderRequest
static class	App.DeviceError
static class	App.EnforceUniqueUsernames
static class	App.EnforceUniqueUsernamesDeserializer
static class	App.EventHook
static class	App.FileUploadConfig
static class	App.FileUploadConfigRequestObject
static class	App.FirebaseConfig
static class	App.FirebaseConfigRequestObject
static class	App.HookType
static class	App.HuaweiConfig
static class	App.HuaweiConfigRequestObject
static class	App.ListPushProviderResponse
static class	App.ListPushProvidersRequest
static class	App.PendingMessageCallback
static class	App.PermissionVersion
static class	App.Policy
static class	App.Product
static class	App.PushConfigRequestObject
static class	App.PushNotificationFields
static class	App.PushProvider
static class	App.PushProviderRequestData
static class	App.PushProviderType
static class	App.PushVersion
static class	App.UpsertPushProviderResponse

Constructor Summary

Constructors

Constructor	Description
App()

Method Summary

Modifier and Type	Method	Description
protected boolean	canEqual(java.lang.Object other)
static @NotNull App.AppCheckPushRequestData.AppCheckPushRequest	checkPush()	Creates a check push request.
static @NotNull App.AppCheckSnsRequestData.AppCheckSnsRequest	checkSns()	Creates a check SNS request.
static @NotNull App.AppCheckSqsRequestData.AppCheckSqsRequest	checkSqs()	Creates a check SQS request.
static byte[]	decodeSnsPayload(@NotNull java.lang.String notificationBody)	Reverses an SNS HTTP notification envelope.
static byte[]	decodeSqsPayload(@NotNull java.lang.String body)	Reverses the SQS firehose envelope: the message Body is base64-decoded and, when the result begins with the gzip magic, it is gzip-decompressed.
static @NotNull App.DeletePushProviderRequest	deletePushProvider(@NotNull java.lang.String providerType, @NotNull java.lang.String name)	Creates a delete push provider request
boolean	equals(java.lang.Object o)
static @NotNull App.AppGetRequest	get()	Creates a get request.
@Nullable App.AppConfig	getApp()
static @NotNull App.AppGetRateLimitsRequest	getRateLimits()	Creates a get rate limits request.
static byte[]	gunzipPayload(@org.jetbrains.annotations.NotNull byte[] body)	Returns body unchanged unless it starts with the gzip magic (1f 8b, per RFC 1952), in which case the gzip stream is inflated and the decompressed bytes are returned.
int	hashCode()
static @NotNull App.ListPushProvidersRequest	listPushProviders()	Creates a list push providers request
static @NotNull Event	parseEvent(@org.jetbrains.annotations.NotNull byte[] payload)	Parse a JSON-encoded webhook event into a typed Event.
static @NotNull Event	parseSns(@NotNull java.lang.String notificationBody)	Decode an SNS-delivered payload (unwraps envelope JSON when needed) and return the parsed Event.
static @NotNull Event	parseSqs(@NotNull java.lang.String messageBody)	Decode the SQS Body (base64, then gzip-if-magic) and return the parsed Event.
static @NotNull App.AppRevokeTokensRequest	revokeTokens(@Nullable java.util.Date revokeTokensIssuedBefore)	Creates a revoke tokens request
void	setApp(@Nullable App.AppConfig app)
java.lang.String	toString()
static @NotNull App.AppUpdateRequestData.AppUpdateRequest	update()	Creates an update request.
static @NotNull App.PushProviderRequestData.PushProviderRequest	upsertPushProvider()	Creates an upsert push provider request
static @NotNull Event	verifyAndParseWebhook(@org.jetbrains.annotations.NotNull byte[] body, @NotNull java.lang.String signature)	Singleton-secret overload: uses the API secret of the configured Client singleton.
static @NotNull Event	verifyAndParseWebhook(@org.jetbrains.annotations.NotNull byte[] body, @NotNull java.lang.String signature, @NotNull java.lang.String secret)	Decompresses body when gzipped, verifies the HMAC signature, and returns the parsed Event.
static boolean	verifySignature(@org.jetbrains.annotations.NotNull byte[] body, @NotNull java.lang.String signature, @NotNull java.lang.String secret)	Constant-time HMAC-SHA256 verification of signature against the digest of body using secret as the key.
boolean	verifyWebhook(@NotNull java.lang.String body, @NotNull java.lang.String signature)	Validates if hmac signature is correct for the message body.
static boolean	verifyWebhookSignature(@NotNull java.lang.String body, @NotNull java.lang.String signature)	Validates if hmac signature is correct for the message body using the singleton client's API secret.
static boolean	verifyWebhookSignature(@NotNull java.lang.String apiSecret, @NotNull java.lang.String body, @NotNull java.lang.String signature)	Validates if hmac signature is correct for message body.

Methods inherited from class io.getstream.chat.java.models.framework.StreamResponseObject

getDuration, getRateLimit, setDuration, setRateLimit

Methods inherited from class java.lang.Object

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

Constructor Detail

App

public App()

Method Detail

get

@NotNull
public static @NotNull App.AppGetRequest get()

Creates a get request.

Returns:

the created request

update

@NotNull
public static @NotNull App.AppUpdateRequestData.AppUpdateRequest update()

Creates an update request.

Returns:

the created request

getRateLimits

@NotNull
public static @NotNull App.AppGetRateLimitsRequest getRateLimits()

Creates a get rate limits request.

Returns:

the created request

checkSqs

@NotNull
public static @NotNull App.AppCheckSqsRequestData.AppCheckSqsRequest checkSqs()

Creates a check SQS request.

Returns:

the created request

checkSns

@NotNull
public static @NotNull App.AppCheckSnsRequestData.AppCheckSnsRequest checkSns()

Creates a check SNS request.

Returns:

the created request

checkPush

@NotNull
public static @NotNull App.AppCheckPushRequestData.AppCheckPushRequest checkPush()

Creates a check push request.

Returns:

the created request

revokeTokens

@NotNull
public static @NotNull App.AppRevokeTokensRequest revokeTokens(@Nullable
                                                               @Nullable java.util.Date revokeTokensIssuedBefore)

Creates a revoke tokens request

Parameters:

revokeTokensIssuedBefore - the limit date to revoke tokens

Returns:

the created request

upsertPushProvider

@NotNull
public static @NotNull App.PushProviderRequestData.PushProviderRequest upsertPushProvider()

Creates an upsert push provider request

Returns:

the created request

listPushProviders

@NotNull
public static @NotNull App.ListPushProvidersRequest listPushProviders()

Creates a list push providers request

Returns:

the created request

deletePushProvider

@NotNull
public static @NotNull App.DeletePushProviderRequest deletePushProvider(@NotNull
                                                                        @NotNull java.lang.String providerType,
                                                                        @NotNull
                                                                        @NotNull java.lang.String name)

Creates a delete push provider request

Parameters:

providerType - push provider type

name - push provider name

Returns:

the created request

verifyWebhook

public boolean verifyWebhook(@NotNull
                             @NotNull java.lang.String body,
                             @NotNull
                             @NotNull java.lang.String signature)

Validates if hmac signature is correct for the message body.

Kept for backward compatibility. New integrations should call verifyAndParseWebhook(byte[], String) (or the SQS / SNS variants), which also handle gzip payload compression.

Parameters:

body - raw body from http request converted to a string.

signature - the signature provided in X-Signature header

Returns:

true if the signature is valid

verifyWebhookSignature

public static boolean verifyWebhookSignature(@NotNull
                                             @NotNull java.lang.String apiSecret,
                                             @NotNull
                                             @NotNull java.lang.String body,
                                             @NotNull
                                             @NotNull java.lang.String signature)

Validates if hmac signature is correct for message body. Backward-compatible alias for verifySignature(byte[], String, String).

Parameters:

apiSecret - the secret key

body - raw body from http request converted to a string.

signature - the signature provided in X-Signature header

Returns:

true if the signature is valid

verifyWebhookSignature

public static boolean verifyWebhookSignature(@NotNull
                                             @NotNull java.lang.String body,
                                             @NotNull
                                             @NotNull java.lang.String signature)

Validates if hmac signature is correct for the message body using the singleton client's API secret.

Parameters:

body - the message body

signature - the signature provided in X-Signature header

Returns:

true if the signature is valid

verifySignature

public static boolean verifySignature(@NotNull
                                      @org.jetbrains.annotations.NotNull byte[] body,
                                      @NotNull
                                      @NotNull java.lang.String signature,
                                      @NotNull
                                      @NotNull java.lang.String secret)

Constant-time HMAC-SHA256 verification of signature against the digest of body using secret as the key.

The signature is always computed over the uncompressed JSON bytes, so callers that decoded a gzipped or base64-wrapped payload must pass the inflated bytes here.

Parameters:

body - the uncompressed body bytes

signature - the signature provided in X-Signature

secret - the app's API secret

Returns:

true if the signature matches

gunzipPayload

public static byte[] gunzipPayload(@NotNull
                                   @org.jetbrains.annotations.NotNull byte[] body)

Returns body unchanged unless it starts with the gzip magic (1f 8b, per RFC 1952), in which case the gzip stream is inflated and the decompressed bytes are returned.

Magic-byte detection (rather than relying on a header) lets the same handler stay correct when middleware auto-decompresses the request before your code sees it.

decodeSqsPayload

public static byte[] decodeSqsPayload(@NotNull
                                      @NotNull java.lang.String body)

Reverses the SQS firehose envelope: the message Body is base64-decoded and, when the result begins with the gzip magic, it is gzip-decompressed. The same call works whether or not Stream is currently compressing payloads.

Parameters:

body - the SQS message Body

Returns:

the raw JSON bytes Stream signed

decodeSnsPayload

public static byte[] decodeSnsPayload(@NotNull
                                      @NotNull java.lang.String notificationBody)

Reverses an SNS HTTP notification envelope. When notificationBody is a JSON envelope ({"Type":"Notification","Message":"..."}), the inner Message field is extracted and run through the SQS pipeline (base64-decode, then gzip-if-magic). When the input is not a JSON envelope it is treated as the already-extracted Message string, so call sites that pre-unwrap continue to work.

parseEvent

@NotNull
public static @NotNull Event parseEvent(@NotNull
                                        @org.jetbrains.annotations.NotNull byte[] payload)

Parse a JSON-encoded webhook event into a typed Event. Unknown event types still parse successfully because Event.getType() is a free-form string; unknown nested fields and unknown enum values are tolerated so the handler stays forward-compatible with new Stream server releases.

Throws:

InvalidWebhookError - when the bytes are not valid JSON

verifyAndParseWebhook

@NotNull
public static @NotNull Event verifyAndParseWebhook(@NotNull
                                                   @org.jetbrains.annotations.NotNull byte[] body,
                                                   @NotNull
                                                   @NotNull java.lang.String signature,
                                                   @NotNull
                                                   @NotNull java.lang.String secret)

Decompresses body when gzipped, verifies the HMAC signature, and returns the parsed Event. Works for HTTP webhooks regardless of whether payload compression is enabled.

Parameters:

body - raw HTTP request body bytes Stream signed

signature - value of the X-Signature header

secret - the app's API secret

Returns:

the parsed event

Throws:

InvalidWebhookError - when the signature does not match, the gzip envelope is malformed, or the payload is not JSON

verifyAndParseWebhook

@NotNull
public static @NotNull Event verifyAndParseWebhook(@NotNull
                                                   @org.jetbrains.annotations.NotNull byte[] body,
                                                   @NotNull
                                                   @NotNull java.lang.String signature)

Singleton-secret overload: uses the API secret of the configured Client singleton.

parseSqs

@NotNull
public static @NotNull Event parseSqs(@NotNull
                                      @NotNull java.lang.String messageBody)

Decode the SQS Body (base64, then gzip-if-magic) and return the parsed Event. Stream does not HMAC-sign SQS message bodies.

parseSns

@NotNull
public static @NotNull Event parseSns(@NotNull
                                      @NotNull java.lang.String notificationBody)

Decode an SNS-delivered payload (unwraps envelope JSON when needed) and return the parsed Event. No HMAC verification.

getApp

@Nullable
public @Nullable App.AppConfig getApp()

setApp

public void setApp(@Nullable
                   @Nullable App.AppConfig app)

toString

public java.lang.String toString()

Overrides:

toString in class StreamResponseObject

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class StreamResponseObject

canEqual

protected boolean canEqual(java.lang.Object other)

Overrides:

canEqual in class StreamResponseObject

hashCode

public int hashCode()

Overrides:

hashCode in class StreamResponseObject