All Downloads are FREE. Search and download functionalities are using the official Maven repository.

config.louie_config.xsd Maven / Gradle / Ivy

The newest version!


  
    
      louie is the expected root element of the louie configuration file
    
    
      
        
          
            If present, loads the xml file specified, and resets the config parser to load configs from this new file. Nothing else from the current xml file will be parsed.
          
        
        
          
            "servers" denotes a block of known louie deployments
          
          
            
              
                
                  "server" is an expected element name, and "name" is an expected attribute."name" will represent an easily accessible key for this host w/in the louie environment
                
                
                  
                    
                      
                        "host" is the address or resolvable host name
                      
                    
                    
                      
                        "location" represents a more constant way for a service to find a remote server (since the serving hardware may change)
                      
                    
                    
                      
                        "display" is informational only
                      
                    
                    
                      
                        "timezone" is a Java TimeZone compatible time zone ID. see: TimeZone.getAvailableIDs();
                      
                    
                    
                      
                        "gateway" represents an alternate gateway/context-root (Default is 'louie')
                      
                    
                    
                      
                        "port" is the designated port for HTTP connections (Default is 8080)
                      
                    
                    
                      
                        "ip" can be specified if the hostname is not resolvable via DNS
                      
                    
                    
                      
                        "external_ip" is used in the event that a client does not have access to the servers internal ip
                      
                    
                    
                      
                        "central_auth" denotes a server which will act as a centralized auth across a distributed set of Louies in one datacenter.
                      
                    
                    
                      
                        "secure" denotes that this host will be reachable only through HTTPS and that users will have to be properly authenticated
                      
                    
                    
                      
                        Any custom configurations must be placed inside this block
                      
                      
                        
                          
                            
                              This custom configuration will be handled as key:value where key is the element name and value is the element value
                            
                          
                        
                      
                    
                  
                  
                
              
            
          
        
        
          
            "services" is an expected element, denoting a block of configured services for this deployment
          
          
            
              
                
                  "defaults" is an expected element name, representing default configurations for any serviceswhich may not be explicitly configured here. (Service configurations are generated for anyfound services without explicit configurations by inheriting these defaults)
                
                
                  
                    
                      
                        "enable" as the default, this specifies whether this deployment behaves as opt-in or opt-out for starting up services
                      
                    
                    
                      
                        DEPRECATED in favor of remote_server. "remote_host" represents a remote host for remote layers (services which reroute all calls to a specific host)
                      
                    
                    
                      
                        "remote_server" represents a remote server from the servers list for remote layers (services which reroute all calls to a specific host)
                      
                    
                    
                      
                        "readonly" disables Service methods which were annotated w/ @Updating
                      
                    
                    
                      
                        "caching" can enable/disable a caching layer (Currently it is up to the developer to check this w/in their Service implementation)
                      
                    
                  
                
              
              
                
                  Represents configurations for a single service. Missing fields will be populated by defaults if present.
                
                
                 
                    
                      
                        Service Layers can be configured to customize the service stack. Ommitting layers will default to loading annotation based layers
                      
                      
                        
                          
                          
                          
                          
                              
                                "remote" forms a remote layer, connecting to the server specified by the "server" attribute, or to the "host", "gateway", and "port" attributes alternatively
                              
                              
                                  
                                  
                                  
                                  
                              
                          
                          
                            
                              
                                
                                  
                                
                              
                            
                          
                        
                      
                    
                    
                        
                            A list of groups which may access @Restricted annotated methods. Each group must refer to a configured group in the top level groups element.
                        
                        
                            
                                
                            
                        
                    
                     
                      
                        Any configuration specified here will override anything found in the defaults
                      
                    
                    
                      
                        Enable or disable caching per service
                      
                    
                    
                      
                        A service factory which will be used to load this service at deploy time. Only necessary for custom providers or multiple identically named services
                      
                    
                    
                      
                        Any custom configurations must be placed inside this block
                      
                      
                        
                          
                            
                              This custom configuration will be handled as key:value where key is the element name and value is the element value
                            
                          
                        
                      
                    
                  
                  
                  
                    
                        Enable or disable a service
                    
                  
                
              
            
          
        
        
          
            "messaging" and "jmsadapter" are used to configure a JMS implementation
          
          
            
              
                
                  
                  
                  
                  
                
              
              
                
                  
                  
                
              
              
                
                  
                  
                  
              
              
                
                  
                  
                  
              
              
                
                  Any custom configurations must be placed inside this block
                
                
                  
                    
                  
                
              
            
          
        
        
          
            email configurations
          
          
            
              
                  
                      Specifies the name of a Mail Session resource registered in jndi, ie mail/MySession
                  
              
              
                
                  Any custom configurations must be placed inside this block
                
                
                  
                    
                      
                        This custom configuration will be handled as key:value where key is the element name and value is the element value
                      
                    
                  
                
              
            
          
        
        
            
                task scheduler configurations
            
            
                
                    
                        
                            Specify a maximum thread pool size for the task scheduler
                        
                    
                    
                        
                            Specify a jndi name to lookup a ManagedScheduledExecutorService to use for the TaskScheduler
                        
                    
                
            
                    
        
        
            
                general alert configurations
            
            
                
                    
                        
                            
                                Specify + enable a Request Monitor
                            
                            
                                
                                    
                                        Specify an email address to send alerts to
                                    
                                
                                
                                    
                                        The duration of time (milliseconds) which a request must surpass in order to qualify as concerning.
                                    
                                
                                
                                    
                                        How often to execute the monitor action (in seconds)
                                    
                                
                                
                                    
                                        The hour (0-23) of the day in which to generate a summary email. If not specified, no summary is sent.
                                    
                                
                            
                        
                    
                    
                        
                            
                                Specify + enable a Memory Monitor
                            
                            
                                
                                    
                                        Specify an email address to send alerts to
                                    
                                
                                
                                    
                                        How often to execute the monitor action (in seconds)
                                    
                                
                                
                                    
                                        Percentage of total, represented as a positive integer. ie 90 for 90%
                                    
                                
                            
                        
                      
                
            
        
        
            
                a list of groups, denoted by a group name and containing repeated users
            
            
                
                    
                        
                            A group definition, with a "name" attribute and a list of users
                        
                        
                            
                                
                            
                                
                        
                    
                
            
        
        
          
            Any custom configurations must be placed inside this block
          
          
            
              
                
                  Custom Properties are usable via LouieProperties.getCustomProperty() and can contain one level of nested information
                
              
            
          
        
      
    
  





© 2015 - 2024 Weber Informatics LLC | Privacy Policy