Interface PropertyIfc

All Known Implementing Classes:
AggregatorNode, Asn1FileEINode, CommonProcessorNode, DCNode, DiscardingProcessorNode, DupRemoverNode, EINode, EmptyPartitionedDCNode, FFOINode, FileEINode, FileEnhancerNode, FlatFileEINode, FlexibleAggregatorNode, FtpFileEINode, FtpFileEnhancerNode, GeneralNPLProcessorNode, GenericUdpEINode, GenevaOINode, HCDeduplicatorEP, IPDREIFileNode, IPDREINode, JDBCEINode, JDBCOINode, LDAPEnhancerNode, MXAggregatorNode, NAREINode, NAROINode, NARSelectorNode, NARXMLOINode, NMinusOneRecordNode, NPLProcessorNode, NPLProcessorNodeMT, OIFtpNode, OINode, PartitionedDCNode, PortalOINode, ProcessorNode, RadiusOINode, SequenceProcessorNode, SoapXmlEINode, Sol42EINode, XMLEIFileNode, XMLEINode, XMLOIFileNode

public interface PropertyIfc
Defines methods for setting and retrieving general-purpose environment and runtime properties for the node.
  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
    Value of type for Environment subset of properties
    static final String
    Value of type for Runtime subset of properties
  • Method Summary

    Modifier and Type
    Method
    Description
    Retrieve the property value for the specified type and key.
    Retrieve a list of 'property keys' for the given type subset.
    Retrieve a list of 'property type' subsets.
    void
    setProperty(String type, String key, String value)
    Set the property value for the specified type and key.
  • Field Details

  • Method Details

    • getProperty

      String getProperty(String type, String key)
      Retrieve the property value for the specified type and key.
      Parameters:
      type - A String indicating the subset to which the property belongs (i.e. environment, runtime, etc.)
      key - A String indicating the specific property to be retrieved
      Returns:
      The value of the specified property, or null if the property has not been set
    • getPropertyTypes

      String[] getPropertyTypes()
      Retrieve a list of 'property type' subsets.
      Returns:
      A String[] containing the various 'types' of properties
    • getPropertyKeys

      String[] getPropertyKeys(String type)
      Retrieve a list of 'property keys' for the given type subset.
      Returns:
      A String[] containing the various 'keys' for the type subset
    • setProperty

      void setProperty(String type, String key, String value) throws IllegalArgumentException
      Set the property value for the specified type and key.
      Parameters:
      type - A String indicating the subset the property to which the property belongs (i.e. environment, runtime, etc.)
      key - A String indicating the specific property to be set
      value - The value of the property to be set. A null value will cause the current property to be unset.
      Throws:
      IllegalArgumentException - if type or key is null