Package 

Class Capability

  • 
public class Capability

    A class representing an Ably Capability, providing convenience methods to simplify creation of token requests

    • Constructor Summary

      Constructors 
      Constructor Description
      Capability() Construct a new empty Capability

    • Method Summary

      Modifier and Type Method Description
      static String c14n(String capability) Convenience method to canonicalise a JSON capability expression.
      void addResource(String resource, Array<String> ops) Add a resource to an existing Capability instance with thegiven set of operations.
      void removeResource(String resource) Remove a resource from an existing Capability instance
      void addOperation(String resource, String op) Add an operation to an existing Capability instance for agiven resource.
      void removeOperation(String resource, String op) Remove an operation for a given resource.If the resource becomes empty as a result,it is removed.
      String toString() Get the canonicalised String text for a Capability instance.The json object and its members are sorted if the object has been modifiedsince the last time it was canonicalised.

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

      • Capability

        Capability()
        Construct a new empty Capability

    • Method Detail

      • c14n

         static String c14n(String capability)

        Convenience method to canonicalise a JSON capability expression.

        Parameters:
        capability - a capability string, which is the JSON text for the capability

      • addResource

         void addResource(String resource, Array<String> ops)

        Add a resource to an existing Capability instance with thegiven set of operations. If the resource already exists,it is wholly replaced by the given set of operations.

        Parameters:
        resource - the resource string
        ops - a String varargs of the operations permitted for this resource;the arguments do not need to be sorted

      • removeResource

         void removeResource(String resource)

        Remove a resource from an existing Capability instance

        Parameters:
        resource - the (possibly existing) resource

      • addOperation

         void addOperation(String resource, String op)

        Add an operation to an existing Capability instance for agiven resource. If the resource does not already exist,it is created.

        Parameters:
        resource - the resource string
        op - a single operation String to be added for this resource;

      • removeOperation

         void removeOperation(String resource, String op)

        Remove an operation for a given resource.If the resource becomes empty as a result,it is removed.

        Parameters:
        resource - the resource string
        op - a operation String to be removed for this resource;

      • toString

         String toString()

        Get the canonicalised String text for a Capability instance.The json object and its members are sorted if the object has been modifiedsince the last time it was canonicalised.