MessageEndpointListenerConfiguration (Couchbase, Inc. Enterprise Edition License Agreement 3.1.6-2)

java.lang.Object

com.couchbase.lite.MessageEndpointListenerConfiguration

public class MessageEndpointListenerConfiguration extends Object

ENTERPRISE EDITION API

Configuration for MessageEndpointListener

Constructor Summary

Constructors

Constructor

Description

MessageEndpointListenerConfiguration(Database database, ProtocolType protocolType)

Deprecated.
Use MessageEndpointListener(Collection, ProtocolType)

MessageEndpointListenerConfiguration(Set<Collection> collections, ProtocolType protocolType)

Create a MessageEndpointListenerConfiguration with the passed protocol type, for the passed Collections The passed set must contain at least one collection and all of the collections it contains must belong to the same scope and the same database, otherwise an InvalidArgumentException will be thrown.
Method Summary

Modifier and Type

Method

Description

Set<Collection>

getCollections()

Database

getDatabase()

Deprecated.
Use getCollections()

ProtocolType

getProtocolType()

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details
- MessageEndpointListenerConfiguration
  
  @Deprecated public MessageEndpointListenerConfiguration(@NonNull Database database, @NonNull ProtocolType protocolType)
  
  Deprecated.
  Use MessageEndpointListener(Collection, ProtocolType)
  
  The database to which the listener is attached
  
  Parameters:
  
  database - to which the listener is attached
  
  protocolType - protocol type
- MessageEndpointListenerConfiguration
  
  public MessageEndpointListenerConfiguration(@NonNull Set<Collection> collections, @NonNull ProtocolType protocolType)
  
  Create a MessageEndpointListenerConfiguration with the passed protocol type, for the passed Collections The passed set must contain at least one collection and all of the collections it contains must belong to the same scope and the same database, otherwise an InvalidArgumentException will be thrown. If one of the specified collections is deleted during replication, connected clients will be closed with an error.
  
  Parameters:
  
  collections - the collections to which the listener is attached
  
  protocolType - protocol type
Method Details
- getDatabase
  
  @Deprecated @NonNull public Database getDatabase()
  
  Deprecated.
  Use getCollections()
  
  Returns:
  
  the endpoint database
- getCollections
  
  @NonNull public Set<Collection> getCollections()
- getProtocolType
  
  @NonNull public ProtocolType getProtocolType()