extensions/net.sf.basedb.opengrid/trunk/src/net/sf/basedb/opengrid/json/JSONOption.java

Code
Comments
Other
Rev Date Author Line
4257 30 Nov 16 nicklas 1 package net.sf.basedb.opengrid.json;
4257 30 Nov 16 nicklas 2
4320 24 Jan 17 nicklas 3 import net.sf.basedb.core.DbControl;
4257 30 Nov 16 nicklas 4 import net.sf.basedb.opengrid.OpenGridCluster;
4275 19 Dec 16 nicklas 5 import net.sf.basedb.opengrid.config.ClusterConfig;
4257 30 Nov 16 nicklas 6 import net.sf.basedb.opengrid.config.ConnectionInfo;
4257 30 Nov 16 nicklas 7
4257 30 Nov 16 nicklas 8 /**
4257 30 Nov 16 nicklas 9   Define individual options that can be enabled when
4257 30 Nov 16 nicklas 10   returning data in JSON format.
4257 30 Nov 16 nicklas 11   
4257 30 Nov 16 nicklas 12   @author nicklas
4257 30 Nov 16 nicklas 13   @since 1.0
4257 30 Nov 16 nicklas 14 */
4257 30 Nov 16 nicklas 15 public class JSONOption 
4257 30 Nov 16 nicklas 16 {
4257 30 Nov 16 nicklas 17
4257 30 Nov 16 nicklas 18   /**
4257 30 Nov 16 nicklas 19     Returns the connection password when calling
4257 30 Nov 16 nicklas 20     {@link ConnectionInfo#asJSONObject(JSONOptions)}.
4257 30 Nov 16 nicklas 21   */
4257 30 Nov 16 nicklas 22   public static final JSONOption CONNECTION_PASSWORD = new JSONOption("CONNECTION_PASSWORD");
4257 30 Nov 16 nicklas 23   
4257 30 Nov 16 nicklas 24   /**
4741 09 Apr 18 nicklas 25     Returns the private key information (including password)
4741 09 Apr 18 nicklas 26     when calling {@link ConnectionInfo#asJSONObject(JSONOptions)}.
4741 09 Apr 18 nicklas 27     @since 1.2
4741 09 Apr 18 nicklas 28   */
4741 09 Apr 18 nicklas 29   public static final JSONOption PRIVATE_KEY = new JSONOption("PRIVATE_KEY");
4741 09 Apr 18 nicklas 30   
4741 09 Apr 18 nicklas 31   /**
4257 30 Nov 16 nicklas 32     Include the Open Grid cluster information from 
4257 30 Nov 16 nicklas 33     {@link OpenGridCluster#getClusterInfo()} when calling
4257 30 Nov 16 nicklas 34     {@link OpenGridCluster#asJSONObject(JSONOptions)}.
4257 30 Nov 16 nicklas 35   */
4257 30 Nov 16 nicklas 36   public static final JSONOption CLUSTER_INFO = new JSONOption("CLUSTER_INFO");
6827 31 Aug 22 nicklas 37
6827 31 Aug 22 nicklas 38   /**
6827 31 Aug 22 nicklas 39     Include the custom configuration options when calling
6827 31 Aug 22 nicklas 40     {@link ClusterConfig#asJSONObject(JSONOptions)}.
6827 31 Aug 22 nicklas 41     @since 1.7
6827 31 Aug 22 nicklas 42   */
6827 31 Aug 22 nicklas 43   public static final JSONOption CUSTOM_OPTIONS = new JSONOption("CUSTOM_OPTIONS");
6827 31 Aug 22 nicklas 44
4257 30 Nov 16 nicklas 45   
4275 19 Dec 16 nicklas 46   /**
4275 19 Dec 16 nicklas 47     Inlcude the node information when calling
4275 19 Dec 16 nicklas 48     {@link ClusterConfig#asJSONObject(JSONOptions)}.
4275 19 Dec 16 nicklas 49   */
4275 19 Dec 16 nicklas 50   public static final JSONOption NODE_INFO = new JSONOption("NODE_INFO");
4275 19 Dec 16 nicklas 51   
4317 23 Jan 17 nicklas 52   /**
4317 23 Jan 17 nicklas 53     Inlcude job agent information from the BASE database
4317 23 Jan 17 nicklas 54     when calling {@link ClusterConfig#asJSONObject(JSONOptions)}.
4317 23 Jan 17 nicklas 55     This option is ignored unless a {@link DbControl} has been set on
4317 23 Jan 17 nicklas 56     the {@link JSONOptions} instance.
4317 23 Jan 17 nicklas 57    */
4317 23 Jan 17 nicklas 58   public static final JSONOption JOBAGENT_INFO = new JSONOption("JOBAGENT_INFO");
4317 23 Jan 17 nicklas 59   
4257 30 Nov 16 nicklas 60   private final String name;
4257 30 Nov 16 nicklas 61   public JSONOption(String name)
4257 30 Nov 16 nicklas 62   {
4257 30 Nov 16 nicklas 63     this.name = name;
4257 30 Nov 16 nicklas 64   }
4257 30 Nov 16 nicklas 65   
4257 30 Nov 16 nicklas 66   @Override
4257 30 Nov 16 nicklas 67   public String toString() 
4257 30 Nov 16 nicklas 68   {
4257 30 Nov 16 nicklas 69     return name;
4257 30 Nov 16 nicklas 70   }
4257 30 Nov 16 nicklas 71     
4257 30 Nov 16 nicklas 72 }

Generated on Tue Nov 21 03:28:25 2023 (UTC) by svndigest 0.11.2pre (dev build 1672)