Index

A C D G I J R S T U V
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form

A

AcceptInvitationRequest - Class in com.vortexsoftware.sdk.types

Request payload for accepting invitations

AcceptInvitationRequest() - Constructor for class com.vortexsoftware.sdk.types.AcceptInvitationRequest

AcceptInvitationRequest(List<String>, InvitationTarget) - Constructor for class com.vortexsoftware.sdk.types.AcceptInvitationRequest

acceptInvitations(AcceptInvitationRequest) - Method in class com.vortexsoftware.sdk.spring.VortexController

Accept invitations POST /invitations/accept

acceptInvitations(List<String>, InvitationTarget) - Method in class com.vortexsoftware.sdk.VortexClient

Accept multiple invitations for a target

authenticateUser() - Method in interface com.vortexsoftware.sdk.spring.VortexConfig

Convert the current request context to a Vortex user This should extract user information from the current HTTP request and return it in the format expected by Vortex JWT generation.

authorizeOperation(String, VortexConfig.VortexUser) - Method in interface com.vortexsoftware.sdk.spring.VortexConfig

Check if the current user can perform a specific operation

C

close() - Method in class com.vortexsoftware.sdk.VortexClient

Close the HTTP client when done

com.vortexsoftware.sdk - package com.vortexsoftware.sdk

Vortex Java SDK for invitation management and JWT generation.

com.vortexsoftware.sdk.spring - package com.vortexsoftware.sdk.spring

com.vortexsoftware.sdk.types - package com.vortexsoftware.sdk.types

createVortexApiPath(String, String) - Static method in class com.vortexsoftware.sdk.spring.VortexRoutes

Create the full API path based on base URL

D

deleteInvitationsByGroup(String, String) - Method in class com.vortexsoftware.sdk.spring.VortexController

Delete invitations by group DELETE /invitations/by-group/{groupType}/{groupId}

deleteInvitationsByGroup(String, String) - Method in class com.vortexsoftware.sdk.VortexClient

Delete all invitations for a specific group

G

generateJwt(Map<String, Object>) - Method in class com.vortexsoftware.sdk.VortexClient

Generate a JWT using the same algorithm as the Node.js SDK

generateJWT() - Method in class com.vortexsoftware.sdk.spring.VortexController

Generate JWT for the authenticated user POST /jwt

getAcceptedAt() - Method in class com.vortexsoftware.sdk.types.InvitationAcceptance

getAccepts() - Method in class com.vortexsoftware.sdk.types.InvitationResult

getAccountId() - Method in class com.vortexsoftware.sdk.types.InvitationAcceptance

getAccountId() - Method in class com.vortexsoftware.sdk.types.InvitationGroup

getAccountId() - Method in class com.vortexsoftware.sdk.types.InvitationResult

getAdminScopes() - Method in class com.vortexsoftware.sdk.types.User

getAttributes() - Method in class com.vortexsoftware.sdk.types.InvitationResult

getClickThroughs() - Method in class com.vortexsoftware.sdk.types.InvitationResult

getConfigurationAttributes() - Method in class com.vortexsoftware.sdk.types.InvitationResult

getCreatedAt() - Method in class com.vortexsoftware.sdk.types.InvitationGroup

getCreatedAt() - Method in class com.vortexsoftware.sdk.types.InvitationResult

getDeliveryCount() - Method in class com.vortexsoftware.sdk.types.InvitationResult

getDeliveryTypes() - Method in class com.vortexsoftware.sdk.types.InvitationResult

getEmail() - Method in class com.vortexsoftware.sdk.types.User

getForeignCreatorId() - Method in class com.vortexsoftware.sdk.types.InvitationResult

getGroupId() - Method in class com.vortexsoftware.sdk.types.Group

getGroupId() - Method in class com.vortexsoftware.sdk.types.InvitationGroup

getGroups() - Method in class com.vortexsoftware.sdk.spring.VortexConfig.VortexUser

getGroups() - Method in class com.vortexsoftware.sdk.types.InvitationResult

getGroups() - Method in class com.vortexsoftware.sdk.types.JWTPayload

getId() - Method in class com.vortexsoftware.sdk.types.Group

getId() - Method in class com.vortexsoftware.sdk.types.InvitationAcceptance

getId() - Method in class com.vortexsoftware.sdk.types.InvitationGroup

getId() - Method in class com.vortexsoftware.sdk.types.InvitationResult

getId() - Method in class com.vortexsoftware.sdk.types.User

getIdentifiers() - Method in class com.vortexsoftware.sdk.spring.VortexConfig.VortexUser

getIdentifiers() - Method in class com.vortexsoftware.sdk.types.JWTPayload

getInvitation(String) - Method in class com.vortexsoftware.sdk.spring.VortexController

Get specific invitation by ID GET /invitations/{invitationId}

getInvitation(String) - Method in class com.vortexsoftware.sdk.VortexClient

Get a specific invitation by ID

getInvitationIds() - Method in class com.vortexsoftware.sdk.types.AcceptInvitationRequest

getInvitations() - Method in class com.vortexsoftware.sdk.types.InvitationResponse

getInvitationsByGroup(String, String) - Method in class com.vortexsoftware.sdk.spring.VortexController

Get invitations by group GET /invitations/by-group/{groupType}/{groupId}

getInvitationsByGroup(String, String) - Method in class com.vortexsoftware.sdk.VortexClient

Get all invitations for a specific group

getInvitationsByTarget(String, String) - Method in class com.vortexsoftware.sdk.spring.VortexController

Get invitations by target GET /invitations?targetType=email&targetValue=user@example.com

getInvitationsByTarget(String, String) - Method in class com.vortexsoftware.sdk.VortexClient

Get invitations by target (email, username, phoneNumber)

getInvitationType() - Method in class com.vortexsoftware.sdk.types.InvitationResult

getModifiedAt() - Method in class com.vortexsoftware.sdk.types.InvitationResult

getName() - Method in class com.vortexsoftware.sdk.types.Group

getName() - Method in class com.vortexsoftware.sdk.types.InvitationGroup

getProjectId() - Method in class com.vortexsoftware.sdk.types.InvitationAcceptance

getProjectId() - Method in class com.vortexsoftware.sdk.types.InvitationResult

getRole() - Method in class com.vortexsoftware.sdk.spring.VortexConfig.VortexUser

getRole() - Method in class com.vortexsoftware.sdk.types.JWTPayload

getScope() - Method in class com.vortexsoftware.sdk.types.InvitationResult

getScopeType() - Method in class com.vortexsoftware.sdk.types.InvitationResult

getStatus() - Method in class com.vortexsoftware.sdk.types.InvitationResult

getTarget() - Method in class com.vortexsoftware.sdk.types.AcceptInvitationRequest

getTarget() - Method in class com.vortexsoftware.sdk.types.InvitationResult

getTargetType() - Method in class com.vortexsoftware.sdk.types.InvitationAcceptance

getTargetValue() - Method in class com.vortexsoftware.sdk.types.InvitationAcceptance

getType() - Method in class com.vortexsoftware.sdk.types.Group

getType() - Method in class com.vortexsoftware.sdk.types.Identifier

getType() - Method in class com.vortexsoftware.sdk.types.InvitationGroup

getType() - Method in class com.vortexsoftware.sdk.types.InvitationTarget

getUserEmail() - Method in class com.vortexsoftware.sdk.spring.VortexConfig.VortexUser

getUserEmail() - Method in class com.vortexsoftware.sdk.types.JWTPayload

getUserId() - Method in class com.vortexsoftware.sdk.spring.VortexConfig.VortexUser

getUserId() - Method in class com.vortexsoftware.sdk.types.JWTPayload

getUserIsAutoJoinAdmin() - Method in class com.vortexsoftware.sdk.spring.VortexConfig.VortexUser

getUserIsAutoJoinAdmin() - Method in class com.vortexsoftware.sdk.types.JWTPayload

getValue() - Method in class com.vortexsoftware.sdk.types.Identifier

getValue() - Method in class com.vortexsoftware.sdk.types.InvitationTarget

getViews() - Method in class com.vortexsoftware.sdk.types.InvitationResult

getWidgetConfigurationId() - Method in class com.vortexsoftware.sdk.types.InvitationResult

Group - Class in com.vortexsoftware.sdk.types

Represents a group for JWT generation (input).

Group() - Constructor for class com.vortexsoftware.sdk.types.Group

Group(String, String) - Constructor for class com.vortexsoftware.sdk.types.Group

Group(String, String, String, String) - Constructor for class com.vortexsoftware.sdk.types.Group

I

Identifier - Class in com.vortexsoftware.sdk.types

Represents an identifier for a user (email, sms, etc.) Used for JWT generation.

Identifier() - Constructor for class com.vortexsoftware.sdk.types.Identifier

Identifier(String, String) - Constructor for class com.vortexsoftware.sdk.types.Identifier

INVITATION - Static variable in class com.vortexsoftware.sdk.spring.VortexRoutes

INVITATION_REINVITE - Static variable in class com.vortexsoftware.sdk.spring.VortexRoutes

InvitationAcceptance - Class in com.vortexsoftware.sdk.types

Represents an accepted invitation

InvitationAcceptance() - Constructor for class com.vortexsoftware.sdk.types.InvitationAcceptance

InvitationGroup - Class in com.vortexsoftware.sdk.types

Represents a group associated with an invitation.

InvitationGroup() - Constructor for class com.vortexsoftware.sdk.types.InvitationGroup

InvitationGroup(String, String, String, String, String, String) - Constructor for class com.vortexsoftware.sdk.types.InvitationGroup

InvitationResponse - Class in com.vortexsoftware.sdk.types

Response wrapper for invitation API calls that return multiple invitations

InvitationResponse() - Constructor for class com.vortexsoftware.sdk.types.InvitationResponse

InvitationResponse(List<InvitationResult>) - Constructor for class com.vortexsoftware.sdk.types.InvitationResponse

InvitationResult - Class in com.vortexsoftware.sdk.types

Complete invitation result as returned by the Vortex API

InvitationResult() - Constructor for class com.vortexsoftware.sdk.types.InvitationResult

INVITATIONS - Static variable in class com.vortexsoftware.sdk.spring.VortexRoutes

INVITATIONS_ACCEPT - Static variable in class com.vortexsoftware.sdk.spring.VortexRoutes

INVITATIONS_BY_GROUP - Static variable in class com.vortexsoftware.sdk.spring.VortexRoutes

InvitationTarget - Class in com.vortexsoftware.sdk.types

Represents the target of an invitation (email, SMS, etc.)

InvitationTarget() - Constructor for class com.vortexsoftware.sdk.types.InvitationTarget

InvitationTarget(String, String) - Constructor for class com.vortexsoftware.sdk.types.InvitationTarget

isDeactivated() - Method in class com.vortexsoftware.sdk.types.InvitationResult

J

JWT - Static variable in class com.vortexsoftware.sdk.spring.VortexRoutes

Base routes that match the React provider's API calls

JWTPayload - Class in com.vortexsoftware.sdk.types

JWT payload for Vortex token generation Supports both new simplified format (userEmail, userIsAutoJoinAdmin) and legacy format (identifiers, groups, role) for backward compatibility.

JWTPayload() - Constructor for class com.vortexsoftware.sdk.types.JWTPayload

JWTPayload(String, String, Boolean) - Constructor for class com.vortexsoftware.sdk.types.JWTPayload

Create a payload with new simplified format (recommended)

JWTPayload(String, List<Identifier>, List<Group>, String) - Constructor for class com.vortexsoftware.sdk.types.JWTPayload

Deprecated.

Use constructor with userEmail instead

R

reinvite(String) - Method in class com.vortexsoftware.sdk.spring.VortexController

Reinvite user POST /invitations/{invitationId}/reinvite

reinvite(String) - Method in class com.vortexsoftware.sdk.VortexClient

Reinvite a user (send invitation again)

revokeInvitation(String) - Method in class com.vortexsoftware.sdk.spring.VortexController

Revoke (delete) invitation DELETE /invitations/{invitationId}

revokeInvitation(String) - Method in class com.vortexsoftware.sdk.VortexClient

Revoke (delete) an invitation

S

setAcceptedAt(String) - Method in class com.vortexsoftware.sdk.types.InvitationAcceptance

setAccepts(List<InvitationAcceptance>) - Method in class com.vortexsoftware.sdk.types.InvitationResult

setAccountId(String) - Method in class com.vortexsoftware.sdk.types.InvitationAcceptance

setAccountId(String) - Method in class com.vortexsoftware.sdk.types.InvitationGroup

setAccountId(String) - Method in class com.vortexsoftware.sdk.types.InvitationResult

setAdminScopes(List<String>) - Method in class com.vortexsoftware.sdk.types.User

setAttributes(Map<String, Object>) - Method in class com.vortexsoftware.sdk.types.InvitationResult

setClickThroughs(int) - Method in class com.vortexsoftware.sdk.types.InvitationResult

setConfigurationAttributes(Map<String, Object>) - Method in class com.vortexsoftware.sdk.types.InvitationResult

setCreatedAt(String) - Method in class com.vortexsoftware.sdk.types.InvitationGroup

setCreatedAt(String) - Method in class com.vortexsoftware.sdk.types.InvitationResult

setDeactivated(boolean) - Method in class com.vortexsoftware.sdk.types.InvitationResult

setDeliveryCount(int) - Method in class com.vortexsoftware.sdk.types.InvitationResult

setDeliveryTypes(List<String>) - Method in class com.vortexsoftware.sdk.types.InvitationResult

setEmail(String) - Method in class com.vortexsoftware.sdk.types.User

setForeignCreatorId(String) - Method in class com.vortexsoftware.sdk.types.InvitationResult

setGroupId(String) - Method in class com.vortexsoftware.sdk.types.Group

setGroupId(String) - Method in class com.vortexsoftware.sdk.types.InvitationGroup

setGroups(List<Group>) - Method in class com.vortexsoftware.sdk.spring.VortexConfig.VortexUser

setGroups(List<Group>) - Method in class com.vortexsoftware.sdk.types.JWTPayload

setGroups(List<InvitationGroup>) - Method in class com.vortexsoftware.sdk.types.InvitationResult

setId(String) - Method in class com.vortexsoftware.sdk.types.Group

setId(String) - Method in class com.vortexsoftware.sdk.types.InvitationAcceptance

setId(String) - Method in class com.vortexsoftware.sdk.types.InvitationGroup

setId(String) - Method in class com.vortexsoftware.sdk.types.InvitationResult

setId(String) - Method in class com.vortexsoftware.sdk.types.User

setIdentifiers(List<Identifier>) - Method in class com.vortexsoftware.sdk.spring.VortexConfig.VortexUser

setIdentifiers(List<Identifier>) - Method in class com.vortexsoftware.sdk.types.JWTPayload

setInvitationIds(List<String>) - Method in class com.vortexsoftware.sdk.types.AcceptInvitationRequest

setInvitations(List<InvitationResult>) - Method in class com.vortexsoftware.sdk.types.InvitationResponse

setInvitationType(String) - Method in class com.vortexsoftware.sdk.types.InvitationResult

setModifiedAt(String) - Method in class com.vortexsoftware.sdk.types.InvitationResult

setName(String) - Method in class com.vortexsoftware.sdk.types.Group

setName(String) - Method in class com.vortexsoftware.sdk.types.InvitationGroup

setProjectId(String) - Method in class com.vortexsoftware.sdk.types.InvitationAcceptance

setProjectId(String) - Method in class com.vortexsoftware.sdk.types.InvitationResult

setRole(String) - Method in class com.vortexsoftware.sdk.spring.VortexConfig.VortexUser

setRole(String) - Method in class com.vortexsoftware.sdk.types.JWTPayload

setScope(String) - Method in class com.vortexsoftware.sdk.types.InvitationResult

setScopeType(String) - Method in class com.vortexsoftware.sdk.types.InvitationResult

setStatus(String) - Method in class com.vortexsoftware.sdk.types.InvitationResult

setTarget(InvitationTarget) - Method in class com.vortexsoftware.sdk.types.AcceptInvitationRequest

setTarget(List<InvitationTarget>) - Method in class com.vortexsoftware.sdk.types.InvitationResult

setTargetType(String) - Method in class com.vortexsoftware.sdk.types.InvitationAcceptance

setTargetValue(String) - Method in class com.vortexsoftware.sdk.types.InvitationAcceptance

setType(String) - Method in class com.vortexsoftware.sdk.types.Group

setType(String) - Method in class com.vortexsoftware.sdk.types.Identifier

setType(String) - Method in class com.vortexsoftware.sdk.types.InvitationGroup

setType(String) - Method in class com.vortexsoftware.sdk.types.InvitationTarget

setUserEmail(String) - Method in class com.vortexsoftware.sdk.spring.VortexConfig.VortexUser

setUserEmail(String) - Method in class com.vortexsoftware.sdk.types.JWTPayload

setUserId(String) - Method in class com.vortexsoftware.sdk.spring.VortexConfig.VortexUser

setUserId(String) - Method in class com.vortexsoftware.sdk.types.JWTPayload

setUserIsAutoJoinAdmin(Boolean) - Method in class com.vortexsoftware.sdk.spring.VortexConfig.VortexUser

setUserIsAutoJoinAdmin(Boolean) - Method in class com.vortexsoftware.sdk.types.JWTPayload

setValue(String) - Method in class com.vortexsoftware.sdk.types.Identifier

setValue(String) - Method in class com.vortexsoftware.sdk.types.InvitationTarget

setViews(int) - Method in class com.vortexsoftware.sdk.types.InvitationResult

setWidgetConfigurationId(String) - Method in class com.vortexsoftware.sdk.types.InvitationResult

T

toString() - Method in class com.vortexsoftware.sdk.spring.VortexConfig.VortexUser

toString() - Method in class com.vortexsoftware.sdk.types.AcceptInvitationRequest

toString() - Method in class com.vortexsoftware.sdk.types.Group

toString() - Method in class com.vortexsoftware.sdk.types.Identifier

toString() - Method in class com.vortexsoftware.sdk.types.InvitationAcceptance

toString() - Method in class com.vortexsoftware.sdk.types.InvitationGroup

toString() - Method in class com.vortexsoftware.sdk.types.InvitationResponse

toString() - Method in class com.vortexsoftware.sdk.types.InvitationResult

toString() - Method in class com.vortexsoftware.sdk.types.InvitationTarget

toString() - Method in class com.vortexsoftware.sdk.types.JWTPayload

toString() - Method in class com.vortexsoftware.sdk.types.User

U

User - Class in com.vortexsoftware.sdk.types

User data for JWT generation Required fields: - id: User's unique identifier in your system - email: User's email address Optional fields: - adminScopes: List of admin scopes (e.g., ["autoJoin"]) Example:

User() - Constructor for class com.vortexsoftware.sdk.types.User

Default constructor for Jackson deserialization

User(String, String) - Constructor for class com.vortexsoftware.sdk.types.User

Create a new User with required fields

User(String, String, List<String>) - Constructor for class com.vortexsoftware.sdk.types.User

Create a new User with all fields

V

VortexAutoConfiguration - Class in com.vortexsoftware.sdk.spring

Auto-configuration for Vortex Spring Boot integration This automatically sets up VortexClient and related beans when the vortex.api.key property is provided.

VortexAutoConfiguration() - Constructor for class com.vortexsoftware.sdk.spring.VortexAutoConfiguration

vortexClient(String, String) - Method in class com.vortexsoftware.sdk.spring.VortexAutoConfiguration

VortexClient - Class in com.vortexsoftware.sdk

Main Vortex SDK client for Java applications Provides JWT generation and Vortex API integration with the same functionality as the Node.js SDK, ensuring compatibility with React providers.

VortexClient(String) - Constructor for class com.vortexsoftware.sdk.VortexClient

Create a new Vortex client with the given API key

VortexClient(String, String) - Constructor for class com.vortexsoftware.sdk.VortexClient

Create a new Vortex client with custom base URL

vortexConfig() - Method in class com.vortexsoftware.sdk.spring.VortexAutoConfiguration

VortexConfig - Interface in com.vortexsoftware.sdk.spring

Configuration interface for Vortex Spring integration This interface allows applications to define how users are authenticated and authorized for Vortex operations, matching the pattern from Express SDK.

VortexConfig.VortexUser - Class in com.vortexsoftware.sdk.spring

Represents a user in the Vortex system Supports both new simplified format (userEmail + userIsAutoJoinAdmin) and legacy format (identifiers + groups + role) for backward compatibility.

vortexController(VortexClient, VortexConfig) - Method in class com.vortexsoftware.sdk.spring.VortexAutoConfiguration

VortexController - Class in com.vortexsoftware.sdk.spring

Spring Boot controller providing Vortex API endpoints This controller provides the same route structure as the Express SDK, ensuring compatibility with React providers and other frontend frameworks.

VortexController(VortexClient, VortexConfig) - Constructor for class com.vortexsoftware.sdk.spring.VortexController

VortexException - Exception Class in com.vortexsoftware.sdk

Exception thrown by Vortex SDK operations

VortexException(String) - Constructor for exception class com.vortexsoftware.sdk.VortexException

VortexException(String, Throwable) - Constructor for exception class com.vortexsoftware.sdk.VortexException

VortexException(Throwable) - Constructor for exception class com.vortexsoftware.sdk.VortexException

VortexRoutes - Class in com.vortexsoftware.sdk.spring

Constants defining the Vortex API route structure These routes match exactly with the Express SDK and React provider to ensure complete compatibility across different backend implementations.

VortexUser() - Constructor for class com.vortexsoftware.sdk.spring.VortexConfig.VortexUser

VortexUser(String, String, Boolean) - Constructor for class com.vortexsoftware.sdk.spring.VortexConfig.VortexUser

Create a VortexUser with new simplified format (recommended)

VortexUser(String, List<Identifier>, List<Group>, String) - Constructor for class com.vortexsoftware.sdk.spring.VortexConfig.VortexUser

Deprecated.

Use constructor with userEmail instead

A C D G I J R S T U V
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form