ConnectionRequest

All Known Subinterfaces:: RemoteClient

public interface ConnectionRequest

Encapsulates information about a client required by a server for establishing a connection

Nested Class Summary

Nested Classes

Modifier and Type

Interface

Description

static interface

ConnectionRequest.Builder

A builder for ConnectionRequest
Method Summary

Modifier and Type

Method

Description

static ConnectionRequest.Builder

builder()

UUID

clientId()

Locale

clientLocale()

ZoneId

clientTimeZone()

String

clientTypeId()

Optional<Version>

clientVersion()

ConnectionRequest

copy()

Version

frameworkVersion()

Map<String,Object>

parameters()

User

user()

Method Details
- user
  
  User user()
  
  Returns:
  
  the user
- clientId
  
  UUID clientId()
  
  Returns:
  
  the client id
- clientTypeId
  
  String clientTypeId()
  
  Returns:
  
  the client type id
- clientLocale
  
  Locale clientLocale()
  
  Returns:
  
  the client locale
- clientTimeZone
  
  ZoneId clientTimeZone()
  
  Returns:
  
  the client time zone
- clientVersion
  
  Optional<Version> clientVersion()
  
  Returns:
  
  the client version
- frameworkVersion
  
  Version frameworkVersion()
  
  Returns:
  
  the version of Codion the client is using
- parameters
  
  Map<String,Object> parameters()
  
  Returns:
  
  misc. parameters, an empty map if none are specified
- copy
  
  ConnectionRequest copy()
  
  Returns:
  
  a copy of this connection request with a copy of the user instance
- builder
  
  static ConnectionRequest.Builder builder()
  
  Returns:
  
  a ConnectionRequest.Builder