copyright The Portico Project 2008.

org.portico.shared
Class PorticoConstants

java.lang.Object
  extended by org.portico.shared.PorticoConstants

public class PorticoConstants
extends Object


Field Summary
static String DEFAULT_PLUGIN_DIR
          The default plugin directory
static String DEFAULT_RTI_RID
          The location of the RID file to load.
static String LOG4J_CONFIG_FILE
          The default location Portico will look for the log4j configuration properties file
static boolean LOGGING_CONFIGURED
          A shared property that will signal when logging has/has not been configured so that multiple LRCs in one JVM or LRCs and RTIs in the same JVM don't overwrite each other
static boolean LRC_LOGGING_CONFIGURED
          The same as LOGGING_CONFIGURED, but only for LRCs
static long MAX_EXTENT
          Min/Max extent values for use in DDM
static int MAX_NUMBER_OF_EXTENTS
          The maximum number of extents allowed per region - at the moment there is no explicit reason for this number, it is just an arbitrary choice that should be safe
static long MIN_EXTENT
          Min/Max extent values for use in DDM
static String MRR_ERROR
          The multicast registry error response for unknown requests
static String MRR_MULTICAST_IP
          The multicast ip the multicast registry will listen on
static int MRR_MULTICAST_PORT
          The port the multicast registry will listen on
static String MRR_REQUEST
          The prefix for multicast registry requests
static String MRR_RESPONSE
          The prefix for multicast registry responses
static int NULL_HANDLE
          Consistent value for an invalid handle
static double NULL_TIME
          Consistent form for identifying an invalid time
static String PLUGIN_CONFIG_LRC
          The name of the resource that identifies an LRC plugin configuration file
static String PLUGIN_CONFIG_RTI
          The name of the resource that identifies an RTI plugin configuration file
static String PLUGIN_MANIFEST_LRC
          The name of the manifest main attribute that can point to a plugin file for the LRC
static String PLUGIN_MANIFEST_RTI
          The name of the manifest main attribute that can point to a plugin file for the RTI
static String RTI_NAME
          The official name for the RTI, used in the RTIFactory
static String RTI_VERSION
          The current version of the RTI
static boolean USE_Q_NAMES
          Should the ObjectModel types return their qualified names from toString()?
 
Constructor Summary
PorticoConstants()
           
 
Method Summary
static String arrayToString(int[] array)
          This is the same as setToString(Set), except that it works on an int[].
static String arrayToStringWithSizes(int[] array, byte[][] values)
          The same as arrayToString(int[]) except that it adds information about the size of the values provided in the second 2d array.
private static String getRtiVersion()
          Load the file "etc/portico.properties" into the system properties and then return the value of portico.version.
static String setToString(Set<Integer> set)
          This is a helper method that will convert a set of integers (presumed to be handles) into a String that lists them in the format: {1,2,3,x}
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

RTI_NAME

public static final String RTI_NAME
The official name for the RTI, used in the RTIFactory

See Also:
Constant Field Values

RTI_VERSION

public static final String RTI_VERSION
The current version of the RTI


NULL_TIME

public static final double NULL_TIME
Consistent form for identifying an invalid time

See Also:
Constant Field Values

NULL_HANDLE

public static final int NULL_HANDLE
Consistent value for an invalid handle

See Also:
Constant Field Values

DEFAULT_PLUGIN_DIR

public static final String DEFAULT_PLUGIN_DIR
The default plugin directory

See Also:
Constant Field Values

MRR_MULTICAST_IP

public static final String MRR_MULTICAST_IP
The multicast ip the multicast registry will listen on

See Also:
Constant Field Values

MRR_MULTICAST_PORT

public static final int MRR_MULTICAST_PORT
The port the multicast registry will listen on

See Also:
Constant Field Values

MRR_REQUEST

public static final String MRR_REQUEST
The prefix for multicast registry requests

See Also:
Constant Field Values

MRR_RESPONSE

public static final String MRR_RESPONSE
The prefix for multicast registry responses

See Also:
Constant Field Values

MRR_ERROR

public static final String MRR_ERROR
The multicast registry error response for unknown requests

See Also:
Constant Field Values

DEFAULT_RTI_RID

public static final String DEFAULT_RTI_RID
The location of the RID file to load. This is only used if found

See Also:
Constant Field Values

LOGGING_CONFIGURED

public static boolean LOGGING_CONFIGURED
A shared property that will signal when logging has/has not been configured so that multiple LRCs in one JVM or LRCs and RTIs in the same JVM don't overwrite each other


LRC_LOGGING_CONFIGURED

public static boolean LRC_LOGGING_CONFIGURED
The same as LOGGING_CONFIGURED, but only for LRCs


LOG4J_CONFIG_FILE

public static String LOG4J_CONFIG_FILE
The default location Portico will look for the log4j configuration properties file


USE_Q_NAMES

public static boolean USE_Q_NAMES
Should the ObjectModel types return their qualified names from toString()? If true, they will, otherwise, they'll return the handle values


PLUGIN_CONFIG_RTI

public static final String PLUGIN_CONFIG_RTI
The name of the resource that identifies an RTI plugin configuration file

See Also:
Constant Field Values

PLUGIN_MANIFEST_RTI

public static final String PLUGIN_MANIFEST_RTI
The name of the manifest main attribute that can point to a plugin file for the RTI

See Also:
Constant Field Values

PLUGIN_CONFIG_LRC

public static final String PLUGIN_CONFIG_LRC
The name of the resource that identifies an LRC plugin configuration file

See Also:
Constant Field Values

PLUGIN_MANIFEST_LRC

public static final String PLUGIN_MANIFEST_LRC
The name of the manifest main attribute that can point to a plugin file for the LRC

See Also:
Constant Field Values

MIN_EXTENT

public static final long MIN_EXTENT
Min/Max extent values for use in DDM

See Also:
Constant Field Values

MAX_EXTENT

public static final long MAX_EXTENT
Min/Max extent values for use in DDM

See Also:
Constant Field Values

MAX_NUMBER_OF_EXTENTS

public static final int MAX_NUMBER_OF_EXTENTS
The maximum number of extents allowed per region - at the moment there is no explicit reason for this number, it is just an arbitrary choice that should be safe

See Also:
Constant Field Values
Constructor Detail

PorticoConstants

public PorticoConstants()
Method Detail

getRtiVersion

private static String getRtiVersion()
Load the file "etc/portico.properties" into the system properties and then return the value of portico.version.


setToString

public static String setToString(Set<Integer> set)
This is a helper method that will convert a set of integers (presumed to be handles) into a String that lists them in the format: {1,2,3,x}


arrayToString

public static String arrayToString(int[] array)
This is the same as setToString(Set), except that it works on an int[].


arrayToStringWithSizes

public static String arrayToStringWithSizes(int[] array,
                                            byte[][] values)
The same as arrayToString(int[]) except that it adds information about the size of the values provided in the second 2d array. Sample output: {32(12b),3(1b)}

Parameters:
handles - The handles to put in the output
values - The values associated with the handles, the length of the values array is used

copyright The Portico Project 2008.