From d479253768d296a40b4f699e1de9b03c7146a97a Mon Sep 17 00:00:00 2001 From: Jesse Morgan Date: Tue, 3 Dec 2013 14:03:28 -0800 Subject: Adding javadocs and Carbonado User Guide --- .../amazon/carbonado/capability/Capability.html | 172 +++++++ .../capability/GroupAccessCapability.html | 220 ++++++++ .../amazon/carbonado/capability/GroupMembers.html | 215 ++++++++ .../com/amazon/carbonado/capability/IndexInfo.html | 294 +++++++++++ .../carbonado/capability/IndexInfoCapability.html | 225 +++++++++ .../carbonado/capability/RemoteProcedure.Call.html | 383 ++++++++++++++ .../capability/RemoteProcedure.Reply.html | 330 ++++++++++++ .../capability/RemoteProcedure.Request.html | 288 +++++++++++ .../carbonado/capability/RemoteProcedure.html | 268 ++++++++++ .../capability/RemoteProcedureCapability.html | 237 +++++++++ .../capability/ResyncCapability.Listener.html | 561 +++++++++++++++++++++ .../carbonado/capability/ResyncCapability.html | 300 +++++++++++ .../carbonado/capability/ShutdownCapability.html | 277 ++++++++++ .../capability/StorableInfoCapability.html | 265 ++++++++++ .../carbonado/capability/class-use/Capability.html | 478 ++++++++++++++++++ .../class-use/GroupAccessCapability.html | 117 +++++ .../capability/class-use/GroupMembers.html | 161 ++++++ .../carbonado/capability/class-use/IndexInfo.html | 266 ++++++++++ .../capability/class-use/IndexInfoCapability.html | 117 +++++ .../capability/class-use/RemoteProcedure.Call.html | 186 +++++++ .../class-use/RemoteProcedure.Reply.html | 186 +++++++ .../class-use/RemoteProcedure.Request.html | 162 ++++++ .../capability/class-use/RemoteProcedure.html | 161 ++++++ .../class-use/RemoteProcedureCapability.html | 117 +++++ .../class-use/ResyncCapability.Listener.html | 165 ++++++ .../capability/class-use/ResyncCapability.html | 117 +++++ .../capability/class-use/ShutdownCapability.html | 161 ++++++ .../class-use/StorableInfoCapability.html | 117 +++++ .../amazon/carbonado/capability/package-frame.html | 36 ++ .../carbonado/capability/package-summary.html | 238 +++++++++ .../amazon/carbonado/capability/package-tree.html | 157 ++++++ .../amazon/carbonado/capability/package-use.html | 420 +++++++++++++++ 32 files changed, 7397 insertions(+) create mode 100644 apidocs/com/amazon/carbonado/capability/Capability.html create mode 100644 apidocs/com/amazon/carbonado/capability/GroupAccessCapability.html create mode 100644 apidocs/com/amazon/carbonado/capability/GroupMembers.html create mode 100644 apidocs/com/amazon/carbonado/capability/IndexInfo.html create mode 100644 apidocs/com/amazon/carbonado/capability/IndexInfoCapability.html create mode 100644 apidocs/com/amazon/carbonado/capability/RemoteProcedure.Call.html create mode 100644 apidocs/com/amazon/carbonado/capability/RemoteProcedure.Reply.html create mode 100644 apidocs/com/amazon/carbonado/capability/RemoteProcedure.Request.html create mode 100644 apidocs/com/amazon/carbonado/capability/RemoteProcedure.html create mode 100644 apidocs/com/amazon/carbonado/capability/RemoteProcedureCapability.html create mode 100644 apidocs/com/amazon/carbonado/capability/ResyncCapability.Listener.html create mode 100644 apidocs/com/amazon/carbonado/capability/ResyncCapability.html create mode 100644 apidocs/com/amazon/carbonado/capability/ShutdownCapability.html create mode 100644 apidocs/com/amazon/carbonado/capability/StorableInfoCapability.html create mode 100644 apidocs/com/amazon/carbonado/capability/class-use/Capability.html create mode 100644 apidocs/com/amazon/carbonado/capability/class-use/GroupAccessCapability.html create mode 100644 apidocs/com/amazon/carbonado/capability/class-use/GroupMembers.html create mode 100644 apidocs/com/amazon/carbonado/capability/class-use/IndexInfo.html create mode 100644 apidocs/com/amazon/carbonado/capability/class-use/IndexInfoCapability.html create mode 100644 apidocs/com/amazon/carbonado/capability/class-use/RemoteProcedure.Call.html create mode 100644 apidocs/com/amazon/carbonado/capability/class-use/RemoteProcedure.Reply.html create mode 100644 apidocs/com/amazon/carbonado/capability/class-use/RemoteProcedure.Request.html create mode 100644 apidocs/com/amazon/carbonado/capability/class-use/RemoteProcedure.html create mode 100644 apidocs/com/amazon/carbonado/capability/class-use/RemoteProcedureCapability.html create mode 100644 apidocs/com/amazon/carbonado/capability/class-use/ResyncCapability.Listener.html create mode 100644 apidocs/com/amazon/carbonado/capability/class-use/ResyncCapability.html create mode 100644 apidocs/com/amazon/carbonado/capability/class-use/ShutdownCapability.html create mode 100644 apidocs/com/amazon/carbonado/capability/class-use/StorableInfoCapability.html create mode 100644 apidocs/com/amazon/carbonado/capability/package-frame.html create mode 100644 apidocs/com/amazon/carbonado/capability/package-summary.html create mode 100644 apidocs/com/amazon/carbonado/capability/package-tree.html create mode 100644 apidocs/com/amazon/carbonado/capability/package-use.html (limited to 'apidocs/com/amazon/carbonado/capability') diff --git a/apidocs/com/amazon/carbonado/capability/Capability.html b/apidocs/com/amazon/carbonado/capability/Capability.html new file mode 100644 index 0000000..ad1e7db --- /dev/null +++ b/apidocs/com/amazon/carbonado/capability/Capability.html @@ -0,0 +1,172 @@ + + + + + + +Capability (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
com.amazon.carbonado.capability
+

Interface Capability

+
+
+
+ +
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ +

Copyright © 2006-2013 Amazon Technologies, Inc.. All Rights Reserved.

+ + diff --git a/apidocs/com/amazon/carbonado/capability/GroupAccessCapability.html b/apidocs/com/amazon/carbonado/capability/GroupAccessCapability.html new file mode 100644 index 0000000..93d18e6 --- /dev/null +++ b/apidocs/com/amazon/carbonado/capability/GroupAccessCapability.html @@ -0,0 +1,220 @@ + + + + + + +GroupAccessCapability (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
com.amazon.carbonado.capability
+

Interface GroupAccessCapability

+
+
+
+
    +
  • +
    +
    All Superinterfaces:
    +
    Capability
    +
    +
    +
    +
    public interface GroupAccessCapability
+extends Capability
    +
    Capability for gaining access to replication group members.
    +
    Author:
    +
    Vishal Parakh
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      GroupMembersgetGroupMembers() +
      Return all replication group members, including this repository.
      +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getGroupMembers

        +
        GroupMembers getGroupMembers()
        +
        Return all replication group members, including this repository. + Returned instance remains the same unless group membership changes.
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ +

Copyright © 2006-2013 Amazon Technologies, Inc.. All Rights Reserved.

+ + diff --git a/apidocs/com/amazon/carbonado/capability/GroupMembers.html b/apidocs/com/amazon/carbonado/capability/GroupMembers.html new file mode 100644 index 0000000..e0b5336 --- /dev/null +++ b/apidocs/com/amazon/carbonado/capability/GroupMembers.html @@ -0,0 +1,215 @@ + + + + + + +GroupMembers (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
com.amazon.carbonado.capability
+

Interface GroupMembers

+
+
+
+
    +
  • +
    +
    +
    public interface GroupMembers
    +
    Author:
    +
    Vishal Parakh, Brian S O'Neill
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      java.util.SortedMap<java.lang.Object,Repository>getReadWriteMembers() +
      Returns members intended for read and write access.
      +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getReadWriteMembers

        +
        java.util.SortedMap<java.lang.Object,Repository> getReadWriteMembers()
        +
        Returns members intended for read and write access. Keys must uniquely + identify group members, must be serializable, and must have appropriate + implementations of the hashCode and equals methods.
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ +

Copyright © 2006-2013 Amazon Technologies, Inc.. All Rights Reserved.

+ + diff --git a/apidocs/com/amazon/carbonado/capability/IndexInfo.html b/apidocs/com/amazon/carbonado/capability/IndexInfo.html new file mode 100644 index 0000000..28f8e06 --- /dev/null +++ b/apidocs/com/amazon/carbonado/capability/IndexInfo.html @@ -0,0 +1,294 @@ + + + + + + +IndexInfo (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
com.amazon.carbonado.capability
+

Interface IndexInfo

+
+
+
+
    +
  • +
    +
    All Known Subinterfaces:
    +
    IndexEntryAccessor<S>
    +
    +
    +
    All Known Implementing Classes:
    +
    IndexInfoImpl
    +
    +
    +
    +
    public interface IndexInfo
    +
    General information about an index defined in a Storage. + +

    IndexInfo instances are thread-safe and immutable.

    +
    Author:
    +
    Brian S O'Neill
    +
    See Also:
    IndexInfoCapability
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      java.lang.StringgetName() +
      Returns the name of this index, or null if not applicable.
      +
      Direction[]getPropertyDirections() +
      Returns the directions of all the properties in this index.
      +
      java.lang.String[]getPropertyNames() +
      Returns the properties in this index.
      +
      booleanisClustered() +
      Returns true if index is clustered, which means it defines the physical + ordering of storables.
      +
      booleanisUnique() +
      Returns true if index entries are unique.
      +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getName

        +
        java.lang.String getName()
        +
        Returns the name of this index, or null if not applicable.
        +
        • +
      + + + +
        +
      • +

        isUnique

        +
        boolean isUnique()
        +
        Returns true if index entries are unique.
        +
        • +
      + + + +
        +
      • +

        isClustered

        +
        boolean isClustered()
        +
        Returns true if index is clustered, which means it defines the physical + ordering of storables.
        +
        • +
      + + + +
        +
      • +

        getPropertyNames

        +
        java.lang.String[] getPropertyNames()
        +
        Returns the properties in this index. The array might be empty, but it + is never null. The array is a copy, and so it may be safely modified.
        +
        • +
      + + + +
        +
      • +

        getPropertyDirections

        +
        Direction[] getPropertyDirections()
        +
        Returns the directions of all the properties in this index. The length + of the array matches the length returned by getPropertyNames(). The array is a copy, and so it may be safely + modified.
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ +

Copyright © 2006-2013 Amazon Technologies, Inc.. All Rights Reserved.

+ + diff --git a/apidocs/com/amazon/carbonado/capability/IndexInfoCapability.html b/apidocs/com/amazon/carbonado/capability/IndexInfoCapability.html new file mode 100644 index 0000000..2e416fe --- /dev/null +++ b/apidocs/com/amazon/carbonado/capability/IndexInfoCapability.html @@ -0,0 +1,225 @@ + + + + + + +IndexInfoCapability (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
com.amazon.carbonado.capability
+

Interface IndexInfoCapability

+
+
+
+
    +
  • +
    +
    All Superinterfaces:
    +
    Capability
    +
    +
    +
    +
    public interface IndexInfoCapability
+extends Capability
    +
    Capability for getting information about physical indexes for storables.
    +
    Author:
    +
    Brian S O'Neill
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      <S extends Storable> 
      IndexInfo[]      		getIndexInfo(java.lang.Class<S> storableType) +
      Returns information about the known indexes for the given storable + type.
      +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getIndexInfo

        +
        <S extends Storable> IndexInfo[] getIndexInfo(java.lang.Class<S> storableType)
+                         throws RepositoryException
        +
        Returns information about the known indexes for the given storable + type. The array might be empty, but it is never null. The array is a + copy, and so it may be safely modified.
        +
        Throws:
        +
        RepositoryException
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ +

Copyright © 2006-2013 Amazon Technologies, Inc.. All Rights Reserved.

+ + diff --git a/apidocs/com/amazon/carbonado/capability/RemoteProcedure.Call.html b/apidocs/com/amazon/carbonado/capability/RemoteProcedure.Call.html new file mode 100644 index 0000000..f4dd965 --- /dev/null +++ b/apidocs/com/amazon/carbonado/capability/RemoteProcedure.Call.html @@ -0,0 +1,383 @@ + + + + + + +RemoteProcedure.Call (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
com.amazon.carbonado.capability
+

Interface RemoteProcedure.Call<R,D>

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

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      voidexecute() +
      Executes the call without expecting a reply.
      +
      voidexecuteAsync() +
      Executes the call without expecting a reply.
      +
      Cursor<R>fetchReply() +
      Executes the call and receive a reply.
      +
      voidflush() +
      Flushes all the data sent so far.
      +
      RemoteProcedure.Call<R,D>reset() +
      Reset the internal object stream of the call, allowing cached + objects to get freed.
      +
      RemoteProcedure.Call<R,D>send(D data) +
      Send data to the remote procedure.
      +
      RemoteProcedure.Call<R,D>sendAll(Cursor<? extends D> cursor) +
      Send all data from the given cursor to the remote procedure.
      +
      RemoteProcedure.Call<R,D>sendAll(java.lang.Iterable<? extends D> iterable) +
      Send all data from the given iterable to the remote procedure.
      +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Detail

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

        sendAll

        +
        RemoteProcedure.Call<R,D> sendAll(java.lang.Iterable<? extends D> iterable)
+                                  throws RepositoryException
        +
        Send all data from the given iterable to the remote procedure.
        +
        Returns:
        this Call instance
        +
        Throws:
        +
        java.lang.IllegalArgumentException - if data is null
        +
        java.lang.IllegalStateException - if a call has been executed
        +
        RepositoryException
        +
        • +
      + + + +
        +
      • +

        sendAll

        +
        RemoteProcedure.Call<R,D> sendAll(Cursor<? extends D> cursor)
+                                  throws RepositoryException
        +
        Send all data from the given cursor to the remote procedure.
        +
        Returns:
        this Call instance
        +
        Throws:
        +
        java.lang.IllegalArgumentException - if data is null
        +
        java.lang.IllegalStateException - if a call has been executed
        +
        RepositoryException
        +
        • +
      + + + + + + + + + + + +
        +
      • +

        fetchReply

        +
        Cursor<R> fetchReply()
+                     throws RepositoryException
        +
        Executes the call and receive a reply. Calling this method does not + block, but methods on the returned Cursor may block waiting for + data.
        +
        Throws:
        +
        java.lang.IllegalStateException - if a call has been executed
        +
        RepositoryException
        +
        • +
      + + + +
        +
      • +

        execute

        +
        void execute()
+             throws RepositoryException
        +
        Executes the call without expecting a reply. Method blocks waiting + for procedure to finish.
        +
        Throws:
        +
        java.lang.IllegalStateException - if a call has been executed
        +
        RepositoryException
        +
        • +
      + + + +
        +
      • +

        executeAsync

        +
        void executeAsync()
+                  throws RepositoryException
        +
        Executes the call without expecting a reply. Method does not block + waiting for procedure to finish. Asynchronous execution is not + allowed if the current thread is in a transaction. This is because + transaction ownership becomes ambiguous.
        +
        Throws:
        +
        java.lang.IllegalStateException - if a call has been executed or if + current thread is in a transaction
        +
        RepositoryException
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ +

Copyright © 2006-2013 Amazon Technologies, Inc.. All Rights Reserved.

+ + diff --git a/apidocs/com/amazon/carbonado/capability/RemoteProcedure.Reply.html b/apidocs/com/amazon/carbonado/capability/RemoteProcedure.Reply.html new file mode 100644 index 0000000..5f140a1 --- /dev/null +++ b/apidocs/com/amazon/carbonado/capability/RemoteProcedure.Reply.html @@ -0,0 +1,330 @@ + + + + + + +RemoteProcedure.Reply (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
com.amazon.carbonado.capability
+

Interface RemoteProcedure.Reply<R>

+
+
+
+
    +
  • +
    Type Parameters:
    R - reply object type
    +
    +
    Enclosing interface:
    +
    RemoteProcedure<R,D>
    +
    +
    +
    +
    public static interface RemoteProcedure.Reply<R>
    +
    Reply from remote procedure implementation. To avoid leaking resources, + the finish method must always be invoked. If an exception is thrown by a + method defined in this interface, resources are automatically released.
    +
    • +
+
+
+
    +
  • + + +
    • +
+
+
+ +
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ +

Copyright © 2006-2013 Amazon Technologies, Inc.. All Rights Reserved.

+ + diff --git a/apidocs/com/amazon/carbonado/capability/RemoteProcedure.Request.html b/apidocs/com/amazon/carbonado/capability/RemoteProcedure.Request.html new file mode 100644 index 0000000..04a63b8 --- /dev/null +++ b/apidocs/com/amazon/carbonado/capability/RemoteProcedure.Request.html @@ -0,0 +1,288 @@ + + + + + + +RemoteProcedure.Request (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
com.amazon.carbonado.capability
+

Interface RemoteProcedure.Request<R,D>

+
+
+
+
    +
  • +
    Type Parameters:
    R - reply object type
    D - request data object type
    +
    +
    Enclosing interface:
    +
    RemoteProcedure<R,D>
    +
    +
    +
    +
    public static interface RemoteProcedure.Request<R,D>
    +
    Request into a remote procedure, as seen by procedure implementation. To + avoid leaking resources, the request or reply object must always be + finished. If an exception is thrown by a method defined in this + interface, resources are automatically released.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      RemoteProcedure.Reply<R>beginReply() +
      Begin a reply after receiving all data.
      +
      voidfinish() +
      Reply and immediately finish, without sending any data to caller.
      +
      Dreceive() +
      Receive data from caller.
      +
      intreceiveInto(java.util.Collection<? super D> c) +
      Receive all remaining data from caller.
      +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + + + + + +
        +
      • +

        receiveInto

        +
        int receiveInto(java.util.Collection<? super D> c)
+                throws RepositoryException
        +
        Receive all remaining data from caller.
        +
        Parameters:
        c - collection to receive data
        +
        Returns:
        amount received
        +
        Throws:
        +
        RepositoryException
        +
        • +
      + + + +
        +
      • +

        beginReply

        +
        RemoteProcedure.Reply<R> beginReply()
+                                    throws RepositoryException
        +
        Begin a reply after receiving all data. If no data is expected, + reply can be made without calling receive.
        +
        Throws:
        +
        java.lang.IllegalStateException - if reply was already begun, or if + request is finished, or if more data must be received
        +
        RepositoryException
        +
        • +
      + + + +
        +
      • +

        finish

        +
        void finish()
+            throws RepositoryException
        +
        Reply and immediately finish, without sending any data to caller.
        +
        Throws:
        +
        java.lang.IllegalStateException - if a reply was already begun or if + more data must be received
        +
        RepositoryException
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ +

Copyright © 2006-2013 Amazon Technologies, Inc.. All Rights Reserved.

+ + diff --git a/apidocs/com/amazon/carbonado/capability/RemoteProcedure.html b/apidocs/com/amazon/carbonado/capability/RemoteProcedure.html new file mode 100644 index 0000000..4b64cbb --- /dev/null +++ b/apidocs/com/amazon/carbonado/capability/RemoteProcedure.html @@ -0,0 +1,268 @@ + + + + + + +RemoteProcedure (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
com.amazon.carbonado.capability
+

Interface RemoteProcedure<R,D>

+
+
+
+
    +
  • +
    Type Parameters:
    R - reply object type
    D - request data object type
    +
    +
    All Superinterfaces:
    +
    java.io.Serializable
    +
    +
    +
    +
    public interface RemoteProcedure<R,D>
+extends java.io.Serializable
    +
    Defines a remote procedure which can be executed by RemoteProcedureCapability. Any data within the procedure instance is + serialized to the remote host, and possibly the class definition + too. Execution might have security restrictions applied. + +

    The RemoteProcedure instance is Serializable, and so any serializable + parameters can be passed with it. Storables and extra data can be sent + through the RemoteProcedure.Request object. Any data returned by procedure + implementation must be sent through the RemoteProcedure.Reply object.

    +
    Author:
    +
    Brian S O'Neill
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Nested Class Summary

      + + + + + + + + + + + + + + + + + + +
      Nested Classes 
      Modifier and TypeInterface and Description
      static interface RemoteProcedure.Call<R,D> +
      Client-side call into a remote procedure.
      +
      static interface RemoteProcedure.Reply<R> +
      Reply from remote procedure implementation.
      +
      static interface RemoteProcedure.Request<R,D> +
      Request into a remote procedure, as seen by procedure implementation.
      +
      +
      • +
    + + +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        handleRequest

        +
        boolean handleRequest(Repository repo,
+                    RemoteProcedure.Request<R,D> request)
+                      throws RepositoryException
        +
        Request handler for remote procedure implementation.
        +
        Parameters:
        repo - repository as seen by host that procedure is running from
        request - non-null request object
        +
        Returns:
        false if request is still active when this method returns; + request must eventually be explicitly finished
        +
        Throws:
        +
        RepositoryException
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ +

Copyright © 2006-2013 Amazon Technologies, Inc.. All Rights Reserved.

+ + diff --git a/apidocs/com/amazon/carbonado/capability/RemoteProcedureCapability.html b/apidocs/com/amazon/carbonado/capability/RemoteProcedureCapability.html new file mode 100644 index 0000000..141e802 --- /dev/null +++ b/apidocs/com/amazon/carbonado/capability/RemoteProcedureCapability.html @@ -0,0 +1,237 @@ + + + + + + +RemoteProcedureCapability (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
com.amazon.carbonado.capability
+

Interface RemoteProcedureCapability

+
+
+
+
    +
  • +
    +
    All Superinterfaces:
    +
    Capability
    +
    +
    +
    +
    public interface RemoteProcedureCapability
+extends Capability
    +
    Capability which allows arbitrary code to run on a remote host and access + its repository. The remote procedure might have security restrictions + applied to it. + +

    Examples:

    + RemoteProcedureCapability cap = ...
+ Cursor<MyRecord> c1 = cap.beginCall(new CustomQuery<MyRecord>(params)).fetchReply();
+ ...
+
+ Cursor<InputRecord> c2 = ...
+ cap.beginCall(new Importer<InputRecord>()).sendAll(c2).finish();
+
    +
    Author:
    +
    Brian S O'Neill
    +
    See Also:
    RemoteProcedure
    +
    • +
+
+
+
    +
  • + + +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        beginCall

        +
        <R,D> RemoteProcedure.Call<R,D> beginCall(RemoteProcedure<R,D> proc)
+                                    throws RepositoryException
        +
        Begins a call to execute the given procedure on a remote host. + Execution commences when the Call object is instructed to do so.
        +
        Type Parameters:
        R - reply object type
        D - request data object type
        Parameters:
        proc - procedure to execute
        +
        Returns:
        object for defining the call and receiving a reply
        +
        Throws:
        +
        RepositoryException
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ +

Copyright © 2006-2013 Amazon Technologies, Inc.. All Rights Reserved.

+ + diff --git a/apidocs/com/amazon/carbonado/capability/ResyncCapability.Listener.html b/apidocs/com/amazon/carbonado/capability/ResyncCapability.Listener.html new file mode 100644 index 0000000..b82045d --- /dev/null +++ b/apidocs/com/amazon/carbonado/capability/ResyncCapability.Listener.html @@ -0,0 +1,561 @@ + + + + + + +ResyncCapability.Listener (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
com.amazon.carbonado.capability
+

Class ResyncCapability.Listener<S>

+
+
+ +
+
    +
  • +
    +
    Enclosing interface:
    +
    ResyncCapability
    +
    +
    +
    +
    public static class ResyncCapability.Listener<S>
+extends Trigger<S>
    +
    Trigger which is invoked as storables get re-sync'd. Callbacks are + invoked in the scope of the resync transaction. If any unchecked + exception is thrown, the immediate changes are rolled back and the + entire repository resync operation is aborted. + +

    The listener implementation should return quickly from the callback + methods, to avoid lingering transactions. If the listener is used to + invoke special repair operations, they should be placed into a task + queue. A separate thread can then perform the repairs outside the resync + transaction.

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

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      voidafterDelete(S oldStorable, + java.lang.Object state) +
      Called right after a bogus storable has been successfully deleted.
      +
      voidafterInsert(S newStorable, + java.lang.Object state) +
      Called right after a sync'd storable has been successfully inserted.
      +
      voidafterUpdate(S newStorable, + java.lang.Object state) +
      Called right after a sync'd storable has been successfully updated.
      +
      java.lang.ObjectbeforeDelete(S oldStorable) +
      Called before a bogus storable is to be deleted.
      +
      java.lang.ObjectbeforeInsert(S newStorable) +
      Called before a sync'd storable is to be inserted.
      +
      java.lang.ObjectbeforeUpdate(S newStorable) +
      Called before a sync'd storable is to be updated.
      +
      java.lang.ObjectbeforeUpdate(S oldStorable, + S newStorable) +
      Overloaded version of beforeUpdate method which is passed the + storable in it's out-of-sync and sync'd states.
      +
      voidfailedDelete(S oldStorable, + java.lang.Object state) +
      Called when a delete operation failed because an exception was + thrown.
      +
      voidfailedInsert(S newStorable, + java.lang.Object state) +
      Called when an insert operation failed because an exception was + thrown.
      +
      voidfailedUpdate(S newStorable, + java.lang.Object state) +
      Called when an update operation failed because an exception was + thrown.
      +
      + +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Constructor Detail

      + + + +
        +
      • +

        ResyncCapability.Listener

        +
        public ResyncCapability.Listener()
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + + + +
        +
      • +

        beforeInsert

        +
        public java.lang.Object beforeInsert(S newStorable)
+                              throws PersistException
        +
        Called before a sync'd storable is to be inserted. Changes can be + made to the storable at this point, possibly to define independent + properties.
        +
        +
        Overrides:
        +
        beforeInsert in class Trigger<S>
        +
        Parameters:
        newStorable - sync'd storable before being inserted
        +
        Returns:
        arbitrary state object, passed to afterInsert or failedInsert method
        +
        Throws:
        +
        PersistException
        +
        • +
      + + + + + +
        +
      • +

        afterInsert

        +
        public void afterInsert(S newStorable,
+               java.lang.Object state)
+                 throws PersistException
        +
        Called right after a sync'd storable has been successfully inserted.
        +
        +
        Overrides:
        +
        afterInsert in class Trigger<S>
        +
        Parameters:
        newStorable - sync'd storable after being inserted
        state - object returned by beforeInsert method
        +
        Throws:
        +
        PersistException
        +
        • +
      + + + + + +
        +
      • +

        failedInsert

        +
        public void failedInsert(S newStorable,
+                java.lang.Object state)
        +
        Called when an insert operation failed because an exception was + thrown. The main purpose of this method is to allow any necessary + clean-up to occur on the optional state object.
        +
        +
        Overrides:
        +
        failedInsert in class Trigger<S>
        +
        Parameters:
        newStorable - sync'd storable which failed to be inserted
        state - object returned by beforeInsert method, but it may be null
        +
        • +
      + + + + + +
        +
      • +

        beforeUpdate

        +
        public java.lang.Object beforeUpdate(S newStorable)
+                              throws PersistException
        +
        Called before a sync'd storable is to be updated. Changes can be + made to the storable at this point, possibly to update independent + properties.
        +
        +
        Overrides:
        +
        beforeUpdate in class Trigger<S>
        +
        Parameters:
        newStorable - sync'd storable before being updated
        +
        Returns:
        arbitrary state object, passed to afterUpdate or failedUpdate method
        +
        Throws:
        +
        PersistException
        +
        • +
      + + + + + +
        +
      • +

        beforeUpdate

        +
        public java.lang.Object beforeUpdate(S oldStorable,
+                            S newStorable)
+                              throws PersistException
        +
        Overloaded version of beforeUpdate method which is passed the + storable in it's out-of-sync and sync'd states. Changes can be made + to the storable at this point, possibly to update independent + properties. + +

        The default implementation calls the single argument beforeUpdate + method, only passing the newly sync'd storable.

        +
        Parameters:
        oldStorable - storable prior to being sync'd
        newStorable - sync'd storable before being updated
        +
        Throws:
        +
        PersistException
        +
        • +
      + + + + + +
        +
      • +

        afterUpdate

        +
        public void afterUpdate(S newStorable,
+               java.lang.Object state)
+                 throws PersistException
        +
        Called right after a sync'd storable has been successfully updated.
        +
        +
        Overrides:
        +
        afterUpdate in class Trigger<S>
        +
        Parameters:
        newStorable - sync'd storable after being updated
        state - optional object returned by beforeUpdate method
        +
        Throws:
        +
        PersistException
        +
        • +
      + + + + + +
        +
      • +

        failedUpdate

        +
        public void failedUpdate(S newStorable,
+                java.lang.Object state)
        +
        Called when an update operation failed because an exception was + thrown. The main purpose of this method is to allow any necessary + clean-up to occur on the optional state object.
        +
        +
        Overrides:
        +
        failedUpdate in class Trigger<S>
        +
        Parameters:
        newStorable - sync'd storable which failed to be updated
        state - object returned by beforeUpdate method, but it may be null
        +
        • +
      + + + + + +
        +
      • +

        beforeDelete

        +
        public java.lang.Object beforeDelete(S oldStorable)
+                              throws PersistException
        +
        Called before a bogus storable is to be deleted.
        +
        +
        Overrides:
        +
        beforeDelete in class Trigger<S>
        +
        Parameters:
        oldStorable - bogus storable before being deleted
        +
        Returns:
        arbitrary state object, passed to afterDelete or failedDelete method
        +
        Throws:
        +
        PersistException
        +
        • +
      + + + + + +
        +
      • +

        afterDelete

        +
        public void afterDelete(S oldStorable,
+               java.lang.Object state)
+                 throws PersistException
        +
        Called right after a bogus storable has been successfully deleted.
        +
        +
        Overrides:
        +
        afterDelete in class Trigger<S>
        +
        Parameters:
        oldStorable - bogus storable after being deleted
        state - optional object returned by beforeDelete method
        +
        Throws:
        +
        PersistException
        +
        • +
      + + + + + +
        +
      • +

        failedDelete

        +
        public void failedDelete(S oldStorable,
+                java.lang.Object state)
        +
        Called when a delete operation failed because an exception was + thrown. The main purpose of this method is to allow any necessary + clean-up to occur on the optional state object.
        +
        +
        Overrides:
        +
        failedDelete in class Trigger<S>
        +
        Parameters:
        oldStorable - bogus storable which failed to be deleted
        state - object returned by beforeDelete method, but it may be null
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ +

Copyright © 2006-2013 Amazon Technologies, Inc.. All Rights Reserved.

+ + diff --git a/apidocs/com/amazon/carbonado/capability/ResyncCapability.html b/apidocs/com/amazon/carbonado/capability/ResyncCapability.html new file mode 100644 index 0000000..9233805 --- /dev/null +++ b/apidocs/com/amazon/carbonado/capability/ResyncCapability.html @@ -0,0 +1,300 @@ + + + + + + +ResyncCapability (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
com.amazon.carbonado.capability
+

Interface ResyncCapability

+
+
+
+
    +
  • +
    +
    All Superinterfaces:
    +
    Capability
    +
    +
    +
    +
    public interface ResyncCapability
+extends Capability
    +
    Capability of replicating repositories for re-synchronizing to the master + repository. A re-sync operation can be used to fill up a fresh replication + repository or to repair inconsistencies.
    +
    Author:
    +
    Brian S O'Neill
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Nested Class Summary

      + + + + + + + + + + +
      Nested Classes 
      Modifier and TypeInterface and Description
      static class ResyncCapability.Listener<S> +
      Trigger which is invoked as storables get re-sync'd.
      +
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      RepositorygetMasterRepository() +
      Returns the immediate master Repository, for manual comparison.
      +
      <S extends Storable> 
      void      		resync(java.lang.Class<S> type, + double desiredSpeed, + java.lang.String filter, + java.lang.Object... filterValues) +
      Re-synchronizes replicated storables against the master repository.
      +
      <S extends Storable> 
      void      		resync(java.lang.Class<S> type, + ResyncCapability.Listener<? super S> listener, + double desiredSpeed, + java.lang.String filter, + java.lang.Object... filterValues) +
      Re-synchronizes replicated storables against the master repository.
      +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        resync

        +
        <S extends Storable> void resync(java.lang.Class<S> type,
+                               double desiredSpeed,
+                               java.lang.String filter,
+                               java.lang.Object... filterValues)
+            throws RepositoryException
        +
        Re-synchronizes replicated storables against the master repository.
        +
        Parameters:
        type - type of storable to re-sync
        desiredSpeed - throttling parameter - 1.0 = full speed, 0.5 = half + speed, 0.1 = one-tenth speed, etc
        filter - optional query filter to limit which objects get re-sync'ed
        filterValues - filter values for optional filter
        +
        Throws:
        +
        RepositoryException
        +
        • +
      + + + +
        +
      • +

        resync

        +
        <S extends Storable> void resync(java.lang.Class<S> type,
+                               ResyncCapability.Listener<? super S> listener,
+                               double desiredSpeed,
+                               java.lang.String filter,
+                               java.lang.Object... filterValues)
+            throws RepositoryException
        +
        Re-synchronizes replicated storables against the master repository.
        +
        Parameters:
        type - type of storable to re-sync
        listener - optional listener which gets notified as storables are re-sync'd
        desiredSpeed - throttling parameter - 1.0 = full speed, 0.5 = half + speed, 0.1 = one-tenth speed, etc
        filter - optional query filter to limit which objects get re-sync'ed
        filterValues - filter values for optional filter
        +
        Throws:
        +
        RepositoryException
        Since:
        +
        1.2
        +
        • +
      + + + +
        +
      • +

        getMasterRepository

        +
        Repository getMasterRepository()
        +
        Returns the immediate master Repository, for manual comparison. Direct + updates to the master will likely create inconsistencies.
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ +

Copyright © 2006-2013 Amazon Technologies, Inc.. All Rights Reserved.

+ + diff --git a/apidocs/com/amazon/carbonado/capability/ShutdownCapability.html b/apidocs/com/amazon/carbonado/capability/ShutdownCapability.html new file mode 100644 index 0000000..278f1da --- /dev/null +++ b/apidocs/com/amazon/carbonado/capability/ShutdownCapability.html @@ -0,0 +1,277 @@ + + + + + + +ShutdownCapability (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
com.amazon.carbonado.capability
+

Interface ShutdownCapability

+
+
+
+
    +
  • +
    +
    All Superinterfaces:
    +
    Capability
    +
    +
    +
    All Known Implementing Classes:
    +
    AbstractRepository
    +
    +
    +
    +
    public interface ShutdownCapability
+extends Capability
    +
    Capability for repositories that require special attention with the Java + virtual machine exits.
    +
    Author:
    +
    Brian S O'Neill
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      booleanisAutoShutdownEnabled() +
      Returns true if repository has a shutdown hook registered to + automatically call shutdown when the virtual machine exits.
      +
      voidsetAutoShutdownEnabled(boolean enabled) +
      Request to enable or disable the automatic shutdown hook.
      +
      voidshutdown() +
      Similar to calling close on a repository, except should only be called + when the virtual machine is in the process of shutting down.
      +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        isAutoShutdownEnabled

        +
        boolean isAutoShutdownEnabled()
        +
        Returns true if repository has a shutdown hook registered to + automatically call shutdown when the virtual machine exits.
        +
        • +
      + + + +
        +
      • +

        setAutoShutdownEnabled

        +
        void setAutoShutdownEnabled(boolean enabled)
        +
        Request to enable or disable the automatic shutdown hook. Repository may + ignore this request if shutdown is in progress.
        +
        Throws:
        +
        java.lang.SecurityException - if caller does not have permission
        +
        • +
      + + + +
        +
      • +

        shutdown

        +
        void shutdown()
        +
        Similar to calling close on a repository, except should only be called + when the virtual machine is in the process of shutting down. Calling + close may cause spurious exceptions to be thrown by other threads which + may be interacting with the repository. Shutdown tries to reduce these + exceptions from being thrown by effectively suspending any + threads which continue to interact with this repository. For this + reason, this method should only ever be called during a virtual machine + shutdown. + +

        Repositories may choose to implement this method by simply calling + close. There is no guarantee that shutdown will reduce exceptions, and + it might not suspend any threads. Also, repositories that require proper + shutdown should automatically register runtime hooks, and so this method + usually doesn't need to be called manually.

        +
        Throws:
        +
        java.lang.SecurityException - if caller does not have permission
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ +

Copyright © 2006-2013 Amazon Technologies, Inc.. All Rights Reserved.

+ + diff --git a/apidocs/com/amazon/carbonado/capability/StorableInfoCapability.html b/apidocs/com/amazon/carbonado/capability/StorableInfoCapability.html new file mode 100644 index 0000000..2e7263e --- /dev/null +++ b/apidocs/com/amazon/carbonado/capability/StorableInfoCapability.html @@ -0,0 +1,265 @@ + + + + + + +StorableInfoCapability (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
com.amazon.carbonado.capability
+

Interface StorableInfoCapability

+
+
+
+
    +
  • +
    +
    All Superinterfaces:
    +
    Capability
    +
    +
    +
    +
    public interface StorableInfoCapability
+extends Capability
    +
    Capability that returns information about known storable types in a + repository.
    +
    Author:
    +
    Brian S O'Neill
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      java.lang.String[]getUserStorableTypeNames() +
      Returns an array of storable type class names for user-level storables + known to the repository.
      +
      booleanisPropertySupported(java.lang.Class<Storable> type, + java.lang.String name) +
      Returns true if the given property exists and is supported.
      +
      booleanisSupported(java.lang.Class<Storable> type) +
      Returns true if the given storable type is supported.
      +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getUserStorableTypeNames

        +
        java.lang.String[] getUserStorableTypeNames()
+                                            throws RepositoryException
        +
        Returns an array of storable type class names for user-level storables + known to the repository. The array might be empty, but it is never + null. The array is a copy, and so it may be safely modified. +

        + This method returns class names instead of class instances because the + repository may not be able to load the classes.

        +
        Throws:
        +
        RepositoryException
        +
        • +
      + + + +
        +
      • +

        isSupported

        +
        boolean isSupported(java.lang.Class<Storable> type)
        +
        Returns true if the given storable type is supported.
        +
        Parameters:
        type - storable type to examine
        +
        • +
      + + + +
        +
      • +

        isPropertySupported

        +
        boolean isPropertySupported(java.lang.Class<Storable> type,
+                          java.lang.String name)
        +
        Returns true if the given property exists and is supported.
        +
        Parameters:
        type - storable type to examine
        name - name of property to examine
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ +

Copyright © 2006-2013 Amazon Technologies, Inc.. All Rights Reserved.

+ + diff --git a/apidocs/com/amazon/carbonado/capability/class-use/Capability.html b/apidocs/com/amazon/carbonado/capability/class-use/Capability.html new file mode 100644 index 0000000..a55397f --- /dev/null +++ b/apidocs/com/amazon/carbonado/capability/class-use/Capability.html @@ -0,0 +1,478 @@ + + + + + + +Uses of Interface com.amazon.carbonado.capability.Capability (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Interface
com.amazon.carbonado.capability.Capability

+
+
+ +
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

Copyright © 2006-2013 Amazon Technologies, Inc.. All Rights Reserved.

+ + diff --git a/apidocs/com/amazon/carbonado/capability/class-use/GroupAccessCapability.html b/apidocs/com/amazon/carbonado/capability/class-use/GroupAccessCapability.html new file mode 100644 index 0000000..ae015ef --- /dev/null +++ b/apidocs/com/amazon/carbonado/capability/class-use/GroupAccessCapability.html @@ -0,0 +1,117 @@ + + + + + + +Uses of Interface com.amazon.carbonado.capability.GroupAccessCapability (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Interface
com.amazon.carbonado.capability.GroupAccessCapability

+
+
No usage of com.amazon.carbonado.capability.GroupAccessCapability
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

Copyright © 2006-2013 Amazon Technologies, Inc.. All Rights Reserved.

+ + diff --git a/apidocs/com/amazon/carbonado/capability/class-use/GroupMembers.html b/apidocs/com/amazon/carbonado/capability/class-use/GroupMembers.html new file mode 100644 index 0000000..e329c4f --- /dev/null +++ b/apidocs/com/amazon/carbonado/capability/class-use/GroupMembers.html @@ -0,0 +1,161 @@ + + + + + + +Uses of Interface com.amazon.carbonado.capability.GroupMembers (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Interface
com.amazon.carbonado.capability.GroupMembers

+
+
+ +
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

Copyright © 2006-2013 Amazon Technologies, Inc.. All Rights Reserved.

+ + diff --git a/apidocs/com/amazon/carbonado/capability/class-use/IndexInfo.html b/apidocs/com/amazon/carbonado/capability/class-use/IndexInfo.html new file mode 100644 index 0000000..08d3155 --- /dev/null +++ b/apidocs/com/amazon/carbonado/capability/class-use/IndexInfo.html @@ -0,0 +1,266 @@ + + + + + + +Uses of Interface com.amazon.carbonado.capability.IndexInfo (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Interface
com.amazon.carbonado.capability.IndexInfo

+
+
+ +
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

Copyright © 2006-2013 Amazon Technologies, Inc.. All Rights Reserved.

+ + diff --git a/apidocs/com/amazon/carbonado/capability/class-use/IndexInfoCapability.html b/apidocs/com/amazon/carbonado/capability/class-use/IndexInfoCapability.html new file mode 100644 index 0000000..e461469 --- /dev/null +++ b/apidocs/com/amazon/carbonado/capability/class-use/IndexInfoCapability.html @@ -0,0 +1,117 @@ + + + + + + +Uses of Interface com.amazon.carbonado.capability.IndexInfoCapability (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Interface
com.amazon.carbonado.capability.IndexInfoCapability

+
+
No usage of com.amazon.carbonado.capability.IndexInfoCapability
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

Copyright © 2006-2013 Amazon Technologies, Inc.. All Rights Reserved.

+ + diff --git a/apidocs/com/amazon/carbonado/capability/class-use/RemoteProcedure.Call.html b/apidocs/com/amazon/carbonado/capability/class-use/RemoteProcedure.Call.html new file mode 100644 index 0000000..f245205 --- /dev/null +++ b/apidocs/com/amazon/carbonado/capability/class-use/RemoteProcedure.Call.html @@ -0,0 +1,186 @@ + + + + + + +Uses of Interface com.amazon.carbonado.capability.RemoteProcedure.Call (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Interface
com.amazon.carbonado.capability.RemoteProcedure.Call

+
+
+ +
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

Copyright © 2006-2013 Amazon Technologies, Inc.. All Rights Reserved.

+ + diff --git a/apidocs/com/amazon/carbonado/capability/class-use/RemoteProcedure.Reply.html b/apidocs/com/amazon/carbonado/capability/class-use/RemoteProcedure.Reply.html new file mode 100644 index 0000000..10f2da8 --- /dev/null +++ b/apidocs/com/amazon/carbonado/capability/class-use/RemoteProcedure.Reply.html @@ -0,0 +1,186 @@ + + + + + + +Uses of Interface com.amazon.carbonado.capability.RemoteProcedure.Reply (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Interface
com.amazon.carbonado.capability.RemoteProcedure.Reply

+
+
+ +
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

Copyright © 2006-2013 Amazon Technologies, Inc.. All Rights Reserved.

+ + diff --git a/apidocs/com/amazon/carbonado/capability/class-use/RemoteProcedure.Request.html b/apidocs/com/amazon/carbonado/capability/class-use/RemoteProcedure.Request.html new file mode 100644 index 0000000..f26f2b6 --- /dev/null +++ b/apidocs/com/amazon/carbonado/capability/class-use/RemoteProcedure.Request.html @@ -0,0 +1,162 @@ + + + + + + +Uses of Interface com.amazon.carbonado.capability.RemoteProcedure.Request (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Interface
com.amazon.carbonado.capability.RemoteProcedure.Request

+
+
+ +
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

Copyright © 2006-2013 Amazon Technologies, Inc.. All Rights Reserved.

+ + diff --git a/apidocs/com/amazon/carbonado/capability/class-use/RemoteProcedure.html b/apidocs/com/amazon/carbonado/capability/class-use/RemoteProcedure.html new file mode 100644 index 0000000..a9831e7 --- /dev/null +++ b/apidocs/com/amazon/carbonado/capability/class-use/RemoteProcedure.html @@ -0,0 +1,161 @@ + + + + + + +Uses of Interface com.amazon.carbonado.capability.RemoteProcedure (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Interface
com.amazon.carbonado.capability.RemoteProcedure

+
+
+ +
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

Copyright © 2006-2013 Amazon Technologies, Inc.. All Rights Reserved.

+ + diff --git a/apidocs/com/amazon/carbonado/capability/class-use/RemoteProcedureCapability.html b/apidocs/com/amazon/carbonado/capability/class-use/RemoteProcedureCapability.html new file mode 100644 index 0000000..6da012c --- /dev/null +++ b/apidocs/com/amazon/carbonado/capability/class-use/RemoteProcedureCapability.html @@ -0,0 +1,117 @@ + + + + + + +Uses of Interface com.amazon.carbonado.capability.RemoteProcedureCapability (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Interface
com.amazon.carbonado.capability.RemoteProcedureCapability

+
+
No usage of com.amazon.carbonado.capability.RemoteProcedureCapability
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

Copyright © 2006-2013 Amazon Technologies, Inc.. All Rights Reserved.

+ + diff --git a/apidocs/com/amazon/carbonado/capability/class-use/ResyncCapability.Listener.html b/apidocs/com/amazon/carbonado/capability/class-use/ResyncCapability.Listener.html new file mode 100644 index 0000000..ab27e14 --- /dev/null +++ b/apidocs/com/amazon/carbonado/capability/class-use/ResyncCapability.Listener.html @@ -0,0 +1,165 @@ + + + + + + +Uses of Class com.amazon.carbonado.capability.ResyncCapability.Listener (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Class
com.amazon.carbonado.capability.ResyncCapability.Listener

+
+
+ +
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

Copyright © 2006-2013 Amazon Technologies, Inc.. All Rights Reserved.

+ + diff --git a/apidocs/com/amazon/carbonado/capability/class-use/ResyncCapability.html b/apidocs/com/amazon/carbonado/capability/class-use/ResyncCapability.html new file mode 100644 index 0000000..369f856 --- /dev/null +++ b/apidocs/com/amazon/carbonado/capability/class-use/ResyncCapability.html @@ -0,0 +1,117 @@ + + + + + + +Uses of Interface com.amazon.carbonado.capability.ResyncCapability (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Interface
com.amazon.carbonado.capability.ResyncCapability

+
+
No usage of com.amazon.carbonado.capability.ResyncCapability
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

Copyright © 2006-2013 Amazon Technologies, Inc.. All Rights Reserved.

+ + diff --git a/apidocs/com/amazon/carbonado/capability/class-use/ShutdownCapability.html b/apidocs/com/amazon/carbonado/capability/class-use/ShutdownCapability.html new file mode 100644 index 0000000..5b8e69b --- /dev/null +++ b/apidocs/com/amazon/carbonado/capability/class-use/ShutdownCapability.html @@ -0,0 +1,161 @@ + + + + + + +Uses of Interface com.amazon.carbonado.capability.ShutdownCapability (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Interface
com.amazon.carbonado.capability.ShutdownCapability

+
+
+ +
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

Copyright © 2006-2013 Amazon Technologies, Inc.. All Rights Reserved.

+ + diff --git a/apidocs/com/amazon/carbonado/capability/class-use/StorableInfoCapability.html b/apidocs/com/amazon/carbonado/capability/class-use/StorableInfoCapability.html new file mode 100644 index 0000000..887aad2 --- /dev/null +++ b/apidocs/com/amazon/carbonado/capability/class-use/StorableInfoCapability.html @@ -0,0 +1,117 @@ + + + + + + +Uses of Interface com.amazon.carbonado.capability.StorableInfoCapability (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Interface
com.amazon.carbonado.capability.StorableInfoCapability

+
+
No usage of com.amazon.carbonado.capability.StorableInfoCapability
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

Copyright © 2006-2013 Amazon Technologies, Inc.. All Rights Reserved.

+ + diff --git a/apidocs/com/amazon/carbonado/capability/package-frame.html b/apidocs/com/amazon/carbonado/capability/package-frame.html new file mode 100644 index 0000000..4891a36 --- /dev/null +++ b/apidocs/com/amazon/carbonado/capability/package-frame.html @@ -0,0 +1,36 @@ + + + + + + +com.amazon.carbonado.capability (Carbonado 1.2.3 API) + + + + +

com.amazon.carbonado.capability

+
+

Interfaces

+ +

Classes

+ +
+ + diff --git a/apidocs/com/amazon/carbonado/capability/package-summary.html b/apidocs/com/amazon/carbonado/capability/package-summary.html new file mode 100644 index 0000000..af0b7c6 --- /dev/null +++ b/apidocs/com/amazon/carbonado/capability/package-summary.html @@ -0,0 +1,238 @@ + + + + + + +com.amazon.carbonado.capability (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Package com.amazon.carbonado.capability

+
+
Common capabilities for repositories.
+
+

See: Description

+
+
+ + + + +

Package com.amazon.carbonado.capability Description

+
Common capabilities for repositories.
+
See Also:
Repository.getCapability(java.lang.Class<C>)
+
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

Copyright © 2006-2013 Amazon Technologies, Inc.. All Rights Reserved.

+ + diff --git a/apidocs/com/amazon/carbonado/capability/package-tree.html b/apidocs/com/amazon/carbonado/capability/package-tree.html new file mode 100644 index 0000000..94bd294 --- /dev/null +++ b/apidocs/com/amazon/carbonado/capability/package-tree.html @@ -0,0 +1,157 @@ + + + + + + +com.amazon.carbonado.capability Class Hierarchy (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Hierarchy For Package com.amazon.carbonado.capability

+Package Hierarchies: + +
+
+

Class Hierarchy

+ +

Interface Hierarchy

+ +
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

Copyright © 2006-2013 Amazon Technologies, Inc.. All Rights Reserved.

+ + diff --git a/apidocs/com/amazon/carbonado/capability/package-use.html b/apidocs/com/amazon/carbonado/capability/package-use.html new file mode 100644 index 0000000..30c510b --- /dev/null +++ b/apidocs/com/amazon/carbonado/capability/package-use.html @@ -0,0 +1,420 @@ + + + + + + +Uses of Package com.amazon.carbonado.capability (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Package
com.amazon.carbonado.capability

+
+
+ +
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +

Copyright © 2006-2013 Amazon Technologies, Inc.. All Rights Reserved.

+ + -- cgit v1.2.3