From 08f13764e827a8879f9886334ae8222ffc44850f Mon Sep 17 00:00:00 2001 From: agapple Date: Tue, 29 Oct 2013 14:30:46 +0800 Subject: [PATCH] Publishing javadoc for canal.client:1.0.13 --- apidocs/1.0.13/allclasses-frame.html | 28 + apidocs/1.0.13/allclasses-noframe.html | 28 + .../otter/canal/client/CanalConnector.html | 518 ++++++++++++ .../otter/canal/client/CanalConnectors.html | 322 +++++++ .../canal/client/CanalNodeAccessStrategy.html | 217 +++++ .../client/class-use/CanalConnector.html | 210 +++++ .../client/class-use/CanalConnectors.html | 117 +++ .../class-use/CanalNodeAccessStrategy.html | 205 +++++ .../client/impl/ClusterCanalConnector.html | 786 ++++++++++++++++++ .../impl/ClusterNodeAccessStrategy.html | 300 +++++++ .../client/impl/SimpleCanalConnector.html | 741 +++++++++++++++++ .../client/impl/SimpleNodeAccessStrategy.html | 272 ++++++ .../impl/class-use/ClusterCanalConnector.html | 117 +++ .../class-use/ClusterNodeAccessStrategy.html | 117 +++ .../impl/class-use/SimpleCanalConnector.html | 157 ++++ .../class-use/SimpleNodeAccessStrategy.html | 117 +++ .../canal/client/impl/package-frame.html | 23 + .../canal/client/impl/package-summary.html | 155 ++++ .../otter/canal/client/impl/package-tree.html | 133 +++ .../otter/canal/client/impl/package-use.html | 152 ++++ .../impl/running/ClientRunningData.html | 328 ++++++++ .../impl/running/ClientRunningListener.html | 232 ++++++ .../impl/running/ClientRunningMonitor.html | 430 ++++++++++ .../running/class-use/ClientRunningData.html | 157 ++++ .../class-use/ClientRunningListener.html | 157 ++++ .../class-use/ClientRunningMonitor.html | 117 +++ .../client/impl/running/package-frame.html | 25 + .../client/impl/running/package-summary.html | 160 ++++ .../client/impl/running/package-tree.html | 139 ++++ .../client/impl/running/package-use.html | 157 ++++ .../otter/canal/client/package-frame.html | 25 + .../otter/canal/client/package-summary.html | 160 ++++ .../otter/canal/client/package-tree.html | 135 +++ .../otter/canal/client/package-use.html | 178 ++++ apidocs/1.0.13/constant-values.html | 117 +++ apidocs/1.0.13/deprecated-list.html | 117 +++ apidocs/1.0.13/index-all.html | 469 +++++++++++ apidocs/1.0.13/index.html | 68 ++ apidocs/1.0.13/overview-frame.html | 24 + apidocs/1.0.13/overview-summary.html | 139 ++++ apidocs/1.0.13/overview-tree.html | 148 ++++ apidocs/1.0.13/package-list | 3 + apidocs/1.0.13/resources/background.gif | Bin 0 -> 2313 bytes apidocs/1.0.13/resources/tab.gif | Bin 0 -> 291 bytes apidocs/1.0.13/resources/titlebar.gif | Bin 0 -> 10701 bytes apidocs/1.0.13/resources/titlebar_end.gif | Bin 0 -> 849 bytes apidocs/1.0.13/stylesheet.css | 474 +++++++++++ 47 files changed, 8674 insertions(+) create mode 100644 apidocs/1.0.13/allclasses-frame.html create mode 100644 apidocs/1.0.13/allclasses-noframe.html create mode 100644 apidocs/1.0.13/com/alibaba/otter/canal/client/CanalConnector.html create mode 100644 apidocs/1.0.13/com/alibaba/otter/canal/client/CanalConnectors.html create mode 100644 apidocs/1.0.13/com/alibaba/otter/canal/client/CanalNodeAccessStrategy.html create mode 100644 apidocs/1.0.13/com/alibaba/otter/canal/client/class-use/CanalConnector.html create mode 100644 apidocs/1.0.13/com/alibaba/otter/canal/client/class-use/CanalConnectors.html create mode 100644 apidocs/1.0.13/com/alibaba/otter/canal/client/class-use/CanalNodeAccessStrategy.html create mode 100644 apidocs/1.0.13/com/alibaba/otter/canal/client/impl/ClusterCanalConnector.html create mode 100644 apidocs/1.0.13/com/alibaba/otter/canal/client/impl/ClusterNodeAccessStrategy.html create mode 100644 apidocs/1.0.13/com/alibaba/otter/canal/client/impl/SimpleCanalConnector.html create mode 100644 apidocs/1.0.13/com/alibaba/otter/canal/client/impl/SimpleNodeAccessStrategy.html create mode 100644 apidocs/1.0.13/com/alibaba/otter/canal/client/impl/class-use/ClusterCanalConnector.html create mode 100644 apidocs/1.0.13/com/alibaba/otter/canal/client/impl/class-use/ClusterNodeAccessStrategy.html create mode 100644 apidocs/1.0.13/com/alibaba/otter/canal/client/impl/class-use/SimpleCanalConnector.html create mode 100644 apidocs/1.0.13/com/alibaba/otter/canal/client/impl/class-use/SimpleNodeAccessStrategy.html create mode 100644 apidocs/1.0.13/com/alibaba/otter/canal/client/impl/package-frame.html create mode 100644 apidocs/1.0.13/com/alibaba/otter/canal/client/impl/package-summary.html create mode 100644 apidocs/1.0.13/com/alibaba/otter/canal/client/impl/package-tree.html create mode 100644 apidocs/1.0.13/com/alibaba/otter/canal/client/impl/package-use.html create mode 100644 apidocs/1.0.13/com/alibaba/otter/canal/client/impl/running/ClientRunningData.html create mode 100644 apidocs/1.0.13/com/alibaba/otter/canal/client/impl/running/ClientRunningListener.html create mode 100644 apidocs/1.0.13/com/alibaba/otter/canal/client/impl/running/ClientRunningMonitor.html create mode 100644 apidocs/1.0.13/com/alibaba/otter/canal/client/impl/running/class-use/ClientRunningData.html create mode 100644 apidocs/1.0.13/com/alibaba/otter/canal/client/impl/running/class-use/ClientRunningListener.html create mode 100644 apidocs/1.0.13/com/alibaba/otter/canal/client/impl/running/class-use/ClientRunningMonitor.html create mode 100644 apidocs/1.0.13/com/alibaba/otter/canal/client/impl/running/package-frame.html create mode 100644 apidocs/1.0.13/com/alibaba/otter/canal/client/impl/running/package-summary.html create mode 100644 apidocs/1.0.13/com/alibaba/otter/canal/client/impl/running/package-tree.html create mode 100644 apidocs/1.0.13/com/alibaba/otter/canal/client/impl/running/package-use.html create mode 100644 apidocs/1.0.13/com/alibaba/otter/canal/client/package-frame.html create mode 100644 apidocs/1.0.13/com/alibaba/otter/canal/client/package-summary.html create mode 100644 apidocs/1.0.13/com/alibaba/otter/canal/client/package-tree.html create mode 100644 apidocs/1.0.13/com/alibaba/otter/canal/client/package-use.html create mode 100644 apidocs/1.0.13/constant-values.html create mode 100644 apidocs/1.0.13/deprecated-list.html create mode 100644 apidocs/1.0.13/index-all.html create mode 100644 apidocs/1.0.13/index.html create mode 100644 apidocs/1.0.13/overview-frame.html create mode 100644 apidocs/1.0.13/overview-summary.html create mode 100644 apidocs/1.0.13/overview-tree.html create mode 100644 apidocs/1.0.13/package-list create mode 100644 apidocs/1.0.13/resources/background.gif create mode 100644 apidocs/1.0.13/resources/tab.gif create mode 100644 apidocs/1.0.13/resources/titlebar.gif create mode 100644 apidocs/1.0.13/resources/titlebar_end.gif create mode 100644 apidocs/1.0.13/stylesheet.css diff --git a/apidocs/1.0.13/allclasses-frame.html b/apidocs/1.0.13/allclasses-frame.html new file mode 100644 index 00000000..bfb89d55 --- /dev/null +++ b/apidocs/1.0.13/allclasses-frame.html @@ -0,0 +1,28 @@ + + + + + + +所有类 (canal client module for otter 1.0.13 1.0.13 API) + + + + +

所有类

+
+ +
+ + \ No newline at end of file diff --git a/apidocs/1.0.13/allclasses-noframe.html b/apidocs/1.0.13/allclasses-noframe.html new file mode 100644 index 00000000..9206926b --- /dev/null +++ b/apidocs/1.0.13/allclasses-noframe.html @@ -0,0 +1,28 @@ + + + + + + +所有类 (canal client module for otter 1.0.13 1.0.13 API) + + + + +

所有类

+
+ +
+ + \ No newline at end of file diff --git a/apidocs/1.0.13/com/alibaba/otter/canal/client/CanalConnector.html b/apidocs/1.0.13/com/alibaba/otter/canal/client/CanalConnector.html new file mode 100644 index 00000000..f77fbcad --- /dev/null +++ b/apidocs/1.0.13/com/alibaba/otter/canal/client/CanalConnector.html @@ -0,0 +1,518 @@ + + + + + + +CanalConnector (canal client module for otter 1.0.13 1.0.13 API) + + + + + + + +
+ + + + + +
canal.client-1.0.13
+
+
+ + + +
+ +
+
+
    +
  • 概要: 
    • +
  • 嵌套 | 
    • +
  • 字段 | 
    • +
  • 构造器 | 
    • +
  • 方法
    • +
+
    +
  • 详细资料: 
    • +
  • 字段 | 
    • +
  • 构造器 | 
    • +
  • 方法
    • +
+
+ + +
+ + +
+
com.alibaba.otter.canal.client
+

接口 CanalConnector

+
+
+
+
    +
  • +
    +
    所有已知实现类:
    +
    ClusterCanalConnector, SimpleCanalConnector
    +
    +
    +
    +
    public interface CanalConnector
    +
    canal数据操作客户端
    +
    版本:
    +
    1.0.0
    +
    作者:
    +
    zebin.xuzb @ 2012-6-19, jianghang
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      方法概要

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      方法 
      限定符和类型方法和说明
      voidack(long batchId) +
      进行 batch id 的确认。
      +
      booleancheckValid() +
      检查下链接是否合法 + + + 几种case下链接不合法: + 1.
      +
      voidconnect() +
      链接对应的canal server
      +
      voiddisconnect() +
      释放链接
      +
      com.alibaba.otter.canal.protocol.Messageget(int batchSize) +
      获取数据，自动进行确认，该方法返回的条件：尝试拿batchSize条记录，有多少取多少，不会阻塞等待
      +
      com.alibaba.otter.canal.protocol.Messageget(int batchSize, + Long timeout, + TimeUnit unit) +
      获取数据，自动进行确认 + + + 该方法返回的条件： + a.
      +
      com.alibaba.otter.canal.protocol.MessagegetWithoutAck(int batchSize) +
      不指定 position 获取事件，该方法返回的条件: 尝试拿batchSize条记录，有多少取多少，不会阻塞等待
      + canal 会记住此 client 最新的position。
      +
      com.alibaba.otter.canal.protocol.MessagegetWithoutAck(int batchSize, + Long timeout, + TimeUnit unit) +
      不指定 position 获取事件.
      +
      voidrollback() +
      回滚到未进行 ack 的地方，下次fetch的时候，可以从最后一个没有 ack 的地方开始拿
      +
      voidrollback(long batchId) +
      回滚到未进行 ack 的地方，指定回滚具体的batchId
      +
      voidsubscribe() +
      客户端订阅，不提交客户端filter，以服务端的filter为准
      +
      voidsubscribe(String filter) +
      客户端订阅，重复订阅时会更新对应的filter信息 + + + 说明： + a.
      +
      voidunsubscribe() +
      取消订阅
      +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      方法详细资料

      + + + +
        +
      • +

        connect

        +
        void connect()
+             throws com.alibaba.otter.canal.protocol.exception.CanalClientException
        +
        链接对应的canal server
        +
        抛出:
        +
        com.alibaba.otter.canal.protocol.exception.CanalClientException
        +
        • +
      + + + +
        +
      • +

        disconnect

        +
        void disconnect()
+                throws com.alibaba.otter.canal.protocol.exception.CanalClientException
        +
        释放链接
        +
        抛出:
        +
        com.alibaba.otter.canal.protocol.exception.CanalClientException
        +
        • +
      + + + +
        +
      • +

        checkValid

        +
        boolean checkValid()
+                   throws com.alibaba.otter.canal.protocol.exception.CanalClientException
        +
        检查下链接是否合法 + + 
        + 几种case下链接不合法:
+ 1. 链接canal server失败，一直没有一个可用的链接，返回false
+ 2. 当前客户端在进行running抢占的时候，做为备份节点存在，非处于工作节点，返回false
+ 
+ 说明：
+ a. 当前客户端一旦做为备份节点存在，当前所有的对CanalConnector的操作都会处于阻塞状态，直到转为工作节点
+ b. 所以业务方最好定时调用checkValid()方法用，比如调用CanalConnector所在线程的interrupt，直接退出CanalConnector，并根据自己的需要退出自己的资源
+
        +
        抛出:
        +
        com.alibaba.otter.canal.protocol.exception.CanalClientException
        +
        • +
      + + + +
        +
      • +

        subscribe

        +
        void subscribe(String filter)
+               throws com.alibaba.otter.canal.protocol.exception.CanalClientException
        +
        客户端订阅，重复订阅时会更新对应的filter信息 + + 
        + 说明：
+ a. 如果本次订阅中filter信息为空，则直接使用canal server服务端配置的filter信息
+ b. 如果本次订阅中filter信息不为空，目前会直接替换canal server服务端配置的filter信息，以本次提交的为准
+ 
+ TODO: 后续可以考虑，如果本次提交的filter不为空，在执行过滤时，是对canal server filter + 本次filter的交集处理，达到只取1份binlog数据，多个客户端消费不同的表
+
        +
        参数:
        clientIdentity -
        +
        抛出:
        +
        com.alibaba.otter.canal.protocol.exception.CanalClientException
        +
        • +
      + + + +
        +
      • +

        subscribe

        +
        void subscribe()
+               throws com.alibaba.otter.canal.protocol.exception.CanalClientException
        +
        客户端订阅，不提交客户端filter，以服务端的filter为准
        +
        参数:
        clientIdentity -
        +
        抛出:
        +
        com.alibaba.otter.canal.protocol.exception.CanalClientException
        +
        • +
      + + + +
        +
      • +

        unsubscribe

        +
        void unsubscribe()
+                 throws com.alibaba.otter.canal.protocol.exception.CanalClientException
        +
        取消订阅
        +
        参数:
        clientIdentity -
        +
        抛出:
        +
        com.alibaba.otter.canal.protocol.exception.CanalClientException
        +
        • +
      + + + +
        +
      • +

        get

        +
        com.alibaba.otter.canal.protocol.Message get(int batchSize)
+                                             throws com.alibaba.otter.canal.protocol.exception.CanalClientException
        +
        获取数据，自动进行确认，该方法返回的条件：尝试拿batchSize条记录，有多少取多少，不会阻塞等待
        +
        参数:
        batchSize -
        +
        返回:
        +
        抛出:
        +
        com.alibaba.otter.canal.protocol.exception.CanalClientException
        +
        • +
      + + + +
        +
      • +

        get

        +
        com.alibaba.otter.canal.protocol.Message get(int batchSize,
+                                           Long timeout,
+                                           TimeUnit unit)
+                                             throws com.alibaba.otter.canal.protocol.exception.CanalClientException
        +
        获取数据，自动进行确认 + + 
        + 该方法返回的条件：
+  a. 拿够batchSize条记录或者超过timeout时间
+  b. 如果timeout=0，则阻塞至拿到batchSize记录才返回
+
        +
        参数:
        batchSize -
        +
        返回:
        +
        抛出:
        +
        com.alibaba.otter.canal.protocol.exception.CanalClientException
        +
        • +
      + + + +
        +
      • +

        getWithoutAck

        +
        com.alibaba.otter.canal.protocol.Message getWithoutAck(int batchSize)
+                                                       throws com.alibaba.otter.canal.protocol.exception.CanalClientException
        +
        不指定 position 获取事件，该方法返回的条件: 尝试拿batchSize条记录，有多少取多少，不会阻塞等待
        + canal 会记住此 client 最新的position。
        + 如果是第一次 fetch，则会从 canal 中保存的最老一条数据开始输出。
        +
        参数:
        batchSize -
        +
        抛出:
        +
        com.alibaba.otter.canal.protocol.exception.CanalClientException
        +
        • +
      + + + +
        +
      • +

        getWithoutAck

        +
        com.alibaba.otter.canal.protocol.Message getWithoutAck(int batchSize,
+                                                     Long timeout,
+                                                     TimeUnit unit)
+                                                       throws com.alibaba.otter.canal.protocol.exception.CanalClientException
        +
        不指定 position 获取事件. + + 
        + 该方法返回的条件：
+  a. 拿够batchSize条记录或者超过timeout时间
+  b. 如果timeout=0，则阻塞至拿到batchSize记录才返回
+
        + + canal 会记住此 client 最新的position。
        + 如果是第一次 fetch，则会从 canal 中保存的最老一条数据开始输出。
        +
        参数:
        batchSize -
        timeout -
        unit -
        +
        返回:
        +
        抛出:
        +
        com.alibaba.otter.canal.protocol.exception.CanalClientException
        +
        • +
      + + + +
        +
      • +

        ack

        +
        void ack(long batchId)
+         throws com.alibaba.otter.canal.protocol.exception.CanalClientException
        +
        进行 batch id 的确认。确认之后，小于等于此 batchId 的 Message 都会被确认。
        +
        参数:
        batchId -
        +
        抛出:
        +
        com.alibaba.otter.canal.protocol.exception.CanalClientException
        +
        • +
      + + + +
        +
      • +

        rollback

        +
        void rollback(long batchId)
+              throws com.alibaba.otter.canal.protocol.exception.CanalClientException
        +
        回滚到未进行 ack 的地方，指定回滚具体的batchId
        +
        抛出:
        +
        com.alibaba.otter.canal.protocol.exception.CanalClientException
        +
        • +
      + + + +
        +
      • +

        rollback

        +
        void rollback()
+              throws com.alibaba.otter.canal.protocol.exception.CanalClientException
        +
        回滚到未进行 ack 的地方，下次fetch的时候，可以从最后一个没有 ack 的地方开始拿
        +
        抛出:
        +
        com.alibaba.otter.canal.protocol.exception.CanalClientException
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
canal.client-1.0.13
+
+
+ + + +
+ +
+
+
    +
  • 概要: 
    • +
  • 嵌套 | 
    • +
  • 字段 | 
    • +
  • 构造器 | 
    • +
  • 方法
    • +
+
    +
  • 详细资料: 
    • +
  • 字段 | 
    • +
  • 构造器 | 
    • +
  • 方法
    • +
+
+ + +
+ +

Copyright © 2013. All rights reserved.

+ + \ No newline at end of file diff --git a/apidocs/1.0.13/com/alibaba/otter/canal/client/CanalConnectors.html b/apidocs/1.0.13/com/alibaba/otter/canal/client/CanalConnectors.html new file mode 100644 index 00000000..1c09a515 --- /dev/null +++ b/apidocs/1.0.13/com/alibaba/otter/canal/client/CanalConnectors.html @@ -0,0 +1,322 @@ + + + + + + +CanalConnectors (canal client module for otter 1.0.13 1.0.13 API) + + + + + + + +
+ + + + + +
canal.client-1.0.13
+
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
com.alibaba.otter.canal.client
+

类 CanalConnectors

+
+
+ +
+
    +
  • +
    +
    +
    public class CanalConnectors
+extends Object
    +
    canal connectors创建工具类
    +
    版本:
    +
    1.0.0
    +
    作者:
    +
    jianghang 2012-10-29 下午11:18:50
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      构造器详细资料

      + + + +
        +
      • +

        CanalConnectors

        +
        public CanalConnectors()
        +
        • +
      +
      • +
    + +
      +
    • + + +

      方法详细资料

      + + + +
        +
      • +

        newSingleConnector

        +
        public static CanalConnector newSingleConnector(SocketAddress address,
+                                String destination,
+                                String username,
+                                String password)
        +
        创建单链接的客户端链接
        +
        参数:
        address -
        username -
        password -
        +
        返回:
        +
        • +
      + + + +
        +
      • +

        newClusterConnector

        +
        public static CanalConnector newClusterConnector(List<? extends SocketAddress> addresses,
+                                 String destination,
+                                 String username,
+                                 String password)
        +
        创建带cluster模式的客户端链接，自动完成failover切换
        +
        参数:
        addresses -
        username -
        password -
        +
        返回:
        +
        • +
      + + + +
        +
      • +

        newClusterConnector

        +
        public static CanalConnector newClusterConnector(String zkServers,
+                                 String destination,
+                                 String username,
+                                 String password)
        +
        创建带cluster模式的客户端链接，自动完成failover切换，服务器列表自动扫描
        +
        参数:
        username -
        password -
        +
        返回:
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
canal.client-1.0.13
+
+
+ + + +
+ +
+
+ + +
+ + +
+ +

Copyright © 2013. All rights reserved.

+ + \ No newline at end of file diff --git a/apidocs/1.0.13/com/alibaba/otter/canal/client/CanalNodeAccessStrategy.html b/apidocs/1.0.13/com/alibaba/otter/canal/client/CanalNodeAccessStrategy.html new file mode 100644 index 00000000..d1f40bd4 --- /dev/null +++ b/apidocs/1.0.13/com/alibaba/otter/canal/client/CanalNodeAccessStrategy.html @@ -0,0 +1,217 @@ + + + + + + +CanalNodeAccessStrategy (canal client module for otter 1.0.13 1.0.13 API) + + + + + + + +
+ + + + + +
canal.client-1.0.13
+
+
+ + + +
+ +
+
+
    +
  • 概要: 
    • +
  • 嵌套 | 
    • +
  • 字段 | 
    • +
  • 构造器 | 
    • +
  • 方法
    • +
+
    +
  • 详细资料: 
    • +
  • 字段 | 
    • +
  • 构造器 | 
    • +
  • 方法
    • +
+
+ + +
+ + +
+
com.alibaba.otter.canal.client
+

接口 CanalNodeAccessStrategy

+
+
+
+ +
+
+ +
+
+ +
+
+ + +
+ + + + + +
canal.client-1.0.13
+
+
+ + + +
+ +
+
+
    +
  • 概要: 
    • +
  • 嵌套 | 
    • +
  • 字段 | 
    • +
  • 构造器 | 
    • +
  • 方法
    • +
+
    +
  • 详细资料: 
    • +
  • 字段 | 
    • +
  • 构造器 | 
    • +
  • 方法
    • +
+
+ + +
+ +

Copyright © 2013. All rights reserved.

+ + \ No newline at end of file diff --git a/apidocs/1.0.13/com/alibaba/otter/canal/client/class-use/CanalConnector.html b/apidocs/1.0.13/com/alibaba/otter/canal/client/class-use/CanalConnector.html new file mode 100644 index 00000000..0762f475 --- /dev/null +++ b/apidocs/1.0.13/com/alibaba/otter/canal/client/class-use/CanalConnector.html @@ -0,0 +1,210 @@ + + + + + + +接口 com.alibaba.otter.canal.client.CanalConnector的使用 (canal client module for otter 1.0.13 1.0.13 API) + + + + + + + +
+ + + + + +
canal.client-1.0.13
+
+
+ + + +
+ +
+ + +
+ +
+

接口 com.alibaba.otter.canal.client.CanalConnector
的使用

+
+
+ +
+ +
+ + + + + +
canal.client-1.0.13
+
+
+ + + +
+ +
+ + +
+ +

Copyright © 2013. All rights reserved.

+ + \ No newline at end of file diff --git a/apidocs/1.0.13/com/alibaba/otter/canal/client/class-use/CanalConnectors.html b/apidocs/1.0.13/com/alibaba/otter/canal/client/class-use/CanalConnectors.html new file mode 100644 index 00000000..e0422322 --- /dev/null +++ b/apidocs/1.0.13/com/alibaba/otter/canal/client/class-use/CanalConnectors.html @@ -0,0 +1,117 @@ + + + + + + +类 com.alibaba.otter.canal.client.CanalConnectors的使用 (canal client module for otter 1.0.13 1.0.13 API) + + + + + + + +
+ + + + + +
canal.client-1.0.13
+
+
+ + + +
+ +
+ + +
+ +
+

类 com.alibaba.otter.canal.client.CanalConnectors
的使用

+
+
没有com.alibaba.otter.canal.client.CanalConnectors的用法
+ +
+ + + + + +
canal.client-1.0.13
+
+
+ + + +
+ +
+ + +
+ +

Copyright © 2013. All rights reserved.

+ + \ No newline at end of file diff --git a/apidocs/1.0.13/com/alibaba/otter/canal/client/class-use/CanalNodeAccessStrategy.html b/apidocs/1.0.13/com/alibaba/otter/canal/client/class-use/CanalNodeAccessStrategy.html new file mode 100644 index 00000000..de9eab95 --- /dev/null +++ b/apidocs/1.0.13/com/alibaba/otter/canal/client/class-use/CanalNodeAccessStrategy.html @@ -0,0 +1,205 @@ + + + + + + +接口 com.alibaba.otter.canal.client.CanalNodeAccessStrategy的使用 (canal client module for otter 1.0.13 1.0.13 API) + + + + + + + +
+ + + + + +
canal.client-1.0.13
+
+
+ + + +
+ +
+ + +
+ +
+

接口 com.alibaba.otter.canal.client.CanalNodeAccessStrategy
的使用

+
+
+ +
+ +
+ + + + + +
canal.client-1.0.13
+
+
+ + + +
+ +
+ + +
+ +

Copyright © 2013. All rights reserved.

+ + \ No newline at end of file diff --git a/apidocs/1.0.13/com/alibaba/otter/canal/client/impl/ClusterCanalConnector.html b/apidocs/1.0.13/com/alibaba/otter/canal/client/impl/ClusterCanalConnector.html new file mode 100644 index 00000000..f704974a --- /dev/null +++ b/apidocs/1.0.13/com/alibaba/otter/canal/client/impl/ClusterCanalConnector.html @@ -0,0 +1,786 @@ + + + + + + +ClusterCanalConnector (canal client module for otter 1.0.13 1.0.13 API) + + + + + + + +
+ + + + + +
canal.client-1.0.13
+
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
com.alibaba.otter.canal.client.impl
+

类 ClusterCanalConnector

+
+
+ +
+
    +
  • +
    +
    所有已实现的接口:
    +
    CanalConnector
    +
    +
    +
    +
    public class ClusterCanalConnector
+extends Object
+implements CanalConnector
    +
    集群版本connector实现，自带了failover功能
    +
    版本:
    +
    1.0.0
    +
    作者:
    +
    jianghang 2012-10-29 下午08:04:06
    +
    • +
+
+
+ +
+
+
    +
  • + + + +
      +
    • + + +

      方法详细资料

      + + + +
        +
      • +

        connect

        +
        public void connect()
+             throws com.alibaba.otter.canal.protocol.exception.CanalClientException
        +
        从接口复制的说明: CanalConnector
        +
        链接对应的canal server
        +
        +
        指定者:
        +
        connect 在接口中 CanalConnector
        +
        抛出:
        +
        com.alibaba.otter.canal.protocol.exception.CanalClientException
        +
        • +
      + + + +
        +
      • +

        checkValid

        +
        public boolean checkValid()
        +
        从接口复制的说明: CanalConnector
        +
        检查下链接是否合法 + + 
        + 几种case下链接不合法:
+ 1. 链接canal server失败，一直没有一个可用的链接，返回false
+ 2. 当前客户端在进行running抢占的时候，做为备份节点存在，非处于工作节点，返回false
+ 
+ 说明：
+ a. 当前客户端一旦做为备份节点存在，当前所有的对CanalConnector的操作都会处于阻塞状态，直到转为工作节点
+ b. 所以业务方最好定时调用checkValid()方法用，比如调用CanalConnector所在线程的interrupt，直接退出CanalConnector，并根据自己的需要退出自己的资源
+
        +
        +
        指定者:
        +
        checkValid 在接口中 CanalConnector
        +
        +
        • +
      + + + +
        +
      • +

        disconnect

        +
        public void disconnect()
+                throws com.alibaba.otter.canal.protocol.exception.CanalClientException
        +
        从接口复制的说明: CanalConnector
        +
        释放链接
        +
        +
        指定者:
        +
        disconnect 在接口中 CanalConnector
        +
        抛出:
        +
        com.alibaba.otter.canal.protocol.exception.CanalClientException
        +
        • +
      + + + +
        +
      • +

        subscribe

        +
        public void subscribe()
+               throws com.alibaba.otter.canal.protocol.exception.CanalClientException
        +
        从接口复制的说明: CanalConnector
        +
        客户端订阅，不提交客户端filter，以服务端的filter为准
        +
        +
        指定者:
        +
        subscribe 在接口中 CanalConnector
        +
        抛出:
        +
        com.alibaba.otter.canal.protocol.exception.CanalClientException
        +
        • +
      + + + +
        +
      • +

        subscribe

        +
        public void subscribe(String filter)
+               throws com.alibaba.otter.canal.protocol.exception.CanalClientException
        +
        从接口复制的说明: CanalConnector
        +
        客户端订阅，重复订阅时会更新对应的filter信息 + + 
        + 说明：
+ a. 如果本次订阅中filter信息为空，则直接使用canal server服务端配置的filter信息
+ b. 如果本次订阅中filter信息不为空，目前会直接替换canal server服务端配置的filter信息，以本次提交的为准
+ 
+ TODO: 后续可以考虑，如果本次提交的filter不为空，在执行过滤时，是对canal server filter + 本次filter的交集处理，达到只取1份binlog数据，多个客户端消费不同的表
+
        +
        +
        指定者:
        +
        subscribe 在接口中 CanalConnector
        +
        抛出:
        +
        com.alibaba.otter.canal.protocol.exception.CanalClientException
        +
        • +
      + + + +
        +
      • +

        unsubscribe

        +
        public void unsubscribe()
+                 throws com.alibaba.otter.canal.protocol.exception.CanalClientException
        +
        从接口复制的说明: CanalConnector
        +
        取消订阅
        +
        +
        指定者:
        +
        unsubscribe 在接口中 CanalConnector
        +
        抛出:
        +
        com.alibaba.otter.canal.protocol.exception.CanalClientException
        +
        • +
      + + + +
        +
      • +

        get

        +
        public com.alibaba.otter.canal.protocol.Message get(int batchSize)
+                                             throws com.alibaba.otter.canal.protocol.exception.CanalClientException
        +
        从接口复制的说明: CanalConnector
        +
        获取数据，自动进行确认，该方法返回的条件：尝试拿batchSize条记录，有多少取多少，不会阻塞等待
        +
        +
        指定者:
        +
        get 在接口中 CanalConnector
        +
        返回:
        +
        抛出:
        +
        com.alibaba.otter.canal.protocol.exception.CanalClientException
        +
        • +
      + + + +
        +
      • +

        get

        +
        public com.alibaba.otter.canal.protocol.Message get(int batchSize,
+                                           Long timeout,
+                                           TimeUnit unit)
+                                             throws com.alibaba.otter.canal.protocol.exception.CanalClientException
        +
        从接口复制的说明: CanalConnector
        +
        获取数据，自动进行确认 + + 
        + 该方法返回的条件：
+  a. 拿够batchSize条记录或者超过timeout时间
+  b. 如果timeout=0，则阻塞至拿到batchSize记录才返回
+
        +
        +
        指定者:
        +
        get 在接口中 CanalConnector
        +
        返回:
        +
        抛出:
        +
        com.alibaba.otter.canal.protocol.exception.CanalClientException
        +
        • +
      + + + +
        +
      • +

        getWithoutAck

        +
        public com.alibaba.otter.canal.protocol.Message getWithoutAck(int batchSize)
+                                                       throws com.alibaba.otter.canal.protocol.exception.CanalClientException
        +
        从接口复制的说明: CanalConnector
        +
        不指定 position 获取事件，该方法返回的条件: 尝试拿batchSize条记录，有多少取多少，不会阻塞等待
        + canal 会记住此 client 最新的position。
        + 如果是第一次 fetch，则会从 canal 中保存的最老一条数据开始输出。
        +
        +
        指定者:
        +
        getWithoutAck 在接口中 CanalConnector
        +
        抛出:
        +
        com.alibaba.otter.canal.protocol.exception.CanalClientException
        +
        • +
      + + + +
        +
      • +

        getWithoutAck

        +
        public com.alibaba.otter.canal.protocol.Message getWithoutAck(int batchSize,
+                                                     Long timeout,
+                                                     TimeUnit unit)
+                                                       throws com.alibaba.otter.canal.protocol.exception.CanalClientException
        +
        从接口复制的说明: CanalConnector
        +
        不指定 position 获取事件. + + 
        + 该方法返回的条件：
+  a. 拿够batchSize条记录或者超过timeout时间
+  b. 如果timeout=0，则阻塞至拿到batchSize记录才返回
+
        + + canal 会记住此 client 最新的position。
        + 如果是第一次 fetch，则会从 canal 中保存的最老一条数据开始输出。
        +
        +
        指定者:
        +
        getWithoutAck 在接口中 CanalConnector
        +
        返回:
        +
        抛出:
        +
        com.alibaba.otter.canal.protocol.exception.CanalClientException
        +
        • +
      + + + +
        +
      • +

        rollback

        +
        public void rollback(long batchId)
+              throws com.alibaba.otter.canal.protocol.exception.CanalClientException
        +
        从接口复制的说明: CanalConnector
        +
        回滚到未进行 ack 的地方，指定回滚具体的batchId
        +
        +
        指定者:
        +
        rollback 在接口中 CanalConnector
        +
        抛出:
        +
        com.alibaba.otter.canal.protocol.exception.CanalClientException
        +
        • +
      + + + +
        +
      • +

        rollback

        +
        public void rollback()
+              throws com.alibaba.otter.canal.protocol.exception.CanalClientException
        +
        从接口复制的说明: CanalConnector
        +
        回滚到未进行 ack 的地方，下次fetch的时候，可以从最后一个没有 ack 的地方开始拿
        +
        +
        指定者:
        +
        rollback 在接口中 CanalConnector
        +
        抛出:
        +
        com.alibaba.otter.canal.protocol.exception.CanalClientException
        +
        • +
      + + + +
        +
      • +

        ack

        +
        public void ack(long batchId)
+         throws com.alibaba.otter.canal.protocol.exception.CanalClientException
        +
        从接口复制的说明: CanalConnector
        +
        进行 batch id 的确认。确认之后，小于等于此 batchId 的 Message 都会被确认。
        +
        +
        指定者:
        +
        ack 在接口中 CanalConnector
        +
        抛出:
        +
        com.alibaba.otter.canal.protocol.exception.CanalClientException
        +
        • +
      + + + +
        +
      • +

        getUsername

        +
        public String getUsername()
        +
        • +
      + + + +
        +
      • +

        setUsername

        +
        public void setUsername(String username)
        +
        • +
      + + + +
        +
      • +

        getPassword

        +
        public String getPassword()
        +
        • +
      + + + +
        +
      • +

        setPassword

        +
        public void setPassword(String password)
        +
        • +
      + + + +
        +
      • +

        getSoTimeout

        +
        public int getSoTimeout()
        +
        • +
      + + + +
        +
      • +

        setSoTimeout

        +
        public void setSoTimeout(int soTimeout)
        +
        • +
      + + + +
        +
      • +

        getRetryTimes

        +
        public int getRetryTimes()
        +
        • +
      + + + +
        +
      • +

        setRetryTimes

        +
        public void setRetryTimes(int retryTimes)
        +
        • +
      + + + +
        +
      • +

        getRetryInterval

        +
        public int getRetryInterval()
        +
        • +
      + + + +
        +
      • +

        setRetryInterval

        +
        public void setRetryInterval(int retryInterval)
        +
        • +
      + + + + + + + + + + + + +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
canal.client-1.0.13
+
+
+ + + +
+ +
+
+ + +
+ + +
+ +

Copyright © 2013. All rights reserved.

+ + \ No newline at end of file diff --git a/apidocs/1.0.13/com/alibaba/otter/canal/client/impl/ClusterNodeAccessStrategy.html b/apidocs/1.0.13/com/alibaba/otter/canal/client/impl/ClusterNodeAccessStrategy.html new file mode 100644 index 00000000..8d114a40 --- /dev/null +++ b/apidocs/1.0.13/com/alibaba/otter/canal/client/impl/ClusterNodeAccessStrategy.html @@ -0,0 +1,300 @@ + + + + + + +ClusterNodeAccessStrategy (canal client module for otter 1.0.13 1.0.13 API) + + + + + + + +
+ + + + + +
canal.client-1.0.13
+
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
com.alibaba.otter.canal.client.impl
+

类 ClusterNodeAccessStrategy

+
+
+ +
+ +
+
+ +
+
+
    +
  • + +
      +
    • + + +

      构造器详细资料

      + + + +
        +
      • +

        ClusterNodeAccessStrategy

        +
        public ClusterNodeAccessStrategy(String destination,
+                         com.alibaba.otter.canal.common.zookeeper.ZkClientx zkClient)
        +
        • +
      +
      • +
    + +
      +
    • + + +

      方法详细资料

      + + + + + + + +
        +
      • +

        setZkClient

        +
        public void setZkClient(com.alibaba.otter.canal.common.zookeeper.ZkClientx zkClient)
        +
        • +
      + + + +
        +
      • +

        getZkClient

        +
        public com.alibaba.otter.canal.common.zookeeper.ZkClientx getZkClient()
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
canal.client-1.0.13
+
+
+ + + +
+ +
+
+ + +
+ + +
+ +

Copyright © 2013. All rights reserved.

+ + \ No newline at end of file diff --git a/apidocs/1.0.13/com/alibaba/otter/canal/client/impl/SimpleCanalConnector.html b/apidocs/1.0.13/com/alibaba/otter/canal/client/impl/SimpleCanalConnector.html new file mode 100644 index 00000000..12e0d249 --- /dev/null +++ b/apidocs/1.0.13/com/alibaba/otter/canal/client/impl/SimpleCanalConnector.html @@ -0,0 +1,741 @@ + + + + + + +SimpleCanalConnector (canal client module for otter 1.0.13 1.0.13 API) + + + + + + + +
+ + + + + +
canal.client-1.0.13
+
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
com.alibaba.otter.canal.client.impl
+

类 SimpleCanalConnector

+
+
+ +
+
    +
  • +
    +
    所有已实现的接口:
    +
    CanalConnector
    +
    +
    +
    +
    public class SimpleCanalConnector
+extends Object
+implements CanalConnector
    +
    基于CanalServerWithNetty定义的网络协议接口，对于canal数据进行get/rollback/ack等操作
    +
    版本:
    +
    1.0.0
    +
    作者:
    +
    jianghang 2012-10-24 下午05:37:20
    +
    • +
+
+
+
    +
  • + + + +
      +
    • + + +

      方法概要

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      方法 
      限定符和类型方法和说明
      voidack(long batchId) +
      进行 batch id 的确认。
      +
      booleancheckValid() +
      检查下链接是否合法 + + + 几种case下链接不合法: + 1.
      +
      voidconnect() +
      链接对应的canal server
      +
      voiddisconnect() +
      释放链接
      +
      com.alibaba.otter.canal.protocol.Messageget(int batchSize) +
      获取数据，自动进行确认，该方法返回的条件：尝试拿batchSize条记录，有多少取多少，不会阻塞等待
      +
      com.alibaba.otter.canal.protocol.Messageget(int batchSize, + Long timeout, + TimeUnit unit) +
      获取数据，自动进行确认 + + + 该方法返回的条件： + a.
      +
      SocketAddressgetAddress() 
      StringgetPassword() 
      intgetSoTimeout() 
      StringgetUsername() 
      com.alibaba.otter.canal.protocol.MessagegetWithoutAck(int batchSize) +
      不指定 position 获取事件，该方法返回的条件: 尝试拿batchSize条记录，有多少取多少，不会阻塞等待
      + canal 会记住此 client 最新的position。
      +
      com.alibaba.otter.canal.protocol.MessagegetWithoutAck(int batchSize, + Long timeout, + TimeUnit unit) +
      不指定 position 获取事件.
      +
      voidrollback() +
      回滚到未进行 ack 的地方，下次fetch的时候，可以从最后一个没有 ack 的地方开始拿
      +
      voidrollback(long batchId) +
      回滚到未进行 ack 的地方，指定回滚具体的batchId
      +
      voidsetRollbackOnConnect(boolean rollbackOnConnect) 
      voidsetRollbackOnDisConnect(boolean rollbackOnDisConnect) 
      voidsetSoTimeout(int soTimeout) 
      voidsetZkClientx(com.alibaba.otter.canal.common.zookeeper.ZkClientx zkClientx) 
      voidsubscribe() +
      客户端订阅，不提交客户端filter，以服务端的filter为准
      +
      voidsubscribe(String filter) +
      客户端订阅，重复订阅时会更新对应的filter信息 + + + 说明： + a.
      +
      voidunsubscribe() +
      取消订阅
      +
      + +
      • +
    +
    • +
+
+
+
    +
  • + + + +
      +
    • + + +

      方法详细资料

      + + + +
        +
      • +

        connect

        +
        public void connect()
+             throws com.alibaba.otter.canal.protocol.exception.CanalClientException
        +
        从接口复制的说明: CanalConnector
        +
        链接对应的canal server
        +
        +
        指定者:
        +
        connect 在接口中 CanalConnector
        +
        抛出:
        +
        com.alibaba.otter.canal.protocol.exception.CanalClientException
        +
        • +
      + + + +
        +
      • +

        disconnect

        +
        public void disconnect()
+                throws com.alibaba.otter.canal.protocol.exception.CanalClientException
        +
        从接口复制的说明: CanalConnector
        +
        释放链接
        +
        +
        指定者:
        +
        disconnect 在接口中 CanalConnector
        +
        抛出:
        +
        com.alibaba.otter.canal.protocol.exception.CanalClientException
        +
        • +
      + + + +
        +
      • +

        subscribe

        +
        public void subscribe()
+               throws com.alibaba.otter.canal.protocol.exception.CanalClientException
        +
        从接口复制的说明: CanalConnector
        +
        客户端订阅，不提交客户端filter，以服务端的filter为准
        +
        +
        指定者:
        +
        subscribe 在接口中 CanalConnector
        +
        抛出:
        +
        com.alibaba.otter.canal.protocol.exception.CanalClientException
        +
        • +
      + + + +
        +
      • +

        subscribe

        +
        public void subscribe(String filter)
+               throws com.alibaba.otter.canal.protocol.exception.CanalClientException
        +
        从接口复制的说明: CanalConnector
        +
        客户端订阅，重复订阅时会更新对应的filter信息 + + 
        + 说明：
+ a. 如果本次订阅中filter信息为空，则直接使用canal server服务端配置的filter信息
+ b. 如果本次订阅中filter信息不为空，目前会直接替换canal server服务端配置的filter信息，以本次提交的为准
+ 
+ TODO: 后续可以考虑，如果本次提交的filter不为空，在执行过滤时，是对canal server filter + 本次filter的交集处理，达到只取1份binlog数据，多个客户端消费不同的表
+
        +
        +
        指定者:
        +
        subscribe 在接口中 CanalConnector
        +
        抛出:
        +
        com.alibaba.otter.canal.protocol.exception.CanalClientException
        +
        • +
      + + + +
        +
      • +

        unsubscribe

        +
        public void unsubscribe()
+                 throws com.alibaba.otter.canal.protocol.exception.CanalClientException
        +
        从接口复制的说明: CanalConnector
        +
        取消订阅
        +
        +
        指定者:
        +
        unsubscribe 在接口中 CanalConnector
        +
        抛出:
        +
        com.alibaba.otter.canal.protocol.exception.CanalClientException
        +
        • +
      + + + +
        +
      • +

        get

        +
        public com.alibaba.otter.canal.protocol.Message get(int batchSize)
+                                             throws com.alibaba.otter.canal.protocol.exception.CanalClientException
        +
        从接口复制的说明: CanalConnector
        +
        获取数据，自动进行确认，该方法返回的条件：尝试拿batchSize条记录，有多少取多少，不会阻塞等待
        +
        +
        指定者:
        +
        get 在接口中 CanalConnector
        +
        返回:
        +
        抛出:
        +
        com.alibaba.otter.canal.protocol.exception.CanalClientException
        +
        • +
      + + + +
        +
      • +

        get

        +
        public com.alibaba.otter.canal.protocol.Message get(int batchSize,
+                                           Long timeout,
+                                           TimeUnit unit)
+                                             throws com.alibaba.otter.canal.protocol.exception.CanalClientException
        +
        从接口复制的说明: CanalConnector
        +
        获取数据，自动进行确认 + + 
        + 该方法返回的条件：
+  a. 拿够batchSize条记录或者超过timeout时间
+  b. 如果timeout=0，则阻塞至拿到batchSize记录才返回
+
        +
        +
        指定者:
        +
        get 在接口中 CanalConnector
        +
        返回:
        +
        抛出:
        +
        com.alibaba.otter.canal.protocol.exception.CanalClientException
        +
        • +
      + + + +
        +
      • +

        getWithoutAck

        +
        public com.alibaba.otter.canal.protocol.Message getWithoutAck(int batchSize)
+                                                       throws com.alibaba.otter.canal.protocol.exception.CanalClientException
        +
        从接口复制的说明: CanalConnector
        +
        不指定 position 获取事件，该方法返回的条件: 尝试拿batchSize条记录，有多少取多少，不会阻塞等待
        + canal 会记住此 client 最新的position。
        + 如果是第一次 fetch，则会从 canal 中保存的最老一条数据开始输出。
        +
        +
        指定者:
        +
        getWithoutAck 在接口中 CanalConnector
        +
        抛出:
        +
        com.alibaba.otter.canal.protocol.exception.CanalClientException
        +
        • +
      + + + +
        +
      • +

        getWithoutAck

        +
        public com.alibaba.otter.canal.protocol.Message getWithoutAck(int batchSize,
+                                                     Long timeout,
+                                                     TimeUnit unit)
+                                                       throws com.alibaba.otter.canal.protocol.exception.CanalClientException
        +
        从接口复制的说明: CanalConnector
        +
        不指定 position 获取事件. + + 
        + 该方法返回的条件：
+  a. 拿够batchSize条记录或者超过timeout时间
+  b. 如果timeout=0，则阻塞至拿到batchSize记录才返回
+
        + + canal 会记住此 client 最新的position。
        + 如果是第一次 fetch，则会从 canal 中保存的最老一条数据开始输出。
        +
        +
        指定者:
        +
        getWithoutAck 在接口中 CanalConnector
        +
        返回:
        +
        抛出:
        +
        com.alibaba.otter.canal.protocol.exception.CanalClientException
        +
        • +
      + + + +
        +
      • +

        ack

        +
        public void ack(long batchId)
+         throws com.alibaba.otter.canal.protocol.exception.CanalClientException
        +
        从接口复制的说明: CanalConnector
        +
        进行 batch id 的确认。确认之后，小于等于此 batchId 的 Message 都会被确认。
        +
        +
        指定者:
        +
        ack 在接口中 CanalConnector
        +
        抛出:
        +
        com.alibaba.otter.canal.protocol.exception.CanalClientException
        +
        • +
      + + + +
        +
      • +

        rollback

        +
        public void rollback(long batchId)
+              throws com.alibaba.otter.canal.protocol.exception.CanalClientException
        +
        从接口复制的说明: CanalConnector
        +
        回滚到未进行 ack 的地方，指定回滚具体的batchId
        +
        +
        指定者:
        +
        rollback 在接口中 CanalConnector
        +
        抛出:
        +
        com.alibaba.otter.canal.protocol.exception.CanalClientException
        +
        • +
      + + + +
        +
      • +

        rollback

        +
        public void rollback()
+              throws com.alibaba.otter.canal.protocol.exception.CanalClientException
        +
        从接口复制的说明: CanalConnector
        +
        回滚到未进行 ack 的地方，下次fetch的时候，可以从最后一个没有 ack 的地方开始拿
        +
        +
        指定者:
        +
        rollback 在接口中 CanalConnector
        +
        抛出:
        +
        com.alibaba.otter.canal.protocol.exception.CanalClientException
        +
        • +
      + + + +
        +
      • +

        checkValid

        +
        public boolean checkValid()
        +
        从接口复制的说明: CanalConnector
        +
        检查下链接是否合法 + + 
        + 几种case下链接不合法:
+ 1. 链接canal server失败，一直没有一个可用的链接，返回false
+ 2. 当前客户端在进行running抢占的时候，做为备份节点存在，非处于工作节点，返回false
+ 
+ 说明：
+ a. 当前客户端一旦做为备份节点存在，当前所有的对CanalConnector的操作都会处于阻塞状态，直到转为工作节点
+ b. 所以业务方最好定时调用checkValid()方法用，比如调用CanalConnector所在线程的interrupt，直接退出CanalConnector，并根据自己的需要退出自己的资源
+
        +
        +
        指定者:
        +
        checkValid 在接口中 CanalConnector
        +
        +
        • +
      + + + + + + + +
        +
      • +

        getUsername

        +
        public String getUsername()
        +
        • +
      + + + +
        +
      • +

        getPassword

        +
        public String getPassword()
        +
        • +
      + + + +
        +
      • +

        getSoTimeout

        +
        public int getSoTimeout()
        +
        • +
      + + + +
        +
      • +

        setSoTimeout

        +
        public void setSoTimeout(int soTimeout)
        +
        • +
      + + + +
        +
      • +

        setZkClientx

        +
        public void setZkClientx(com.alibaba.otter.canal.common.zookeeper.ZkClientx zkClientx)
        +
        • +
      + + + +
        +
      • +

        setRollbackOnConnect

        +
        public void setRollbackOnConnect(boolean rollbackOnConnect)
        +
        • +
      + + + +
        +
      • +

        setRollbackOnDisConnect

        +
        public void setRollbackOnDisConnect(boolean rollbackOnDisConnect)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
canal.client-1.0.13
+
+
+ + + +
+ +
+
+ + +
+ + +
+ +

Copyright © 2013. All rights reserved.

+ + \ No newline at end of file diff --git a/apidocs/1.0.13/com/alibaba/otter/canal/client/impl/SimpleNodeAccessStrategy.html b/apidocs/1.0.13/com/alibaba/otter/canal/client/impl/SimpleNodeAccessStrategy.html new file mode 100644 index 00000000..9e851799 --- /dev/null +++ b/apidocs/1.0.13/com/alibaba/otter/canal/client/impl/SimpleNodeAccessStrategy.html @@ -0,0 +1,272 @@ + + + + + + +SimpleNodeAccessStrategy (canal client module for otter 1.0.13 1.0.13 API) + + + + + + + +
+ + + + + +
canal.client-1.0.13
+
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
com.alibaba.otter.canal.client.impl
+

类 SimpleNodeAccessStrategy

+
+
+ +
+ +
+
+ +
+
+ +
+
+ + +
+ + + + + +
canal.client-1.0.13
+
+
+ + + +
+ +
+
+ + +
+ + +
+ +

Copyright © 2013. All rights reserved.

+ + \ No newline at end of file diff --git a/apidocs/1.0.13/com/alibaba/otter/canal/client/impl/class-use/ClusterCanalConnector.html b/apidocs/1.0.13/com/alibaba/otter/canal/client/impl/class-use/ClusterCanalConnector.html new file mode 100644 index 00000000..9ca80ab3 --- /dev/null +++ b/apidocs/1.0.13/com/alibaba/otter/canal/client/impl/class-use/ClusterCanalConnector.html @@ -0,0 +1,117 @@ + + + + + + +类 com.alibaba.otter.canal.client.impl.ClusterCanalConnector的使用 (canal client module for otter 1.0.13 1.0.13 API) + + + + + + + +
+ + + + + +
canal.client-1.0.13
+
+
+ + + +
+ +
+ + +
+ +
+

类 com.alibaba.otter.canal.client.impl.ClusterCanalConnector
的使用

+
+
没有com.alibaba.otter.canal.client.impl.ClusterCanalConnector的用法
+ +
+ + + + + +
canal.client-1.0.13
+
+
+ + + +
+ +
+ + +
+ +

Copyright © 2013. All rights reserved.

+ + \ No newline at end of file diff --git a/apidocs/1.0.13/com/alibaba/otter/canal/client/impl/class-use/ClusterNodeAccessStrategy.html b/apidocs/1.0.13/com/alibaba/otter/canal/client/impl/class-use/ClusterNodeAccessStrategy.html new file mode 100644 index 00000000..df0ce962 --- /dev/null +++ b/apidocs/1.0.13/com/alibaba/otter/canal/client/impl/class-use/ClusterNodeAccessStrategy.html @@ -0,0 +1,117 @@ + + + + + + +类 com.alibaba.otter.canal.client.impl.ClusterNodeAccessStrategy的使用 (canal client module for otter 1.0.13 1.0.13 API) + + + + + + + +
+ + + + + +
canal.client-1.0.13
+
+
+ + + +
+ +
+ + +
+ +
+

类 com.alibaba.otter.canal.client.impl.ClusterNodeAccessStrategy
的使用

+
+
没有com.alibaba.otter.canal.client.impl.ClusterNodeAccessStrategy的用法
+ +
+ + + + + +
canal.client-1.0.13
+
+
+ + + +
+ +
+ + +
+ +

Copyright © 2013. All rights reserved.

+ + \ No newline at end of file diff --git a/apidocs/1.0.13/com/alibaba/otter/canal/client/impl/class-use/SimpleCanalConnector.html b/apidocs/1.0.13/com/alibaba/otter/canal/client/impl/class-use/SimpleCanalConnector.html new file mode 100644 index 00000000..75b531f3 --- /dev/null +++ b/apidocs/1.0.13/com/alibaba/otter/canal/client/impl/class-use/SimpleCanalConnector.html @@ -0,0 +1,157 @@ + + + + + + +类 com.alibaba.otter.canal.client.impl.SimpleCanalConnector的使用 (canal client module for otter 1.0.13 1.0.13 API) + + + + + + + +
+ + + + + +
canal.client-1.0.13
+
+
+ + + +
+ +
+ + +
+ +
+

类 com.alibaba.otter.canal.client.impl.SimpleCanalConnector
的使用

+
+
+ +
+ +
+ + + + + +
canal.client-1.0.13
+
+
+ + + +
+ +
+ + +
+ +

Copyright © 2013. All rights reserved.

+ + \ No newline at end of file diff --git a/apidocs/1.0.13/com/alibaba/otter/canal/client/impl/class-use/SimpleNodeAccessStrategy.html b/apidocs/1.0.13/com/alibaba/otter/canal/client/impl/class-use/SimpleNodeAccessStrategy.html new file mode 100644 index 00000000..ac14701b --- /dev/null +++ b/apidocs/1.0.13/com/alibaba/otter/canal/client/impl/class-use/SimpleNodeAccessStrategy.html @@ -0,0 +1,117 @@ + + + + + + +类 com.alibaba.otter.canal.client.impl.SimpleNodeAccessStrategy的使用 (canal client module for otter 1.0.13 1.0.13 API) + + + + + + + +
+ + + + + +
canal.client-1.0.13
+
+
+ + + +
+ +
+ + +
+ +
+

类 com.alibaba.otter.canal.client.impl.SimpleNodeAccessStrategy
的使用

+
+
没有com.alibaba.otter.canal.client.impl.SimpleNodeAccessStrategy的用法
+ +
+ + + + + +
canal.client-1.0.13
+
+
+ + + +
+ +
+ + +
+ +

Copyright © 2013. All rights reserved.

+ + \ No newline at end of file diff --git a/apidocs/1.0.13/com/alibaba/otter/canal/client/impl/package-frame.html b/apidocs/1.0.13/com/alibaba/otter/canal/client/impl/package-frame.html new file mode 100644 index 00000000..4ed27b77 --- /dev/null +++ b/apidocs/1.0.13/com/alibaba/otter/canal/client/impl/package-frame.html @@ -0,0 +1,23 @@ + + + + + + +com.alibaba.otter.canal.client.impl (canal client module for otter 1.0.13 1.0.13 API) + + + + +

com.alibaba.otter.canal.client.impl

+
+

类

+ +
+ + \ No newline at end of file diff --git a/apidocs/1.0.13/com/alibaba/otter/canal/client/impl/package-summary.html b/apidocs/1.0.13/com/alibaba/otter/canal/client/impl/package-summary.html new file mode 100644 index 00000000..a769b7b7 --- /dev/null +++ b/apidocs/1.0.13/com/alibaba/otter/canal/client/impl/package-summary.html @@ -0,0 +1,155 @@ + + + + + + +com.alibaba.otter.canal.client.impl (canal client module for otter 1.0.13 1.0.13 API) + + + + + + + +
+ + + + + +
canal.client-1.0.13
+
+
+ + + +
+ +
+ + +
+ +
+

程序包 com.alibaba.otter.canal.client.impl

+
+
+ +
+ +
+ + + + + +
canal.client-1.0.13
+
+
+ + + +
+ +
+ + +
+ +

Copyright © 2013. All rights reserved.

+ + \ No newline at end of file diff --git a/apidocs/1.0.13/com/alibaba/otter/canal/client/impl/package-tree.html b/apidocs/1.0.13/com/alibaba/otter/canal/client/impl/package-tree.html new file mode 100644 index 00000000..864fe22d --- /dev/null +++ b/apidocs/1.0.13/com/alibaba/otter/canal/client/impl/package-tree.html @@ -0,0 +1,133 @@ + + + + + + +com.alibaba.otter.canal.client.impl 类分层结构 (canal client module for otter 1.0.13 1.0.13 API) + + + + + + + +
+ + + + + +
canal.client-1.0.13
+
+
+ + + +
+ +
+ + +
+ +
+

程序包com.alibaba.otter.canal.client.impl的分层结构

+程序包分层结构: + +
+
+

类分层结构

+ +
+ +
+ + + + + +
canal.client-1.0.13
+
+
+ + + +
+ +
+ + +
+ +

Copyright © 2013. All rights reserved.

+ + \ No newline at end of file diff --git a/apidocs/1.0.13/com/alibaba/otter/canal/client/impl/package-use.html b/apidocs/1.0.13/com/alibaba/otter/canal/client/impl/package-use.html new file mode 100644 index 00000000..887e4d4d --- /dev/null +++ b/apidocs/1.0.13/com/alibaba/otter/canal/client/impl/package-use.html @@ -0,0 +1,152 @@ + + + + + + +程序包 com.alibaba.otter.canal.client.impl的使用 (canal client module for otter 1.0.13 1.0.13 API) + + + + + + + +
+ + + + + +
canal.client-1.0.13
+
+
+ + + +
+ +
+ + +
+ +
+

程序包 com.alibaba.otter.canal.client.impl
的使用

+
+
+ +
+ +
+ + + + + +
canal.client-1.0.13
+
+
+ + + +
+ +
+ + +
+ +

Copyright © 2013. All rights reserved.

+ + \ No newline at end of file diff --git a/apidocs/1.0.13/com/alibaba/otter/canal/client/impl/running/ClientRunningData.html b/apidocs/1.0.13/com/alibaba/otter/canal/client/impl/running/ClientRunningData.html new file mode 100644 index 00000000..b71637ae --- /dev/null +++ b/apidocs/1.0.13/com/alibaba/otter/canal/client/impl/running/ClientRunningData.html @@ -0,0 +1,328 @@ + + + + + + +ClientRunningData (canal client module for otter 1.0.13 1.0.13 API) + + + + + + + +
+ + + + + +
canal.client-1.0.13
+
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
com.alibaba.otter.canal.client.impl.running
+

类 ClientRunningData

+
+
+ +
+
    +
  • +
    +
    +
    public class ClientRunningData
+extends Object
    +
    client running状态信息
    +
    版本:
    +
    1.0.0
    +
    作者:
    +
    jianghang 2012-11-22 下午03:41:50
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      构造器详细资料

      + + + +
        +
      • +

        ClientRunningData

        +
        public ClientRunningData()
        +
        • +
      +
      • +
    + +
      +
    • + + +

      方法详细资料

      + + + +
        +
      • +

        getClientId

        +
        public short getClientId()
        +
        • +
      + + + +
        +
      • +

        setClientId

        +
        public void setClientId(short clientId)
        +
        • +
      + + + +
        +
      • +

        getAddress

        +
        public String getAddress()
        +
        • +
      + + + +
        +
      • +

        setAddress

        +
        public void setAddress(String address)
        +
        • +
      + + + +
        +
      • +

        isActive

        +
        public boolean isActive()
        +
        • +
      + + + +
        +
      • +

        setActive

        +
        public void setActive(boolean active)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
canal.client-1.0.13
+
+
+ + + +
+ +
+
+ + +
+ + +
+ +

Copyright © 2013. All rights reserved.

+ + \ No newline at end of file diff --git a/apidocs/1.0.13/com/alibaba/otter/canal/client/impl/running/ClientRunningListener.html b/apidocs/1.0.13/com/alibaba/otter/canal/client/impl/running/ClientRunningListener.html new file mode 100644 index 00000000..f7ecb6a9 --- /dev/null +++ b/apidocs/1.0.13/com/alibaba/otter/canal/client/impl/running/ClientRunningListener.html @@ -0,0 +1,232 @@ + + + + + + +ClientRunningListener (canal client module for otter 1.0.13 1.0.13 API) + + + + + + + +
+ + + + + +
canal.client-1.0.13
+
+
+ + + +
+ +
+
+
    +
  • 概要: 
    • +
  • 嵌套 | 
    • +
  • 字段 | 
    • +
  • 构造器 | 
    • +
  • 方法
    • +
+
    +
  • 详细资料: 
    • +
  • 字段 | 
    • +
  • 构造器 | 
    • +
  • 方法
    • +
+
+ + +
+ + +
+
com.alibaba.otter.canal.client.impl.running
+

接口 ClientRunningListener

+
+
+
+
    +
  • +
    +
    +
    public interface ClientRunningListener
    +
    触发一下mainstem发生切换
    +
    版本:
    +
    1.0.0
    +
    作者:
    +
    jianghang 2012-9-11 下午02:26:03
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      方法概要

      + + + + + + + + + + + + + + +
      方法 
      限定符和类型方法和说明
      InetSocketAddressprocessActiveEnter() +
      触发现在轮到自己做为active，需要载入上一个active的上下文数据
      +
      voidprocessActiveExit() +
      触发一下当前active模式失败
      +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      方法详细资料

      + + + +
        +
      • +

        processActiveEnter

        +
        InetSocketAddress processActiveEnter()
        +
        触发现在轮到自己做为active，需要载入上一个active的上下文数据
        +
        • +
      + + + +
        +
      • +

        processActiveExit

        +
        void processActiveExit()
        +
        触发一下当前active模式失败
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
canal.client-1.0.13
+
+
+ + + +
+ +
+
+
    +
  • 概要: 
    • +
  • 嵌套 | 
    • +
  • 字段 | 
    • +
  • 构造器 | 
    • +
  • 方法
    • +
+
    +
  • 详细资料: 
    • +
  • 字段 | 
    • +
  • 构造器 | 
    • +
  • 方法
    • +
+
+ + +
+ +

Copyright © 2013. All rights reserved.

+ + \ No newline at end of file diff --git a/apidocs/1.0.13/com/alibaba/otter/canal/client/impl/running/ClientRunningMonitor.html b/apidocs/1.0.13/com/alibaba/otter/canal/client/impl/running/ClientRunningMonitor.html new file mode 100644 index 00000000..97250599 --- /dev/null +++ b/apidocs/1.0.13/com/alibaba/otter/canal/client/impl/running/ClientRunningMonitor.html @@ -0,0 +1,430 @@ + + + + + + +ClientRunningMonitor (canal client module for otter 1.0.13 1.0.13 API) + + + + + + + +
+ + + + + +
canal.client-1.0.13
+
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
com.alibaba.otter.canal.client.impl.running
+

类 ClientRunningMonitor

+
+
+ +
+
    +
  • +
    +
    所有已实现的接口:
    +
    com.alibaba.otter.canal.common.CanalLifeCycle
    +
    +
    +
    +
    public class ClientRunningMonitor
+extends com.alibaba.otter.canal.common.AbstractCanalLifeCycle
    +
    clinet running控制
    +
    版本:
    +
    1.0.0
    +
    作者:
    +
    jianghang 2012-11-22 下午03:43:01
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      构造器详细资料

      + + + +
        +
      • +

        ClientRunningMonitor

        +
        public ClientRunningMonitor()
        +
        • +
      +
      • +
    + +
      +
    • + + +

      方法详细资料

      + + + +
        +
      • +

        start

        +
        public void start()
        +
        +
        指定者:
        +
        start 在接口中 com.alibaba.otter.canal.common.CanalLifeCycle
        +
        覆盖:
        +
        start 在类中 com.alibaba.otter.canal.common.AbstractCanalLifeCycle
        +
        +
        • +
      + + + +
        +
      • +

        stop

        +
        public void stop()
        +
        +
        指定者:
        +
        stop 在接口中 com.alibaba.otter.canal.common.CanalLifeCycle
        +
        覆盖:
        +
        stop 在类中 com.alibaba.otter.canal.common.AbstractCanalLifeCycle
        +
        +
        • +
      + + + +
        +
      • +

        initRunning

        +
        public void initRunning()
        +
        • +
      + + + + + + + +
        +
      • +

        check

        +
        public boolean check()
        +
        检查当前的状态
        +
        • +
      + + + +
        +
      • +

        releaseRunning

        +
        public boolean releaseRunning()
        +
        • +
      + + + + + + + +
        +
      • +

        setDestination

        +
        public void setDestination(String destination)
        +
        • +
      + + + + + + + +
        +
      • +

        setDelayTime

        +
        public void setDelayTime(int delayTime)
        +
        • +
      + + + +
        +
      • +

        setZkClient

        +
        public void setZkClient(com.alibaba.otter.canal.common.zookeeper.ZkClientx zkClient)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
canal.client-1.0.13
+
+
+ + + +
+ +
+
+ + +
+ + +
+ +

Copyright © 2013. All rights reserved.

+ + \ No newline at end of file diff --git a/apidocs/1.0.13/com/alibaba/otter/canal/client/impl/running/class-use/ClientRunningData.html b/apidocs/1.0.13/com/alibaba/otter/canal/client/impl/running/class-use/ClientRunningData.html new file mode 100644 index 00000000..7c8198a1 --- /dev/null +++ b/apidocs/1.0.13/com/alibaba/otter/canal/client/impl/running/class-use/ClientRunningData.html @@ -0,0 +1,157 @@ + + + + + + +类 com.alibaba.otter.canal.client.impl.running.ClientRunningData的使用 (canal client module for otter 1.0.13 1.0.13 API) + + + + + + + +
+ + + + + +
canal.client-1.0.13
+
+
+ + + +
+ +
+ + +
+ +
+

类 com.alibaba.otter.canal.client.impl.running.ClientRunningData
的使用

+
+
+ +
+ +
+ + + + + +
canal.client-1.0.13
+
+
+ + + +
+ +
+ + +
+ +

Copyright © 2013. All rights reserved.

+ + \ No newline at end of file diff --git a/apidocs/1.0.13/com/alibaba/otter/canal/client/impl/running/class-use/ClientRunningListener.html b/apidocs/1.0.13/com/alibaba/otter/canal/client/impl/running/class-use/ClientRunningListener.html new file mode 100644 index 00000000..4f95276e --- /dev/null +++ b/apidocs/1.0.13/com/alibaba/otter/canal/client/impl/running/class-use/ClientRunningListener.html @@ -0,0 +1,157 @@ + + + + + + +接口 com.alibaba.otter.canal.client.impl.running.ClientRunningListener的使用 (canal client module for otter 1.0.13 1.0.13 API) + + + + + + + +
+ + + + + +
canal.client-1.0.13
+
+
+ + + +
+ +
+ + +
+ +
+

接口 com.alibaba.otter.canal.client.impl.running.ClientRunningListener
的使用

+
+
+ +
+ +
+ + + + + +
canal.client-1.0.13
+
+
+ + + +
+ +
+ + +
+ +

Copyright © 2013. All rights reserved.

+ + \ No newline at end of file diff --git a/apidocs/1.0.13/com/alibaba/otter/canal/client/impl/running/class-use/ClientRunningMonitor.html b/apidocs/1.0.13/com/alibaba/otter/canal/client/impl/running/class-use/ClientRunningMonitor.html new file mode 100644 index 00000000..93465a09 --- /dev/null +++ b/apidocs/1.0.13/com/alibaba/otter/canal/client/impl/running/class-use/ClientRunningMonitor.html @@ -0,0 +1,117 @@ + + + + + + +类 com.alibaba.otter.canal.client.impl.running.ClientRunningMonitor的使用 (canal client module for otter 1.0.13 1.0.13 API) + + + + + + + +
+ + + + + +
canal.client-1.0.13
+
+
+ + + +
+ +
+ + +
+ +
+

类 com.alibaba.otter.canal.client.impl.running.ClientRunningMonitor
的使用

+
+
没有com.alibaba.otter.canal.client.impl.running.ClientRunningMonitor的用法
+ +
+ + + + + +
canal.client-1.0.13
+
+
+ + + +
+ +
+ + +
+ +

Copyright © 2013. All rights reserved.

+ + \ No newline at end of file diff --git a/apidocs/1.0.13/com/alibaba/otter/canal/client/impl/running/package-frame.html b/apidocs/1.0.13/com/alibaba/otter/canal/client/impl/running/package-frame.html new file mode 100644 index 00000000..81012244 --- /dev/null +++ b/apidocs/1.0.13/com/alibaba/otter/canal/client/impl/running/package-frame.html @@ -0,0 +1,25 @@ + + + + + + +com.alibaba.otter.canal.client.impl.running (canal client module for otter 1.0.13 1.0.13 API) + + + + +

com.alibaba.otter.canal.client.impl.running

+
+

接口

+ +

类

+ +
+ + \ No newline at end of file diff --git a/apidocs/1.0.13/com/alibaba/otter/canal/client/impl/running/package-summary.html b/apidocs/1.0.13/com/alibaba/otter/canal/client/impl/running/package-summary.html new file mode 100644 index 00000000..9c9d4615 --- /dev/null +++ b/apidocs/1.0.13/com/alibaba/otter/canal/client/impl/running/package-summary.html @@ -0,0 +1,160 @@ + + + + + + +com.alibaba.otter.canal.client.impl.running (canal client module for otter 1.0.13 1.0.13 API) + + + + + + + +
+ + + + + +
canal.client-1.0.13
+
+
+ + + +
+ +
+ + +
+ +
+

程序包 com.alibaba.otter.canal.client.impl.running

+
+
+ +
+ +
+ + + + + +
canal.client-1.0.13
+
+
+ + + +
+ +
+ + +
+ +

Copyright © 2013. All rights reserved.

+ + \ No newline at end of file diff --git a/apidocs/1.0.13/com/alibaba/otter/canal/client/impl/running/package-tree.html b/apidocs/1.0.13/com/alibaba/otter/canal/client/impl/running/package-tree.html new file mode 100644 index 00000000..9e64b5be --- /dev/null +++ b/apidocs/1.0.13/com/alibaba/otter/canal/client/impl/running/package-tree.html @@ -0,0 +1,139 @@ + + + + + + +com.alibaba.otter.canal.client.impl.running 类分层结构 (canal client module for otter 1.0.13 1.0.13 API) + + + + + + + +
+ + + + + +
canal.client-1.0.13
+
+
+ + + +
+ +
+ + +
+ +
+

程序包com.alibaba.otter.canal.client.impl.running的分层结构

+程序包分层结构: + +
+
+

类分层结构

+ +

接口分层结构

+ +
+ +
+ + + + + +
canal.client-1.0.13
+
+
+ + + +
+ +
+ + +
+ +

Copyright © 2013. All rights reserved.

+ + \ No newline at end of file diff --git a/apidocs/1.0.13/com/alibaba/otter/canal/client/impl/running/package-use.html b/apidocs/1.0.13/com/alibaba/otter/canal/client/impl/running/package-use.html new file mode 100644 index 00000000..f8fa9c14 --- /dev/null +++ b/apidocs/1.0.13/com/alibaba/otter/canal/client/impl/running/package-use.html @@ -0,0 +1,157 @@ + + + + + + +程序包 com.alibaba.otter.canal.client.impl.running的使用 (canal client module for otter 1.0.13 1.0.13 API) + + + + + + + +
+ + + + + +
canal.client-1.0.13
+
+
+ + + +
+ +
+ + +
+ +
+

程序包 com.alibaba.otter.canal.client.impl.running
的使用

+
+
+ +
+ +
+ + + + + +
canal.client-1.0.13
+
+
+ + + +
+ +
+ + +
+ +

Copyright © 2013. All rights reserved.

+ + \ No newline at end of file diff --git a/apidocs/1.0.13/com/alibaba/otter/canal/client/package-frame.html b/apidocs/1.0.13/com/alibaba/otter/canal/client/package-frame.html new file mode 100644 index 00000000..0a149bda --- /dev/null +++ b/apidocs/1.0.13/com/alibaba/otter/canal/client/package-frame.html @@ -0,0 +1,25 @@ + + + + + + +com.alibaba.otter.canal.client (canal client module for otter 1.0.13 1.0.13 API) + + + + +

com.alibaba.otter.canal.client

+
+

接口

+ +

类

+ +
+ + \ No newline at end of file diff --git a/apidocs/1.0.13/com/alibaba/otter/canal/client/package-summary.html b/apidocs/1.0.13/com/alibaba/otter/canal/client/package-summary.html new file mode 100644 index 00000000..581d8028 --- /dev/null +++ b/apidocs/1.0.13/com/alibaba/otter/canal/client/package-summary.html @@ -0,0 +1,160 @@ + + + + + + +com.alibaba.otter.canal.client (canal client module for otter 1.0.13 1.0.13 API) + + + + + + + +
+ + + + + +
canal.client-1.0.13
+
+
+ + + +
+ +
+ + +
+ +
+

程序包 com.alibaba.otter.canal.client

+
+
+ +
+ +
+ + + + + +
canal.client-1.0.13
+
+
+ + + +
+ +
+ + +
+ +

Copyright © 2013. All rights reserved.

+ + \ No newline at end of file diff --git a/apidocs/1.0.13/com/alibaba/otter/canal/client/package-tree.html b/apidocs/1.0.13/com/alibaba/otter/canal/client/package-tree.html new file mode 100644 index 00000000..163e045f --- /dev/null +++ b/apidocs/1.0.13/com/alibaba/otter/canal/client/package-tree.html @@ -0,0 +1,135 @@ + + + + + + +com.alibaba.otter.canal.client 类分层结构 (canal client module for otter 1.0.13 1.0.13 API) + + + + + + + +
+ + + + + +
canal.client-1.0.13
+
+
+ + + +
+ +
+ + +
+ +
+

程序包com.alibaba.otter.canal.client的分层结构

+程序包分层结构: + +
+
+

类分层结构

+ +

接口分层结构

+ +
+ +
+ + + + + +
canal.client-1.0.13
+
+
+ + + +
+ +
+ + +
+ +

Copyright © 2013. All rights reserved.

+ + \ No newline at end of file diff --git a/apidocs/1.0.13/com/alibaba/otter/canal/client/package-use.html b/apidocs/1.0.13/com/alibaba/otter/canal/client/package-use.html new file mode 100644 index 00000000..0ee8fb7b --- /dev/null +++ b/apidocs/1.0.13/com/alibaba/otter/canal/client/package-use.html @@ -0,0 +1,178 @@ + + + + + + +程序包 com.alibaba.otter.canal.client的使用 (canal client module for otter 1.0.13 1.0.13 API) + + + + + + + +
+ + + + + +
canal.client-1.0.13
+
+
+ + + +
+ +
+ + +
+ +
+

程序包 com.alibaba.otter.canal.client
的使用

+
+
+ +
+ +
+ + + + + +
canal.client-1.0.13
+
+
+ + + +
+ +
+ + +
+ +

Copyright © 2013. All rights reserved.

+ + \ No newline at end of file diff --git a/apidocs/1.0.13/constant-values.html b/apidocs/1.0.13/constant-values.html new file mode 100644 index 00000000..0244a935 --- /dev/null +++ b/apidocs/1.0.13/constant-values.html @@ -0,0 +1,117 @@ + + + + + + +常量字段值 (canal client module for otter 1.0.13 1.0.13 API) + + + + + + + +
+ + + + + +
canal.client-1.0.13
+
+
+ + + +
+ +
+ + +
+ +
+

常量字段值

+

目录

+
+ +
+ + + + + +
canal.client-1.0.13
+
+
+ + + +
+ +
+ + +
+ +

Copyright © 2013. All rights reserved.

+ + \ No newline at end of file diff --git a/apidocs/1.0.13/deprecated-list.html b/apidocs/1.0.13/deprecated-list.html new file mode 100644 index 00000000..bd45e377 --- /dev/null +++ b/apidocs/1.0.13/deprecated-list.html @@ -0,0 +1,117 @@ + + + + + + +已过时的列表 (canal client module for otter 1.0.13 1.0.13 API) + + + + + + + +
+ + + + + +
canal.client-1.0.13
+
+
+ + + +
+ +
+ + +
+ +
+

已过时的 API

+

目录

+
+ +
+ + + + + +
canal.client-1.0.13
+
+
+ + + +
+ +
+ + +
+ +

Copyright © 2013. All rights reserved.

+ + \ No newline at end of file diff --git a/apidocs/1.0.13/index-all.html b/apidocs/1.0.13/index-all.html new file mode 100644 index 00000000..a2e97a4b --- /dev/null +++ b/apidocs/1.0.13/index-all.html @@ -0,0 +1,469 @@ + + + + + + +索引 (canal client module for otter 1.0.13 1.0.13 API) + + + + + + + +
+ + + + + +
canal.client-1.0.13
+
+
+ + + +
+ +
+ + +
+ +
A C D G I N P R S U W  + + +

A

+
+
ack(long) - 接口 中的方法com.alibaba.otter.canal.client.CanalConnector
+
+
进行 batch id 的确认。
+
+
ack(long) - 类 中的方法com.alibaba.otter.canal.client.impl.ClusterCanalConnector
+
 
+
ack(long) - 类 中的方法com.alibaba.otter.canal.client.impl.SimpleCanalConnector
+
 
+
+ + + +

C

+
+
CanalConnector - com.alibaba.otter.canal.client中的接口
+
+
canal数据操作客户端
+
+
CanalConnectors - com.alibaba.otter.canal.client中的类
+
+
canal connectors创建工具类
+
+
CanalConnectors() - 类 的构造器com.alibaba.otter.canal.client.CanalConnectors
+
 
+
CanalNodeAccessStrategy - com.alibaba.otter.canal.client中的接口
+
+
集群节点访问控制接口
+
+
check() - 类 中的方法com.alibaba.otter.canal.client.impl.running.ClientRunningMonitor
+
+
检查当前的状态
+
+
checkValid() - 接口 中的方法com.alibaba.otter.canal.client.CanalConnector
+
+
检查下链接是否合法 + + + 几种case下链接不合法: + 1.
+
+
checkValid() - 类 中的方法com.alibaba.otter.canal.client.impl.ClusterCanalConnector
+
 
+
checkValid() - 类 中的方法com.alibaba.otter.canal.client.impl.SimpleCanalConnector
+
 
+
ClientRunningData - com.alibaba.otter.canal.client.impl.running中的类
+
+
client running状态信息
+
+
ClientRunningData() - 类 的构造器com.alibaba.otter.canal.client.impl.running.ClientRunningData
+
 
+
ClientRunningListener - com.alibaba.otter.canal.client.impl.running中的接口
+
+
触发一下mainstem发生切换
+
+
ClientRunningMonitor - com.alibaba.otter.canal.client.impl.running中的类
+
+
clinet running控制
+
+
ClientRunningMonitor() - 类 的构造器com.alibaba.otter.canal.client.impl.running.ClientRunningMonitor
+
 
+
ClusterCanalConnector - com.alibaba.otter.canal.client.impl中的类
+
+
集群版本connector实现，自带了failover功能
+
+
ClusterCanalConnector(String, String, String, CanalNodeAccessStrategy) - 类 的构造器com.alibaba.otter.canal.client.impl.ClusterCanalConnector
+
 
+
ClusterNodeAccessStrategy - com.alibaba.otter.canal.client.impl中的类
+
+
集群模式的调度策略
+
+
ClusterNodeAccessStrategy(String, ZkClientx) - 类 的构造器com.alibaba.otter.canal.client.impl.ClusterNodeAccessStrategy
+
 
+
com.alibaba.otter.canal.client - 程序包 com.alibaba.otter.canal.client
+
 
+
com.alibaba.otter.canal.client.impl - 程序包 com.alibaba.otter.canal.client.impl
+
 
+
com.alibaba.otter.canal.client.impl.running - 程序包 com.alibaba.otter.canal.client.impl.running
+
 
+
connect() - 接口 中的方法com.alibaba.otter.canal.client.CanalConnector
+
+
链接对应的canal server
+
+
connect() - 类 中的方法com.alibaba.otter.canal.client.impl.ClusterCanalConnector
+
 
+
connect() - 类 中的方法com.alibaba.otter.canal.client.impl.SimpleCanalConnector
+
 
+
+ + + +

D

+
+
disconnect() - 接口 中的方法com.alibaba.otter.canal.client.CanalConnector
+
+
释放链接
+
+
disconnect() - 类 中的方法com.alibaba.otter.canal.client.impl.ClusterCanalConnector
+
 
+
disconnect() - 类 中的方法com.alibaba.otter.canal.client.impl.SimpleCanalConnector
+
 
+
+ + + +

G

+
+
get(int) - 接口 中的方法com.alibaba.otter.canal.client.CanalConnector
+
+
获取数据，自动进行确认，该方法返回的条件：尝试拿batchSize条记录，有多少取多少，不会阻塞等待
+
+
get(int, Long, TimeUnit) - 接口 中的方法com.alibaba.otter.canal.client.CanalConnector
+
+
获取数据，自动进行确认 + + + 该方法返回的条件： + a.
+
+
get(int) - 类 中的方法com.alibaba.otter.canal.client.impl.ClusterCanalConnector
+
 
+
get(int, Long, TimeUnit) - 类 中的方法com.alibaba.otter.canal.client.impl.ClusterCanalConnector
+
 
+
get(int) - 类 中的方法com.alibaba.otter.canal.client.impl.SimpleCanalConnector
+
 
+
get(int, Long, TimeUnit) - 类 中的方法com.alibaba.otter.canal.client.impl.SimpleCanalConnector
+
 
+
getAccessStrategy() - 类 中的方法com.alibaba.otter.canal.client.impl.ClusterCanalConnector
+
 
+
getAddress() - 类 中的方法com.alibaba.otter.canal.client.impl.running.ClientRunningData
+
 
+
getAddress() - 类 中的方法com.alibaba.otter.canal.client.impl.SimpleCanalConnector
+
 
+
getClientId() - 类 中的方法com.alibaba.otter.canal.client.impl.running.ClientRunningData
+
 
+
getCurrentConnector() - 类 中的方法com.alibaba.otter.canal.client.impl.ClusterCanalConnector
+
 
+
getPassword() - 类 中的方法com.alibaba.otter.canal.client.impl.ClusterCanalConnector
+
 
+
getPassword() - 类 中的方法com.alibaba.otter.canal.client.impl.SimpleCanalConnector
+
 
+
getRetryInterval() - 类 中的方法com.alibaba.otter.canal.client.impl.ClusterCanalConnector
+
 
+
getRetryTimes() - 类 中的方法com.alibaba.otter.canal.client.impl.ClusterCanalConnector
+
 
+
getSoTimeout() - 类 中的方法com.alibaba.otter.canal.client.impl.ClusterCanalConnector
+
 
+
getSoTimeout() - 类 中的方法com.alibaba.otter.canal.client.impl.SimpleCanalConnector
+
 
+
getUsername() - 类 中的方法com.alibaba.otter.canal.client.impl.ClusterCanalConnector
+
 
+
getUsername() - 类 中的方法com.alibaba.otter.canal.client.impl.SimpleCanalConnector
+
 
+
getWithoutAck(int) - 接口 中的方法com.alibaba.otter.canal.client.CanalConnector
+
+
不指定 position 获取事件，该方法返回的条件: 尝试拿batchSize条记录，有多少取多少，不会阻塞等待
+ canal 会记住此 client 最新的position。
+
+
getWithoutAck(int, Long, TimeUnit) - 接口 中的方法com.alibaba.otter.canal.client.CanalConnector
+
+
不指定 position 获取事件.
+
+
getWithoutAck(int) - 类 中的方法com.alibaba.otter.canal.client.impl.ClusterCanalConnector
+
 
+
getWithoutAck(int, Long, TimeUnit) - 类 中的方法com.alibaba.otter.canal.client.impl.ClusterCanalConnector
+
 
+
getWithoutAck(int) - 类 中的方法com.alibaba.otter.canal.client.impl.SimpleCanalConnector
+
 
+
getWithoutAck(int, Long, TimeUnit) - 类 中的方法com.alibaba.otter.canal.client.impl.SimpleCanalConnector
+
 
+
getZkClient() - 类 中的方法com.alibaba.otter.canal.client.impl.ClusterNodeAccessStrategy
+
 
+
+ + + +

I

+
+
initRunning() - 类 中的方法com.alibaba.otter.canal.client.impl.running.ClientRunningMonitor
+
 
+
isActive() - 类 中的方法com.alibaba.otter.canal.client.impl.running.ClientRunningData
+
 
+
+ + + +

N

+
+
newClusterConnector(List<? extends SocketAddress>, String, String, String) - 类 中的静态方法com.alibaba.otter.canal.client.CanalConnectors
+
+
创建带cluster模式的客户端链接，自动完成failover切换
+
+
newClusterConnector(String, String, String, String) - 类 中的静态方法com.alibaba.otter.canal.client.CanalConnectors
+
+
创建带cluster模式的客户端链接，自动完成failover切换，服务器列表自动扫描
+
+
newSingleConnector(SocketAddress, String, String, String) - 类 中的静态方法com.alibaba.otter.canal.client.CanalConnectors
+
+
创建单链接的客户端链接
+
+
nextNode() - 接口 中的方法com.alibaba.otter.canal.client.CanalNodeAccessStrategy
+
 
+
nextNode() - 类 中的方法com.alibaba.otter.canal.client.impl.ClusterNodeAccessStrategy
+
 
+
nextNode() - 类 中的方法com.alibaba.otter.canal.client.impl.SimpleNodeAccessStrategy
+
 
+
+ + + +

P

+
+
processActiveEnter() - 接口 中的方法com.alibaba.otter.canal.client.impl.running.ClientRunningListener
+
+
触发现在轮到自己做为active，需要载入上一个active的上下文数据
+
+
processActiveExit() - 接口 中的方法com.alibaba.otter.canal.client.impl.running.ClientRunningListener
+
+
触发一下当前active模式失败
+
+
+ + + +

R

+
+
releaseRunning() - 类 中的方法com.alibaba.otter.canal.client.impl.running.ClientRunningMonitor
+
 
+
rollback(long) - 接口 中的方法com.alibaba.otter.canal.client.CanalConnector
+
+
回滚到未进行 ack 的地方，指定回滚具体的batchId
+
+
rollback() - 接口 中的方法com.alibaba.otter.canal.client.CanalConnector
+
+
回滚到未进行 ack 的地方，下次fetch的时候，可以从最后一个没有 ack 的地方开始拿
+
+
rollback(long) - 类 中的方法com.alibaba.otter.canal.client.impl.ClusterCanalConnector
+
 
+
rollback() - 类 中的方法com.alibaba.otter.canal.client.impl.ClusterCanalConnector
+
 
+
rollback(long) - 类 中的方法com.alibaba.otter.canal.client.impl.SimpleCanalConnector
+
 
+
rollback() - 类 中的方法com.alibaba.otter.canal.client.impl.SimpleCanalConnector
+
 
+
+ + + +

S

+
+
setAccessStrategy(CanalNodeAccessStrategy) - 类 中的方法com.alibaba.otter.canal.client.impl.ClusterCanalConnector
+
 
+
setActive(boolean) - 类 中的方法com.alibaba.otter.canal.client.impl.running.ClientRunningData
+
 
+
setAddress(String) - 类 中的方法com.alibaba.otter.canal.client.impl.running.ClientRunningData
+
 
+
setClientData(ClientRunningData) - 类 中的方法com.alibaba.otter.canal.client.impl.running.ClientRunningMonitor
+
 
+
setClientId(short) - 类 中的方法com.alibaba.otter.canal.client.impl.running.ClientRunningData
+
 
+
setDelayTime(int) - 类 中的方法com.alibaba.otter.canal.client.impl.running.ClientRunningMonitor
+
 
+
setDestination(String) - 类 中的方法com.alibaba.otter.canal.client.impl.running.ClientRunningMonitor
+
 
+
setListener(ClientRunningListener) - 类 中的方法com.alibaba.otter.canal.client.impl.running.ClientRunningMonitor
+
 
+
setPassword(String) - 类 中的方法com.alibaba.otter.canal.client.impl.ClusterCanalConnector
+
 
+
setRetryInterval(int) - 类 中的方法com.alibaba.otter.canal.client.impl.ClusterCanalConnector
+
 
+
setRetryTimes(int) - 类 中的方法com.alibaba.otter.canal.client.impl.ClusterCanalConnector
+
 
+
setRollbackOnConnect(boolean) - 类 中的方法com.alibaba.otter.canal.client.impl.SimpleCanalConnector
+
 
+
setRollbackOnDisConnect(boolean) - 类 中的方法com.alibaba.otter.canal.client.impl.SimpleCanalConnector
+
 
+
setSoTimeout(int) - 类 中的方法com.alibaba.otter.canal.client.impl.ClusterCanalConnector
+
 
+
setSoTimeout(int) - 类 中的方法com.alibaba.otter.canal.client.impl.SimpleCanalConnector
+
 
+
setUsername(String) - 类 中的方法com.alibaba.otter.canal.client.impl.ClusterCanalConnector
+
 
+
setZkClient(ZkClientx) - 类 中的方法com.alibaba.otter.canal.client.impl.ClusterNodeAccessStrategy
+
 
+
setZkClient(ZkClientx) - 类 中的方法com.alibaba.otter.canal.client.impl.running.ClientRunningMonitor
+
 
+
setZkClientx(ZkClientx) - 类 中的方法com.alibaba.otter.canal.client.impl.SimpleCanalConnector
+
 
+
SimpleCanalConnector - com.alibaba.otter.canal.client.impl中的类
+
+
基于CanalServerWithNetty定义的网络协议接口，对于canal数据进行get/rollback/ack等操作
+
+
SimpleCanalConnector(SocketAddress, String, String, String) - 类 的构造器com.alibaba.otter.canal.client.impl.SimpleCanalConnector
+
 
+
SimpleCanalConnector(SocketAddress, String, String, String, int) - 类 的构造器com.alibaba.otter.canal.client.impl.SimpleCanalConnector
+
 
+
SimpleNodeAccessStrategy - com.alibaba.otter.canal.client.impl中的类
+
+
简单版本的node访问实现
+
+
SimpleNodeAccessStrategy(List<? extends SocketAddress>) - 类 的构造器com.alibaba.otter.canal.client.impl.SimpleNodeAccessStrategy
+
 
+
start() - 类 中的方法com.alibaba.otter.canal.client.impl.running.ClientRunningMonitor
+
 
+
stop() - 类 中的方法com.alibaba.otter.canal.client.impl.running.ClientRunningMonitor
+
 
+
subscribe(String) - 接口 中的方法com.alibaba.otter.canal.client.CanalConnector
+
+
客户端订阅，重复订阅时会更新对应的filter信息 + + + 说明： + a.
+
+
subscribe() - 接口 中的方法com.alibaba.otter.canal.client.CanalConnector
+
+
客户端订阅，不提交客户端filter，以服务端的filter为准
+
+
subscribe() - 类 中的方法com.alibaba.otter.canal.client.impl.ClusterCanalConnector
+
 
+
subscribe(String) - 类 中的方法com.alibaba.otter.canal.client.impl.ClusterCanalConnector
+
 
+
subscribe() - 类 中的方法com.alibaba.otter.canal.client.impl.SimpleCanalConnector
+
 
+
subscribe(String) - 类 中的方法com.alibaba.otter.canal.client.impl.SimpleCanalConnector
+
 
+
+ + + +

U

+
+
unsubscribe() - 接口 中的方法com.alibaba.otter.canal.client.CanalConnector
+
+
取消订阅
+
+
unsubscribe() - 类 中的方法com.alibaba.otter.canal.client.impl.ClusterCanalConnector
+
 
+
unsubscribe() - 类 中的方法com.alibaba.otter.canal.client.impl.SimpleCanalConnector
+
 
+
+ + + +

W

+
+
waitForActive() - 类 中的方法com.alibaba.otter.canal.client.impl.running.ClientRunningMonitor
+
+
阻塞等待自己成为active，如果自己成为active，立马返回
+
+
+A C D G I N P R S U W 
+ +
+ + + + + +
canal.client-1.0.13
+
+
+ + + +
+ +
+ + +
+ +

Copyright © 2013. All rights reserved.

+ + \ No newline at end of file diff --git a/apidocs/1.0.13/index.html b/apidocs/1.0.13/index.html new file mode 100644 index 00000000..64437a14 --- /dev/null +++ b/apidocs/1.0.13/index.html @@ -0,0 +1,68 @@ + + + + + + +canal client module for otter 1.0.13 1.0.13 API + + + + + + + + + +<noscript> +<div>您的浏览器已禁用 JavaScript。</div> +</noscript> +<h2>框架预警</h2> +<p>请使用框架功能查看此文档。如果看到此消息, 则表明您使用的是不支持框架的 Web 客户机。链接到<a href="overview-summary.html">非框架版本</a>。</p> + + + \ No newline at end of file diff --git a/apidocs/1.0.13/overview-frame.html b/apidocs/1.0.13/overview-frame.html new file mode 100644 index 00000000..5e25a5b5 --- /dev/null +++ b/apidocs/1.0.13/overview-frame.html @@ -0,0 +1,24 @@ + + + + + + +概览列表 (canal client module for otter 1.0.13 1.0.13 API) + + + + +

canal.client-1.0.13

+
所有类
+
+

程序包

+ +
+

 

+ + \ No newline at end of file diff --git a/apidocs/1.0.13/overview-summary.html b/apidocs/1.0.13/overview-summary.html new file mode 100644 index 00000000..fbd74fd0 --- /dev/null +++ b/apidocs/1.0.13/overview-summary.html @@ -0,0 +1,139 @@ + + + + + + +概览 (canal client module for otter 1.0.13 1.0.13 API) + + + + + + + +
+ + + + + +
canal.client-1.0.13
+
+
+ + + +
+ +
+ + +
+ +
+

canal.client-1.0.13

+
+
+ + + + + + + + + + + + + + + + + + + + +
程序包 
程序包说明
com.alibaba.otter.canal.client 
com.alibaba.otter.canal.client.impl 
com.alibaba.otter.canal.client.impl.running 
+
+ +
+ + + + + +
canal.client-1.0.13
+
+
+ + + +
+ +
+ + +
+ +

Copyright © 2013. All rights reserved.

+ + \ No newline at end of file diff --git a/apidocs/1.0.13/overview-tree.html b/apidocs/1.0.13/overview-tree.html new file mode 100644 index 00000000..77bdbc9f --- /dev/null +++ b/apidocs/1.0.13/overview-tree.html @@ -0,0 +1,148 @@ + + + + + + +类分层结构 (canal client module for otter 1.0.13 1.0.13 API) + + + + + + + +
+ + + + + +
canal.client-1.0.13
+
+
+ + + +
+ +
+ + +
+ +
+

所有程序包的分层结构

+程序包分层结构: + +
+
+

类分层结构

+ +

接口分层结构

+ +
+ +
+ + + + + +
canal.client-1.0.13
+
+
+ + + +
+ +
+ + +
+ +

Copyright © 2013. All rights reserved.

+ + \ No newline at end of file diff --git a/apidocs/1.0.13/package-list b/apidocs/1.0.13/package-list new file mode 100644 index 00000000..0bd99e75 --- /dev/null +++ b/apidocs/1.0.13/package-list @@ -0,0 +1,3 @@ +com.alibaba.otter.canal.client +com.alibaba.otter.canal.client.impl +com.alibaba.otter.canal.client.impl.running diff --git a/apidocs/1.0.13/resources/background.gif b/apidocs/1.0.13/resources/background.gif new file mode 100644 index 0000000000000000000000000000000000000000..f471940fde2f39ef8943a6af9569bcf986b1579b GIT binary patch literal 2313 zcmV+k3HJ6!Nk%w1VKM-40OkMy00030|NlK(aXwsfKV5S}VtGJbbVOr%L0@%CZH88Q zl{{NzcR^uxNo<2iYk@pjY)*5FJz8x~bc{)B zfk z+1T6M-s9WdW8dcJ-wO*3@9+W*5AY543-j^$^!EPz_4eHZ2#>)41`h@dc!2OAgN6$a zCS2I?;lqgx6IR4nkpTe;1RN0f=zxMq2O=q`94V5d$&e>Unta)^<;;^G3>e7yp=ZvW z6DIW3xpSvaogXF?_4%`@(V;s}NR^5J!3hrtJV@1QRV&r5S*L!zYE|rss${iFkg&!? zTN5V#)~=bmMorwgZsEpdOE)iExo+FO-8;8Kga{=HbSQCnF=E6W3?o*|ID%uwi5**> zJXy127Y9m+=HQ|PhXWi+xNwoWv}n_%Pq%(e+H~mGqhq5kv4Mo|-n~g|7!F*xZ{xv< zCpXS~dGg^IGK?4@J-T%b(XnUHFul6n<@2&4)zzyO2) z3Q8`i0+UKY*`$}e9mmp;tg*))`|PsK1|hAo%u0K$vDwm4gaSkm0j{`26k#qAKmbuhxZ#cquDR>B zD{s8+&TH-uNg$C#68QG}1HMBHfrP&L@@w$F_!itRzXdCN@V|LDAu%3!IDtq1#1UV7 z#1RxvT=B(DWbCoU5l=ia$Pp`Hgb_?Mp@hmtxZDI2N-)v#$}PXVvdm1d>@v(v`0TUJ zF)Pu89(q`zv=w^nVTIF3@3BYIPA}c`(@ZCAwbNBEt@PDUKe5CTR8aB66IE1!w%Amt zy+jpcn~k>GZpVFg+H6x{_uOksvBlq0OyT$6TyQZ37k(cOxZr|JEx1sGm<(M9gH z-~PMqyn|tT=))UN`|-FFFUA#KToK0fUOaz=7}Z~KeHhVC&%O27cTfHQ^WBU8z4p&T zp#>D|V}XShTD;Hx745Iz{`>K-Z$A|7!*Boo{mY;G21vjH8t{M!OrQc6$iN0V@PQDF zpadsK!3tXNf*8!81~qnXWuHZ)kytd=_y+ADWvw31ouV;CdZ#ya*(l7-A-C-Y^+iit8O zBy3*`Ls$|5Hn4m_^I^|C7{m7EFn|5vTk;|oywIgCc9Bb*=L+Y$)M>9GC<|HGs@6NB zHLY%03!dDf=eDRt2O6lVSFRcsuWZEwU?=z$CZ0W?#VJfdN>HG(l%oKpyiftJc|Y)xkjSJYCrQal-0PC~()T9xwF!Jf zVi1UA#3BBbh(i8r5&v#Pz!cF41KjbCc?4u2@@Q~oKLirt2TM30;y6b+zyX2`Yl9u; z`0$3;v0-YUp&7NdPT#q`cZlbij$jvbRk6R>8g*>}*b9E+WDwmpHAAxYzyT aU_pX{M6b8i>#Dq3onfZy}_nli%!Q$ZV%e&!tN2 zX3B0NWXQ443Eo1rUP86rLU>O>oTp%wt3Z{Tz&P*)Iraq^_@X;RtUFY!JxH|4U!>kw zxXwqo&R3Y=EsXaR!ng@y+y$%L1P3FZ4@N!j3m5MW74HcC->_JFuvlxLXiI=-OQ2|@ zpGc#>2-aN)<1RE9^`bB0`65VSK2>5m>CHs^YZCC)NX*NfbeT1%)Cxpu2_(6cCbLvjLY`hf1%*q}QO*%V4SfOu5Nqg~`-+(-76= za<`RA&(qDB^S!nIS^od5|Nk$KPXD8(qSB!f`M*{E?A^&yOW$08V^iNPK!%UNJ-@xmz>`pG2_%4I3QWk4UdtwP!GH$C%mo2K|$Ap=_)Y!#O($1@ohsUtR1k%wI*) z4*X&g==oWh`j{uP=HFm;Ye>0>UbDdtSp^~MaQ!L9I#)Ga?q}{@T#|qec*FkMLDenm zj^sCgk!^O^3o|vG!~2$$$7`C#4Ry zdQ!tui+J1*HyavK+4{`r+zvYHj9IsRt~@uEBOreWS8~2rXAR3!|7aTdr+x4|>@$Az z)b1t$gSB~6USxpfLmy^|_J_eNt*PI=ScO1SVH895N#`ef%IOh&o-2GIjK1s-JzkyZ z@r7O%hChz}kMHCM@Wqi^R-9t&%Fh^#9dVB0%ej@$=OjXA%XZdzCXf}c>SW26_z-Te z5b{}XWg&rELM=N*%aimp)k04t2c+`WAS>ZFIPWKvtyOI))HzpRA!T!b{tv?4NzF1v zNlP%#{&p@lFFEKvcroMAsI)mq?&`!e%l+-y&j9ZqhN}oG&dB=Pw09r+Q%m0cMujS# zs$a7!9VH`CC7k{!bV(J`rm%Jpj6&nLtWhPcy$onn$8G#ZdD9hxO<9k67Ya>K_7W~3 z&KYf14fq<{qHA7u6;>AOcomhdg?ianjr9uINt}*7w?g%z9{Q`(qRo@hDwSpGmxz&h&>%G%T(URL~=c>C{>y$K?+wLFp zy*M1@FTUKYV>8DeDIAIKM+!T5c-k&C4?Y~y^E zQCIc-=9~DiPtfVZB=_c3`qH3h|NXd^BcOQG`funSe)i5!NoA_r{b6PwzSDIXG+!(F z9CqJgo&~#7^VZHWj{u23q+NDCHn}GeWDC*(SW%{f4WMtP3l2jsO7*M)EX)#NLlsNnU4q@#jn0r#rsWsf^ngE0&ambG1f;Rj zfOk#_>1|25Z%?iI{0Yv8)DQfk>m1td?~}m0N%^k^u%EuUCc#ItmlY|epQ3YLWehYw zRU0qpPb#X&WU*UOU8et(s8x~WyYWYsgJCF+;U6@*nICY8)dk}IG+(#_Bz8zURd3HZ6qPE68U1%S{wL0 z;K{PDw2iRFIGG?(UiE9kT9?siuv4O{ z`dX2-eiXU3N)H2nT4V=AO^~J}sw+gr{&~qx%$$wlMv_JCWAMfcjYl}*Cfcf!adOY8 z8oLmJ{%49e+nLiVo#H9}wRk?UCzDz^>9TDxreVHzl~R*)?YU>Uu;J2eQ27O5`&X^8 z`94{)YWJQa#l0Fbz0N6B>j&8J;<%VuG6OYM9&QIdtueWjI3X;*dEtGiF@1AcvN4U> zG5SXIEXxB>)!mtQOztJLyeF78S*kLiU-!>PtQ_s~OMl~&y(hVVe$A5 zwo}E-DJ6${QP75?LsQ}Wl@MXwXMT4d>|?rD!g?jE>J^N*y;X}5FLe%d0_ zZ>eIBK6l@jkfw{p_YiDP;MS{jww{%j#?rk2z1J!HqE;Vd!TrCl_7UPef8;edI}wD6 zT&12Bxj&q}d4%$GHq+$~UYtWv`wI9k`89oKkCEK_E;-+O)(rhThjOM|kXDn{!W1Lo z`_?yQv=lp=-w()R<=0&c5%RWHY_fw@qb}uwFuPAGkl~@Kis}eE%MY@~6ZyWcF+llM zGyK`)(vn1F%%z=W7-Y=1$`w0Mv+-|#d};%JjCmw)Y1hOxwA|{}P%6LS4X`jQCGh`mR@=hGrr|cXa^Ipj;Mh)6mTqd1s_HmP0IxXT!w7YhoIHT>Hm#!;c@|L9OjV zsTlHE{Z;HWeM9^tPm-`|&nnl$%DRtNG1~?npUvgKPwKlaccEe4q!7YU3zykJnu6Sr z()LMXs_)^~u-ds7+wMff)RAJF?2?1H`_wDnt%MssYeB5;q~ojgVm6OHA6B>FG2erv z8&`|6<`=!EPKR^8Qlp5MiKwfxy4D`mN> ze$RKh_6*YJd4y0nnUZvwN%iY&^9xk@cM|5g#pZkc#N*(PH?^w&?ilTDMXFcd0`5!E zvgHS`=Lc|~1aO=L@L~eE*aP{90lc7qXY7GOs)3JH14T{(`K1D%tpvUT1-?F^1d4_S zJ#7yXkP3Q37bJlRQfv=mV-J3B8O*m5B%L3uW)S>|Jwy`|s6iK`sv0Z-3NcU(0knrG z5ChFXA@A9PUSdLI+(VU!!J1Mbw!~0VP^jZci2X|Nx0BF!24ObrAr>b=QtlyN4TAhn z!mQncJm~^m4MIafVLt_ewDUtO+e5w*!`(6A&H^F7i9s4t5&uBpNvh$nlTZjqTM5krNRRQ zqP)VR!|9@H>7qN_!+-)&_9s!^;gOvy5s~iEB&qP8{77&2NJMzZcsnJgSt_bYDzYU% zxQ#uuk3D*e7_*d5^?HW(^(WxICGf-mcmM((VStzIz%zFsm0;ZI3h=5OciJ#a%7I(IeGbFv+PP^?^sKBPrRBl<+qK^o%3fi=L9`la>-l4~p|hzAl~W zf=%(|NHgF7r5dJD+Cf08q-c(m;Epsldaz4cqHzTHT>)4xEe(cE0i~tf{Y0xs_1~Kv z+BYQ-TpEOch13;5YC9nHYEXhSv{ew=LV~nQL%UBQEgaDL2m?9u~v zEQmOvM=aB)Z$+eE38rs%AZR_)4>@2raqwH#Fji#xoLc&PS_TU^W8W(M0GqLdO~1yF z{sfHZ_sC#FX58(}d>RSkKZCz8%D7{cC3Z$Zh@52{31&V*W-@s~Z<8~aBeNcNW?e&O zsR(7fHOf}B&fsRqdZ(WK1e~s*o^uD6{YX9QJvqyWAqQXt*E>r$V94YK=X@8+{1cg> z*_i`a%alCJvbD~lCg&Q1Gk=|BzY)sejf9EHJ{s7lu4?ExCWR3jgTiET;exy{sW!Mg zuj*_YOf0@ScN~X0$7V6&KpL172rf|rA8?K<2+GelXw)NUk#@b4aT5MO%1ip4*ym}B-JI__S1R?CK z<4eW~bH;@H@tR55x}&JNSw_NvEPk)6E>XDt7*)4sgWuw+_vNZzmaS(tsi(57zcjA9 z@~XcHtzYq~IX|z*Md9mh>W~`sk3<^s7;EmyH4wcTdAo5NkUA2ofeG69{Gx7#i_*lt zQ7;N@xEo#nNRj&SbDHNnP0w#OE0{DZ$~7ySG%IN~zwd5Vu4&dnH>*OMb>&*VL^tbA zG;7y1t9dsYU$p3pw0x6mwGe6fjBYWsZ8e3q8f~-~cefgHxBangajI$kv(c*W-DZGp zbM$UgnP{_MYPXYX|6$u^deIhE(-xuGX2RVXqS+o~(iSV%;ZW1=Zqkut(r&xak^pT> zsp*I@X|-eOd^gb+sM(%3(E$|c47Y91mTU99Xe;4vFOTl5gmwVB+fvc3n2pwK?~Xd# zwrY{?CUj@~Msr?wXU0WKv2A$hq z`$V^gNq4(<*C=;4e4}$*uIC$5&uUHkM08J~N$>VV*VpdmLCuc!?!J9=-)VH;fo9)| zNN4m#^Kb9|`RF!^ZAT-z=bC8$do8~Tjc^o-aQjyc2(TW*d50E1#NW0pKb^~tf&OUlS+W}>0!m@!~1 z&TdSLhm`0u99c-z=oxYL8IFaGCDoFwFUP!1iJ%xF1UC4hhv*VR2451Pc0+kQGC)39C5 za81oV=$+xzZNYhn=RB-CTZ>Bevj)A3mi9|OS(dcy=N#Zm=Dza|z4Jd<=3IQ2CB>FiwH7{4Ej#+oa>M67 z!56)Km&2xJ|H7B;%~rJDuJ{rbZQiaX*e^$DEt~T$#h9(y#jg6>uX?boq!N}Q;EQth zYo1rjc15dETPw~*Ymu=lreoE9g^wb)ZcRe1yp1(Eo(rmqUYZXOU$BC_| zX{{&qE?E06wXm#v#cpKwE)jaydSaI`TkCCClr_lKMzPkyFT!R%VRn&sZSrchKx&4e~pJQcfViQxxl=T=7}#gYz7Pvoh`T#Jbab%2A2m zxh?A<`}A?8_GumBEcL;$x%gQb@PZ(If%ZE~D?ax#Km4a~+GV~!;Bb~qxxh@HHc|H6 zr%$^c9Dw~UQFWJv+81rCXS1vqqLfQ~-BtO63xCArGVA4T-}xPXYGHqB5h^+n5%$24 z(BROpi13J@*qFfR$oRMHel`=(zy zovs-UKHD3VkJ?hVeq!aA+8Fh4+NIlFhcC~UrR{4I#}K*u&z%68+P1*=q0B1r*2MY> z!9gYs*vlTO5v#8S>c#3goFmp>3iVKdU)NkjNV(s7tO4Wq?2M}o5Cj-*7;S=fEshOA zR*4$dm{ROvUamG%xL_tSW6}U$Nl=@91T;nC11o-iIVyVrfkd) zTCp;^tOy|_kuOFV$Nn=$AQJO9;&sZ&eDs^!r*m;Hw!)vpO1vcfj2EV{dJ?7ap0tq6 z$SwUVM*Vt+MS_`;bas-svPV|3POQi8G~?f^KOx4hg1He+Wd*s3Hl1{TfJS-+zv6vc zPoKiwr?7wECbub(IdB)9f_!kmUjBR*KY_z4E8_QA9xSr#G&@i5y^H`jB^I{|akh>W z%Cn3luOVY|8P>u>e^~#{$kmgX&-q>k{#pFbm2({(rtG<%nb0UCQ0%{Cy`F&~7}*we z@Of>ND_)V&XwN_+n~KjVorUQWZ*B6cld7ymQl{;rwlHl34K#}2YWxE+4CX@P&u6AfCda`&ZT1MOY69e-L@gNcAvwx8%1Z7lB4zc=_Cpt~&s ze%?;){1DB(PSK!^za967qF?lIjB~&06}Lf`cgh2qUiI^|$-VCTNE=hp&Ij}^A9&|* zQQrSqo3gn#_=z9j(y6f@T|OkJYv(fjwpz}$*U$|nLH2F zPNMuTS4g8 z*^hOlRh6~Mk}58;d477R>F^~aLO$dOXmhA*6zwIaHK()t2zKjo?j^NOJbh_=+71xg zO{Mgp7x?Z-1MKzoQ<+V2g#|e}|JawOPJZBL{o~PYdtWDX?jl##!Aiq|w>)vGJLipp zBK1xGhcvgSsQ;rn>+`>UmxlID{<~}7{y>SO^cyktN^Fsz!Z|B4?p*RKQG*8}SYBt{ zuFO{vJ?jgL{gUzYsnv(io}c0vlCp#*1vE?}KL^UZ&VF^TK+D;40CxX%j);%dCt;Z{ zAeMXC9JPWvKGwsCxx4w2iv_wNGG8l16AVI93rmc^c1>r(P||YE zpXa+=-&k995hfykL^J5S&vJF^ljR&`FE#ppNMM3%Omc!F)Mn{{&Ip#)JegbEJxud2 zn`wDVB~DMii5|H%m~51YeU1juNG3!+&?*uC#q@)z8q~`4yEL5I8}PtyA1IZ=52P$x zX)KhZt z7czUXBsy-8d`GVQ`90`wIh(Xt7v5j7h0t&ET~2M!Tb~4rN-xtK@8@mB*c(6QTwOS- z%9445_WY|cfm4?$nX$72&{~^mu}an^x^Da%=UU6YI;ur3+9L6I>raW5!=-Nzy(F2Z zwZlg7aM3NN5b{K|FB>s4R}|&Lr32_Ys{wwkECxo|rV@;5aHB25iUs7(6@dDpjN{Y%?C~UGp>*Q}K?)KKk64 zAn;@-dER}QG0L${jQ1cR75eM3-~ZTltTQ8%sm9x4Y`ve@ekMuvpA#Rh51@s6;6^&Q z!&M7^b%cea7FlZkPV9}@!bPBBfB&~XvGlE2T7V?IpM~OBmuK;OSt{~N`rL5c_I^de z9n*=@p|l;d`b_YIn8Aem1t7pp0=2-MCTIcJHlY z6x+mNLgi{JpwP)y(yzAFL2A#>bI&EwZE`PGvd*FQ!rx~6bUN&+Ij3)L;=595L#G;m8*^e?ap1`J5w7-q)*iUT_W9w8 z&xS-`i++HpWzY-a-)CWd0(pLW$A85P{Dy9r-=uPekNpN^yA}pJ7yWTZ>3iw4d6+IK zF%1XXkGcJm{0*vhSG5R1ySW;jctk9O==1-Mk?=Bl<{HE1p_@tx1s^+GoczYxj#B=i=kwQvEPrOt`<4W*pJw zbNjEqpr7B|Llc%m{V*QssV)im;pb00LUob=yFaU4`P_}ywU zt*QZl-bUsmh@L&zQaX4uHL&7YD(BOb9hH;;y;O-b-_O$4EFi1vCrMlz`dN|u?}HNO^aFQV{UZg_yy%nf>IXpulip!cR8|vNu7P*; zQye@}Qmj%(TB6`5E=c~w=LITF266XJ6X5xA7!OM1SE=~N*o3EP5Qqx!W<_+EMSLGo zqkC18AQ=0AK9=hgGQtrTovYc5^?Z^RLX?hlO-j&e1MXTTbfm>MS^=}!p>C>icUKdZ zBcNOb(6IJ!kq*e7N8Fx!!kPyn+2B2^2hd00+W^PUA&+S63jFE)bP5Tv+L5l~n(pu? zbeO|+K{{?pEow3?j0+dGVu)a6(0r{1Uj7{3 zxSsZ|BdMk>1-S}-;+`pk{Q5>H=tLRx+YqeenaSRsEX@gtPzz>j1A9g!C9kGtspY(- z%YL>NkVDE2z@}*;Q{=&5)yS;NupAmmibGUE4qte7aY6PcnXJgw>}ad(SW;@HtNurF ziV0_yHz=;Di%Tki6DW^tjkL`t%Ktct(ay zvuAOYoCu!Pm~@P5CIjk$bp`_iv{^l*Au{fB8mJK1>Macv?GL)**8*+JNvySIH5Y7i#1;!%NT!efc z;Z0*AOM&1VpR+6wIQxBM{xf`8T1V@#e<#QL}=YRwMkWG8%1(Fgj{iX)N zup{Txko(DqJWf=#Oi?Z!nra-?C{);TP`w|4>L+EKx1&P3swX<*#_50F!lD_$nQyuK??!UwA-{y)^QmMxoK1xIJ~uML{u;5!Z5tQyEL>;KaUd!_9FP zl2$QOI6V1`QdF|8gkdZsSpUqCjSBu(1H)r*vL#PEy)@Px>5TIk7_9o#Bj zzD&<1_k(ejk%qO6ak=GMmG5b7LTAA^KKq-Ey#z8(2wy2;Ot^oZI(MG@)~iY$RAnJt zu`ioyvR?Vws_tuK9hDqmel+)bP0kyxJV{7t=&3{b(@Hs1fs$9n45aq)IKknZa2H*7 z^P-ZDyOMdMj&-9{(-?dqo5I3Gy=K$!L%q>3^0N~o^2i0^_@^2nQv>S4B&=5_8^a^V zaY!NjyA5QgO&r#^CJcp&=!))MZ*CC&hvLEzWU*!IO=aYo{_yG+53H$XOAIQWnG`uD zLuuwTY6e8N^m5^AHQa}Y5Z#SdbEY;+x{oW?g;ie4CNYomRyQd2mv^L}T!>a5<*wTh>@>Qtwp~nejn`~DcZJI+QC-xU zoxz=5z0k%1;jBrGI%Th~FQElrAPr?E-Fv9|o09dPk=?>f)jFKL8PK|;w(cVDq>YWP zEfL7RGBv|<>f4IccND3wCi*V8`>#a$FPZu&a{V`W`me+Kuf_CJ)%IV%?5ByL^#3Q{ z&uBM5|34IKI>0_Tz{5OngXe#6w*N6;;5PH%9n%56%RaWA{wJ4%515Apdj`a62bp<> zM12OuV+QZ^55ATkViO(UWgg}%9C}kb^r~=BiDyWIXZWM&kb>Q?dd$#W`4KU|2#4qh zz;sZ>ZqS5h#Kdk$&1c9AHmDUdtmHE)CqH0RIAZEE;t(^+RXF+*FlJyk;?6Vn{&MsO zZ0HwY)b4Va!F1#s^N5$-s9(&mPa*Lu4>4SxXm~l|3?PR2jB1J!Q|(4#0i$lFME^-r zA~Q(2O+PHOdcVN((R8zqi>%+yx4PA5u&+jI zZ?)Fm8m-+`n!Bnrx0PvZE7!Q)Z+NTE@K(R!nO40sZF(n~bq_b_9H`UYU#q>pPJ3UC z_UeU>J7qcy%%`ks9)BNcS^GDOn z?oKkjHNoWO1e2?M#vd12e^_AscAnLnc~-CISiYWX`D%{k^H~<37unpMYJYdSv=Om2vbAM@`Qp{{SI=yP zj6WN*eEt0G$9EPX6FU%)-ho>hWTW!yzXBIo73<0umM-=@eG&niY^` zlG(|vuCl_x(X^Fob@=i{8+M5vWf7Bz=#aHGTNA;fZQyfbfueI8Z^639n`(DI%w^-^ zl`=@!u)r~Xf920-xd$Ab+S&PJY%K0H8a_J8uN3^_!K1_NV$*e#*Y*6|)XpiW=9H`*`Xx7W%v@7{XDma1?v0a%(K6rI&1!a YpWXKgmku8Vj|K)Vje`mzEKCg608Q#dYybcN literal 0 HcmV?d00001 diff --git a/apidocs/1.0.13/stylesheet.css b/apidocs/1.0.13/stylesheet.css new file mode 100644 index 00000000..7f1f6e73 --- /dev/null +++ b/apidocs/1.0.13/stylesheet.css @@ -0,0 +1,474 @@ +/* Javadoc style sheet */ +/* +Overall document style +*/ +body { + background-color:#ffffff; + color:#353833; + font-family:Arial, Helvetica, sans-serif; + font-size:76%; + margin:0; +} +a:link, a:visited { + text-decoration:none; + color:#4c6b87; +} +a:hover, a:focus { + text-decoration:none; + color:#bb7a2a; +} +a:active { + text-decoration:none; + color:#4c6b87; +} +a[name] { + color:#353833; +} +a[name]:hover { + text-decoration:none; + color:#353833; +} +pre { + font-size:1.3em; +} +h1 { + font-size:1.8em; +} +h2 { + font-size:1.5em; +} +h3 { + font-size:1.4em; +} +h4 { + font-size:1.3em; +} +h5 { + font-size:1.2em; +} +h6 { + font-size:1.1em; +} +ul { + list-style-type:disc; +} +code, tt { + font-size:1.2em; +} +dt code { + font-size:1.2em; +} +table tr td dt code { + font-size:1.2em; + vertical-align:top; +} +sup { + font-size:.6em; +} +/* +Document title and Copyright styles +*/ +.clear { + clear:both; + height:0px; + overflow:hidden; +} +.aboutLanguage { + float:right; + padding:0px 21px; + font-size:.8em; + z-index:200; + margin-top:-7px; +} +.legalCopy { + margin-left:.5em; +} +.bar a, .bar a:link, .bar a:visited, .bar a:active { + color:#FFFFFF; + text-decoration:none; +} +.bar a:hover, .bar a:focus { + color:#bb7a2a; +} +.tab { + background-color:#0066FF; + background-image:url(resources/titlebar.gif); + background-position:left top; + background-repeat:no-repeat; + color:#ffffff; + padding:8px; + width:5em; + font-weight:bold; +} +/* +Navigation bar styles +*/ +.bar { + background-image:url(resources/background.gif); + background-repeat:repeat-x; + color:#FFFFFF; + padding:.8em .5em .4em .8em; + height:auto;/*height:1.8em;*/ + font-size:1em; + margin:0; +} +.topNav { + background-image:url(resources/background.gif); + background-repeat:repeat-x; + color:#FFFFFF; + float:left; + padding:0; + width:100%; + clear:right; + height:2.8em; + padding-top:10px; + overflow:hidden; +} +.bottomNav { + margin-top:10px; + background-image:url(resources/background.gif); + background-repeat:repeat-x; + color:#FFFFFF; + float:left; + padding:0; + width:100%; + clear:right; + height:2.8em; + padding-top:10px; + overflow:hidden; +} +.subNav { + background-color:#dee3e9; + border-bottom:1px solid #9eadc0; + float:left; + width:100%; + overflow:hidden; +} +.subNav div { + clear:left; + float:left; + padding:0 0 5px 6px; +} +ul.navList, ul.subNavList { + float:left; + margin:0 25px 0 0; + padding:0; +} +ul.navList li{ + list-style:none; + float:left; + padding:3px 6px; +} +ul.subNavList li{ + list-style:none; + float:left; + font-size:90%; +} +.topNav a:link, .topNav a:active, .topNav a:visited, .bottomNav a:link, .bottomNav a:active, .bottomNav a:visited { + color:#FFFFFF; + text-decoration:none; +} +.topNav a:hover, .bottomNav a:hover { + text-decoration:none; + color:#bb7a2a; +} +.navBarCell1Rev { + background-image:url(resources/tab.gif); + background-color:#a88834; + color:#FFFFFF; + margin: auto 5px; + border:1px solid #c9aa44; +} +/* +Page header and footer styles +*/ +.header, .footer { + clear:both; + margin:0 20px; + padding:5px 0 0 0; +} +.indexHeader { + margin:10px; + position:relative; +} +.indexHeader h1 { + font-size:1.3em; +} +.title { + color:#2c4557; + margin:10px 0; +} +.subTitle { + margin:5px 0 0 0; +} +.header ul { + margin:0 0 25px 0; + padding:0; +} +.footer ul { + margin:20px 0 5px 0; +} +.header ul li, .footer ul li { + list-style:none; + font-size:1.2em; +} +/* +Heading styles +*/ +div.details ul.blockList ul.blockList ul.blockList li.blockList h4, div.details ul.blockList ul.blockList ul.blockListLast li.blockList h4 { + background-color:#dee3e9; + border-top:1px solid #9eadc0; + border-bottom:1px solid #9eadc0; + margin:0 0 6px -8px; + padding:2px 5px; +} +ul.blockList ul.blockList ul.blockList li.blockList h3 { + background-color:#dee3e9; + border-top:1px solid #9eadc0; + border-bottom:1px solid #9eadc0; + margin:0 0 6px -8px; + padding:2px 5px; +} +ul.blockList ul.blockList li.blockList h3 { + padding:0; + margin:15px 0; +} +ul.blockList li.blockList h2 { + padding:0px 0 20px 0; +} +/* +Page layout container styles +*/ +.contentContainer, .sourceContainer, .classUseContainer, .serializedFormContainer, .constantValuesContainer { + clear:both; + padding:10px 20px; + position:relative; +} +.indexContainer { + margin:10px; + position:relative; + font-size:1.0em; +} +.indexContainer h2 { + font-size:1.1em; + padding:0 0 3px 0; +} +.indexContainer ul { + margin:0; + padding:0; +} +.indexContainer ul li { + list-style:none; +} +.contentContainer .description dl dt, .contentContainer .details dl dt, .serializedFormContainer dl dt { + font-size:1.1em; + font-weight:bold; + margin:10px 0 0 0; + color:#4E4E4E; +} +.contentContainer .description dl dd, .contentContainer .details dl dd, .serializedFormContainer dl dd { + margin:10px 0 10px 20px; +} +.serializedFormContainer dl.nameValue dt { + margin-left:1px; + font-size:1.1em; + display:inline; + font-weight:bold; +} +.serializedFormContainer dl.nameValue dd { + margin:0 0 0 1px; + font-size:1.1em; + display:inline; +} +/* +List styles +*/ +ul.horizontal li { + display:inline; + font-size:0.9em; +} +ul.inheritance { + margin:0; + padding:0; +} +ul.inheritance li { + display:inline; + list-style:none; +} +ul.inheritance li ul.inheritance { + margin-left:15px; + padding-left:15px; + padding-top:1px; +} +ul.blockList, ul.blockListLast { + margin:10px 0 10px 0; + padding:0; +} +ul.blockList li.blockList, ul.blockListLast li.blockList { + list-style:none; + margin-bottom:25px; +} +ul.blockList ul.blockList li.blockList, ul.blockList ul.blockListLast li.blockList { + padding:0px 20px 5px 10px; + border:1px solid #9eadc0; + background-color:#f9f9f9; +} +ul.blockList ul.blockList ul.blockList li.blockList, ul.blockList ul.blockList ul.blockListLast li.blockList { + padding:0 0 5px 8px; + background-color:#ffffff; + border:1px solid #9eadc0; + border-top:none; +} +ul.blockList ul.blockList ul.blockList ul.blockList li.blockList { + margin-left:0; + padding-left:0; + padding-bottom:15px; + border:none; + border-bottom:1px solid #9eadc0; +} +ul.blockList ul.blockList ul.blockList ul.blockList li.blockListLast { + list-style:none; + border-bottom:none; + padding-bottom:0; +} +table tr td dl, table tr td dl dt, table tr td dl dd { + margin-top:0; + margin-bottom:1px; +} +/* +Table styles +*/ +.contentContainer table, .classUseContainer table, .constantValuesContainer table { + border-bottom:1px solid #9eadc0; + width:100%; +} +.contentContainer ul li table, .classUseContainer ul li table, .constantValuesContainer ul li table { + width:100%; +} +.contentContainer .description table, .contentContainer .details table { + border-bottom:none; +} +.contentContainer ul li table th.colOne, .contentContainer ul li table th.colFirst, .contentContainer ul li table th.colLast, .classUseContainer ul li table th, .constantValuesContainer ul li table th, .contentContainer ul li table td.colOne, .contentContainer ul li table td.colFirst, .contentContainer ul li table td.colLast, .classUseContainer ul li table td, .constantValuesContainer ul li table td{ + vertical-align:top; + padding-right:20px; +} +.contentContainer ul li table th.colLast, .classUseContainer ul li table th.colLast,.constantValuesContainer ul li table th.colLast, +.contentContainer ul li table td.colLast, .classUseContainer ul li table td.colLast,.constantValuesContainer ul li table td.colLast, +.contentContainer ul li table th.colOne, .classUseContainer ul li table th.colOne, +.contentContainer ul li table td.colOne, .classUseContainer ul li table td.colOne { + padding-right:3px; +} +.overviewSummary caption, .packageSummary caption, .contentContainer ul.blockList li.blockList caption, .summary caption, .classUseContainer caption, .constantValuesContainer caption { + position:relative; + text-align:left; + background-repeat:no-repeat; + color:#FFFFFF; + font-weight:bold; + clear:none; + overflow:hidden; + padding:0px; + margin:0px; +} +caption a:link, caption a:hover, caption a:active, caption a:visited { + color:#FFFFFF; +} +.overviewSummary caption span, .packageSummary caption span, .contentContainer ul.blockList li.blockList caption span, .summary caption span, .classUseContainer caption span, .constantValuesContainer caption span { + white-space:nowrap; + padding-top:8px; + padding-left:8px; + display:block; + float:left; + background-image:url(resources/titlebar.gif); + height:18px; +} +.overviewSummary .tabEnd, .packageSummary .tabEnd, .contentContainer ul.blockList li.blockList .tabEnd, .summary .tabEnd, .classUseContainer .tabEnd, .constantValuesContainer .tabEnd { + width:10px; + background-image:url(resources/titlebar_end.gif); + background-repeat:no-repeat; + background-position:top right; + position:relative; + float:left; +} +ul.blockList ul.blockList li.blockList table { + margin:0 0 12px 0px; + width:100%; +} +.tableSubHeadingColor { + background-color: #EEEEFF; +} +.altColor { + background-color:#eeeeef; +} +.rowColor { + background-color:#ffffff; +} +.overviewSummary td, .packageSummary td, .contentContainer ul.blockList li.blockList td, .summary td, .classUseContainer td, .constantValuesContainer td { + text-align:left; + padding:3px 3px 3px 7px; +} +th.colFirst, th.colLast, th.colOne, .constantValuesContainer th { + background:#dee3e9; + border-top:1px solid #9eadc0; + border-bottom:1px solid #9eadc0; + text-align:left; + padding:3px 3px 3px 7px; +} +td.colOne a:link, td.colOne a:active, td.colOne a:visited, td.colOne a:hover, td.colFirst a:link, td.colFirst a:active, td.colFirst a:visited, td.colFirst a:hover, td.colLast a:link, td.colLast a:active, td.colLast a:visited, td.colLast a:hover, .constantValuesContainer td a:link, .constantValuesContainer td a:active, .constantValuesContainer td a:visited, .constantValuesContainer td a:hover { + font-weight:bold; +} +td.colFirst, th.colFirst { + border-left:1px solid #9eadc0; + white-space:nowrap; +} +td.colLast, th.colLast { + border-right:1px solid #9eadc0; +} +td.colOne, th.colOne { + border-right:1px solid #9eadc0; + border-left:1px solid #9eadc0; +} +table.overviewSummary { + padding:0px; + margin-left:0px; +} +table.overviewSummary td.colFirst, table.overviewSummary th.colFirst, +table.overviewSummary td.colOne, table.overviewSummary th.colOne { + width:25%; + vertical-align:middle; +} +table.packageSummary td.colFirst, table.overviewSummary th.colFirst { + width:25%; + vertical-align:middle; +} +/* +Content styles +*/ +.description pre { + margin-top:0; +} +.deprecatedContent { + margin:0; + padding:10px 0; +} +.docSummary { + padding:0; +} +/* +Formatting effect styles +*/ +.sourceLineNo { + color:green; + padding:0 30px 0 0; +} +h1.hidden { + visibility:hidden; + overflow:hidden; + font-size:.9em; +} +.block { + display:block; + margin:3px 0 0 0; +} +.strong { + font-weight:bold; +} \ No newline at end of file