Package org.apache.cayenne.configuration.rop.client

# Class ClientRuntime

java.lang.Object
org.apache.cayenne.configuration.CayenneRuntime
org.apache.cayenne.configuration.rop.client.ClientRuntime

public class ClientRuntime extends CayenneRuntime
A user application entry point to Cayenne stack on the ROP client.

Since:
  3.1, 4.0 preferred way to create this class is with `builder()` method.

- ## Field Summary

  Fields
  Modifier and Type
  Field
  Description
  `static final String`
  `CLIENT_SERVER_CHANNEL_KEY`

  ### Fields inherited from class org.apache.cayenne.configuration.CayenneRuntime

  `injector, modules, threadInjector`

- ## Constructor Summary

  Constructors
  Modifier
  Constructor
  Description
  `protected`
  `ClientRuntime(Collection<Module> modules)`

- ## Method Summary

  Modifier and Type
  Method
  Description
  `static ClientRuntimeBuilder`
  `builder()`
  Creates new builder of client runtime
  `ClientConnection`
  `getConnection()`

  ### Methods inherited from class org.apache.cayenne.configuration.CayenneRuntime

  `bindThreadInjector, getChannel, getInjector, getModules, getThreadInjector, newContext, newContext, shutdown`

  ### Methods inherited from class java.lang.Object

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

- ## Field Details

  - ### CLIENT_SERVER_CHANNEL_KEY

    public static final String CLIENT_SERVER_CHANNEL_KEY
    Since:
      4.0 moved from deprecated ClientLocalRuntime class
    See Also:
      - Constant Field Values

- ## Constructor Details

  - ### ClientRuntime

    protected ClientRuntime(Collection<Module> modules)
    Since:
      4.0

- ## Method Details

  - ### builder

    public static ClientRuntimeBuilder builder()
    Creates new builder of client runtime
    Returns:
      client runtime builder
    Since:
      4.0

  - ### getConnection

    public ClientConnection getConnection()