FWD » Core Development » User Interface

import com.fasterxml.jackson.annotation.*;

@JsonInclude(JsonInclude.Include.NON_NULL)

   @JsonCreator

public interface ClientExports extends ObjectStorage

/*

** Module   : ClientStorageProxy.java

** Abstract : Implements the proxy for the client object storage that can be used on the server.

**

** Copyright (c) 2019, Golden Code Development Corporation.

**

** -#- -I- --Date-- ---------------------------------Description---------------------------------

** 001 SBI 20190911 Created initial version.

*/

/*

** This program is free software: you can redistribute it and/or modify

** it under the terms of the GNU Affero General Public License as

** published by the Free Software Foundation, either version 3 of the

** License, or (at your option) any later version.

**

** This program is distributed in the hope that it will be useful,

** but WITHOUT ANY WARRANTY; without even the implied warranty of

** MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

** GNU Affero General Public License for more details.

**

** You may find a copy of the GNU Affero GPL version 3 at the following

** location: https://www.gnu.org/licenses/agpl-3.0.en.html

** 

** Additional terms under GNU Affero GPL version 3 section 7:

** 

**   Under Section 7 of the GNU Affero GPL version 3, the following additional

**   terms apply to the works covered under the License.  These additional terms

**   are non-permissive additional terms allowed under Section 7 of the GNU

**   Affero GPL version 3 and may not be removed by you.

** 

**   0. Attribution Requirement.

** 

**     You must preserve all legal notices or author attributions in the covered

**     work or Appropriate Legal Notices displayed by works containing the covered

**     work.  You may not remove from the covered work any author or developer

**     credit already included within the covered work.

** 

**   1. No License To Use Trademarks.

** 

**     This license does not grant any license or rights to use the trademarks

**     Golden Code, FWD, any Golden Code or FWD logo, or any other trademarks

**     of Golden Code Development Corporation. You are not authorized to use the

**     name Golden Code, FWD, or the names of any author or contributor, for

**     publicity purposes without written authorization.

** 

**   2. No Misrepresentation of Affiliation.

** 

**     You may not represent yourself as Golden Code Development Corporation or FWD.

** 

**     You may not represent yourself for publicity purposes as associated with

**     Golden Code Development Corporation, FWD, or any author or contributor to

**     the covered work, without written authorization.

** 

**   3. No Misrepresentation of Source or Origin.

** 

**     You may not represent the covered work as solely your work.  All modified

**     versions of the covered work must be marked in a reasonable way to make it

**     clear that the modified work is not originating from Golden Code Development

**     Corporation or FWD.  All modified versions must contain the notices of

**     attribution required in this license.

*/

package com.goldencode.p2j.ui;

/**

 * Represents the server side client storage proxy

 */

public class ClientStorageProxy

implements ObjectStorage

{

   /** The client exported API */

   private final ClientExports client;

   /**

    * Creates a proxy object.

    * 

    * @param    client

    *           The delegate that represents the client exported API.

    */

   public ClientStorageProxy(ClientExports client)

   {

      this.client = client;

   }

   /**

    * Retrieves the number value of the given key from this storage.

    * 

    * @param    key

    *           The given key

    * 

    * @return   The number value of the given key 

    */

   @Override

   public Number getNumber(String key)

   {

      return client.getNumber(key);

   }

   /**

    * Saves the number value of this key in this storage.

    * 

    * @param    key

    *           The given key

    * @param    value

    *           The value of the given key

    */

   @Override

   public void setNumber(String key, Number value)

   {

      client.setNumber(key, value);

   }

   /**

    * Retrieves the boolean value of the given key from this storage.

    * 

    * @param    key

    *           The given key

    * 

    * @return   The boolean value of the given key

    */

   @Override

   public Boolean getBoolean(String key)

   {

      return client.getBoolean(key);

   }

   /**

    * Saves the boolean value of this key in this storage.

    * 

    * @param    key

    *           The given key

    * @param    value

    *           The value of the given key

    */

   @Override

   public void setBoolean(String key, Boolean value)

   {

      client.setBoolean(key, value);

   }

   /**

    * Retrieves the string value of the given key from this storage.

    * 

    * @param    key

    *           The given key

    * 

    * @return   The string value of the given key

    */

   @Override

   public String getString(String key)

   {

      return client.getString(key);

   }

   /**

    * Saves the string value of this key in this storage.

    * 

    * @param    key

    *           The given key

    * @param    value

    *           The value of the given key

    */

   @Override

   public void setString(String key, String value)

   {

      client.setString(key, value);

   }

   /**

    * Deletes the given key and its value from this storage.

    * 

    * @param    key

    *           The given key

    */

   @Override

   public void delete(String key)

   {

      client.delete(key);

   }

   /**

    * Retrieves the object value of the given key from this storage.

    * 

    * @param    key

    *           The given key

    * @param    clazz

    *           The java class that represents this object

    * 

    * @return   The object value of the given key

    */

   @SuppressWarnings("rawtypes")

   @Override

   public Object getObject(String key, Class clazz)

   {

      return client.getObject(key, clazz);

   }

   /**

    * Sets the object value of the given key for this storage.

    * 

    * @param    key

    *           The given key

    * @param    value

    *           The object value

    */

   @Override

   public void setObject(String key, Object value)

   {

      client.setObject(key, value);

   }

   /**

    * Returns the storage size.

    * 

    * @return   The storage size

    */

   @Override

   public int getSize()

   {

      return client.getSize();

   }

   /**

    * Returns the key by its index number in a sequence of all storage keys.

    * 

    * @param    index

    *           The given index number in a sequence of all storage keys.

    * 

    * @return   The key

    */

   @Override

   public String getKey(int index)

   {

      return client.getKey(index);

   }

}

import com.fasterxml.jackson.annotation.*;

@JsonInclude(JsonInclude.Include.NON_NULL)

   @JsonIgnore

   @JsonIgnore

import com.fasterxml.jackson.annotation.*;

   @JsonCreator

   public EnhancedBrowseConfigStorageKey(@JsonProperty("userName") String    userName,

                                         @JsonProperty("configKey")BrowseKey configKey)

/*

** Module   : KeyValueStorage.java

** Abstract : Defines methods to store and retrieve key and value pairs.

**

** Copyright (c) 2019, Golden Code Development Corporation.

**

** -#- -I- --Date-- ---------------------------------Description---------------------------------

** 001 SBI 20190911 Created initial version.

*/

/*

** This program is free software: you can redistribute it and/or modify

** it under the terms of the GNU Affero General Public License as

** published by the Free Software Foundation, either version 3 of the

** License, or (at your option) any later version.

**

** This program is distributed in the hope that it will be useful,

** but WITHOUT ANY WARRANTY; without even the implied warranty of

** MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

** GNU Affero General Public License for more details.

**

** You may find a copy of the GNU Affero GPL version 3 at the following

** location: https://www.gnu.org/licenses/agpl-3.0.en.html

** 

** Additional terms under GNU Affero GPL version 3 section 7:

** 

**   Under Section 7 of the GNU Affero GPL version 3, the following additional

**   terms apply to the works covered under the License.  These additional terms

**   are non-permissive additional terms allowed under Section 7 of the GNU

**   Affero GPL version 3 and may not be removed by you.

** 

**   0. Attribution Requirement.

** 

**     You must preserve all legal notices or author attributions in the covered

**     work or Appropriate Legal Notices displayed by works containing the covered

**     work.  You may not remove from the covered work any author or developer

**     credit already included within the covered work.

** 

**   1. No License To Use Trademarks.

** 

**     This license does not grant any license or rights to use the trademarks

**     Golden Code, FWD, any Golden Code or FWD logo, or any other trademarks

**     of Golden Code Development Corporation. You are not authorized to use the

**     name Golden Code, FWD, or the names of any author or contributor, for

**     publicity purposes without written authorization.

** 

**   2. No Misrepresentation of Affiliation.

** 

**     You may not represent yourself as Golden Code Development Corporation or FWD.

** 

**     You may not represent yourself for publicity purposes as associated with

**     Golden Code Development Corporation, FWD, or any author or contributor to

**     the covered work, without written authorization.

** 

**   3. No Misrepresentation of Source or Origin.

** 

**     You may not represent the covered work as solely your work.  All modified

**     versions of the covered work must be marked in a reasonable way to make it

**     clear that the modified work is not originating from Golden Code Development

**     Corporation or FWD.  All modified versions must contain the notices of

**     attribution required in this license.

*/

package com.goldencode.p2j.ui;

/**

 * This interface defines access methods for a key value storage.

 */

public interface KeyValueStorage

{

   /**

    * Retrieves the number value of the given key from this storage.

    * 

    * @param    key

    *           The given key

    * 

    * @return   The number value of the given key 

    */

   Number getNumber(String key);

   /**

    * Saves the number value of this key in this storage.

    * 

    * @param    key

    *           The given key

    * @param    value

    *           The value of the given key

    */

   void setNumber(String key, Number value);

   /**

    * Retrieves the boolean value of the given key from this storage.

    * 

    * @param    key

    *           The given key

    * 

    * @return   The boolean value of the given key

    */

   Boolean getBoolean(String key);

   /**

    * Saves the boolean value of this key in this storage.

    * 

    * @param    key

    *           The given key

    * @param    value

    *           The value of the given key

    */

   void setBoolean(String key, Boolean value);

   /**

    * Retrieves the string value of the given key from this storage.

    * 

    * @param    key

    *           The given key

    * 

    * @return   The string value of the given key

    */

   String getString(String key);

   /**

    * Saves the string value of this key in this storage.

    * 

    * @param    key

    *           The given key

    * @param    value

    *           The value of the given key

    */

   void setString(String key, String value);

   /**

    * Deletes the given key and its value from this storage.

    * 

    * @param    key

    *           The given key

    */

   void delete(String key);

   /**

    * Returns the storage size.

    * 

    * @return   The storage size

    */

   int getSize();

   /**

    * Returns the key by its index number in a sequence of all storage keys.

    * 

    * @param    index

    *           The given index number in a sequence of all storage keys.

    * 

    * @return   The key

    */

   String getKey(int index);

}

/*

** Module   : KeyValueStorageAdapter.java

** Abstract : Implements the adapter for the KeyValueStorage backend and the client object storage.

**

** Copyright (c) 2019, Golden Code Development Corporation.

**

** -#- -I- --Date-- ---------------------------------Description---------------------------------

** 001 SBI 20190911 Created initial version.

*/

/*

** This program is free software: you can redistribute it and/or modify

** it under the terms of the GNU Affero General Public License as

** published by the Free Software Foundation, either version 3 of the

** License, or (at your option) any later version.

**

** This program is distributed in the hope that it will be useful,

** but WITHOUT ANY WARRANTY; without even the implied warranty of

** MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

** GNU Affero General Public License for more details.

**

** You may find a copy of the GNU Affero GPL version 3 at the following

** location: https://www.gnu.org/licenses/agpl-3.0.en.html

** 

** Additional terms under GNU Affero GPL version 3 section 7:

** 

**   Under Section 7 of the GNU Affero GPL version 3, the following additional

**   terms apply to the works covered under the License.  These additional terms

**   are non-permissive additional terms allowed under Section 7 of the GNU

**   Affero GPL version 3 and may not be removed by you.

** 

**   0. Attribution Requirement.

** 

**     You must preserve all legal notices or author attributions in the covered

**     work or Appropriate Legal Notices displayed by works containing the covered

**     work.  You may not remove from the covered work any author or developer

**     credit already included within the covered work.

** 

**   1. No License To Use Trademarks.

** 

**     This license does not grant any license or rights to use the trademarks

**     Golden Code, FWD, any Golden Code or FWD logo, or any other trademarks

**     of Golden Code Development Corporation. You are not authorized to use the

**     name Golden Code, FWD, or the names of any author or contributor, for

**     publicity purposes without written authorization.

** 

**   2. No Misrepresentation of Affiliation.

** 

**     You may not represent yourself as Golden Code Development Corporation or FWD.

** 

**     You may not represent yourself for publicity purposes as associated with

**     Golden Code Development Corporation, FWD, or any author or contributor to

**     the covered work, without written authorization.

** 

**   3. No Misrepresentation of Source or Origin.

** 

**     You may not represent the covered work as solely your work.  All modified

**     versions of the covered work must be marked in a reasonable way to make it

**     clear that the modified work is not originating from Golden Code Development

**     Corporation or FWD.  All modified versions must contain the notices of

**     attribution required in this license.

*/

package com.goldencode.p2j.ui;

import java.io.*;

import com.fasterxml.jackson.core.*;

import com.fasterxml.jackson.databind.*;

/**

 * Implements a string key value user's storage backed by java user preferences file storage.

 */

public class KeyValueStorageAdapter

implements ObjectStorage

{

   /** Object to JSON converter*/

   private final ObjectMapper mapper;

   /** The backed key and value storage */

   private KeyValueStorage backend;

   /**

    * Creates this adapter.

    */

   public KeyValueStorageAdapter()

   {

      this.mapper = new ObjectMapper();

      mapper.disable(DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES);

   }

   /**

    * Retrieves the number value of the given key from this storage.

    * 

    * @param    key

    *           The given key

    * 

    * @return   The number value of the given key 

    */

   @Override

   public Number getNumber(String key)

   {

      return this.backend.getNumber(key);

   }

   /**

    * Saves the number value of this key in this storage.

    * 

    * @param    key

    *           The given key

    * @param    value

    *           The value of the given key

    */

   @Override

   public void setNumber(String key, Number value)

   {

      this.backend.setNumber(key, value);

   }

   /**

    * Retrieves the boolean value of the given key from this storage.

    * 

    * @param    key

    *           The given key

    * 

    * @return   The boolean value of the given key

    */

   @Override

   public Boolean getBoolean(String key)

   {

      return this.backend.getBoolean(key);

   }

   /**

    * Saves the boolean value of this key in this storage.

    * 

    * @param    key

    *           The given key

    * @param    value

    *           The value of the given key

    */

   @Override

   public void setBoolean(String key, Boolean value)

   {

      this.backend.setBoolean(key, value);

   }

   /**

    * Retrieves the string value of the given key from this storage.

    * 

    * @param    key

    *           The given key

    * 

    * @return   The string value of the given key

    */

   @Override

   public String getString(String key)

   {

      return this.backend.getString(key);

   }

   @Override

   public void setString(String key, String value)

   {

      this.backend.setString(key, value);

   }

   /**

    * Deletes the given key and its value from this storage.

    * 

    * @param    key

    *           The given key

    */

   @Override

   public void delete(String key)

   {

      this.backend.delete(key);

   }

   /**

    * Sets the backend key and value storage.

    * 

    * @param    backend

    *           The backend key and value storage

    */

   public void setBackend(KeyValueStorage backend)

   {

      this.backend = backend;

   }

   /**

    * Retrieves the object value of the given key from this storage.

    * 

    * @param    key

    *           The given key

    * @param    clazz

    *           The java class that represents this object

    * 

    * @return   The object value of the given key

    */

   @SuppressWarnings("rawtypes")

   @Override

   public Object getObject(String key, Class clazz)

   {

      return parseJSON(key, clazz);

   }

   /**

    * Sets the object value of the given key for this storage.

    * 

    * @param    key

    *           The given key

    * @param    value

    *           The object value

    */

   public void setObject(String key, Object value)

   {

      try

      {

         String json = mapper.writeValueAsString(value);

         backend.setString(key, json);

      }

      catch (JsonProcessingException e)

      {

         e.printStackTrace();

      }

   }

   /**

    * The template method to get the object from its json presentation retrieved from the storage

    * by the given key.

    * 

    * @param    key

    *           The given key

    * @param    clazz

    *           The java class that represents this object

    * 

    * @return   The object value of the given key

    */

   private <T> T parseJSON(String key, Class<T> clazz)

   {

      String content = backend.getString(key);

      if (content != null)

      {

         try

         {

            return mapper.readValue(content, clazz);

         }

         catch (IOException e)

         {

            e.printStackTrace();

         }

      }

      return null;

   }

   /**

    * Returns the storage size.

    * 

    * @return   The storage size

    */

   @Override

   public int getSize()

   {

      return backend.getSize();

   }

   /**

    * Returns the key by its index number in a sequence of all storage keys.

    * 

    * @param    index

    *           The given index number in a sequence of all storage keys.

    * 

    * @return   The key

    */

   @Override

   public String getKey(int index)

   {

      return backend.getKey(index);

   }

}

   /** The client local storage proxy */

   private ObjectStorage clientLocalStorage;

      clientLocalStorage = new ClientStorageProxy(client);

    * Gets the client local storage.

    * 

    * @return   The client local storage

    */

   public static ObjectStorage getClientStorage()

   {

      return locate().clientLocalStorage;

   }

   /**

/*

** Module   : ObjectStorage.java

** Abstract : Extends a key and value storage to be used as a client object storage.

**

** Copyright (c) 2019, Golden Code Development Corporation.

**

** -#- -I- --Date-- ---------------------------------Description---------------------------------

** 001 SBI 20190911 Created initial version.

*/

/*

** This program is free software: you can redistribute it and/or modify

** it under the terms of the GNU Affero General Public License as

** published by the Free Software Foundation, either version 3 of the

** License, or (at your option) any later version.

**

** This program is distributed in the hope that it will be useful,

** but WITHOUT ANY WARRANTY; without even the implied warranty of

** MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

** GNU Affero General Public License for more details.

**

** You may find a copy of the GNU Affero GPL version 3 at the following

** location: https://www.gnu.org/licenses/agpl-3.0.en.html

** 

** Additional terms under GNU Affero GPL version 3 section 7:

** 

**   Under Section 7 of the GNU Affero GPL version 3, the following additional

**   terms apply to the works covered under the License.  These additional terms

**   are non-permissive additional terms allowed under Section 7 of the GNU

**   Affero GPL version 3 and may not be removed by you.

** 

**   0. Attribution Requirement.

** 

**     You must preserve all legal notices or author attributions in the covered

**     work or Appropriate Legal Notices displayed by works containing the covered

**     work.  You may not remove from the covered work any author or developer

**     credit already included within the covered work.

** 

**   1. No License To Use Trademarks.

** 

**     This license does not grant any license or rights to use the trademarks

**     Golden Code, FWD, any Golden Code or FWD logo, or any other trademarks

**     of Golden Code Development Corporation. You are not authorized to use the

**     name Golden Code, FWD, or the names of any author or contributor, for

**     publicity purposes without written authorization.

** 

**   2. No Misrepresentation of Affiliation.

** 

**     You may not represent yourself as Golden Code Development Corporation or FWD.

** 

**     You may not represent yourself for publicity purposes as associated with

**     Golden Code Development Corporation, FWD, or any author or contributor to

**     the covered work, without written authorization.

** 

**   3. No Misrepresentation of Source or Origin.

** 

**     You may not represent the covered work as solely your work.  All modified

**     versions of the covered work must be marked in a reasonable way to make it

**     clear that the modified work is not originating from Golden Code Development

**     Corporation or FWD.  All modified versions must contain the notices of

**     attribution required in this license.

*/

package com.goldencode.p2j.ui;

/**

 * Added methods to persist object values of keys. Extends this key value storage interface to be

 * an object storage interface. 

 */

public interface ObjectStorage extends KeyValueStorage

{

   /**

    * Retrieves the object value of the given key from this storage.

    * 

    * @param    key

    *           The given key

    * @param    clazz

    *           The java class that represents this object

    * 

    * @return   The object value of the given key

    */

   @SuppressWarnings("rawtypes")

   Object getObject(String key, Class clazz);

   /**

    * Sets the object value of the given key for this storage.

    * 

    * @param    key

    *           The given key

    * @param    value

    *           The object value

    */

   void setObject(String key, Object value);

}

   /**

    * Gets the client storage.

    * 

    * @return   The client storage

    */

   public ObjectStorage getClientStorage()

   {

      return getOutputManager().getDriver().getClientStorage();

   }

   /**

    * Retrieves the object value of the given key from the client storage.

    * 

    * @param    key

    *           The given key

    * @param    clazz

    *           The java class that represents this object

    * 

    * @return   The object value of the given key

    */

   @Override

   public Object getObject(String key, Class clazz)

   {

      return getClientStorage().getObject(key, clazz);

   }

   /**

    * Sets the object value of the given key for the client storage.

    * 

    * @param    key

    *           The given key

    * @param    value

    *           The object value

    */

   @Override

   public void setObject(String key, Object value)

   {

      getClientStorage().setObject(key, value);

   }

   /**

    * Retrieves the number value of the given key from the client storage.

    * 

    * @param    key

    *           The given key

    * 

    * @return   The number value of the given key 

    */

   @Override

   public Number getNumber(String key)

   {

      return getClientStorage().getNumber(key);

   }

   /**

    * Saves the number value of this key in the client storage.

    * 

    * @param    key

    *           The given key

    * @param    value

    *           The value of the given key

    */

   @Override

   public void setNumber(String key, Number value)

   {

      getClientStorage().setNumber(key, value);

   }

   /**

    * Retrieves the boolean value of the given key from the client storage.

    * 

    * @param    key

    *           The given key

    * 

    * @return   The boolean value of the given key

    */

   @Override

   public Boolean getBoolean(String key)

   {

      return getClientStorage().getBoolean(key);

   }

   /**

    * Saves the boolean value of this key in the client storage.

    * 

    * @param    key

    *           The given key

    * @param    value

    *           The value of the given key

    */

   @Override

   public void setBoolean(String key, Boolean value)

   {

      getClientStorage().setBoolean(key, value);

   }

   /**

    * Retrieves the string value of the given key from the client storage.

    * 

    * @param    key

    *           The given key

    * 

    * @return   The string value of the given key

    */

   @Override

   public String getString(String key)

   {

      return getClientStorage().getString(key);

   }

   /**

    * Saves the string value of this key in the client storage.

    * 

    * @param    key

    *           The given key

    * @param    value

    *           The value of the given key

    */

   @Override

   public void setString(String key, String value)

   {

      getClientStorage().setString(key, value);

   }

   /**

    * Deletes the given key and its value from the client storage.

    * 

    * @param    key

    *           The given key

    */

   @Override

   public void delete(String key)

   {

      getClientStorage().delete(key);

   }

   /**

    * Returns the client storage size.

    * 

    * @return   The storage size

    */

   @Override

   public int getSize()

   {

      return getClientStorage().getSize();

   }

   /**

    * Returns the key by its index number in a sequence of all keys from the client storage.

    * 

    * @param    index

    *           The given index number in a sequence of all storage keys.

    * 

    * @return   The key

    */

   @Override

   public String getKey(int index)

   {

      return getClientStorage().getKey(index);

   }

/*

** Module   : UserKeyValueStorage.java

** Abstract : Represents an abstract key and value storage that can be used to persist users

**            settings for storage backends with the capacity limit on the maximal value size.

**

** Copyright (c) 2019, Golden Code Development Corporation.

**

** -#- -I- --Date-- ---------------------------------Description---------------------------------

** 001 SBI 20190916 Created initial version.

*/

/*

** This program is free software: you can redistribute it and/or modify

** it under the terms of the GNU Affero General Public License as

** published by the Free Software Foundation, either version 3 of the

** License, or (at your option) any later version.

**

** This program is distributed in the hope that it will be useful,

** but WITHOUT ANY WARRANTY; without even the implied warranty of

** MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

** GNU Affero General Public License for more details.

**

** You may find a copy of the GNU Affero GPL version 3 at the following

** location: https://www.gnu.org/licenses/agpl-3.0.en.html

** 

** Additional terms under GNU Affero GPL version 3 section 7:

** 

**   Under Section 7 of the GNU Affero GPL version 3, the following additional

**   terms apply to the works covered under the License.  These additional terms

**   are non-permissive additional terms allowed under Section 7 of the GNU

**   Affero GPL version 3 and may not be removed by you.

** 

**   0. Attribution Requirement.

** 

**     You must preserve all legal notices or author attributions in the covered

**     work or Appropriate Legal Notices displayed by works containing the covered

**     work.  You may not remove from the covered work any author or developer

**     credit already included within the covered work.

** 

**   1. No License To Use Trademarks.

** 

**     This license does not grant any license or rights to use the trademarks

**     Golden Code, FWD, any Golden Code or FWD logo, or any other trademarks

**     of Golden Code Development Corporation. You are not authorized to use the

**     name Golden Code, FWD, or the names of any author or contributor, for

**     publicity purposes without written authorization.

** 

**   2. No Misrepresentation of Affiliation.

** 

**     You may not represent yourself as Golden Code Development Corporation or FWD.

** 

**     You may not represent yourself for publicity purposes as associated with

**     Golden Code Development Corporation, FWD, or any author or contributor to

**     the covered work, without written authorization.

** 

**   3. No Misrepresentation of Source or Origin.

** 

**     You may not represent the covered work as solely your work.  All modified

**     versions of the covered work must be marked in a reasonable way to make it

**     clear that the modified work is not originating from Golden Code Development

**     Corporation or FWD.  All modified versions must contain the notices of

**     attribution required in this license.

*/

package com.goldencode.p2j.ui.client;

import java.util.*;

import com.fasterxml.jackson.annotation.*;

import com.goldencode.p2j.ui.*;

/**

 * Represents an abstract key and value storage that stores its data values into chunks in order

 * to store large data within the same storage backend with the capacity limit on the maximal

 * value size. 

 */

public abstract class UserKeyValueStorage

implements KeyValueStorage

{

   /**

    * Retrieves the value of the given key from this storage.

    * 

    * @param    key

    *           The given key

    * 

    * @return   The number value of the given key 

    */

   @Override

   public Number getNumber(String key)

   {

      Chunk head = getFirstChunk(key);

      if (head != null && head.head != null && head.head)

      {

         return head.number;

      }

      return null;

   }

   /**

    * Saves the number value of this key in this storage.

    * 

    * @param    key

    *           The given key

    * @param    value

    *           The value of the given key

    */

   @Override

   public void setNumber(String key, Number value)

   {

      if (isChunkKey(key))

      {

         return;

      }

      Chunk head = new Chunk();

      head.number = value;

      head.head  = true;

      saveHeadChunk(key, head);

      flushChanges();

   }

   /**

    * Retrieves the boolean value of the given key from this storage.

    * 

    * @param    key

    *           The given key

    * 

    * @return   The boolean value of the given key

    */

   @Override

   public Boolean getBoolean(String key)

   {

      Chunk head = getFirstChunk(key);

      if (head != null && head.head != null && head.head)

      {

         return head.bool;

      }

      return null;

   }

   /**

    * Saves the boolean value of this key in this storage.

    * 

    * @param    key

    *           The given key

    * @param    value

    *           The value of the given key

    */

   @Override

   public void setBoolean(String key, Boolean value)

   {

      if (isChunkKey(key))

      {

         return;

      }

      Chunk head = new Chunk();

      head.bool = value;

      head.head  = true;

      saveHeadChunk(key, head);

      flushChanges();

   }

   /**

    * Retrieves the string value of the given key from this storage.

    * 

    * @param    key

    *           The given key

    * 

    * @return   The string value of the given key

    */

   @Override

   public String getString(String key)

   {

      Chunk head = getFirstChunk(key);

      if (head != null && head.head != null && head.head)

      {

         if (head.nextChunkKey != null)

         {

            return collectChunks(key, head);

         }

         else

         {

            return head.value;

         }

      }

      return null;

   }

   /**

    * Saves the string value of this key in this storage.

    * 

    * @param    key

    *           The given key

    * @param    value

    *           The string value of the given key

    */

   @Override

   public void setString(String key, String value)

   {

      if (isChunkKey(key))

      {

         return;

      }

      saveByChunks(key, String.valueOf(value));

   }

   /**

    * Collect stored chunks into the string value of the given key.

    * 

    * @param    key

    *           The given key

    * @param    head

    *           The first chunk

    * 

    * @return   The string value of the given key

    */

   public String collectChunks(String key, Chunk head)

   {

      int size = head.size;

      char[] value = new char[size];

      int destPos = 0;

      int len = head.value.length();

      head.value.getChars(0, len, value, destPos);

      destPos += len;

      String nextChunkKey = head.nextChunkKey;

      while(nextChunkKey != null)

      {

         Chunk chunk = getNextChunk(head, nextChunkKey);

         if (chunk != null)

         {

            len = chunk.value.length();

            chunk.value.getChars(0, len, value, destPos);

            destPos += len;

            nextChunkKey = chunk.nextChunkKey;

         }

      }

      return new String(value);

   }

   /**

    * Saves the string value of this key in this storage by splitting it into chunks in order

    * to fit value capacity limits of this storage backend.

    * 

    * @param    key

    *           The given key

    * @param    value

    *           The string value of the given key

    */

   public void saveByChunks(String key, String value)

   {

      int maximalSize = getMaximalValueSize();

      int size = value.length();

      int curr = 0;

      int end;

      if (size > maximalSize)

      {

         end = maximalSize;

      }

      else

      {

         end = size;

      }

      LinkedList<Chunk> chunks = new LinkedList<>();

      Chunk head = new Chunk();

      head.value = value.substring(curr, end);

      head.size  = size;

      head.head  = true;

      if (end < size)

      {

         setUniqueHeadName(head);

      }

      chunks.add(head);

      int chunkNumber = 0;

      Chunk node = head;

      while(end < size)

      {

         node.nextChunkKey = getNextChunkKey(head, chunkNumber++);

         curr = end;

         int restSize = size - curr;

         if (restSize > maximalSize)

         {

            end = curr + maximalSize;

         }

         else

         {

            end = size;

         }

         node = new Chunk();

         node.value = value.substring(curr, end);

         chunks.add(node);

      }

      saveHeadChunk(key, head);

      node = head;

      for (int i = 1; i < chunks.size(); i++)

      {

         String nextChunkKey = node.nextChunkKey;

         node = chunks.get(i);

         saveNextChunk(head, nextChunkKey, node);

      }

      flushChanges();

   }

   /**

    * Sets the unique name to the given head chunk.

    * 

    * @param    head

    *           The first chunk

    */

   public void setUniqueHeadName(Chunk head)

   {

      head.name = UUID.randomUUID().toString();

   }

   /**

    * Returns the next chunk key.

    * 

    * @param    head

    *           The first chunk of the stored data value

    * @param    chunkNumber

    *           The current chunk number

    * 

    * @return   The next chunk key;

    */

   public String getNextChunkKey(Chunk head, int chunkNumber)

   {

      StringBuilder chunkKey = new StringBuilder(64);

      chunkKey.append(head.name).append('-').append(chunkNumber + 1);

      return chunkKey.toString();

   }

   /**

    * Tests if the given key is used by a chunk that follows the head chunk.

    * 

    * @param    key

    *           The given key to test

    * 

    * @return   Returns true if this key is used by a chunk.

    */

   public abstract boolean isChunkKey(String key);

   /**

    * Stores the head chunk with the given key within this storage backend.

    * 

    * @param    key

    *           The given key

    * @param    head

    *           The head chunk

    */

   public abstract void saveHeadChunk(String key, Chunk head);

   /**

    * Stores the given chunk with the given key within this storage backend.

    * 

    * @param    head

    *           The head chunk