| Package | Description | 
|---|---|
| org.apache.cayenne | Contains persistence APIs directly accessible by users. | 
| org.apache.cayenne.access | Contains classes that make up Cayenne ORM stack. | 
| org.apache.cayenne.configuration | |
| org.apache.cayenne.configuration.rop.client | |
| org.apache.cayenne.configuration.server | |
| org.apache.cayenne.remote | Contains classes an interfaces related to Cayenne remote object persistence features. | 
| org.apache.cayenne.remote.service | |
| org.apache.cayenne.tx | |
| org.apache.cayenne.util | General utility classes. | 
| Modifier and Type | Interface and Description | 
|---|---|
| interface  | ObjectContextA Cayenne object facade to a persistent store. | 
| Modifier and Type | Class and Description | 
|---|---|
| class  | BaseContextA common base superclass for Cayenne ObjectContext implementors. | 
| class  | CayenneContextA default generic implementation of ObjectContext suitable for accessing
 Cayenne from either an ORM or a client tiers. | 
| Modifier and Type | Field and Description | 
|---|---|
| protected DataChannel | BaseContext. channel | 
| Modifier and Type | Method and Description | 
|---|---|
| DataChannel | BaseContext. getChannel() | 
| DataChannel | ObjectContext. getChannel()Returns an DataChannel used by this context. | 
| Modifier and Type | Method and Description | 
|---|---|
| protected void | BaseContext. attachToChannel(DataChannel channel)Attaches to a provided DataChannel. | 
| protected void | CayenneContext. attachToChannel(DataChannel channel) | 
| void | DataChannelFilter. init(DataChannel channel) | 
| void | BaseContext. setChannel(DataChannel channel)Sets a new DataChannel for this context. | 
| Constructor and Description | 
|---|
| CayenneContext(DataChannel channel)Creates a new CayenneContext, initializing it with a channel instance. | 
| CayenneContext(DataChannel channel,
              boolean changeEventsEnabled,
              boolean lifecyleEventsEnabled)Creates a new CayenneContext, initializing it with a channel. | 
| Modifier and Type | Class and Description | 
|---|---|
| class  | ClientServerChannelA DataChannel that provides a server-side end of the bridge between client and server
 objects in a Remote Object Persistence stack. | 
| class  | DataContextThe most common implementation of  ObjectContext. | 
| class  | DataDomainDataDomain performs query routing functions in Cayenne. | 
| Modifier and Type | Method and Description | 
|---|---|
| DataChannel | ClientServerChannel. getParentChannel() | 
| Modifier and Type | Method and Description | 
|---|---|
| protected void | DataContext. attachToChannel(DataChannel channel) | 
| Constructor and Description | 
|---|
| DataContext(DataChannel channel,
           ObjectStore objectStore)Creates a new DataContext with parent DataChannel and ObjectStore. | 
| Modifier and Type | Method and Description | 
|---|---|
| DataChannel | CayenneRuntime. getChannel()Returns the runtime  DataChannel. | 
| Modifier and Type | Method and Description | 
|---|---|
| ObjectContext | ObjectContextFactory. createContext(DataChannel parent)Creates an ObjectContext attached to a provided channel. | 
| ObjectContext | CayenneRuntime. getContext(DataChannel parentChannel)Deprecated. 
 since 3.1 use better named  CayenneRuntime.newContext(DataChannel)instead. | 
| ObjectContext | CayenneRuntime. newContext(DataChannel parentChannel)Returns a new ObjectContext which is a child of the specified
 DataChannel. | 
| Modifier and Type | Field and Description | 
|---|---|
| protected DataChannel | CayenneContextFactory. dataChannel | 
| Modifier and Type | Field and Description | 
|---|---|
| protected Provider<DataChannel> | LocalConnectionProvider. clientServerChannelProvider | 
| Modifier and Type | Method and Description | 
|---|---|
| DataChannel | ClientChannelProvider. get() | 
| DataChannel | LocalClientServerChannelProvider. get() | 
| Modifier and Type | Method and Description | 
|---|---|
| ObjectContext | CayenneContextFactory. createContext(DataChannel parent) | 
| protected CayenneContext | CayenneContextFactory. newInstance(DataChannel parent,
           boolean changeEventsEnabled,
           boolean lifecycleEventsEnabled) | 
| Modifier and Type | Method and Description | 
|---|---|
| DataChannel | DomainDataChannelProvider. get() | 
| Modifier and Type | Method and Description | 
|---|---|
| ObjectContext | DataContextFactory. createContext(DataChannel parent) | 
| protected ObjectContext | DataContextFactory. createFromGenericChannel(DataChannel parent) | 
| protected DataContext | DataContextFactory. newInstance(DataChannel parent,
           ObjectStore objectStore) | 
| Modifier and Type | Class and Description | 
|---|---|
| class  | ClientChannelA  DataChannelimplementation that accesses a remote server
 via a ClientConnection. | 
| Modifier and Type | Field and Description | 
|---|---|
| protected DataChannel | LocalConnection. channel | 
| protected DataChannel | ServerSession. channel | 
| Modifier and Type | Method and Description | 
|---|---|
| protected DataChannel | BaseRemoteService. createChannel()Creates a server-side channel that will handle all client requests. | 
| DataChannel | LocalConnection. getChannel()Returns wrapped DataChannel. | 
| DataChannel | ServerSession. getChannel() | 
| protected DataChannel | HttpRemoteService. getSharedChannel(String name) | 
| Modifier and Type | Method and Description | 
|---|---|
| protected void | HttpRemoteService. saveSharedChannel(String name,
                 DataChannel channel) | 
| Constructor and Description | 
|---|
| LocalConnection(DataChannel handler)Creates LocalConnector with specified handler and no serialization. | 
| LocalConnection(DataChannel handler,
               int serializationPolicy)Creates a LocalConnector with specified handler and serialization policy. | 
| ServerSession(RemoteSession session,
             DataChannel channel) | 
| Modifier and Type | Method and Description | 
|---|---|
| void | TransactionFilter. init(DataChannel channel) | 
| Modifier and Type | Method and Description | 
|---|---|
| static boolean | EventUtil. listenForChannelEvents(DataChannel channel,
                      DataChannelListener listener)Utility method that sets up a GraphChangeListener to be notified when DataChannel
 posts an event. | 
Copyright © 2001–2023 Apache Cayenne. All rights reserved.