Class ProviderConfiguration

  • All Implemented Interfaces:
    java.io.Serializable

    public class ProviderConfiguration
    extends java.lang.Object
    implements java.io.Serializable
    See Also:
    Serialized Form
    • Constructor Detail

      • ProviderConfiguration

        public ProviderConfiguration​(java.lang.String name)
    • Method Detail

      • getName

        public java.lang.String getName()
      • getAllowTagCustomization

        public boolean getAllowTagCustomization()
        If true, the provider will allow users to define additional properties on the tag, such as alarms, history, and so on. Default is TRUE.
      • getAllowTagDeletion

        public boolean getAllowTagDeletion()
        If true, the user will be allowed to delete tags. Otherwise the provider will be the only entity allowed to manage tag removal. Default is FALSE.
      • getPersistTags

        public boolean getPersistTags()
        If true, the system will store definitions for all tags that are created, so that they will be available on startup, even if the system does not create them again. This is useful for systems that build tag models on outside data that might take some time to acquire, or otherwise might not be available immediately on startup, and will be later reconciled. A few notes on compatibility with other settings: 1) If this property is FALSE, but AllowTagCustomizations is TRUE, only changes created by the user will be stored, and the tag will not be displayed until created by the manager. 2) If this is FALSE, PersistValues will be ignored.
      • getPersistValues

        public boolean getPersistValues()
        Indicates whether values of tags should be stored. Used in conjunction with PersistTags, as it is ignored if tags are not persisted. If TRUE, values will be stored and loaded on startup. If FALSE, loaded tags will have bad (stale) quality until they are updated by the manager.
      • getStaleTimeoutMS

        public long getStaleTimeoutMS()
        Not currently implemented fully, is used to mark persistent values stale if value is anything other than 0.
      • getMountPath

        public java.lang.String getMountPath()
        The mount path is a folder structure under which all tags for this provider will reside.
      • getAttributes

        public Flags getAttributes()
      • getAllowDefaultWriteHandling

        public boolean getAllowDefaultWriteHandling()
        Default write handling means that writes to tags will be allowed and will not require a write handler to be installed.
      • hasDataTypes

        public boolean hasDataTypes()
      • setStaleTimeoutMS

        public ProviderConfiguration setStaleTimeoutMS​(long value)
        Not currently implemented fully, is used to mark persistent values stale if value is anything other than 0.
      • setAttribute

        public ProviderConfiguration setAttribute​(int flag,
                                                  boolean value)
        These attributes affect advanced traits of the provider, and currently come from TagProviderProps
      • setAllowDefaultWriteHandling

        public ProviderConfiguration setAllowDefaultWriteHandling​(boolean value)
        If true, writes to tags will be allowed and will not require a write handler to be installed. If false, the manager of the provider must register a WriteHandler for each tag (or wildcard path) that will allow writes. Registered write handlers will still be called, if this value is true.
      • equals

        public boolean equals​(java.lang.Object o)
        Overrides:
        equals in class java.lang.Object
      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class java.lang.Object