Package burp.api.montoya.persistence

Interface PersistedObject

public interface PersistedObject
[Professional only] Enables data to be stored and accessed from the Burp project. Supports HTTP requests, HTTP responses, byte arrays, primitives, lists of all these, and object hierarchies.

  • Method Details

    • getChildObject

      PersistedObject getChildObject(String key)
      PersistedObject associated with the specified key, or null if this map contains no mapping for the key.
      Parameters:
      key - The key whose associated value is to be returned.
      Returns:
      The value to which the specified key is mapped, or null if this map contains no mapping for the key.

    • setChildObject

      void setChildObject(String key, PersistedObject childObject)
      Associates the specified PersistedObject with the specified key in this map. If the map previously contained a mapping for the key, the old value is replaced by the specified value.
      Parameters:
      key - The key with which the specified child object is to be associated.
      childObject - The PersistedObject to be associated with the specified key.

    • deleteChildObject

      void deleteChildObject(String key)
      Removes the mapping of the specified key to the PersistedObject.
      Parameters:
      key - The key whose mapping is to be deleted.

    • childObjectKeys

      Set<String> childObjectKeys()
      Retrieve all keys currently mapped for PersistedObject objects.
      Returns:
      Set of keys.

    • getString

      String getString(String key)
      String associated with the specified key, or null if this map contains no mapping for the key.
      Parameters:
      key - The key whose associated value is to be returned.
      Returns:
      The value associated with the specified key, or null if this map contains no mapping for the key.

    • setString

      void setString(String key, String value)
      Associates the specified String with the specified key in this map. This is an optional operation. If the map previously contained a mapping for the key, the old value is replaced by the specified value.
      Parameters:
      key - The key with which the specified value is to be associated.
      value - The value to be associated with the specified key.

    • deleteString

      void deleteString(String key)
      Removes the mapping of the specified key to the String.
      Parameters:
      key - The key whose mapping is to be deleted.

    • stringKeys

      Set<String> stringKeys()
      Retrieve all keys currently mapped for String values.
      Returns:
      Set of keys.

    • getBoolean

      Boolean getBoolean(String key)
      Boolean associated with the specified key, or null if this map contains no mapping for the key.
      Parameters:
      key - The key whose associated value is to be returned.
      Returns:
      The value associated with the specified key, or null if this map contains no mapping for the key.

    • setBoolean

      void setBoolean(String key, boolean value)
      Associates the specified boolean with the specified key in this map. This is an optional operation. If the map previously contained a mapping for the key, the old value is replaced by the specified value.
      Parameters:
      key - The key with which the specified value is to be associated.
      value - The value to be associated with the specified key. If this value is null then any value that is currently mapped to the specified key is removed.

    • deleteBoolean

      void deleteBoolean(String key)
      Removes the mapping of the specified key to the Boolean.
      Parameters:
      key - The key whose mapping is to be deleted.

    • booleanKeys

      Set<String> booleanKeys()
      Retrieve all keys currently mapped for Boolean values.
      Returns:
      Set of keys.

    • getByte

      Byte getByte(String key)
      Byte associated with the specified key, or null if this map contains no mapping for the key.
      Parameters:
      key - The key whose associated value is to be returned.
      Returns:
      The value associated with the specified key, or null if this map contains no mapping for the key.

    • setByte

      void setByte(String key, byte value)
      Associates the specified byte with the specified key in this map This is an optional operation. If the map previously contained a mapping for the key, the old value is replaced by the specified value.
      Parameters:
      key - The key with which the specified value is to be associated.
      value - The value to be associated with the specified key. If this value is null then any value that is currently mapped to the specified key is removed.

    • deleteByte

      void deleteByte(String key)
      Removes the mapping of the specified key to the Byte.
      Parameters:
      key - The key whose mapping is to be deleted.

    • byteKeys

      Set<String> byteKeys()
      Retrieve all keys currently mapped for Byte values.
      Returns:
      Set of keys.

    • getShort

      Short getShort(String key)
      Short associated with the specified key, or null if this map contains no mapping for the key.
      Parameters:
      key - The key whose associated value is to be returned.
      Returns:
      The value associated with the specified key, or null if this map contains no mapping for the key.

    • setShort

      void setShort(String key, short value)
      Associates the specified short with the specified key in this map This is an optional operation. If the map previously contained a mapping for the key, the old value is replaced by the specified value.
      Parameters:
      key - The key with which the specified value is to be associated.
      value - The value to be associated with the specified key. If this value is null then any value currently mapped to the specified key is removed.

    • deleteShort

      void deleteShort(String key)
      Removes the mapping from the specified key to the Short.
      Parameters:
      key - The key whose mapping is to be deleted.

    • shortKeys

      Set<String> shortKeys()
      Retrieve all keys currently mapped for Short values.
      Returns:
      Set of keys.

    • getInteger

      Integer getInteger(String key)
      Integer associated with the specified key, or null if this map contains no mapping for the key.
      Parameters:
      key - The key whose associated value is to be returned.
      Returns:
      The value associated with the specified key, or null if this map contains no mapping for the key.

    • setInteger

      void setInteger(String key, int value)
      Associates the specified int with the specified key in this map This is an optional operation. If the map previously contained a mapping for the key, the old value is replaced by the specified value.
      Parameters:
      key - The key with which the specified value is to be associated.
      value - The value to be associated with the specified key. If this value is null then any value that is currently mapped to the specified key is removed.

    • deleteInteger

      void deleteInteger(String key)
      Removes the mapping from the specified key to the Integer.
      Parameters:
      key - The key whose mapping is to be deleted.

    • integerKeys

      Set<String> integerKeys()
      Retrieve all keys currently mapped for Integer values.
      Returns:
      Set of keys.

    • getLong

      Long getLong(String key)
      Long associated with the specified key, or null} if this map contains no mapping for the key.
      Parameters:
      key - The key whose associated value is to be returned.
      Returns:
      The value associated with the specified key, or null if this map contains no mapping for the key.

    • setLong

      void setLong(String key, long value)
      Associates the specified long with the specified key in this map. This is an optional operation. If the map previously contained a mapping for the key, the old value is replaced by the specified value.
      Parameters:
      key - The key with which the specified value is to be associated.
      value - The value to be associated with the specified key. If this value is null then any value that is currently mapped to the specified key is removed.

    • deleteLong

      void deleteLong(String key)
      Removes the mapping from the specified key to the Long.
      Parameters:
      key - The key whose mapping is to be deleted.

    • longKeys

      Set<String> longKeys()
      Retrieve all keys currently mapped for Long values.
      Returns:
      Set of keys.

    • getByteArray

      ByteArray getByteArray(String key)
      ByteArray associated with the specified key, or null if this map contains no mapping for the key.
      Parameters:
      key - The key whose associated value is to be returned.
      Returns:
      The value associated with the specified key, or null if this map contains no mapping for the key.

    • setByteArray

      void setByteArray(String key, ByteArray value)
      Associates the specified ByteArray with the specified key in this map. If the map previously contained a mapping for the key, the old value is replaced by the specified value.
      Parameters:
      key - The key with which the specified value is to be associated.
      value - The value to be associated with the specified key.

    • deleteByteArray

      void deleteByteArray(String key)
      Removes the mapping of the specified key to the ByteArray.
      Parameters:
      key - The key whose mapping is to be deleted.

    • byteArrayKeys

      Set<String> byteArrayKeys()
      Retrieve all keys currently mapped for ByteArray values.
      Returns:
      Set of keys.

    • getHttpRequest

      HttpRequest getHttpRequest(String key)
      HttpRequest associated with the specified key, or null if this map contains no mapping for the key
      Parameters:
      key - The key whose associated value is to be returned.
      Returns:
      The value associated with the specified key, or null if this map contains no mapping for the key.

    • setHttpRequest

      void setHttpRequest(String key, HttpRequest value)
      Associates the specified HttpRequest with the specified key in this map. This is an optional operation. If the map previously contained a mapping for the key, the old value is replaced by the specified value.
      Parameters:
      key - The key with which the specified value is to be associated.
      value - The value to be associated with the specified key.

    • deleteHttpRequest

      void deleteHttpRequest(String key)
      Removes the mapping of the specified key to the HttpRequest.
      Parameters:
      key - The key whose mapping is to be deleted.

    • httpRequestKeys

      Set<String> httpRequestKeys()
      Retrieve all keys currently mapped for HttpRequest values.
      Returns:
      Set of keys.

    • getHttpRequestList

      PersistedList<HttpRequest> getHttpRequestList(String key)
      PersistedList of HttpRequest associated with the specified key, or null if this map contains no mapping for the key.
      Parameters:
      key - The key whose associated value is to be returned.
      Returns:
      The value associated with the specified key, or null if this map contains no mapping for the key.

    • setHttpRequestList

      void setHttpRequestList(String key, PersistedList<HttpRequest> value)
      Associates the specified PersistedList of HttpRequest with the specified key in this map. If the map previously contained a mapping for the key, the old value is replaced by the specified value.
      Parameters:
      key - The key with which the specified value is to be associated.
      value - The value to be associated with the specified key. The methods of this list operate on the underlying persisted data.

    • deleteHttpRequestList

      void deleteHttpRequestList(String key)
      Removes the mapping of the specified key to the PersistedList of HttpRequest.
      Parameters:
      key - The key whose mapping is to be deleted.

    • httpRequestListKeys

      Set<String> httpRequestListKeys()
      Retrieve all keys currently mapped for HttpRequest Lists.
      Returns:
      Set of keys.

    • getHttpResponse

      HttpResponse getHttpResponse(String key)
      HttpResponse associated with the specified key, or null if this map contains no mapping for the key
      Parameters:
      key - The key whose associated value is to be returned.
      Returns:
      The value associated with the specified key, or null if this map contains no mapping for the key.

    • setHttpResponse

      void setHttpResponse(String key, HttpResponse value)
      Associates the specified HttpResponse with the specified key in this map. This is an optional operation. If the map previously contained a mapping for the key, the old value is replaced by the specified value.
      Parameters:
      key - The key with which the specified value is to be associated.
      value - The value to be associated with the specified key.

    • deleteHttpResponse

      void deleteHttpResponse(String key)
      Removes the mapping of the specified key to the HttpResponse.
      Parameters:
      key - The key whose mapping is to be deleted.

    • httpResponseKeys

      Set<String> httpResponseKeys()
      Retrieve all keys currently mapped for HttpResponse values.
      Returns:
      Set of keys.

    • getHttpResponseList

      PersistedList<HttpResponse> getHttpResponseList(String key)
      PersistedList of HttpResponse associated with the specified key, or null if this map contains no mapping for the key.
      Parameters:
      key - The key whose associated value is to be returned.
      Returns:
      The value associated with the specified key, or null if this map contains no mapping for the key.

    • setHttpResponseList

      void setHttpResponseList(String key, PersistedList<HttpResponse> value)
      Associates the specified PersistedList of HttpResponse with the specified key in this map. If the map previously contained a mapping for the key, the old value is replaced by the specified value.
      Parameters:
      key - The key with which the specified value is to be associated.
      value - The value to be associated with the specified key. The methods of this list operate on the underlying persisted data.

    • deleteHttpResponseList

      void deleteHttpResponseList(String key)
      Removes the mapping of the specified key to the PersistedList of HttpResponse.
      Parameters:
      key - The key whose mapping is to be deleted.

    • httpResponseListKeys

      Set<String> httpResponseListKeys()
      Retrieve all keys currently mapped for HttpResponse Lists.
      Returns:
      Set of keys.

    • getHttpRequestResponse

      HttpRequestResponse getHttpRequestResponse(String key)
      HttpRequestResponse associated with the specified key, or null if this map contains no mapping for the key.
      Parameters:
      key - The key whose associated value is to be returned.
      Returns:
      The value associated with the specified key, or null if this map contains no mapping for the key.

    • setHttpRequestResponse

      void setHttpRequestResponse(String key, HttpRequestResponse value)
      Associates the specified HttpRequestResponse with the specified key in this map. This is an optional operation. If the map previously contained a mapping for the key, the old value is replaced by the specified value.
      Parameters:
      key - The key with which the specified value is to be associated.
      value - The value to be associated with the specified key.

    • deleteHttpRequestResponse

      void deleteHttpRequestResponse(String key)
      Removes the mapping of the specified key to the HttpRequestResponse.
      Parameters:
      key - The key whose mapping is to be deleted.

    • httpRequestResponseKeys

      Set<String> httpRequestResponseKeys()
      Retrieve all keys currently mapped for HttpRequestResponse values.
      Returns:
      Set of keys.

    • getHttpRequestResponseList

      PersistedList<HttpRequestResponse> getHttpRequestResponseList(String key)
      PersistedList of HttpRequestResponse associated with the specified key, or null if this map contains no mapping for the key.
      Parameters:
      key - The key whose associated value is to be returned.
      Returns:
      The value associated with the specified key, or null if this map contains no mapping for the key.

    • setHttpRequestResponseList

      void setHttpRequestResponseList(String key, PersistedList<HttpRequestResponse> value)
      Associates the specified PersistedList of HttpRequestResponse with the specified key in this map. If the map previously contained a mapping for the key, the old value is replaced by the specified value.
      Parameters:
      key - The key with which the specified value is to be associated.
      value - The value to be associated with the specified key. The methods of this list operate on the underlying persisted data.

    • deleteHttpRequestResponseList

      void deleteHttpRequestResponseList(String key)
      Removes the mapping of the specified key to the PersistedList of HttpRequestResponse.
      Parameters:
      key - The key whose mapping is to be deleted.

    • httpRequestResponseListKeys

      Set<String> httpRequestResponseListKeys()
      Retrieve all keys currently mapped for HttpRequestResponse Lists.
      Returns:
      Set of keys.

    • getBooleanList

      PersistedList<Boolean> getBooleanList(String key)
      PersistedList of Boolean associated with the specified key, or null if this map contains no mapping for the key.
      Parameters:
      key - The key whose associated value is to be returned.
      Returns:
      The value to which the specified key is mapped, or null if this map contains no mapping for the key.

    • setBooleanList

      void setBooleanList(String key, PersistedList<Boolean> value)
      Associates the specified PersistedList of Boolean with the specified key in this map. If the map previously contained a mapping for the key, the old value is replaced by the specified value.
      Parameters:
      key - The key with which the specified value is to be associated.
      value - The value to be associated with the specified key.

    • deleteBooleanList

      void deleteBooleanList(String key)
      Removes the mapping of the specified key to the PersistedList of Boolean.
      Parameters:
      key - The key whose mapping is to be deleted.

    • booleanListKeys

      Set<String> booleanListKeys()
      Retrieve all keys currently mapped for Boolean Lists.
      Returns:
      Set of keys.

    • getShortList

      PersistedList<Short> getShortList(String key)
      PersistedList of Short associated with the specified key, or null if this map contains no mapping for the key.
      Parameters:
      key - The key whose associated value is to be returned.
      Returns:
      The value to which the specified key is mapped, or null if this map contains no mapping for the key.

    • setShortList

      void setShortList(String key, PersistedList<Short> value)
      Associates the specified PersistedList of Short with the specified key in this map. If the map previously contained a mapping for the key, the old value is replaced by the specified value.
      Parameters:
      key - The key with which the specified value is to be associated.
      value - The value to be associated with the specified key.

    • deleteShortList

      void deleteShortList(String key)
      Removes the mapping of the specified key to the PersistedList of Short.
      Parameters:
      key - The key whose mapping is to be deleted.

    • shortListKeys

      Set<String> shortListKeys()
      Retrieve all keys currently mapped for Short Lists.
      Returns:
      Set of keys.

    • getIntegerList

      PersistedList<Integer> getIntegerList(String key)
      PersistedList of Integer associated with the specified key, or null if this map contains no mapping for the key.
      Parameters:
      key - The key whose associated value is to be returned.
      Returns:
      The value to which the specified key is mapped, or null if this map contains no mapping for the key.

    • setIntegerList

      void setIntegerList(String key, PersistedList<Integer> value)
      Associates the specified PersistedList of Integer with the specified key in this map. If the map previously contained a mapping for the key, the old value is replaced by the specified value.
      Parameters:
      key - The key with which the specified value is to be associated.
      value - The value to be associated with the specified key.

    • deleteIntegerList

      void deleteIntegerList(String key)
      Removes the mapping of the specified key to the PersistedList of Integer.
      Parameters:
      key - The key whose mapping is to be deleted.

    • integerListKeys

      Set<String> integerListKeys()
      Retrieve all keys currently mapped for Integer Lists.
      Returns:
      Set of keys.

    • getLongList

      PersistedList<Long> getLongList(String key)
      PersistedList of Long associated with the specified key, or null if this map contains no mapping for the key.
      Parameters:
      key - The key whose associated value is to be returned.
      Returns:
      The value to which the specified key is mapped, or null if this map contains no mapping for the key.

    • setLongList

      void setLongList(String key, PersistedList<Long> value)
      Associates the specified PersistedList of Long with the specified key in this map. If the map previously contained a mapping for the key, the old value is replaced by the specified value.
      Parameters:
      key - The key with which the specified value is to be associated.
      value - The value to be associated with the specified key.

    • deleteLongList

      void deleteLongList(String key)
      Removes the mapping of the specified key to the PersistedList of Long.
      Parameters:
      key - The key whose mapping is to be deleted.

    • longListKeys

      Set<String> longListKeys()
      Retrieve all keys currently mapped for Long Lists.
      Returns:
      Set of keys.

    • getStringList

      PersistedList<String> getStringList(String key)
      PersistedList of String associated with the specified key, or null if this map contains no mapping for the key.
      Parameters:
      key - The key whose associated value is to be returned.
      Returns:
      The value to which the specified key is mapped, or null if this map contains no mapping for the key.

    • setStringList

      void setStringList(String key, PersistedList<String> value)
      Associates the specified PersistedList of String with the specified key in this map. If the map previously contained a mapping for the key, the old value is replaced by the specified value.
      Parameters:
      key - The key with which the specified value is to be associated.
      value - The value to be associated with the specified key.

    • deleteStringList

      void deleteStringList(String key)
      Removes the mapping of the specified key to the PersistedList of String.
      Parameters:
      key - The key whose mapping is to be deleted.

    • stringListKeys

      Set<String> stringListKeys()
      Retrieve all keys currently mapped for String Lists.
      Returns:
      Set of keys.

    • getByteArrayList

      PersistedList<ByteArray> getByteArrayList(String key)
      PersistedList of ByteArray associated with the specified key, or null if this map contains no mapping for the key.
      Parameters:
      key - The key whose associated value is to be returned.
      Returns:
      The value associated with the specified key, or null if this map contains no mapping for the key.

    • setByteArrayList

      void setByteArrayList(String key, PersistedList<ByteArray> value)
      Associates the specified PersistedList of ByteArray with the specified key in this map. If the map previously contained a mapping for the key, the old value is replaced by the specified value.
      Parameters:
      key - The key with which the specified value is to be associated.
      value - The value to be associated with the specified key. The methods of this list operate on the underlying persisted data.

    • deleteByteArrayList

      void deleteByteArrayList(String key)
      Removes the mapping of the specified key to the PersistedList of ByteArray.
      Parameters:
      key - The key whose mapping is to be deleted.

    • byteArrayListKeys

      Set<String> byteArrayListKeys()
      Retrieve all keys currently mapped for ByteArray Lists.
      Returns:
      Set of keys.

    • persistedObject

      static PersistedObject persistedObject()
      Create a new instance of PersistedObject.
      Returns:
      A new PersistedObject instance.