Package io.objectbox.sync

Class Credentials

  • public final class Credentials
extends io.objectbox.flatbuffers.Table
    Credentials consist of a type and the credentials data to perform authentication checks. The data is either provided as plain-bytes, or as a list of strings. Credentials can be used from the client and server side. This depends on the type however: for example, shared secrets are configured at both sides, but username/password is only provided at the client.

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  Credentials.Vector  

    • Field Summary

      • Fields inherited from class io.objectbox.flatbuffers.Table

        bb, bb_pos

    • Constructor Summary

      Constructors 
      Constructor Description
      Credentials()  

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      Credentials __assign​(int _i, java.nio.ByteBuffer _bb)  
      void __init​(int _i, java.nio.ByteBuffer _bb)  
      static void addBytes​(io.objectbox.flatbuffers.FlatBufferBuilder builder, int bytesOffset)  
      static void addStrings​(io.objectbox.flatbuffers.FlatBufferBuilder builder, int stringsOffset)  
      static void addType​(io.objectbox.flatbuffers.FlatBufferBuilder builder, long type)  
      int bytes​(int j)
      Credentials provided by plain bytes.
      java.nio.ByteBuffer bytesAsByteBuffer()  
      java.nio.ByteBuffer bytesInByteBuffer​(java.nio.ByteBuffer _bb)  
      int bytesLength()  
      io.objectbox.flatbuffers.ByteVector bytesVector()  
      io.objectbox.flatbuffers.ByteVector bytesVector​(io.objectbox.flatbuffers.ByteVector obj)  
      static int createBytesVector​(io.objectbox.flatbuffers.FlatBufferBuilder builder, byte[] data)  
      static int createBytesVector​(io.objectbox.flatbuffers.FlatBufferBuilder builder, java.nio.ByteBuffer data)  
      static int createCredentials​(io.objectbox.flatbuffers.FlatBufferBuilder builder, long type, int bytesOffset, int stringsOffset)  
      static int createStringsVector​(io.objectbox.flatbuffers.FlatBufferBuilder builder, int[] data)  
      static int endCredentials​(io.objectbox.flatbuffers.FlatBufferBuilder builder)  
      static Credentials getRootAsCredentials​(java.nio.ByteBuffer _bb)  
      static Credentials getRootAsCredentials​(java.nio.ByteBuffer _bb, Credentials obj)  
      static void startBytesVector​(io.objectbox.flatbuffers.FlatBufferBuilder builder, int numElems)  
      static void startCredentials​(io.objectbox.flatbuffers.FlatBufferBuilder builder)  
      static void startStringsVector​(io.objectbox.flatbuffers.FlatBufferBuilder builder, int numElems)  
      java.lang.String strings​(int j)
      Credentials provided by a string array.
      int stringsLength()  
      io.objectbox.flatbuffers.StringVector stringsVector()  
      io.objectbox.flatbuffers.StringVector stringsVector​(io.objectbox.flatbuffers.StringVector obj)  
      long type()  
      static void ValidateVersion()  

      • Methods inherited from class io.objectbox.flatbuffers.Table

        __has_identifier, __indirect, __indirect, __offset, __offset, __reset, __reset, __string, __string, __union, __union, __vector, __vector_as_bytebuffer, __vector_in_bytebuffer, __vector_len, compareStrings, compareStrings, getByteBuffer, keysCompare, sortTables

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

      • Credentials

        public Credentials()

    • Method Detail

      • ValidateVersion

        public static void ValidateVersion()

      • getRootAsCredentials

        public static Credentials getRootAsCredentials​(java.nio.ByteBuffer _bb)

      • getRootAsCredentials

        public static Credentials getRootAsCredentials​(java.nio.ByteBuffer _bb,
                                               Credentials obj)

      • __init

        public void __init​(int _i,
                   java.nio.ByteBuffer _bb)

      • __assign

        public Credentials __assign​(int _i,
                            java.nio.ByteBuffer _bb)

      • type

        public long type()

      • bytes

        public int bytes​(int j)
        Credentials provided by plain bytes. This is used for shared secrets (client & server).

      • bytesLength

        public int bytesLength()

      • bytesVector

        public io.objectbox.flatbuffers.ByteVector bytesVector()

      • bytesVector

        public io.objectbox.flatbuffers.ByteVector bytesVector​(io.objectbox.flatbuffers.ByteVector obj)

      • bytesAsByteBuffer

        public java.nio.ByteBuffer bytesAsByteBuffer()

      • bytesInByteBuffer

        public java.nio.ByteBuffer bytesInByteBuffer​(java.nio.ByteBuffer _bb)

      • strings

        public java.lang.String strings​(int j)
        Credentials provided by a string array. For username/password (client-only), provide the username in strings[0] and the password in strings[1]. For GoogleAuth, you can provide a list of accepted IDs (server-only).

      • stringsLength

        public int stringsLength()

      • stringsVector

        public io.objectbox.flatbuffers.StringVector stringsVector()

      • stringsVector

        public io.objectbox.flatbuffers.StringVector stringsVector​(io.objectbox.flatbuffers.StringVector obj)

      • createCredentials

        public static int createCredentials​(io.objectbox.flatbuffers.FlatBufferBuilder builder,
                                    long type,
                                    int bytesOffset,
                                    int stringsOffset)

      • startCredentials

        public static void startCredentials​(io.objectbox.flatbuffers.FlatBufferBuilder builder)

      • addType

        public static void addType​(io.objectbox.flatbuffers.FlatBufferBuilder builder,
                           long type)

      • addBytes

        public static void addBytes​(io.objectbox.flatbuffers.FlatBufferBuilder builder,
                            int bytesOffset)

      • createBytesVector

        public static int createBytesVector​(io.objectbox.flatbuffers.FlatBufferBuilder builder,
                                    byte[] data)

      • createBytesVector

        public static int createBytesVector​(io.objectbox.flatbuffers.FlatBufferBuilder builder,
                                    java.nio.ByteBuffer data)

      • startBytesVector

        public static void startBytesVector​(io.objectbox.flatbuffers.FlatBufferBuilder builder,
                                    int numElems)

      • addStrings

        public static void addStrings​(io.objectbox.flatbuffers.FlatBufferBuilder builder,
                              int stringsOffset)

      • createStringsVector

        public static int createStringsVector​(io.objectbox.flatbuffers.FlatBufferBuilder builder,
                                      int[] data)

      • startStringsVector

        public static void startStringsVector​(io.objectbox.flatbuffers.FlatBufferBuilder builder,
                                      int numElems)

      • endCredentials

        public static int endCredentials​(io.objectbox.flatbuffers.FlatBufferBuilder builder)