Package jadex.base

Interface IPlatformConfiguration

  • public interface IPlatformConfiguration
    Interface for platform configuration.

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static java.lang.String ASYNCEXECUTION
      Use asynchronous execution mode?
      static java.lang.String AWADELAY
      The awareness delay in milliseconds
      static java.lang.String AWAEXCLUDES
      Exclude entries for awareness agent.
      static java.lang.String AWAINCLUDES
      Include entries for awareness agent.
      static java.lang.String AWAMECHANISM_BROADCAST
      Uses IPv4 broadcast to announce awareness infos in local networks.
      static java.lang.String AWAMECHANISM_LOCAL
      The local discovery uses a file-based mechanism to detect platforms running on the same host.
      static java.lang.String AWAMECHANISM_MULTICAST
      Uses IPv4 Multicast to find other platforms.
      static java.lang.String AWAMECHANISM_REGISTRY
      The Registry mechanism implements a master-slave mechanism, where one platform is the registry.
      static java.lang.String AWAMECHANISM_SCANNER
      The IP-Scanner discovery mechanism sends out awareness infos to all IP addresses within the local network (using port 55668)
      static java.lang.String AWAMECHANISMS
      Specify the awareness agent discovery mechanisms (comma separated).
      static java.lang.String AWARENESS
      Start the awareness agent (awa) for automatic platform discovery.
      static java.lang.String BASECLASSLOADER
      The base classloader.
      static java.lang.String BINARYMESSAGES
      Use a compact binary message format instead of XML by default.
      static java.lang.String[] BOOLEAN_ARGS
      This is used for consistency checks and includes all argument names which refer to boolean arguments.
      static java.lang.String CHAT
      Start the chat agent for instant messaging and file transfer with user Jadex users.
      static java.lang.String CLI
      Start the platform with command line interface (cli) activated?
      static java.lang.String CLICONSOLE
      Start cli with console in or not
      static java.lang.String COMPONENT
      The component flag argument (for starting an additional component).
      static java.lang.String COMPONENT_FACTORY
      The component factory classname argument.
      static java.lang.String CONFIGURATION_FILE
      The configuration file argument.
      static java.lang.String CONFIGURATION_NAME
      The configuration to use.
      static java.lang.String CONTEXTSERVICECLASS
      Optionally provide alternative context service implementation.
      static java.lang.String DEBUGFUTURES
      The debug futures flag argument.
      static java.lang.String DEBUGSERVICES
      The debug futures services argument.
      static java.lang.String DEBUGSTEPS
      The debug futures services argument.
      static java.lang.String DEFTIMEOUT
      The default timeout argument.
      static java.lang.String FALLBACK_COMPONENT_FACTORY
      The default component factory to be used for platform component.
      static java.lang.String FALLBACK_PLATFORM_CONFIGURATION
      The default platform configuration.
      static java.lang.String GUI
      Start the JCC agent to open the platform GUI?
      static java.lang.String JCCPLATFORMS
      Open JCC for specific remote platforms.
      static java.lang.String KERNELS
      The name(s) of kernel(s) to load (separated by comma).
      static java.lang.String LIBPATH
      Additional library paths (classpath entries) for loading agent models and classes.
      static java.lang.String LOCALTRANSPORT
      Flag if local transport is enabled.
      static java.lang.String LOGGING
      Enable verbose logging (shortcut for setting logging_level to info).
      static java.lang.String LOGGING_LEVEL
      Logging level for platform.
      static java.lang.String MAVEN_DEPENDENCIES
      Flag to enable the Maven dependency service (requires Jadex Pro add-on).
      static java.lang.String MONITORING
      The monitoring flag argument.
      static java.lang.String NOSTACKCOMPACTION
      The stack compaction disable flag argument.
      static java.lang.String OPENGL
      The opengl disable flag argument.
      static java.lang.String PARAMETERCOPY
      Flag if copying parameters for local service calls is allowed.
      static java.lang.String PERSIST
      The persist flag argument.
      static java.lang.String PLATFORM_COMPONENT
      Tell the starter to use the default platform component implementation (usually no need to change).
      static java.lang.String PLATFORM_NAME
      The name of the platform component (null for auto generation).
      static java.lang.String PLATFORMARGS  
      static java.lang.String PLATFORMCONFIG  
      static java.lang.String PLATFORMMODEL  
      static java.lang.String PLATFORMPROXIES
      Flag if CIDs may be reused (true for not).
      static java.lang.String PRINTEXCEPTIONS
      Flag if exceptions should be printed.
      static java.lang.String PROGRAM_ARGUMENTS  
      static java.lang.String REALTIMETIMEOUT
      Flag if local timeouts should be realtime (instead of clock dependent).
      static java.lang.String RELAYADDRESSES
      Address(es) for relay transport (one or more addresses separated by commas).
      static java.lang.String RELAYFORWARDING  
      static java.lang.String RELAYTRANSPORT
      Flag if relay transport is enabled.
      static java.lang.String RSPUBLISH
      Flag if rest service publishing is enabled.
      static java.lang.String RSPUBLISHCOMPONENT
      Optionally provide alternative rs publish implementation.
      static java.lang.String SAVEONEXIT
      Save platform settings on shutdown?
      static java.lang.String SIMULATION
      Use simulation execution mode?
      static java.lang.String STRICTCOM
      Fail on recoverable message decoding errors instead of ignoring.
      static java.lang.String TCPPORT
      Port for TCP transport.
      static java.lang.String TCPTRANSPORT
      Flag if tcp transport is enabled.
      static java.lang.String THREADPOOLCLASS
      Optionally provide alternative thread pool implementation.
      static java.lang.String THREADPOOLDEFER
      Flag for deferring thread creation/deletion in thread pool
      static java.lang.String UNIQUEIDS
      Flag if CIDs may be reused (true for not).
      static java.lang.String WELCOME
      Tell starter to print welcome message.
      static java.lang.String WSPORT  
      static java.lang.String WSPUBLISH
      Flag if web service publishing is enabled.
      static java.lang.String WSTRANSPORT  

    • Field Detail

      • PLATFORM_NAME

        static final java.lang.String PLATFORM_NAME
        The name of the platform component (null for auto generation). To use a custom prefix name and an auto generated postfix the name should end with _* (3 digits) or with _ and an arbitrary number of +, e.g. _++++.
        See Also:
        Constant Field Values

      • CONFIGURATION_NAME

        static final java.lang.String CONFIGURATION_NAME
        The configuration to use.
        See Also:
        Constant Field Values

      • PLATFORM_COMPONENT

        static final java.lang.String PLATFORM_COMPONENT
        Tell the starter to use the default platform component implementation (usually no need to change).
        See Also:
        Constant Field Values

      • FALLBACK_PLATFORM_CONFIGURATION

        static final java.lang.String FALLBACK_PLATFORM_CONFIGURATION
        The default platform configuration.
        See Also:
        Constant Field Values

      • FALLBACK_COMPONENT_FACTORY

        static final java.lang.String FALLBACK_COMPONENT_FACTORY
        The default component factory to be used for platform component.
        See Also:
        Constant Field Values

      • CONFIGURATION_FILE

        static final java.lang.String CONFIGURATION_FILE
        The configuration file argument.
        See Also:
        Constant Field Values

      • COMPONENT_FACTORY

        static final java.lang.String COMPONENT_FACTORY
        The component factory classname argument.
        See Also:
        Constant Field Values

      • MONITORING

        static final java.lang.String MONITORING
        The monitoring flag argument.
        See Also:
        Constant Field Values

      • COMPONENT

        static final java.lang.String COMPONENT
        The component flag argument (for starting an additional component).
        See Also:
        Constant Field Values

      • PERSIST

        static final java.lang.String PERSIST
        The persist flag argument.
        See Also:
        Constant Field Values

      • DEFTIMEOUT

        static final java.lang.String DEFTIMEOUT
        The default timeout argument.
        See Also:
        Constant Field Values

      • DEBUGFUTURES

        static final java.lang.String DEBUGFUTURES
        The debug futures flag argument.
        See Also:
        Constant Field Values

      • DEBUGSERVICES

        static final java.lang.String DEBUGSERVICES
        The debug futures services argument.
        See Also:
        Constant Field Values

      • DEBUGSTEPS

        static final java.lang.String DEBUGSTEPS
        The debug futures services argument.
        See Also:
        Constant Field Values

      • NOSTACKCOMPACTION

        static final java.lang.String NOSTACKCOMPACTION
        The stack compaction disable flag argument.
        See Also:
        Constant Field Values

      • OPENGL

        static final java.lang.String OPENGL
        The opengl disable flag argument.
        See Also:
        Constant Field Values

      • PRINTEXCEPTIONS

        static final java.lang.String PRINTEXCEPTIONS
        Flag if exceptions should be printed.
        See Also:
        Constant Field Values

      • PARAMETERCOPY

        static final java.lang.String PARAMETERCOPY
        Flag if copying parameters for local service calls is allowed.
        See Also:
        Constant Field Values

      • REALTIMETIMEOUT

        static final java.lang.String REALTIMETIMEOUT
        Flag if local timeouts should be realtime (instead of clock dependent).
        See Also:
        Constant Field Values

      • AWAMECHANISM_BROADCAST

        static final java.lang.String AWAMECHANISM_BROADCAST
        Uses IPv4 broadcast to announce awareness infos in local networks. Default Port used is 55670.
        See Also:
        Constant Field Values

      • AWAMECHANISM_MULTICAST

        static final java.lang.String AWAMECHANISM_MULTICAST
        Uses IPv4 Multicast to find other platforms. Default multicast address used is 224.0.0.0, port 5567.
        See Also:
        Constant Field Values

      • AWAMECHANISM_LOCAL

        static final java.lang.String AWAMECHANISM_LOCAL
        The local discovery uses a file-based mechanism to detect platforms running on the same host.
        See Also:
        Constant Field Values

      • AWAMECHANISM_REGISTRY

        static final java.lang.String AWAMECHANISM_REGISTRY
        The Registry mechanism implements a master-slave mechanism, where one platform is the registry. Other platforms that have this mechanism enabled register themselves and the registry distributes awareness info to all registered platforms. All RegistryDiscoveryAgents have to be parameterized with the same ip address (of the registry).
        See Also:
        Constant Field Values

      • AWAMECHANISM_SCANNER

        static final java.lang.String AWAMECHANISM_SCANNER
        The IP-Scanner discovery mechanism sends out awareness infos to all IP addresses within the local network (using port 55668)
        See Also:
        Constant Field Values

      • WELCOME

        static final java.lang.String WELCOME
        Tell starter to print welcome message.
        See Also:
        Constant Field Values

      • GUI

        static final java.lang.String GUI
        Start the JCC agent to open the platform GUI?
        See Also:
        Constant Field Values

      • CLI

        static final java.lang.String CLI
        Start the platform with command line interface (cli) activated? (requires Jadex Pro add-on)
        See Also:
        Constant Field Values

      • CLICONSOLE

        static final java.lang.String CLICONSOLE
        Start cli with console in or not
        See Also:
        Constant Field Values

      • SAVEONEXIT

        static final java.lang.String SAVEONEXIT
        Save platform settings on shutdown?
        See Also:
        Constant Field Values

      • JCCPLATFORMS

        static final java.lang.String JCCPLATFORMS
        Open JCC for specific remote platforms.
        See Also:
        Constant Field Values

      • LOGGING

        static final java.lang.String LOGGING
        Enable verbose logging (shortcut for setting logging_level to info).
        See Also:
        Constant Field Values

      • LOGGING_LEVEL

        static final java.lang.String LOGGING_LEVEL
        Logging level for platform.
        See Also:
        Constant Field Values

      • SIMULATION

        static final java.lang.String SIMULATION
        Use simulation execution mode?
        See Also:
        Constant Field Values

      • ASYNCEXECUTION

        static final java.lang.String ASYNCEXECUTION
        Use asynchronous execution mode?
        See Also:
        Constant Field Values

      • UNIQUEIDS

        static final java.lang.String UNIQUEIDS
        Flag if CIDs may be reused (true for not).
        See Also:
        Constant Field Values

      • PLATFORMPROXIES

        static final java.lang.String PLATFORMPROXIES
        Flag if CIDs may be reused (true for not).
        See Also:
        Constant Field Values

      • THREADPOOLDEFER

        static final java.lang.String THREADPOOLDEFER
        Flag for deferring thread creation/deletion in thread pool
        See Also:
        Constant Field Values

      • LIBPATH

        static final java.lang.String LIBPATH
        Additional library paths (classpath entries) for loading agent models and classes.
        See Also:
        Constant Field Values

      • BASECLASSLOADER

        static final java.lang.String BASECLASSLOADER
        The base classloader.
        See Also:
        Constant Field Values

      • CHAT

        static final java.lang.String CHAT
        Start the chat agent for instant messaging and file transfer with user Jadex users.
        See Also:
        Constant Field Values

      • AWARENESS

        static final java.lang.String AWARENESS
        Start the awareness agent (awa) for automatic platform discovery.
        See Also:
        Constant Field Values

      • AWAMECHANISMS

        static final java.lang.String AWAMECHANISMS
        Specify the awareness agent discovery mechanisms (comma separated).
        See Also:
        Constant Field Values

      • AWADELAY

        static final java.lang.String AWADELAY
        The awareness delay in milliseconds
        See Also:
        Constant Field Values

      • AWAINCLUDES

        static final java.lang.String AWAINCLUDES
        Include entries for awareness agent.
        See Also:
        Constant Field Values

      • AWAEXCLUDES

        static final java.lang.String AWAEXCLUDES
        Exclude entries for awareness agent.
        See Also:
        Constant Field Values

      • BINARYMESSAGES

        static final java.lang.String BINARYMESSAGES
        Use a compact binary message format instead of XML by default.
        See Also:
        Constant Field Values

      • STRICTCOM

        static final java.lang.String STRICTCOM
        Fail on recoverable message decoding errors instead of ignoring.
        See Also:
        Constant Field Values

      • LOCALTRANSPORT

        static final java.lang.String LOCALTRANSPORT
        Flag if local transport is enabled.
        See Also:
        Constant Field Values

      • TCPTRANSPORT

        static final java.lang.String TCPTRANSPORT
        Flag if tcp transport is enabled.
        See Also:
        Constant Field Values

      • RELAYTRANSPORT

        static final java.lang.String RELAYTRANSPORT
        Flag if relay transport is enabled.
        See Also:
        Constant Field Values

      • RELAYADDRESSES

        static final java.lang.String RELAYADDRESSES
        Address(es) for relay transport (one or more addresses separated by commas).
        See Also:
        Constant Field Values

      • WSPUBLISH

        static final java.lang.String WSPUBLISH
        Flag if web service publishing is enabled.
        See Also:
        Constant Field Values

      • RSPUBLISH

        static final java.lang.String RSPUBLISH
        Flag if rest service publishing is enabled.
        See Also:
        Constant Field Values

      • RSPUBLISHCOMPONENT

        static final java.lang.String RSPUBLISHCOMPONENT
        Optionally provide alternative rs publish implementation.
        See Also:
        Constant Field Values

      • KERNELS

        static final java.lang.String KERNELS
        The name(s) of kernel(s) to load (separated by comma). Currently supports 'component', 'micro', 'bpmn', 'bdi', 'gpmn' and 'application' kernel. Alternatively, the 'multi' can be used to start any available kernels on demand. Specifying 'all' will start all available kernels directly.
        See Also:
        Constant Field Values

      • MAVEN_DEPENDENCIES

        static final java.lang.String MAVEN_DEPENDENCIES
        Flag to enable the Maven dependency service (requires Jadex Pro add-on).
        See Also:
        Constant Field Values

      • THREADPOOLCLASS

        static final java.lang.String THREADPOOLCLASS
        Optionally provide alternative thread pool implementation.
        See Also:
        Constant Field Values

      • CONTEXTSERVICECLASS

        static final java.lang.String CONTEXTSERVICECLASS
        Optionally provide alternative context service implementation.
        See Also:
        Constant Field Values

      • BOOLEAN_ARGS

        static final java.lang.String[] BOOLEAN_ARGS
        This is used for consistency checks and includes all argument names which refer to boolean arguments.

    • Method Detail

      • getExtendedPlatformConfiguration

        IExtendedPlatformConfiguration getExtendedPlatformConfiguration()
        Get the extended platform configuration.
        Returns:
        The extended platform configuration.

      • getValues

        java.util.Map<java.lang.String,​java.lang.Object> getValues()
        Get all values of the configuration as map.
        Returns:
        The values.

      • enhanceWith

        void enhanceWith​(IPlatformConfiguration other)
        Enhance this config with given other config. Will overwrite all values that are set in the other config.

      • setReadOnly

        void setReadOnly​(boolean readonly)
        Set the readonly state.
        Parameters:
        readonly - The readonly state.

      • isReadOnly

        boolean isReadOnly()
        Get the readonly state.
        Returns:
        The readonly state.

      • getValue

        java.lang.Object getValue​(java.lang.String key,
                          IModelInfo model)
        Get a value per key.
        Parameters:
        key - The key.
        Returns:
        The value.

      • setValue

        void setValue​(java.lang.String key,
              java.lang.Object value)
        Set a value per key.
        Parameters:
        key - The key.

      • getPlatformName

        java.lang.String getPlatformName()
        Get the platform name.
        Returns:
        The platform name.

      • setPlatformName

        void setPlatformName​(java.lang.String value)
        Set the platform name.
        Parameters:
        value - The name.

      • getConfigurationName

        java.lang.String getConfigurationName()
        Get the configuration name.
        Returns:
        The configuration name.

      • setConfigurationName

        void setConfigurationName​(java.lang.String value)
        Set the configuration name.
        Parameters:
        value - The configuration name.

      • addComponent

        void addComponent​(java.lang.Class<?> clazz)
        Add a component via class.
        Parameters:
        clazz - The classinfo of the component.

      • addComponent

        void addComponent​(java.lang.String path)
        Add a component via file.
        Parameters:
        path - The file path.

      • setComponents

        void setComponents​(java.util.List<java.lang.String> newcomps)
        Set multiple components as list.
        Parameters:
        newcomps - The list of components.

      • getComponents

        java.util.List<java.lang.String> getComponents()
        Get the components as list.
        Returns:
        The components.

      • isPrintExceptions

        boolean isPrintExceptions()
        Shall print exceptions.
        Returns:
        Flag is exceptions should be printed.

      • setPrintExceptions

        void setPrintExceptions​(boolean printex)
        Set print exceptions flag.

      • setDefaultTimeout

        void setDefaultTimeout​(long to)
        Set the default timeout.
        Parameters:
        to - The timeout.

      • getDefaultTimeout

        java.lang.Long getDefaultTimeout()
        Get the default timeout.
        Returns:
        The default timeout.

      • getWelcome

        boolean getWelcome()
        Get the welcome flag.
        Returns:
        True means print welcome message.

      • setWelcome

        void setWelcome​(boolean value)
        Tell starter to print welcome message.
        Parameters:
        value -

      • getGui

        boolean getGui()
        Get the flag if gui is opened.
        Returns:
        True means start with gui.

      • setGui

        void setGui​(boolean value)
        Set the gui flag.
        Parameters:
        value - True for starting with gui.

      • getLogging

        boolean getLogging()
        Get the logging flag.
        Returns:
        The logging flag.

      • setLogging

        void setLogging​(boolean value)
        Set the logging flag.
        Parameters:
        value - The logging flag.

      • getLoggingLevel

        java.util.logging.Level getLoggingLevel()
        Get the logging level.
        Returns:
        The logging level.

      • setLoggingLevel

        void setLoggingLevel​(java.util.logging.Level value)
        Set the logging level.
        Parameters:
        value - The logging level.

      • getAwareness

        boolean getAwareness()
        Get the flag for starting with awareness.
        Returns:
        True for starting with awareness.

      • setAwareness

        void setAwareness​(boolean value)
        Set the flag for starting with awareness.
        Parameters:
        value - True for starting with awareness.

      • getSensors

        boolean getSensors()
        Get the sensors flag.
        Returns:
        The sensors flag.

      • setSensors

        void setSensors​(boolean value)
        Set the sensors flag.
        Parameters:
        value - The sensors flag.

      • getSuperpeer

        boolean getSuperpeer()
        Get the superpeer flag.
        Returns:
        The superpeer flag.

      • setSuperpeer

        void setSuperpeer​(boolean value)
        Set the superpeer flag.
        Parameters:
        value - The superpeer flag.

      • getSupersuperpeer

        boolean getSupersuperpeer()
        Get the superpeer flag.
        Returns:
        The superpeer flag.

      • setSupersuperpeer

        void setSupersuperpeer​(boolean value)
        Set the supersuperpeer flag.
        Parameters:
        value - The supersuperpeer flag.

      • getSuperpeerClient

        boolean getSuperpeerClient()
        Get the superpeer client flag.
        Returns:
        The superpeer client flag.

      • setSuperpeerClient

        void setSuperpeerClient​(boolean value)
        Set the superpeer client flag.
        Parameters:
        value - The superpeer client flag.

      • getNetworkNames

        java.lang.String[] getNetworkNames()
        Get the network name (used at startup).
        Returns:
        The network name.

      • setNetworkNames

        void setNetworkNames​(java.lang.String... value)
        Set the network name (used at startup).
        Parameters:
        value - The network name.

      • isUseSecret

        boolean isUseSecret()
        Returns if the security service should use a platform secret for authentication. If false only networks are considered for authentication.
        Returns:
        True if the security service should use a platform secret.

      • setUseSecret

        void setUseSecret​(boolean usesecret)
        Sets if the security service should use a platform secret for authentication. If false only networks are considered for authentication.
        Parameters:
        usesecret - Set true (default) if the security service should use a platform secret.

      • isPrintSecret

        boolean isPrintSecret()
        Returns if the security service should print the platform secret during start.
        Returns:
        True if the security service should print the platform secret during start.

      • setPrintSecret

        void setPrintSecret​(boolean printsecret)
        Returns if the security service should print the platform secret during start.
        Parameters:
        Set - true (default) if the security service should print the platform secret during start.

      • isRefuseUnauth

        boolean isRefuseUnauth()
        Returns if the security service allows unauthenticated connections.
        Returns:
        True, if unauthenticated connections are refused.

      • setRefuseUnauth

        void setRefuseUnauth​(boolean refuseunauth)
        Configure the security service to whether to allow unauthenticated connections. This must be set to false if Security.UNRESTRICTED services are used or offered. Default is false.
        Parameters:
        refuseunauth - Flag if unauthenticated platforms are refused.

      • getNetworkSecrets

        java.lang.String[] getNetworkSecrets()
        Get the network secret (used at startup).
        Returns:
        The network secret.

      • setNetworkSecrets

        void setNetworkSecrets​(java.lang.String... value)
        Set the network secret (used at startup).
        Parameters:
        value - The network secret.