text,length,is_long_context,metric_val,label_metric "[[cluster-nodes-stats]] === Nodes stats API ++++ Nodes stats ++++ Returns cluster nodes statistics. [[cluster-nodes-stats-api-request]] ==== {api-request-title} `GET /_nodes/stats` + `GET /_nodes//stats` + `GET/_nodes/stats/` + `GET/_nodes//stats/` + `GET /_nodes/stats//` + `GET /_nodes//stats//` [[cluster-nodes-stats-api-desc]] ==== {api-description-title} You can use the cluster nodes stats API to retrieve statistics for nodes in a cluster. All the nodes selective options are explained <>. By default, all stats are returned. You can limit the returned information by using metrics. [[cluster-nodes-stats-api-path-params]] ==== {api-path-parms-title} ``:: (Optional, string) Limits the information returned to the specific metrics. A comma-separated list of the following options: + -- `adaptive_selection`:: Statistics about <>. `breaker`:: Statistics about the field data circuit breaker. `discovery`:: Statistics about the discovery. `fs`:: File system information, data path, free disk space, read/write stats. `http`:: HTTP connection information. `indexing_pressure`:: Statistics about the node's indexing load and related rejections. `indices`:: Indices stats about size, document count, indexing and deletion times, search times, field cache size, merges and flushes. `ingest`:: Statistics about ingest preprocessing. `jvm`:: JVM stats, memory pool information, garbage collection, buffer pools, number of loaded/unloaded classes. `os`:: Operating system stats, load average, mem, swap. `process`:: Process statistics, memory consumption, cpu usage, open file descriptors. `thread_pool`:: Statistics about each thread pool, including current size, queue and rejected tasks. `transport`:: Transport statistics about sent and received bytes in cluster communication. -- ``:: (Optional, string) Limit the information returned for `indices` metric to the specific index metrics. It can be used only if `indices` (or `all`) metric is specified. Supported metrics are: + -- * `completion` * `docs` * `fielddata` * `flush` * `get` * `indexing` * `merge` * `query_cache` * `recovery` * `refresh` * `request_cache` * `search` * `segments` * `store` * `translog` * `warmer` -- include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=node-id] [[cluster-nodes-stats-api-query-params]] ==== {api-query-parms-title} include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=completion-fields] include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=fielddata-fields] include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=fields] include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=groups] include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=level] `types`:: (Optional, string) A comma-separated list of document types for the `indexing` index metric. include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=timeoutparms] include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=include-segment-file-sizes] [role=""child_attributes""] [[cluster-nodes-stats-api-response-body]] ==== {api-response-body-title} `_nodes`:: (object) Contains statistics about the number of nodes selected by the request. + .Properties of `_nodes` [%collapsible%open] ==== `total`:: (integer) Total number of nodes selected by the request. `successful`:: (integer) Number of nodes that responded successfully to the request. `failed`:: (integer) Number of nodes that rejected the request or failed to respond. If this value is not `0`, a reason for the rejection or failure is included in the response. ==== `cluster_name`:: (string) Name of the cluster. Based on the <> setting. `nodes`:: (object) Contains statistics for the nodes selected by the request. + .Properties of `nodes` [%collapsible%open] ==== ``:: (object) Contains statistics for the node. + .Properties of `` [%collapsible%open] ===== `timestamp`:: (integer) Time the node stats were collected for this response. Recorded in milliseconds since the {wikipedia}/Unix_time[Unix Epoch]. `name`:: (string) Human-readable identifier for the node. Based on the <> setting. `transport_address`:: (string) Host and port for the <>, used for internal communication between nodes in a cluster. `host`:: (string) Network host for the node, based on the <> setting. `ip`:: (string) IP address and port for the node. `roles`:: (array of strings) Roles assigned to the node. See <>. `attributes`:: (object) Contains a list of attributes for the node. [[cluster-nodes-stats-api-response-body-indices]] `indices`:: (object) Contains statistics about indices with shards assigned to the node. + .Properties of `indices` [%collapsible%open] ====== `docs`:: (object) Contains statistics about documents across all primary shards assigned to the node. + .Properties of `docs` [%collapsible%open] ======= `count`:: (integer) include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=docs-count] `deleted`:: (integer) include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=docs-deleted] ======= `store`:: (object) Contains statistics about the size of shards assigned to the node. + .Properties of `store` [%collapsible%open] ======= `size`:: (<>) Total size of all shards assigned to the node. `size_in_bytes`:: (integer) Total size, in bytes, of all shards assigned to the node. `reserved`:: (<>) A prediction of how much larger the shard stores on this node will eventually grow due to ongoing peer recoveries, restoring snapshots, and similar activities. A value of `-1b` indicates that this is not available. `reserved_in_bytes`:: (integer) A prediction, in bytes, of how much larger the shard stores on this node will eventually grow due to ongoing peer recoveries, restoring snapshots, and similar activities. A value of `-1` indicates that this is not available. ======= `indexing`:: (object) Contains statistics about indexing operations for the node. + .Properties of `indexing` [%collapsible%open] ======= `index_total`:: (integer) Total number of indexing operations. `index_time`:: (<>) Total time spent performing indexing operations. `index_time_in_millis`:: (integer) Total time in milliseconds spent performing indexing operations. `index_current`:: (integer) Number of indexing operations currently running. `index_failed`:: (integer) Number of failed indexing operations. `delete_total`:: (integer) Total number of deletion operations. `delete_time`:: (<>) Time spent performing deletion operations. `delete_time_in_millis`:: (integer) Time in milliseconds spent performing deletion operations. `delete_current`:: (integer) Number of deletion operations currently running. `noop_update_total`:: (integer) Total number of noop operations. `is_throttled`:: (boolean) Number of times operations were throttled. `throttle_time`:: (<>) Total time spent throttling operations. `throttle_time_in_millis`:: (integer) Total time in milliseconds spent throttling operations. ======= `get`:: (object) Contains statistics about get operations for the node. + .Properties of `get` [%collapsible%open] ======= `total`:: (integer) Total number of get operations. `getTime`:: (<>) Time spent performing get operations. `time_in_millis`:: (integer) Time in milliseconds spent performing get operations. `exists_total`:: (integer) Total number of successful get operations. `exists_time`:: (<>) Time spent performing successful get operations. `exists_time_in_millis`:: (integer) Time in milliseconds spent performing successful get operations. `missing_total`:: (integer) Total number of failed get operations. `missing_time`:: (<>) Time spent performing failed get operations. `missing_time_in_millis`:: (integer) Time in milliseconds spent performing failed get operations. `current`:: (integer) Number of get operations currently running. ======= `search`:: (object) Contains statistics about search operations for the node. + .Properties of `search` [%collapsible%open] ======= `open_contexts`:: (integer) Number of open search contexts. `query_total`:: (integer) Total number of query operations. `query_time`:: (<>) Time spent performing query operations. `query_time_in_millis`:: (integer) Time in milliseconds spent performing query operations. `query_current`:: (integer) Number of query operations currently running. `fetch_total`:: (integer) Total number of fetch operations. `fetch_time`:: (<>) Time spent performing fetch operations. `fetch_time_in_millis`:: (integer) Time in milliseconds spent performing fetch operations. `fetch_current`:: (integer) Number of fetch operations currently running. `scroll_total`:: (integer) Total number of scroll operations. `scroll_time`:: (<>) Time spent performing scroll operations. `scroll_time_in_millis`:: (integer) Time in milliseconds spent performing scroll operations. `scroll_current`:: (integer) Number of scroll operations currently running. `suggest_total`:: (integer) Total number of suggest operations. `suggest_time`:: (<>) Time spent performing suggest operations. `suggest_time_in_millis`:: (integer) Time in milliseconds spent performing suggest operations. `suggest_current`:: (integer) Number of suggest operations currently running. ======= `merges`:: (object) Contains statistics about merge operations for the node. + .Properties of `merges` [%collapsible%open] ======= `current`:: (integer) Number of merge operations currently running. `current_docs`:: (integer) Number of document merges currently running. `current_size`:: (<>) Memory used performing current document merges. `current_size_in_bytes`:: (integer) Memory, in bytes, used performing current document merges. `total`:: (integer) Total number of merge operations. `total_time`:: (<>) Total time spent performing merge operations. `total_time_in_millis`:: (integer) Total time in milliseconds spent performing merge operations. `total_docs`:: (integer) Total number of merged documents. `total_size`:: (<>) Total size of document merges. `total_size_in_bytes`:: (integer) Total size of document merges in bytes. `total_stopped_time`:: (<>) Total time spent stopping merge operations. `total_stopped_time_in_millis`:: (integer) Total time in milliseconds spent stopping merge operations. `total_throttled_time`:: (<>) Total time spent throttling merge operations. `total_throttled_time_in_millis`:: (integer) Total time in milliseconds spent throttling merge operations. `total_auto_throttle`:: (<>) Size of automatically throttled merge operations. `total_auto_throttle_in_bytes`:: (integer) Size, in bytes, of automatically throttled merge operations. ======= `refresh`:: (object) Contains statistics about refresh operations for the node. + .Properties of `refresh` [%collapsible%open] ======= `total`:: (integer) Total number of refresh operations. `total_time`:: (<>) Total time spent performing refresh operations. `total_time_in_millis`:: (integer) Total time in milliseconds spent performing refresh operations. `external_total`:: (integer) Total number of external refresh operations. `external_total_time`:: (<>) Total time spent performing external operations. `external_total_time_in_millis`:: (integer) Total time in milliseconds spent performing external operations. `listeners`:: (integer) Number of refresh listeners. ======= `flush`:: (object) Contains statistics about flush operations for the node. + .Properties of `flush` [%collapsible%open] ======= `total`:: (integer) Number of flush operations. `periodic`:: (integer) Number of flush periodic operations. `total_time`:: (<>) Total time spent performing flush operations. `total_time_in_millis`:: (integer) Total time in milliseconds spent performing flush operations. ======= `warmer`:: (object) Contains statistics about index warming operations for the node. + .Properties of `warmer` [%collapsible%open] ======= `current`:: (integer) Number of active index warmers. `total`:: (integer) Total number of index warmers. `total_time`:: (<>) Total time spent performing index warming operations. `total_time_in_millis`:: (integer) Total time in milliseconds spent performing index warming operations. ======= `query_cache`:: (object) Contains statistics about the query cache across all shards assigned to the node. + .Properties of `query_cache` [%collapsible%open] ======= `memory_size`:: (<>) Total amount of memory used for the query cache across all shards assigned to the node. `memory_size_in_bytes`:: (integer) Total amount of memory, in bytes, used for the query cache across all shards assigned to the node. `total_count`:: (integer) Total count of hits, misses, and cached queries in the query cache. `hit_count`:: (integer) Number of query cache hits. `miss_count`:: (integer) Number of query cache misses. `cache_size`:: (integer) Size, in bytes, of the query cache. `cache_count`:: (integer) Count of queries in the query cache. `evictions`:: (integer) Number of query cache evictions. ======= `fielddata`:: (object) Contains statistics about the field data cache across all shards assigned to the node. + .Properties of `fielddata` [%collapsible%open] ======= `memory_size`:: (<>) Total amount of memory used for the field data cache across all shards assigned to the node. `memory_size_in_bytes`:: (integer) Total amount of memory, in bytes, used for the field data cache across all shards assigned to the node. `evictions`:: (integer) Number of fielddata evictions. ======= `completion`:: (object) Contains statistics about completions across all shards assigned to the node. + .Properties of `completion` [%collapsible%open] ======= `size`:: (<>) Total amount of memory used for completion across all shards assigned to the node. `size_in_bytes`:: (integer) Total amount of memory, in bytes, used for completion across all shards assigned to the node. ======= `segments`:: (object) Contains statistics about segments across all shards assigned to the node. + .Properties of `segments` [%collapsible%open] ======= `count`:: (integer) Number of segments. `memory`:: (<>) Total amount of memory used for segments across all shards assigned to the node. `memory_in_bytes`:: (integer) Total amount of memory, in bytes, used for segments across all shards assigned to the node. `terms_memory`:: (<>) Total amount of memory used for terms across all shards assigned to the node. `terms_memory_in_bytes`:: (integer) Total amount of memory, in bytes, used for terms across all shards assigned to the node. `stored_fields_memory`:: (<>) Total amount of memory used for stored fields across all shards assigned to the node. `stored_fields_memory_in_bytes`:: (integer) Total amount of memory, in bytes, used for stored fields across all shards assigned to the node. `term_vectors_memory`:: (<>) Total amount of memory used for term vectors across all shards assigned to the node. `term_vectors_memory_in_bytes`:: (integer) Total amount of memory, in bytes, used for term vectors across all shards assigned to the node. `norms_memory`:: (<>) Total amount of memory used for normalization factors across all shards assigned to the node. `norms_memory_in_bytes`:: (integer) Total amount of memory, in bytes, used for normalization factors across all shards assigned to the node. `points_memory`:: (<>) Total amount of memory used for points across all shards assigned to the node. `points_memory_in_bytes`:: (integer) Total amount of memory, in bytes, used for points across all shards assigned to the node. `doc_values_memory`:: (<>) Total amount of memory used for doc values across all shards assigned to the node. `doc_values_memory_in_bytes`:: (integer) Total amount of memory, in bytes, used for doc values across all shards assigned to the node. `index_writer_memory`:: (<>) Total amount of memory used by all index writers across all shards assigned to the node. `index_writer_memory_in_bytes`:: (integer) Total amount of memory, in bytes, used by all index writers across all shards assigned to the node. `version_map_memory`:: (<>) Total amount of memory used by all version maps across all shards assigned to the node. `version_map_memory_in_bytes`:: (integer) Total amount of memory, in bytes, used by all version maps across all shards assigned to the node. `fixed_bit_set`:: (<>) Total amount of memory used by fixed bit sets across all shards assigned to the node. + Fixed bit sets are used for nested object field types and type filters for <> fields. `fixed_bit_set_memory_in_bytes`:: (integer) Total amount of memory, in bytes, used by fixed bit sets across all shards assigned to the node. + Fixed bit sets are used for nested object field types and type filters for <> fields. `max_unsafe_auto_id_timestamp`:: (integer) Time of the most recently retried indexing request. Recorded in milliseconds since the {wikipedia}/Unix_time[Unix Epoch]. `file_sizes`:: (object) Contains statistics about the size of the segment file. + .Properties of `file_sizes` [%collapsible%open] ======== `size`:: (<>) Size of the segment file. `size_in_bytes`:: (integer) Size, in bytes, of the segment file. `description`:: (string) Description of the segment file. ======== ======= `translog`:: (object) Contains statistics about transaction log operations for the node. + .Properties of `translog` [%collapsible%open] ======= `operations`:: (integer) Number of transaction log operations. `size`:: (<>) Size of the transaction log. `size_in_bytes`:: (integer) Size, in bytes, of the transaction log. `uncommitted_operations`:: (integer) Number of uncommitted transaction log operations. `uncommitted_size`:: (<>) Size of uncommitted transaction log operations. `uncommitted_size_in_bytes`:: (integer) Size, in bytes, of uncommitted transaction log operations. `earliest_last_modified_age`:: (integer) Earliest last modified age for the transaction log. ======= `request_cache`:: (object) Contains statistics about the request cache across all shards assigned to the node. + .Properties of `request_cache` [%collapsible%open] ======= `memory_size`:: (<>) Memory used by the request cache. `memory_size_in_bytes`:: (integer) Memory, in bytes, used by the request cache. `evictions`:: (integer) Number of request cache operations. `hit_count`:: (integer) Number of request cache hits. `miss_count`:: (integer) Number of request cache misses. ======= `recovery`:: (object) Contains statistics about recovery operations for the node. + .Properties of `recovery` [%collapsible%open] ======= `current_as_source`:: (integer) Number of recoveries that used an index shard as a source. `current_as_target`:: (integer) Number of recoveries that used an index shard as a target. `throttle_time`:: (<>) Time by which recovery operations were delayed due to throttling. `throttle_time_in_millis`:: (integer) Time in milliseconds recovery operations were delayed due to throttling. ======= ====== [[cluster-nodes-stats-api-response-body-os]] `os`:: (object) Contains statistics about the operating system for the node. + .Properties of `os` [%collapsible%open] ====== `timestamp`:: (integer) Last time the operating system statistics were refreshed. Recorded in milliseconds since the {wikipedia}/Unix_time[Unix Epoch]. `cpu`:: (object) Contains statistics about CPU usage for the node. + .Properties of `cpu` [%collapsible%open] ======= `percent`:: (integer) Recent CPU usage for the whole system, or `-1` if not supported. `load_average`:: (object) Contains statistics about load averages on the system. + .Properties of `load_average` [%collapsible%open] ======== `1m`:: (float) One-minute load average on the system (field is not present if one-minute load average is not available). `5m`:: (float) Five-minute load average on the system (field is not present if five-minute load average is not available). `15m`:: (float) Fifteen-minute load average on the system (field is not present if fifteen-minute load average is not available). ======== ======= `mem`:: (object) Contains statistics about memory usage for the node. + .Properties of `mem` [%collapsible%open] ======= `total`:: (<>) Total amount of physical memory. `total_in_bytes`:: (integer) Total amount of physical memory in bytes. `free`:: (<>) Amount of free physical memory. `free_in_bytes`:: (integer) Amount of free physical memory in bytes. `used`:: (<>) Amount of used physical memory. `used_in_bytes`:: (integer) Amount of used physical memory in bytes. `free_percent`:: (integer) Percentage of free memory. `used_percent`:: (integer) Percentage of used memory. ======= `swap`:: (object) Contains statistics about swap space for the node. + .Properties of `swap` [%collapsible%open] ======= `total`:: (<>) Total amount of swap space. `total_in_bytes`:: (integer) Total amount of swap space in bytes. `free`:: (<>) Amount of free swap space. `free_in_bytes`:: (integer) Amount of free swap space in bytes. `used`:: (<>) Amount of used swap space. `used_in_bytes`:: (integer) Amount of used swap space in bytes. ======= `cgroup` (Linux only):: (object) Contains cgroup statistics for the node. + NOTE: For the cgroup stats to be visible, cgroups must be compiled into the kernel, the `cpu` and `cpuacct` cgroup subsystems must be configured and stats must be readable from `/sys/fs/cgroup/cpu` and `/sys/fs/cgroup/cpuacct`. + .Properties of `cgroup` [%collapsible%open] ======= `cpuacct` (Linux only):: (object) Contains statistics about `cpuacct` control group for the node. + .Properties of `cpuacct` [%collapsible%open] ======== `control_group` (Linux only):: (string) The `cpuacct` control group to which the {es} process belongs. `usage_nanos` (Linux only):: (integer) The total CPU time (in nanoseconds) consumed by all tasks in the same cgroup as the {es} process. ======== `cpu` (Linux only):: (object) Contains statistics about `cpu` control group for the node. + .Properties of `cpu` [%collapsible%open] ======== `control_group` (Linux only):: (string) The `cpu` control group to which the {es} process belongs. `cfs_period_micros` (Linux only):: (integer) The period of time (in microseconds) for how regularly all tasks in the same cgroup as the {es} process should have their access to CPU resources reallocated. `cfs_quota_micros` (Linux only):: (integer) The total amount of time (in microseconds) for which all tasks in the same cgroup as the {es} process can run during one period `cfs_period_micros`. `stat` (Linux only):: (object) Contains CPU statistics for the node. + .Properties of `stat` [%collapsible%open] ========= `number_of_elapsed_periods` (Linux only):: (integer) The number of reporting periods (as specified by `cfs_period_micros`) that have elapsed. `number_of_times_throttled` (Linux only):: (integer) The number of times all tasks in the same cgroup as the {es} process have been throttled. `time_throttled_nanos` (Linux only):: (integer) The total amount of time (in nanoseconds) for which all tasks in the same cgroup as the {es} process have been throttled. ========= ======== `memory` (Linux only):: (object) Contains statistics about the `memory` control group for the node. + .Properties of `memory` [%collapsible%open] ======== `control_group` (Linux only):: (string) The `memory` control group to which the {es} process belongs. `limit_in_bytes` (Linux only):: (string) The maximum amount of user memory (including file cache) allowed for all tasks in the same cgroup as the {es} process. This value can be too big to store in a `long`, so is returned as a string so that the value returned can exactly match what the underlying operating system interface returns. Any value that is too large to parse into a `long` almost certainly means no limit has been set for the cgroup. `usage_in_bytes` (Linux only):: (string) The total current memory usage by processes in the cgroup (in bytes) by all tasks in the same cgroup as the {es} process. This value is stored as a string for consistency with `limit_in_bytes`. ======== ======= ====== [[cluster-nodes-stats-api-response-body-process]] `process`:: (object) Contains process statistics for the node. + .Properties of `process` [%collapsible%open] ====== `timestamp`:: (integer) Last time the statistics were refreshed. Recorded in milliseconds since the {wikipedia}/Unix_time[Unix Epoch]. `open_file_descriptors`:: (integer) Number of opened file descriptors associated with the current or `-1` if not supported. `max_file_descriptors`:: (integer) Maximum number of file descriptors allowed on the system, or `-1` if not supported. `cpu`:: (object) Contains CPU statistics for the node. + .Properties of `cpu` [%collapsible%open] ======= `percent`:: (integer) CPU usage in percent, or `-1` if not known at the time the stats are computed. `total`:: (<>) CPU time used by the process on which the Java virtual machine is running. `total_in_millis`:: (integer) CPU time (in milliseconds) used by the process on which the Java virtual machine is running, or `-1` if not supported. ======= `mem`:: (object) Contains virtual memory statistics for the node. + .Properties of `mem` [%collapsible%open] ======= `total_virtual`:: (<>) Size of virtual memory that is guaranteed to be available to the running process. `total_virtual_in_bytes`:: (integer) Size in bytes of virtual memory that is guaranteed to be available to the running process. ======= ====== [[cluster-nodes-stats-api-response-body-jvm]] `jvm`:: (object) Contains Java Virtual Machine (JVM) statistics for the node. + .Properties of `jvm` [%collapsible%open] ====== `timestamp`:: (integer) Last time JVM statistics were refreshed. `uptime`:: (<>) JVM uptime. `uptime_in_millis`:: (integer) JVM uptime in milliseconds. `mem`:: (object) Contains JVM memory usage statistics for the node. + .Properties of `mem` [%collapsible%open] ======= `heap_used`:: (<>) Memory currently in use by the heap. `heap_used_in_bytes`:: (integer) Memory, in bytes, currently in use by the heap. `heap_used_percent`:: (integer) Percentage of memory currently in use by the heap. `heap_committed`:: (<>) Amount of memory available for use by the heap. `heap_committed_in_bytes`:: (integer) Amount of memory, in bytes, available for use by the heap. `heap_max`:: (<>) Maximum amount of memory available for use by the heap. `heap_max_in_bytes`:: (integer) Maximum amount of memory, in bytes, available for use by the heap. `non_heap_used`:: (<>) Non-heap memory used. `non_heap_used_in_bytes`:: (integer) Non-heap memory used, in bytes. `non_heap_committed`:: (<>) Amount of non-heap memory available. `non_heap_committed_in_bytes`:: (integer) Amount of non-heap memory available, in bytes. `pools`:: (object) Contains statistics about heap memory usage for the node. + .Properties of `pools` [%collapsible%open] ======== `young`:: (object) Contains statistics about memory usage by the young generation heap for the node. + .Properties of `young` [%collapsible%open] ========= `used`:: (<>) Memory used by the young generation heap. `used_in_bytes`:: (integer) Memory, in bytes, used by the young generation heap. `max`:: (<>) Maximum amount of memory available for use by the young generation heap. `max_in_bytes`:: (integer) Maximum amount of memory, in bytes, available for use by the young generation heap. `peak_used`:: (<>) Largest amount of memory historically used by the young generation heap. `peak_used_in_bytes`:: (integer) Largest amount of memory, in bytes, historically used by the young generation heap. `peak_max`:: (<>) Largest amount of memory historically used by the young generation heap. `peak_max_in_bytes`:: (integer) Largest amount of memory, in bytes, historically used by the young generation heap. ========= `survivor`:: (object) Contains statistics about memory usage by the survivor space for the node. + .Properties of `survivor` [%collapsible%open] ========= `used`:: (<>) Memory used by the survivor space. `used_in_bytes`:: (integer) Memory, in bytes, used by the survivor space. `max`:: (<>) Maximum amount of memory available for use by the survivor space. `max_in_bytes`:: (integer) Maximum amount of memory, in bytes, available for use by the survivor space. `peak_used`:: (<>) Largest amount of memory historically used by the survivor space. `peak_used_in_bytes`:: (integer) Largest amount of memory, in bytes, historically used by the survivor space. `peak_max`:: (<>) Largest amount of memory historically used by the survivor space. `peak_max_in_bytes`:: (integer) Largest amount of memory, in bytes, historically used by the survivor space. ========= `old`:: (object) Contains statistics about memory usage by the old generation heap for the node. + .Properties of `old` [%collapsible%open] ========= `used`:: (<>) Memory used by the old generation heap. `used_in_bytes`:: (integer) Memory, in bytes, used by the old generation heap. `max`:: (<>) Maximum amount of memory available for use by the old generation heap. `max_in_bytes`:: (integer) Maximum amount of memory, in bytes, available for use by the old generation heap. `peak_used`:: (<>) Largest amount of memory historically used by the old generation heap. `peak_used_in_bytes`:: (integer) Largest amount of memory, in bytes, historically used by the old generation heap. `peak_max`:: (<>) Highest memory limit historically available for use by the old generation heap. `peak_max_in_bytes`:: (integer) Highest memory limit, in bytes, historically available for use by the old generation heap. ========= ======== ======= `threads`:: (object) Contains statistics about JVM thread usage for the node. + .Properties of `threads` [%collapsible%open] ======= `count`:: (integer) Number of active threads in use by JVM. `peak_count`:: (integer) Highest number of threads used by JVM. ======= `gc`:: (object) Contains statistics about JVM garbage collectors for the node. + .Properties of `gc` [%collapsible%open] ======= `collectors`:: (object) Contains statistics about JVM garbage collectors for the node. + .Properties of `collectors` [%collapsible%open] ======== `young`:: (object) Contains statistics about JVM garbage collectors that collect young generation objects for the node. + .Properties of `young` [%collapsible%open] ========= `collection_count`:: (integer) Number of JVM garbage collectors that collect young generation objects. `collection_time`:: (<>) Total time spent by JVM collecting young generation objects. `collection_time_in_millis`:: (integer) Total time in milliseconds spent by JVM collecting young generation objects. ========= `old`:: (object) Contains statistics about JVM garbage collectors that collect old generation objects for the node. + .Properties of `old` [%collapsible%open] ========= `collection_count`:: (integer) Number of JVM garbage collectors that collect old generation objects. `collection_time`:: (<>) Total time spent by JVM collecting old generation objects. `collection_time_in_millis`:: (integer) Total time in milliseconds spent by JVM collecting old generation objects. ========= ======== ======= `buffer_pools`:: (object) Contains statistics about JVM buffer pools for the node. + .Properties of `buffer_pools` [%collapsible%open] ======= `mapped`:: (object) Contains statistics about mapped JVM buffer pools for the node. + .Properties of `mapped` [%collapsible%open] ======== `count`:: (integer) Number of mapped buffer pools. `used`:: (<>) Size of mapped buffer pools. `used_in_bytes`:: (integer) Size, in bytes, of mapped buffer pools. `total_capacity`:: (<>) Total capacity of mapped buffer pools. `total_capacity_in_bytes`:: (integer) Total capacity, in bytes, of mapped buffer pools. ======== `direct`:: (object) Contains statistics about direct JVM buffer pools for the node. + .Properties of `direct` [%collapsible%open] ======== `count`:: (integer) Number of direct buffer pools. `used`:: (<>) Size of direct buffer pools. `used_in_bytes`:: (integer) Size, in bytes, of direct buffer pools. `total_capacity`:: (<>) Total capacity of direct buffer pools. `total_capacity_in_bytes`:: (integer) Total capacity, in bytes, of direct buffer pools. ======== ======= `classes`:: (object) Contains statistics about classes loaded by JVM for the node. + .Properties of `classes` [%collapsible%open] ======= `current_loaded_count`:: (integer) Number of classes currently loaded by JVM. `total_loaded_count`:: (integer) Total number of classes loaded since the JVM started. `total_unloaded_count`:: (integer) Total number of classes unloaded since the JVM started. ======= ====== [[cluster-nodes-stats-api-response-body-threadpool]] `thread_pool`:: (object) Contains thread pool statistics for the node + .Properties of `thread_pool` [%collapsible%open] ====== ``:: (object) Contains statistics about the thread pool for the node. + .Properties of `` [%collapsible%open] ======= `threads`:: (integer) Number of threads in the thread pool. `queue`:: (integer) Number of tasks in queue for the thread pool. `active`:: (integer) Number of active threads in the thread pool. `rejected`:: (integer) Number of tasks rejected by the thread pool executor. `largest`:: (integer) Highest number of active threads in the thread pool. `completed`:: (integer) Number of tasks completed by the thread pool executor. ======= ====== [[cluster-nodes-stats-api-response-body-fs]] `fs`:: (object) Contains file store statistics for the node. + .Properties of `fs` [%collapsible%open] ====== `timestamp`:: (integer) Last time the file stores statistics were refreshed. Recorded in milliseconds since the {wikipedia}/Unix_time[Unix Epoch]. `total`:: (object) Contains statistics for all file stores of the node. + .Properties of `total` [%collapsible%open] ======= `total`:: (<>) Total size of all file stores. `total_in_bytes`:: (integer) Total size (in bytes) of all file stores. `free`:: (<>) Total unallocated disk space in all file stores. `free_in_bytes`:: (integer) Total number of unallocated bytes in all file stores. `available`:: (<>) Total disk space available to this Java virtual machine on all file stores. Depending on OS or process level restrictions, this might appear less than `free`. This is the actual amount of free disk space the {es} node can utilise. `available_in_bytes`:: (integer) Total number of bytes available to this Java virtual machine on all file stores. Depending on OS or process level restrictions, this might appear less than `free_in_bytes`. This is the actual amount of free disk space the {es} node can utilise. ======= `least_usage_estimate`:: (object) Contains statistics for the file store with the least estimated usage. See <> for a list of child parameters. `most_usage_estimate`:: (object) Contains statistics for the file store with the most estimated usage. See <> for a list of child parameters. [[cluster-nodes-stats-fs-data]] `data`:: (array of objects) List of all file stores. + .Properties of `data` [%collapsible%open] ======= `path`:: (string) Path to the file store. `mount`:: (string) Mount point of the file store (ex: /dev/sda2). + NOTE: This parameter is not provided for the `least_usage_estimate` or `most_usage_estimate` file stores. `type`:: (string) Type of the file store (ex: ext4). `total`:: (<>) Total size of the file store. `total_in_bytes`:: (integer) Total size (in bytes) of the file store. `free`:: (<>) Total amount of unallocated disk space in the file store. `free_in_bytes`:: (integer) Total number of unallocated bytes in the file store. `available`:: (<>) Total amount of disk space available to this Java virtual machine on this file store. `available_in_bytes`:: (integer) Total number of bytes available to this Java virtual machine on this file store. ======= `io_stats` (Linux only):: (objects) Contains I/O statistics for the node. + .Properties of `io_stats` [%collapsible%open] ======= `devices` (Linux only):: (array) Array of disk metrics for each device that is backing an {es} data path. These disk metrics are probed periodically and averages between the last probe and the current probe are computed. + .Properties of `devices` [%collapsible%open] ======== `device_name` (Linux only):: (string) The Linux device name. `operations` (Linux only):: (integer) The total number of read and write operations for the device completed since starting {es}. `read_operations` (Linux only):: (integer) The total number of read operations for the device completed since starting {es}. `write_operations` (Linux only):: (integer) The total number of write operations for the device completed since starting {es}. `read_kilobytes` (Linux only):: (integer) The total number of kilobytes read for the device since starting {es}. `write_kilobytes` (Linux only):: (integer) The total number of kilobytes written for the device since starting {es}. ======== `operations` (Linux only):: (integer) The total number of read and write operations across all devices used by {es} completed since starting {es}. `read_operations` (Linux only):: (integer) The total number of read operations for across all devices used by {es} completed since starting {es}. `write_operations` (Linux only):: (integer) The total number of write operations across all devices used by {es} completed since starting {es}. `read_kilobytes` (Linux only):: (integer) The total number of kilobytes read across all devices used by {es} since starting {es}. `write_kilobytes` (Linux only):: (integer) The total number of kilobytes written across all devices used by {es} since starting {es}. ======= ====== [[cluster-nodes-stats-api-response-body-transport]] `transport`:: (object) Contains transport statistics for the node. + .Properties of `transport` [%collapsible%open] ====== `server_open`:: (integer) Number of open TCP connections used for internal communication between nodes. `rx_count`:: (integer) Total number of RX (receive) packets received by the node during internal cluster communication. `rx_size`:: (<>) Size of RX packets received by the node during internal cluster communication. `rx_size_in_bytes`:: (integer) Size, in bytes, of RX packets received by the node during internal cluster communication. `tx_count`:: (integer) Total number of TX (transmit) packets sent by the node during internal cluster communication. `tx_size`:: (<>) Size of TX packets sent by the node during internal cluster communication. `tx_size_in_bytes`:: (integer) Size, in bytes, of TX packets sent by the node during internal cluster communication. ====== [[cluster-nodes-stats-api-response-body-http]] `http`:: (object) Contains http statistics for the node. + .Properties of `http` [%collapsible%open] ====== `current_open`:: (integer) Current number of open HTTP connections for the node. `total_opened`:: (integer) Total number of HTTP connections opened for the node. ====== [[cluster-nodes-stats-api-response-body-breakers]] `breakers`:: (object) Contains circuit breaker statistics for the node. + .Properties of `breakers` [%collapsible%open] ====== ``:: (object) Contains statistics for the circuit breaker. + .Properties of `` [%collapsible%open] ======= `limit_size_in_bytes`:: (integer) Memory limit, in bytes, for the circuit breaker. `limit_size`:: (<>) Memory limit for the circuit breaker. `estimated_size_in_bytes`:: (integer) Estimated memory used, in bytes, for the operation. `estimated_size`:: (<>) Estimated memory used for the operation. `overhead`:: (float) A constant that all estimates for the circuit breaker are multiplied with to calculate a final estimate. `tripped`:: (integer) Total number of times the circuit breaker has been triggered and prevented an out of memory error. ======= ====== [[cluster-nodes-stats-api-response-body-script]] `script`:: (object) Contains script statistics for the node. + .Properties of `script` [%collapsible%open] ====== `compilations`:: (integer) Total number of inline script compilations performed by the node. `cache_evictions`:: (integer) Total number of times the script cache has evicted old data. `compilation_limit_triggered`:: (integer) Total number of times the <> circuit breaker has limited inline script compilations. ====== [[cluster-nodes-stats-api-response-body-discovery]] `discovery`:: (object) Contains node discovery statistics for the node. + .Properties of `discovery` [%collapsible%open] ====== `cluster_state_queue`:: (object) Contains statistics for the cluster state queue of the node. + .Properties of `cluster_state_queue` [%collapsible%open] ======= `total`:: (integer) Total number of cluster states in queue. `pending`:: (integer) Number of pending cluster states in queue. `committed`:: (integer) Number of committed cluster states in queue. ======= `published_cluster_states`:: (object) Contains statistics for the published cluster states of the node. + .Properties of `published_cluster_states` [%collapsible%open] ======= `full_states`:: (integer) Number of published cluster states. `incompatible_diffs`:: (integer) Number of incompatible differences between published cluster states. `compatible_diffs`:: (integer) Number of compatible differences between published cluster states. ======= ====== [[cluster-nodes-stats-api-response-body-ingest]] `ingest`:: (object) Contains ingest statistics for the node. + .Properties of `ingest` [%collapsible%open] ====== `total`:: (object) Contains statistics about ingest operations for the node. + .Properties of `total` [%collapsible%open] ======= `count`:: (integer) Total number of documents ingested during the lifetime of this node. `time`:: (<>) Total time spent preprocessing ingest documents during the lifetime of this node. `time_in_millis`:: (integer) Total time, in milliseconds, spent preprocessing ingest documents during the lifetime of this node. `current`:: (integer) Total number of documents currently being ingested. `failed`:: (integer) Total number of failed ingest operations during the lifetime of this node. ======= `pipelines`:: (object) Contains statistics about ingest pipelines for the node. + .Properties of `pipelines` [%collapsible%open] ======= ``:: (object) Contains statistics about the ingest pipeline. + .Properties of `` [%collapsible%open] ======== `count`:: (integer) Number of documents preprocessed by the ingest pipeline. `time`:: (<>) Total time spent preprocessing documents in the ingest pipeline. `time_in_millis`:: (integer) Total time, in milliseconds, spent preprocessing documents in the ingest pipeline. `failed`:: (integer) Total number of failed operations for the ingest pipeline. `processors`:: (array of objects) Contains statistics for the ingest processors for the ingest pipeline. + .Properties of `processors` [%collapsible%open] ========= ``:: (object) Contains statistics for the ingest processor. + .Properties of `` [%collapsible%open] ========== `count`:: (integer) Number of documents transformed by the processor. `time`:: (<>) Time spent by the processor transforming documents. `time_in_millis`:: (integer) Time, in milliseconds, spent by the processor transforming documents. `current`:: (integer) Number of documents currently being transformed by the processor. `failed`:: (integer) Number of failed operations for the processor. ========== ========= ======== ======= ====== [[cluster-nodes-stats-api-response-body-indexing-pressure]] `indexing_pressure`:: (object) Contains <> statistics for the node. + .Properties of `indexing_pressure` [%collapsible%open] ====== `memory`:: (object) Contains statistics for memory consumption from indexing load. + .Properties of `` [%collapsible%open] ======= `current`:: (object) Contains statistics for current indexing load. + .Properties of `` [%collapsible%open] ======== `combined_coordinating_and_primary`:: (<>) Memory consumed by indexing requests in the coordinating or primary stage. This value is not the sum of coordinating and primary as a node can reuse the coordinating memory if the primary stage is executed locally. `combined_coordinating_and_primary_in_bytes`:: (integer) Memory consumed, in bytes, by indexing requests in the coordinating or primary stage. This value is not the sum of coordinating and primary as a node can reuse the coordinating memory if the primary stage is executed locally. `coordinating`:: (<>) Memory consumed by indexing requests in the coordinating stage. `coordinating_in_bytes`:: (integer) Memory consumed, in bytes, by indexing requests in the coordinating stage. `primary`:: (<>) Memory consumed by indexing requests in the primary stage. `primary_in_bytes`:: (integer) Memory consumed, in bytes, by indexing requests in the primary stage. `replica`:: (<>) Memory consumed by indexing requests in the replica stage. `replica_in_bytes`:: (integer) Memory consumed, in bytes, by indexing requests in the replica stage. `all`:: (<>) Memory consumed by indexing requests in the coordinating, primary, or replica stage. `all_in_bytes`:: (integer) Memory consumed, in bytes, by indexing requests in the coordinating, primary, or replica stage. ======== `total`:: (object) Contains statistics for the cumulative indexing load since the node started. + .Properties of `` [%collapsible%open] ======== `combined_coordinating_and_primary`:: (<>) Memory consumed by indexing requests in the coordinating or primary stage. This value is not the sum of coordinating and primary as a node can reuse the coordinating memory if the primary stage is executed locally. `combined_coordinating_and_primary_in_bytes`:: (integer) Memory consumed, in bytes, by indexing requests in the coordinating or primary stage. This value is not the sum of coordinating and primary as a node can reuse the coordinating memory if the primary stage is executed locally. `coordinating`:: (<>) Memory consumed by indexing requests in the coordinating stage. `coordinating_in_bytes`:: (integer) Memory consumed, in bytes, by indexing requests in the coordinating stage. `primary`:: (<>) Memory consumed by indexing requests in the primary stage. `primary_in_bytes`:: (integer) Memory consumed, in bytes, by indexing requests in the primary stage. `replica`:: (<>) Memory consumed by indexing requests in the replica stage. `replica_in_bytes`:: (integer) Memory consumed, in bytes, by indexing requests in the replica stage. `all`:: (<>) Memory consumed by indexing requests in the coordinating, primary, or replica stage. `all_in_bytes`:: (integer) Memory consumed, in bytes, by indexing requests in the coordinating, primary, or replica stage. `coordinating_rejections`:: (integer) Number of indexing requests rejected in the coordinating stage. `primary_rejections`:: (integer) Number of indexing requests rejected in the primary stage. `replica_rejections`:: (integer) Number of indexing requests rejected in the replica stage. ======== ======= ====== [[cluster-nodes-stats-api-response-body-adaptive-selection]] `adaptive_selection`:: (object) Contains adaptive selection statistics for the node. + .Properties of `adaptive_selection` [%collapsible%open] ====== `outgoing_searches`:: (integer) The number of outstanding search requests from the node these stats are for to the keyed node. `avg_queue_size`:: (integer) The exponentially weighted moving average queue size of search requests on the keyed node. `avg_service_time`:: (<>) The exponentially weighted moving average service time of search requests on the keyed node. `avg_service_time_ns`:: (integer) The exponentially weighted moving average service time, in nanoseconds, of search requests on the keyed node. `avg_response_time`:: (<>) The exponentially weighted moving average response time of search requests on the keyed node. `avg_response_time_ns`:: (integer) The exponentially weighted moving average response time, in nanoseconds, of search requests on the keyed node. `rank`:: (string) The rank of this node; used for shard selection when routing search requests. ====== ===== ==== [[cluster-nodes-stats-api-example]] ==== {api-examples-title} [source,console] -------------------------------------------------- # return just indices GET /_nodes/stats/indices # return just os and process GET /_nodes/stats/os,process # return just process for node with IP address 10.0.0.1 GET /_nodes/10.0.0.1/stats/process -------------------------------------------------- All stats can be explicitly requested via `/_nodes/stats/_all` or `/_nodes/stats?metric=_all`. You can get information about indices stats on `node`, `indices`, or `shards` level. [source,console] -------------------------------------------------- # Fielddata summarized by node GET /_nodes/stats/indices/fielddata?fields=field1,field2 # Fielddata summarized by node and index GET /_nodes/stats/indices/fielddata?level=indices&fields=field1,field2 # Fielddata summarized by node, index, and shard GET /_nodes/stats/indices/fielddata?level=shards&fields=field1,field2 # You can use wildcards for field names GET /_nodes/stats/indices/fielddata?fields=field* -------------------------------------------------- You can get statistics about search groups for searches executed on this node. [source,console] -------------------------------------------------- # All groups with all stats GET /_nodes/stats?groups=_all # Some groups from just the indices stats GET /_nodes/stats/indices?groups=foo,bar -------------------------------------------------- [[cluster-nodes-stats-ingest-ex]] ===== Retrieve ingest statistics only To return only ingest-related node statistics, set the `` path parameter to `ingest` and use the <> query parameter. [source,console] -------------------------------------------------- GET /_nodes/stats/ingest?filter_path=nodes.*.ingest -------------------------------------------------- You can use the `metric` and `filter_path` query parameters to get the same response. [source,console] -------------------------------------------------- GET /_nodes/stats?metric=ingest&filter_path=nodes.*.ingest -------------------------------------------------- To further refine the response, change the `filter_path` value. For example, the following request only returns ingest pipeline statistics. [source,console] -------------------------------------------------- GET /_nodes/stats?metric=ingest&filter_path=nodes.*.ingest.pipelines -------------------------------------------------- ",12239,True,2561.3644551179395,median " CLASS unit_tests DEFINITION FOR TESTING FINAL DURATION SHORT RISK LEVEL HARMLESS . *? *? *? *?unit_Tests *? *?f_Cut *? *?ZZZCL_DATETIME *? *? *? *? *? *? *? *? *? PRIVATE SECTION. METHODS: method_chaining FOR TESTING. METHODS: add FOR TESTING. METHODS: add_days FOR TESTING. METHODS: add_hours FOR TESTING. METHODS: add_minutes FOR TESTING. METHODS: add_months FOR TESTING. METHODS: add_seconds FOR TESTING. METHODS: add_weeks FOR TESTING. METHODS: add_years FOR TESTING. METHODS: as_date FOR TESTING. METHODS: as_iso_timestamp FOR TESTING. METHODS: as_long_timestamp FOR TESTING. METHODS: as_timestamp FOR TESTING. METHODS: begin_of_day FOR TESTING. METHODS: begin_of_month FOR TESTING. METHODS: begin_of_quarter FOR TESTING. METHODS: begin_of_week FOR TESTING. METHODS: begin_of_year FOR TESTING. METHODS: clone FOR TESTING. METHODS: day_of_week FOR TESTING. METHODS: end_of_day FOR TESTING. METHODS: end_of_month FOR TESTING. METHODS: end_of_quarter FOR TESTING. METHODS: end_of_week FOR TESTING. METHODS: end_of_year FOR TESTING. METHODS: from_date FOR TESTING. METHODS: from_iso_timestamp FOR TESTING. METHODS: from_now FOR TESTING. METHODS: from_today FOR TESTING. METHODS: get_dayname FOR TESTING. METHODS: get_day_of_week FOR TESTING. METHODS: get_day_of_year FOR TESTING. METHODS: get_ultimo FOR TESTING. METHODS: get_number_of_days_of_month FOR TESTING. METHODS: get_number_of_days_of_year FOR TESTING. METHODS: is_last_day_of_month FOR TESTING. METHODS: set FOR TESTING. METHODS: subtract FOR TESTING. METHODS: get_quarter FOR TESTING. METHODS: get_iso_week FOR TESTING. METHODS: is_leap_year FOR TESTING. METHODS: is_before FOR TESTING. METHODS: is_before_or_equal FOR TESTING. METHODS: is_after FOR TESTING. METHODS: is_after_or_equal FOR TESTING. METHODS: is_equal FOR TESTING. METHODS: create_list FOR TESTING. METHODS: sub_days FOR TESTING. METHODS: sub_hours FOR TESTING. METHODS: sub_minutes FOR TESTING. METHODS: sub_months FOR TESTING. METHODS: sub_seconds FOR TESTING. METHODS: sub_weeks FOR TESTING. METHODS: sub_years FOR TESTING. METHODS: diff FOR TESTING. ENDCLASS. ""unit_Tests CLASS unit_tests IMPLEMENTATION. METHOD method_chaining. DATA(o_datetime) = zcl_datetime=>from_date( '20210307' ). o_datetime->add_days( 3 )->add_hours( 12 )->add_minutes( 30 )->add_seconds( 45 )->add_weeks( 2 )->add_months( 3 )->add_years( 3 ). DATA(ts) = o_datetime->as_timestamp( ). cl_aunit_assert=>assert_equals( act = ts exp = '20240624123045' msg = 'Method chaining check #01' ). o_datetime->add_days( -3 )->add_hours( -12 )->add_minutes( -30 )->add_seconds( -45 )->add_weeks( -2 )->add_months( -3 )->add_years( -3 ). ts = o_datetime->as_timestamp( ). cl_aunit_assert=>assert_equals( act = ts exp = '20210307000000' msg = 'Method chaining check #02' ). ENDMETHOD. METHOD add. "" ISO Timestamp im Format 2021-01-01T01:01:01+01:00 DATA(o_datetime) = zcl_datetime=>from_date( '20210307' ). o_datetime->add( iv_field = zcl_datetime=>c_fields-day iv_value = 3 ). DATA(ts) = o_datetime->as_timestamp( ). cl_aunit_assert=>assert_equals( act = ts exp = '20210310000000' msg = 'Datum +3 Tage fehlerhaft' ). o_datetime->add( iv_field = zcl_datetime=>c_fields-day iv_value = -5 ). o_datetime->add( iv_field = zcl_datetime=>c_fields-hour iv_value = -3 ). ts = o_datetime->as_timestamp( ). cl_aunit_assert=>assert_equals( act = ts exp = '20210304210000' msg = 'Datum -5 Tage - 3 Stunden fehlerhaft' ). o_datetime->add( iv_field = zcl_datetime=>c_fields-week iv_value = 1 ). o_datetime->add( iv_field = zcl_datetime=>c_fields-hour iv_value = 3 ). ts = o_datetime->as_timestamp( ). cl_aunit_assert=>assert_equals( act = ts exp = '20210312000000' msg = 'Datum +1 Woche +3 Stunden fehlerhaft' ). o_datetime = zcl_datetime=>from_date( iv_date = '20210228' iv_time = zcl_datetime=>c_times-end_of_day ). o_datetime->add( iv_field = zcl_datetime=>c_fields-second iv_value = 1 ). ts = o_datetime->as_timestamp( ). cl_aunit_assert=>assert_equals( act = ts exp = '20210301000000' msg = 'Datum +1 Sekunde fehlerhaft' ). ENDMETHOD. METHOD add_days. DATA(o_datetime) = zcl_datetime=>from_date( '20210307' ). o_datetime->add_days( 5 ). DATA(ts) = o_datetime->as_timestamp( ). cl_aunit_assert=>assert_equals( act = ts exp = '20210312000000' msg = 'Datum +5 Tage fehlerhaft' ). o_datetime->add_days( -12 ). ts = o_datetime->as_timestamp( ). cl_aunit_assert=>assert_equals( act = ts exp = '20210228000000' msg = 'Datum -12 Tage fehlerhaft' ). ENDMETHOD. METHOD add_hours. DATA(o_datetime) = zcl_datetime=>from_date( iv_date = '20210307' iv_time = '060000' ). o_datetime->add_hours( 8 ). DATA(ts) = o_datetime->as_timestamp( ). cl_aunit_assert=>assert_equals( act = ts exp = '20210307140000' msg = 'Add hours check #01' ). o_datetime->add_hours( 16 ). ts = o_datetime->as_timestamp( ). cl_aunit_assert=>assert_equals( act = ts exp = '20210308060000' msg = 'Add hours check #02' ). o_datetime->add_hours( -24 ). ts = o_datetime->as_timestamp( ). cl_aunit_assert=>assert_equals( act = ts exp = '20210307060000' msg = 'Add hours check #03' ). ENDMETHOD. METHOD add_minutes. DATA(o_datetime) = zcl_datetime=>from_date( iv_date = '20210307' iv_time = '060000' ). o_datetime->add_minutes( 8 ). DATA(ts) = o_datetime->as_timestamp( ). cl_aunit_assert=>assert_equals( act = ts exp = '20210307060800' msg = 'Add minutes check #01' ). o_datetime->add_minutes( 52 ). ts = o_datetime->as_timestamp( ). cl_aunit_assert=>assert_equals( act = ts exp = '20210307070000' msg = 'Add minutes check #02' ). o_datetime->add_minutes( 60 * 24 * 2 ). ts = o_datetime->as_timestamp( ). cl_aunit_assert=>assert_equals( act = ts exp = '20210309070000' msg = 'Add minutes check #03' ). o_datetime->add_minutes( -1 * ( 60 * 24 * 3 ) ). o_datetime->add_minutes( -60 ). ts = o_datetime->as_timestamp( ). cl_aunit_assert=>assert_equals( act = ts exp = '20210306060000' msg = 'Add minutes check #04' ). ENDMETHOD. METHOD add_months. DATA(o_datetime) = zcl_datetime=>from_date( '20210131' ). DATA(date) = o_datetime->add_months( 1 )->as_date( ). cl_aunit_assert=>assert_equals( act = date exp = '20210228' msg = 'Add month check #01' ). date = o_datetime->add_months( 36 )->as_date( ). cl_aunit_assert=>assert_equals( act = date exp = '20240228' msg = 'Add month check #02' ). ENDMETHOD. METHOD add_seconds. DATA(o_datetime) = zcl_datetime=>from_date( iv_date = '20210307' iv_time = '060000' ). o_datetime->add_seconds( 8 ). DATA(ts) = o_datetime->as_timestamp( ). cl_aunit_assert=>assert_equals( act = ts exp = '20210307060008' msg = 'Add seconds check #01' ). o_datetime->add_seconds( 52 ). ts = o_datetime->as_timestamp( ). cl_aunit_assert=>assert_equals( act = ts exp = '20210307060100' msg = 'Add seconds check #02' ). o_datetime->add_seconds( 60 * 60 * 24 ). ts = o_datetime->as_timestamp( ). cl_aunit_assert=>assert_equals( act = ts exp = '20210308060100' msg = 'Add seconds check #03' ). o_datetime->add_seconds( -600 ). ts = o_datetime->as_timestamp( ). cl_aunit_assert=>assert_equals( act = ts exp = '20210308055100' msg = 'Add seconds check #04' ). ENDMETHOD. METHOD add_weeks. DATA(o_datetime) = zcl_datetime=>from_date( iv_date = '20210307' ). o_datetime->add_weeks( 1 ). DATA(date) = o_datetime->as_date( ). cl_aunit_assert=>assert_equals( act = date exp = '20210314' msg = 'Add weeks check #01' ). o_datetime->add_weeks( -2 ). date = o_datetime->as_date( ). cl_aunit_assert=>assert_equals( act = date exp = '20210228' msg = 'Add weeks check #02' ). ENDMETHOD. METHOD add_years. DATA(o_datetime) = zcl_datetime=>from_date( iv_date = '20210307' ). o_datetime->add_years( 1 ). DATA(date) = o_datetime->as_date( ). cl_aunit_assert=>assert_equals( act = date exp = '20220307' msg = 'Add years check #01' ). o_datetime->add_years( -2 ). date = o_datetime->as_date( ). cl_aunit_assert=>assert_equals( act = date exp = '20200307' msg = 'Add years check #02' ). ENDMETHOD. METHOD as_date. DATA(o_datetime) = zcl_datetime=>from_date( iv_date = '20210307' ). DATA(date) = o_datetime->as_date( ). cl_aunit_assert=>assert_equals( act = date exp = '20210307' msg = 'As date check #01' ). o_datetime = zcl_datetime=>from_date( iv_date = '20210331' ). date = o_datetime->as_date( ). cl_aunit_assert=>assert_equals( act = date exp = '20210331' msg = 'As date check #02' ). o_datetime = zcl_datetime=>from_date( iv_date = '20210401' ). date = o_datetime->as_date( ). cl_aunit_assert=>assert_equals( act = date exp = '20210401' msg = 'As date check #02' ). ENDMETHOD. METHOD as_iso_timestamp. DATA(o_datetime) = zcl_datetime=>from_timestamp( '20210307093045' ). DATA(iso_timestamp) = o_datetime->as_iso_timestamp( ). cl_aunit_assert=>assert_equals( act = iso_timestamp exp = '2021-03-07T09:30:45Z' msg = 'As ISO timestamp check #01' ). ENDMETHOD. METHOD as_long_timestamp. DATA(o_datetime) = zcl_datetime=>from_timestamp( '20210307093045' ). DATA(long_timestamp) = o_datetime->as_long_timestamp( ). cl_aunit_assert=>assert_equals( act = long_timestamp exp = '20210307093045.0000000' msg = 'As date check #01' ). ENDMETHOD. METHOD as_timestamp. DATA(o_datetime) = zcl_datetime=>from_timestamp( '20210307093045' ). DATA(long_timestamp) = o_datetime->as_long_timestamp( ). cl_aunit_assert=>assert_equals( act = long_timestamp exp = '20210307093045' msg = 'As date check #02' ). ENDMETHOD. METHOD begin_of_day. DATA(o_datetime) = zcl_datetime=>from_date( iv_date = '20210307' iv_time = '235959' ). o_datetime->begin_of_day( ). DATA(ts) = o_datetime->as_timestamp( ). cl_aunit_assert=>assert_equals( act = ts exp = '20210307000000' msg = 'Begin of day check #01' ). ENDMETHOD. METHOD begin_of_month. DATA(o_datetime) = zcl_datetime=>from_date( '20210307' ). o_datetime->begin_of_month( ). DATA(ts) = o_datetime->as_timestamp( ). cl_aunit_assert=>assert_equals( act = ts exp = '20210301000000' msg = 'Begin of month check #01' ). ENDMETHOD. METHOD begin_of_quarter. DATA(o_datetime) = zcl_datetime=>from_date( '20210307' ). o_datetime->begin_of_quarter( ). DATA(ts) = o_datetime->as_timestamp( ). cl_aunit_assert=>assert_equals( act = ts exp = '20210101000000' msg = 'Begin of quarter check #01' ). ENDMETHOD. METHOD begin_of_week. DATA(o_datetime) = zcl_datetime=>from_date( '20210101' ). DATA(date) = o_datetime->begin_of_week( )->as_date( ). cl_aunit_assert=>assert_equals( act = date exp = '20201228' msg = 'Begin of week check #01' ). ENDMETHOD. METHOD begin_of_year. DATA(o_datetime) = zcl_datetime=>from_date( '20210307' ). o_datetime->begin_of_quarter( ). DATA(ts) = o_datetime->as_timestamp( ). cl_aunit_assert=>assert_equals( act = ts exp = '20210101000000' msg = 'Begin of year check #01' ). ENDMETHOD. METHOD clone. DATA(o_this_datetime) = zcl_datetime=>from_now( ). DATA(o_other_datetime) = o_this_datetime->clone( ). IF o_this_datetime = o_other_datetime. cl_aunit_assert=>fail( 'Clone check #01' ). ENDIF. IF NOT o_this_datetime->is_equal( o_other_datetime ). cl_aunit_assert=>fail( 'Clone check #02' ). ENDIF. ENDMETHOD. METHOD day_of_week. DATA(o_datetime) = zcl_datetime=>from_date( '20210307' ). "" Sunday o_datetime->day_of_week( zcl_datetime=>c_day_of_week-wednesday ). DATA(ts) = o_datetime->as_timestamp( ). cl_aunit_assert=>assert_equals( act = ts exp = '20210303000000' msg = 'Day of week check #01' ). o_datetime->day_of_week( zcl_datetime=>c_day_of_week-monday ). ts = o_datetime->as_timestamp( ). cl_aunit_assert=>assert_equals( act = ts exp = '20210301000000' msg = 'Day of week check #02' ). ENDMETHOD. METHOD end_of_day. DATA(o_datetime) = zcl_datetime=>from_date( iv_date = '20210307' iv_time = '120000' ). o_datetime->end_of_day( ). DATA(ts) = o_datetime->as_timestamp( ). cl_aunit_assert=>assert_equals( act = ts exp = '20210307235959' msg = 'End of day check #01' ). ENDMETHOD. METHOD end_of_month. DATA(o_datetime) = zcl_datetime=>from_date( '20200205' ). DATA(ts) = o_datetime->end_of_month( )->as_timestamp( ). cl_aunit_assert=>assert_equals( act = ts exp = '20200229000000' msg = 'End of month check #01' ). o_datetime = zcl_datetime=>from_date( '20210205' ). ts = o_datetime->end_of_month( )->as_timestamp( ). cl_aunit_assert=>assert_equals( act = ts exp = '20210228000000' msg = 'End of month check #02' ). ENDMETHOD. METHOD end_of_quarter. DATA(o_datetime) = zcl_datetime=>from_date( '20210307' ). "" Sunday o_datetime->end_of_quarter( ). DATA(ts) = o_datetime->as_timestamp( ). cl_aunit_assert=>assert_equals( act = ts exp = '20210331000000' msg = 'End of quarter check #01' ). o_datetime->add_days( 1 )->end_of_quarter( ). ts = o_datetime->as_timestamp( ). cl_aunit_assert=>assert_equals( act = ts exp = '20210630000000' msg = 'End of quarter check #02' ). o_datetime->add_days( 1 )->end_of_quarter( ). ts = o_datetime->as_timestamp( ). cl_aunit_assert=>assert_equals( act = ts exp = '20210930000000' msg = 'End of quarter check #03' ). o_datetime->add_days( 1 )->end_of_quarter( ). ts = o_datetime->as_timestamp( ). cl_aunit_assert=>assert_equals( act = ts exp = '20211231000000' msg = 'End of quarter check #04' ). ENDMETHOD. METHOD end_of_week. DATA(o_datetime) = zcl_datetime=>from_date( '20210101' ). DATA(date) = o_datetime->end_of_week( )->as_date( ). cl_aunit_assert=>assert_equals( act = date exp = '20210103' msg = 'End of week check #01' ). o_datetime = zcl_datetime=>from_date( '20210301' ). date = o_datetime->end_of_week( )->as_date( ). cl_aunit_assert=>assert_equals( act = date exp = '20210307' msg = 'End of week check #02' ). ENDMETHOD. METHOD end_of_year. DATA(o_datetime) = zcl_datetime=>from_date( '20210101' ). DATA(date) = o_datetime->end_of_year( )->as_date( ). cl_aunit_assert=>assert_equals( act = date exp = '20211231' msg = 'End of year check #01' ). ENDMETHOD. METHOD from_date. DATA(o_datetime) = zcl_datetime=>from_date( '20210101' ). DATA(date) = o_datetime->as_date( ). cl_aunit_assert=>assert_equals( act = date exp = '20210101' msg = 'From date check #01' ). TRY. o_datetime = zcl_datetime=>from_date( '20210229' ). "" 2021 is a none leap year...29th of february is not a valid date. cl_aunit_assert=>fail( msg = 'From date check #02' ). CATCH cx_parameter_invalid_range ##NO_HANDLER. "" Everything is fine. We had expected an exception. ENDTRY. TRY. o_datetime = zcl_datetime=>from_date( '20200229' ). "" 2021 is a leap year...29th of february is a valid date. CATCH cx_parameter_invalid_range ##NO_HANDLER. cl_aunit_assert=>fail( msg = 'From date check #03' ). "" Everything is fine. We had expected an exception. ENDTRY. TRY. o_datetime = zcl_datetime=>from_date( iv_date = '20200229' iv_time = '243030' ). cl_aunit_assert=>fail( msg = 'From date check #04' ). CATCH cx_parameter_invalid_range ##NO_HANDLER. "" Everything is fine. We had expected an exception. ENDTRY. TRY. o_datetime = zcl_datetime=>from_date( iv_date = '20200229' iv_time = '000000' ). CATCH cx_parameter_invalid_range ##NO_HANDLER. cl_aunit_assert=>fail( msg = 'From date check #05' ). ENDTRY. ENDMETHOD. METHOD from_iso_timestamp. DATA(o_datetime) = zcl_datetime=>from_iso_timestamp( '2020-04-21T18:09:25Z' ). DATA(ts) = o_datetime->as_timestamp( ). cl_aunit_assert=>assert_equals( act = ts exp = '20200421180925' msg = 'From iso timestamp check #01' ). TRY. o_datetime = zcl_datetime=>from_iso_timestamp( '2020-04-21T28:09:25Z' ). "" 28:09:25 is not a valid time... cl_aunit_assert=>fail( msg = 'From iso timestamp check #02' ). CATCH cx_xlf_illegal_argument ##NO_HANDLER. "" Everything is fine. We had expected an exception. ENDTRY. ENDMETHOD. METHOD from_now. DATA(current_date) = sy-datum. DATA(current_time) = sy-uzeit. DATA(o_datetime) = zcl_datetime=>from_now( ). DATA(ts) = o_datetime->as_timestamp( ). DATA(o_dt_reference) = zcl_datetime=>from_timestamp( CONV timestamp( |{ current_date }{ current_time }| ) ). DATA(delta) = abs( o_datetime->diff( iv_field = zcl_datetime=>c_fields-second io_datetime = o_dt_reference ) ). "" Max delta of one second is okay. Be aware that this test fails in debugger "" if you arent fast enough... IF delta > 1. cl_aunit_assert=>fail( msg = 'From now check #01' ). ENDIF. ENDMETHOD. METHOD from_today. DATA(current_date) = sy-datum. DATA(o_datetime) = zcl_datetime=>from_today( ). DATA(date) = o_datetime->as_date( ). IF date NE current_date. cl_aunit_assert=>fail( msg = 'From today check #01' ). ENDIF. ENDMETHOD. METHOD get_dayname. ##TODO. ENDMETHOD. METHOD get_day_of_week. DATA(o_datetime) = zcl_datetime=>from_date( '20210101' ). "" We step throug next 7 day and check the expected day of week. "" Checks are done relative to given date 1st January of 2021 DATA(day_of_week) = o_datetime->get_day_of_week( ). cl_aunit_assert=>assert_equals( act = day_of_week exp = zcl_datetime=>c_day_of_week-friday msg = 'Day of week check #01' ). o_datetime->add_days( 1 ). day_of_week = o_datetime->get_day_of_week( ). cl_aunit_assert=>assert_equals( act = day_of_week exp = zcl_datetime=>c_day_of_week-saturday msg = 'Day of week check #02' ). o_datetime->add_days( 1 ). day_of_week = o_datetime->get_day_of_week( ). cl_aunit_assert=>assert_equals( act = day_of_week exp = zcl_datetime=>c_day_of_week-sunday msg = 'Day of week check #03' ). o_datetime->add_days( 1 ). day_of_week = o_datetime->get_day_of_week( ). cl_aunit_assert=>assert_equals( act = day_of_week exp = zcl_datetime=>c_day_of_week-monday msg = 'Day of week check #04' ). o_datetime->add_days( 1 ). day_of_week = o_datetime->get_day_of_week( ). cl_aunit_assert=>assert_equals( act = day_of_week exp = zcl_datetime=>c_day_of_week-tuesday msg = 'Day of week check #05' ). o_datetime->add_days( 1 ). day_of_week = o_datetime->get_day_of_week( ). cl_aunit_assert=>assert_equals( act = day_of_week exp = zcl_datetime=>c_day_of_week-wednesday msg = 'Day of week check #06' ). o_datetime->add_days( 1 ). day_of_week = o_datetime->get_day_of_week( ). cl_aunit_assert=>assert_equals( act = day_of_week exp = zcl_datetime=>c_day_of_week-thursday msg = 'Day of week check #07' ). o_datetime->add_days( 1 ). day_of_week = o_datetime->get_day_of_week( ). cl_aunit_assert=>assert_equals( act = day_of_week exp = zcl_datetime=>c_day_of_week-friday msg = 'Day of week check #08' ). o_datetime = zcl_datetime=>from_date( '20211231' ). day_of_week = o_datetime->get_day_of_week( ). cl_aunit_assert=>assert_equals( act = day_of_week exp = zcl_datetime=>c_day_of_week-friday msg = 'Day of week check #09' ). ENDMETHOD. METHOD get_ultimo. DATA(o_datetime) = zcl_datetime=>from_date( '20210101' ). DATA(ultimo) = o_datetime->get_ultimo( ). cl_aunit_assert=>assert_equals( act = ultimo exp = '20210131' msg = 'Get last day of month check #01' ). ultimo = o_datetime->add_months( 1 )->get_ultimo( ). cl_aunit_assert=>assert_equals( act = ultimo exp = '20210228' msg = 'Get last day of month check #02' ). ultimo = o_datetime->add_years( -1 )->get_ultimo( ). "" 2020 was a leap year... cl_aunit_assert=>assert_equals( act = ultimo exp = '20200229' msg = 'Get last day of month check #03' ). ENDMETHOD. METHOD get_number_of_days_of_month. "" The result is calculated in the same way. me->get_ultimo( ). ENDMETHOD. METHOD get_number_of_days_of_year. DATA(o_datetime) = zcl_datetime=>from_date( '20210101' ). DATA(number_of_days_of_year) = o_datetime->get_number_of_days_of_year( ). cl_aunit_assert=>assert_equals( act = number_of_days_of_year exp = zcl_datetime=>c_day_of_year-max_days_in_none_leap_year msg = 'Get number of days of year check #01' ). number_of_days_of_year = o_datetime->add_years( -1 )->get_number_of_days_of_year( ). cl_aunit_assert=>assert_equals( act = number_of_days_of_year exp = zcl_datetime=>c_day_of_year-max_days_in_leap_year msg = 'Get number of days of year check #02' ). ENDMETHOD. METHOD is_last_day_of_month. DATA(o_datetime) = zcl_datetime=>from_date( '20210131' ). DATA(fl_last_day_of_month) = o_datetime->is_last_day_of_month( ). cl_aunit_assert=>assert_equals( act = fl_last_day_of_month exp = abap_true msg = 'Is last day of month check #01' ). fl_last_day_of_month = o_datetime->add_days( 1 )->is_last_day_of_month( ). cl_aunit_assert=>assert_equals( act = fl_last_day_of_month exp = abap_false msg = 'Is last day of month check #02' ). ENDMETHOD. METHOD set. DATA(o_datetime) = zcl_datetime=>from_date( '20210131' ). o_datetime->set( iv_field = zcl_datetime=>c_fields-year iv_value = 2020 ). o_datetime->set( iv_field = zcl_datetime=>c_fields-month iv_value = 3 ). o_datetime->set( iv_field = zcl_datetime=>c_fields-day iv_value = 1 ). o_datetime->set( iv_field = zcl_datetime=>c_fields-hour iv_value = 9 ). o_datetime->set( iv_field = zcl_datetime=>c_fields-minute iv_value = 30 ). o_datetime->set( iv_field = zcl_datetime=>c_fields-second iv_value = 45 ). DATA(ts) = o_datetime->as_timestamp( ). cl_aunit_assert=>assert_equals( act = ts exp = '20200301093045' msg = 'Set check #01' ). ENDMETHOD. METHOD subtract. ENDMETHOD. METHOD get_day_of_year. DATA(o_datetime) = zcl_datetime=>from_date( '19900806' ). o_datetime->get_day_of_year( ). ENDMETHOD. METHOD get_quarter. DATA(o_datetime) = zcl_datetime=>from_date( '20210101' ). DATA(quarter) = o_datetime->get_quarter( ). cl_aunit_assert=>assert_equals( act = quarter exp = 1 msg = 'Quarter calc check #01' ). o_datetime->add_months( 3 ). quarter = o_datetime->get_quarter( ). cl_aunit_assert=>assert_equals( act = quarter exp = 2 msg = 'Quarter calc check #02' ). o_datetime->add_months( 3 ). quarter = o_datetime->get_quarter( ). cl_aunit_assert=>assert_equals( act = quarter exp = 3 msg = 'Quarter calc check #03' ). o_datetime->add_months( 3 ). quarter = o_datetime->get_quarter( ). cl_aunit_assert=>assert_equals( act = quarter exp = 4 msg = 'Quarter calc check #04' ). o_datetime->add_months( 3 ). quarter = o_datetime->get_quarter( ). cl_aunit_assert=>assert_equals( act = quarter exp = 1 msg = 'Quarter calc check #05' ). ENDMETHOD. METHOD get_iso_week. DATA(o_datetime) = zcl_datetime=>from_date( '20211231' ). DATA(wa_iso_week) = o_datetime->get_iso_week( ). cl_aunit_assert=>assert_equals( act = wa_iso_week exp = VALUE zcl_datetime=>ty_iso_week( week = 52 year = 2021 day_of_week = zcl_datetime=>c_day_of_week-friday ) msg = 'ISO week check #01' ). o_datetime = zcl_datetime=>from_date( '20210101' ). wa_iso_week = o_datetime->get_iso_week( ). cl_aunit_assert=>assert_equals( act = wa_iso_week exp = VALUE zcl_datetime=>ty_iso_week( week = 53 year = 2020 day_of_week = zcl_datetime=>c_day_of_week-friday ) msg = 'ISO week check #02' ). o_datetime = zcl_datetime=>from_date( '20200104' ). wa_iso_week = o_datetime->get_iso_week( ). cl_aunit_assert=>assert_equals( act = wa_iso_week exp = VALUE zcl_datetime=>ty_iso_week( week = 1 year = 2020 day_of_week = zcl_datetime=>c_day_of_week-saturday ) msg = 'ISO week check #03' ). o_datetime = zcl_datetime=>from_date( '20200229' ). wa_iso_week = o_datetime->get_iso_week( ). cl_aunit_assert=>assert_equals( act = wa_iso_week exp = VALUE zcl_datetime=>ty_iso_week( week = 9 year = 2020 day_of_week = zcl_datetime=>c_day_of_week-saturday ) msg = 'ISO week check #04' ). o_datetime = zcl_datetime=>from_date( '20200106' ). wa_iso_week = o_datetime->get_iso_week( ). cl_aunit_assert=>assert_equals( act = wa_iso_week exp = VALUE zcl_datetime=>ty_iso_week( week = 2 year = 2020 day_of_week = zcl_datetime=>c_day_of_week-monday ) msg = 'ISO week check #05' ). ENDMETHOD. METHOD is_leap_year. DATA(o_datetime) = zcl_datetime=>from_date( '20210101' ). DATA(fl_is_leap_year) = o_datetime->is_leap_year( ). cl_aunit_assert=>assert_equals( act = fl_is_leap_year exp = abap_false msg = 'Leap year check #01' ). o_datetime = zcl_datetime=>from_date( '20200101' ). fl_is_leap_year = o_datetime->is_leap_year( ). cl_aunit_assert=>assert_equals( act = fl_is_leap_year exp = abap_true msg = 'Leap year check #02' ). o_datetime = zcl_datetime=>from_date( '16000101' ). fl_is_leap_year = o_datetime->is_leap_year( ). cl_aunit_assert=>assert_equals( act = fl_is_leap_year exp = abap_true msg = 'Leap year check #03' ). o_datetime = zcl_datetime=>from_date( '19000101' ). fl_is_leap_year = o_datetime->is_leap_year( ). cl_aunit_assert=>assert_equals( act = fl_is_leap_year exp = abap_false msg = 'Leap year check #04' ). ENDMETHOD. METHOD is_before. DATA(o_this) = zcl_datetime=>from_now( ). DATA(o_other) = o_this->clone( )->add_days( -1 ). IF o_other->is_before( o_this ). "" Works as expected... ELSE. cl_aunit_assert=>fail( msg = 'Is before check #01' ). ENDIF. IF o_this->is_before( o_other ). cl_aunit_assert=>fail( msg = 'Is before check #02' ). ELSE. "" Works as expected... ENDIF. o_other = o_this->clone( )->add_seconds( -1 ). IF o_other->is_before( o_this ). cl_aunit_assert=>fail( msg = 'Is before check #03' ). ELSE. "" Works as expected... ENDIF. IF o_this->is_before( o_other ). cl_aunit_assert=>fail( msg = 'Is before check #04' ). ELSE. "" Works as expected... ENDIF. IF o_other->is_before( io_datetime = o_this iv_ignore_time = abap_false ). "" Works as expected... ELSE. cl_aunit_assert=>fail( msg = 'Is before check #05' ). ENDIF. ENDMETHOD. METHOD is_before_or_equal. DATA(o_this) = zcl_datetime=>from_now( ). DATA(o_other) = o_this->clone( ). IF o_other->is_before_or_equal( o_this ). "" Works as expected... ELSE. cl_aunit_assert=>fail( msg = 'Is before or equal check #01' ). ENDIF. o_other->add_seconds( -1 ). IF o_other->is_before_or_equal( o_this ). "" Works as expected... ELSE. cl_aunit_assert=>fail( msg = 'Is before or equal check #02' ). ENDIF. o_other = o_this->clone( )->add_seconds( 1 ). IF o_other->is_before_or_equal( o_this ). "" Works as expected... ELSE. cl_aunit_assert=>fail( msg = 'Is before or equal check #03' ). ENDIF. IF o_other->is_before_or_equal( io_datetime = o_this iV_ignore_time = abap_false ). cl_aunit_assert=>fail( msg = 'Is before or equal check #03' ). ELSE. "" Works as expected... ENDIF. ENDMETHOD. METHOD is_after. DATA(o_this) = zcl_datetime=>from_now( ). DATA(o_other) = o_this->clone( ). IF o_this->is_after( o_other ). cl_aunit_assert=>fail( msg = 'Is after check #01' ). ELSE. "" Works as expected... ENDIF. o_other->add_days( - 1 ). IF o_this->is_after( o_other ). "" Works as expected... ELSE. cl_aunit_assert=>fail( msg = 'Is after check #02' ). ENDIF. o_other = o_this->clone( )->add_seconds( -1 ). IF o_this->is_after( io_datetime = o_other iv_ignore_time = abap_false ). "" Works as expected... ELSE. cl_aunit_assert=>fail( msg = 'Is after check #03' ). ENDIF. o_other = o_this->clone( )->add_seconds( 1 ). IF o_this->is_after( io_datetime = o_other iv_ignore_time = abap_false ). cl_aunit_assert=>fail( msg = 'Is after check #03' ). ELSE. "" Works as expected... ENDIF. ENDMETHOD. METHOD is_after_or_equal. DATA(o_this) = zcl_datetime=>from_now( ). DATA(o_other) = o_this->clone( ). IF o_this->is_after_or_equal( o_other ). "" Works as expected... ELSE. cl_aunit_assert=>fail( msg = 'Is after or equal check #01' ). ENDIF. o_other->add_days( 1 ). IF o_this->is_after_or_equal( o_other ). cl_aunit_assert=>fail( msg = 'Is after or equal check #02' ). ELSE. "" Works as expected... ENDIF. o_other = o_this->clone( ). IF o_this->is_after_or_equal( io_datetime = o_other iv_ignore_time = abap_false ). "" Works as expected... ELSE. cl_aunit_assert=>fail( msg = 'Is after or equal check #03' ). ENDIF. o_other->add_seconds( 1 ). IF o_this->is_after_or_equal( io_datetime = o_other iv_ignore_time = abap_false ). cl_aunit_assert=>fail( msg = 'Is after or equal check #04' ). ELSE. "" Works as expected... ENDIF. o_other = o_this->clone( )->add_seconds( - 1 ). IF o_this->is_after_or_equal( io_datetime = o_other iv_ignore_time = abap_false ). "" Works as expected... ELSE. cl_aunit_assert=>fail( msg = 'Is after or equal check #05' ). ENDIF. ENDMETHOD. METHOD is_equal. DATA(o_this) = zcl_datetime=>from_now( ). DATA(o_other) = o_this->clone( ). IF o_this->is_equal( o_other ). "" Works as expected... ELSE. cl_aunit_assert=>fail( msg = 'Is equal check #01' ). ENDIF. o_other->add_days( 1 ). IF o_this->is_equal( o_other ). cl_aunit_assert=>fail( msg = 'Is equal check #02' ). ELSE. "" Works as expected... ENDIF. o_other = o_this->clone( )->add_seconds( 1 ). IF o_this->is_equal( o_other ). "" Works as expected... ELSE. cl_aunit_assert=>fail( msg = 'Is equal check #03' ). ENDIF. IF o_this->is_equal( io_datetime = o_other iv_ignore_time = abap_false ). cl_aunit_assert=>fail( msg = 'Is equal check #04' ). ELSE. "" Works as expected... ENDIF. ENDMETHOD. METHOD create_list. DATA(o_this) = zcl_datetime=>from_date( '20210307' ). o_this->begin_of_year( )->begin_of_day( ). "" Create a list with all 12 month in a year DATA(t_datetime_list) = zcl_datetime=>create_list( io_start = o_this iv_increment_field = zcl_datetime=>c_fields-month iv_increment_value = 1 iv_num_of_elements = 12 ). cl_aunit_assert=>assert_equals( act = lines( t_datetime_list ) exp = 12 msg = 'Create list check #01' ). cl_aunit_assert=>assert_equals( act = t_datetime_list[ 1 ]-o_datetime->as_date( ) exp = CONV dats( '20210101' ) msg = 'Create list check #02' ). cl_aunit_assert=>assert_equals( act = t_datetime_list[ 2 ]-o_datetime->as_date( ) exp = CONV dats( '20210201' ) msg = 'Create list check #03' ). cl_aunit_assert=>assert_equals( act = t_datetime_list[ 3 ]-o_datetime->as_date( ) exp = CONV dats( '20210301' ) msg = 'Create list check #04' ). cl_aunit_assert=>assert_equals( act = t_datetime_list[ 4 ]-o_datetime->as_date( ) exp = CONV dats( '20210401' ) msg = 'Create list check #05' ). cl_aunit_assert=>assert_equals( act = t_datetime_list[ 5 ]-o_datetime->as_date( ) exp = CONV dats( '20210501' ) msg = 'Create list check #06' ). cl_aunit_assert=>assert_equals( act = t_datetime_list[ 6 ]-o_datetime->as_date( ) exp = CONV dats( '20210601' ) msg = 'Create list check #07' ). cl_aunit_assert=>assert_equals( act = t_datetime_list[ 7 ]-o_datetime->as_date( ) exp = CONV dats( '20210701' ) msg = 'Create list check #08' ). cl_aunit_assert=>assert_equals( act = t_datetime_list[ 8 ]-o_datetime->as_date( ) exp = CONV dats( '20210801' ) msg = 'Create list check #09' ). cl_aunit_assert=>assert_equals( act = t_datetime_list[ 9 ]-o_datetime->as_date( ) exp = CONV dats( '20210901' ) msg = 'Create list check #10' ). cl_aunit_assert=>assert_equals( act = t_datetime_list[ 10 ]-o_datetime->as_date( ) exp = CONV dats( '20211001' ) msg = 'Create list check #11' ). cl_aunit_assert=>assert_equals( act = t_datetime_list[ 11 ]-o_datetime->as_date( ) exp = CONV dats( '20211101' ) msg = 'Create list check #12' ). cl_aunit_assert=>assert_equals( act = t_datetime_list[ 12 ]-o_datetime->as_date( ) exp = CONV dats( '20211201' ) msg = 'Create list check #13' ). "" Creating date list with all 31 days of january t_datetime_list = zcl_datetime=>create_list( io_start = o_this iv_increment_field = zcl_datetime=>c_fields-day iv_increment_value = 1 iv_num_of_elements = 31 ). cl_aunit_assert=>assert_equals( act = lines( t_datetime_list ) exp = 31 msg = 'Create list check #14' ). "" Testing only one sample cl_aunit_assert=>assert_equals( act = t_datetime_list[ 15 ]-o_datetime->as_date( ) exp = CONV dats( '20210115' ) msg = 'Create list check #14' ). ENDMETHOD. METHOD sub_days. DATA(o_datetime) = zcl_datetime=>from_date( '20210307' ). o_datetime->sub_days( 5 ). DATA(ts) = o_datetime->as_timestamp( ). cl_aunit_assert=>assert_equals( act = ts exp = '20210302000000' msg = 'Sub days check #01' ). o_datetime->sub_days( -10 ). ts = o_datetime->as_timestamp( ). cl_aunit_assert=>assert_equals( act = ts exp = '20210312000000' msg = 'Sub days check #02' ). ENDMETHOD. METHOD sub_hours. DATA(o_datetime) = zcl_datetime=>from_date( iv_date = '20210307' iv_time = '060000' ). o_datetime->sub_hours( 8 ). DATA(ts) = o_datetime->as_timestamp( ). cl_aunit_assert=>assert_equals( act = ts exp = '20210306220000' msg = 'Sub hours check #01' ). o_datetime->sub_hours( 16 ). ts = o_datetime->as_timestamp( ). cl_aunit_assert=>assert_equals( act = ts exp = '20210306060000' msg = 'Sub hours check #02' ). o_datetime->sub_hours( -24 ). ts = o_datetime->as_timestamp( ). cl_aunit_assert=>assert_equals( act = ts exp = '20210307060000' msg = 'Sub hours check #03' ). ENDMETHOD. METHOD sub_minutes. DATA(o_datetime) = zcl_datetime=>from_date( iv_date = '20210307' iv_time = '060000' ). o_datetime->sub_minutes( 8 ). DATA(ts) = o_datetime->as_timestamp( ). cl_aunit_assert=>assert_equals( act = ts exp = '20210307055200' msg = 'Sub minutes check #01' ). o_datetime->sub_minutes( 52 ). ts = o_datetime->as_timestamp( ). cl_aunit_assert=>assert_equals( act = ts exp = '20210307050000' msg = 'Sub minutes check #02' ). ENDMETHOD. METHOD sub_months. DATA(o_datetime) = zcl_datetime=>from_date( '20210131' ). DATA(date) = o_datetime->sub_months( 1 )->as_date( ). cl_aunit_assert=>assert_equals( act = date exp = '20201231' msg = 'Sub month check #01' ). date = o_datetime->sub_months( 36 )->as_date( ). cl_aunit_assert=>assert_equals( act = date exp = '20171231' msg = 'Sub month check #02' ). ENDMETHOD. METHOD sub_seconds. DATA(o_datetime) = zcl_datetime=>from_date( iv_date = '20210307' iv_time = '060000' ). o_datetime->sub_seconds( 8 ). DATA(ts) = o_datetime->as_timestamp( ). cl_aunit_assert=>assert_equals( act = ts exp = '20210307055952' msg = 'Sub seconds check #01' ). o_datetime->sub_seconds( 52 ). ts = o_datetime->as_timestamp( ). cl_aunit_assert=>assert_equals( act = ts exp = '20210307055900' msg = 'Sub seconds check #02' ). ENDMETHOD. METHOD sub_weeks. DATA(o_datetime) = zcl_datetime=>from_date( iv_date = '20210307' ). o_datetime->sub_weeks( 1 ). DATA(date) = o_datetime->as_date( ). cl_aunit_assert=>assert_equals( act = date exp = '20210228' msg = 'Sub weeks check #01' ). o_datetime->sub_weeks( -2 ). date = o_datetime->as_date( ). cl_aunit_assert=>assert_equals( act = date exp = '20210314' msg = 'Sub weeks check #02' ). ENDMETHOD. METHOD sub_years. DATA(o_datetime) = zcl_datetime=>from_date( iv_date = '20210307' ). o_datetime->sub_years( 1 ). DATA(date) = o_datetime->as_date( ). cl_aunit_assert=>assert_equals( act = date exp = '20200307' msg = 'Sub years check #01' ). o_datetime->sub_years( -2 ). date = o_datetime->as_date( ). cl_aunit_assert=>assert_equals( act = date exp = '20220307' msg = 'Sub years check #02' ). ENDMETHOD. METHOD diff. DATA(o_this) = zcl_datetime=>from_date( iv_date = '20210307' ). DATA(o_other) = o_this->clone( )->add_hours( 36 ). DATA(diff) = o_this->diff( io_datetime = o_other iv_field = zcl_datetime=>c_fields-day ). cl_aunit_assert=>assert_equals( act = diff exp = CONV zcl_datetime=>ty_diff( '1.5' ) msg = 'Diff check #01' ). diff = o_this->diff( io_datetime = o_other iv_field = zcl_datetime=>c_fields-day iv_round_mode = zcl_datetime=>c_rouding-round_ceiling ). cl_aunit_assert=>assert_equals( act = diff exp = CONV zcl_datetime=>ty_diff( '2' ) msg = 'Diff check #02' ). diff = o_this->diff( io_datetime = o_other iv_field = zcl_datetime=>c_fields-day iv_round_mode = zcl_datetime=>c_rouding-round_down ). cl_aunit_assert=>assert_equals( act = diff exp = CONV zcl_datetime=>ty_diff( '1' ) msg = 'Diff check #02' ). o_other = o_this->clone( )->add_hours( 44 ). diff = o_this->diff( io_datetime = o_other iv_field = zcl_datetime=>c_fields-day ). cl_aunit_assert=>assert_equals( act = diff exp = CONV zcl_datetime=>ty_diff( '1.833333333333333' ) msg = 'Diff check #02' ). o_this = zcl_datetime=>from_date( '20210101' ). o_other = zcl_datetime=>from_date( '20211231' ). diff = o_this->diff( io_datetime = o_other iv_field = zcl_datetime=>c_fields-month ). ENDMETHOD. ENDCLASS. ",12880,True,3144.685192996604,median ":toc: macro toc::[] :idprefix: :idseparator: - ifdef::env-github[] :tip-caption: :bulb: :note-caption: :information_source: :important-caption: :heavy_exclamation_mark: :caution-caption: :fire: :warning-caption: :warning: endif::[] = devon4j adding Custom Functionality Now we have a fully functional blank project. All we have to do now is to create the components and services which will compose our application. First, we are going to develop the views of the app through its components, then we will create the services with the logic, security and back-end connection. == Creating Components [NOTE] ==== You have already learned about creating Components in devon4ng https://github.com/devonfw/jump-the-queue/wiki/devon4ng-components#create-a-new-component[here]. + You can go back and read that section again to refresh your memory. ==== Our app is going to consist of 3 main views: * Login * Register * ViewQueue To navigate between these views/components, we are going to implement routes using the Angular Router. To see our progress, move to the root folder of the `angular` project and run `ng serve -o` again. This will recompile and publish our client app to http://localhost:4200. Angular will keep watching for changes, so whenever we modify the code, the app will automatically reload. === Root Component `app.component.ts` inside `angular/src/app` will be our root component, so we don't have to create a new file yet. We are going to add elements to the root component that will be common no matter what view will be displayed. [NOTE] ==== You have already learned about the Root Component in devon4ng https://github.com/devonfw/jump-the-queue/wiki/devon4ng-components#root-component[here]. + You can go back and read that section again to refresh your memory. ==== This applies to the header element which will be on top of the window and on top of all other components. If you want, you can read more about https://teradata.github.io/covalent/#/layouts[Covalent layouts], which we are going to use a lot from now on, for every view component. [NOTE] ==== You have already learned about Covalent Layouts in devon4ng https://github.com/devonfw/jump-the-queue/wiki/devon4ng-components#teradata-covalent-layouts[here]. + You can go back and read that section again to refresh your memory. ==== We don't really need anything more than a header, so we are going to use the simplest layout for this purpose; the *nav view*. In order to be able to use Covalent and Angular Material we are going to create a core module, which we will import into every other module where we want to use Covalent and Angular Material. First, we create a folder called `shared` in the `angular/src/app` directory. Inside there we are going to create a file called `core.module.ts` and will fill it with the following content: [source, typescript] ---- import { NgModule } from '@angular/core'; import { RouterModule } from '@angular/router'; import { CommonModule } from '@angular/common'; import { HttpClientModule, HTTP_INTERCEPTORS } from '@angular/common/http'; import { BrowserAnimationsModule } from '@angular/platform-browser/animations'; import { MatAutocompleteModule, MatButtonModule, MatButtonToggleModule, MatCardModule, MatCheckboxModule, MatChipsModule, MatDatepickerModule, MatDialogModule, MatExpansionModule, MatGridListModule, MatIconModule, MatInputModule, MatListModule, MatMenuModule, MatNativeDateModule, MatPaginatorModule, MatProgressBarModule, MatProgressSpinnerModule, MatRadioModule, MatRippleModule, MatSelectModule, MatSidenavModule, MatSliderModule, MatSlideToggleModule, MatSnackBarModule, MatSortModule, MatTableModule, MatTabsModule, MatToolbarModule, MatTooltipModule, } from '@angular/material'; import { CdkTableModule } from '@angular/cdk/table'; import { CovalentChipsModule, CovalentLayoutModule, CovalentExpansionPanelModule, CovalentDataTableModule, CovalentPagingModule, CovalentDialogsModule, CovalentLoadingModule, CovalentMediaModule, CovalentNotificationsModule, CovalentCommonModule, } from '@covalent/core'; @NgModule({ imports: [ RouterModule, BrowserAnimationsModule, MatCardModule, MatButtonModule, MatIconModule, CovalentMediaModule, CovalentLayoutModule, CdkTableModule, ], exports: [ CommonModule, CovalentChipsModule, CovalentLayoutModule, CovalentExpansionPanelModule, CovalentDataTableModule, CovalentPagingModule, CovalentDialogsModule, CovalentLoadingModule, CovalentMediaModule, CovalentNotificationsModule, CovalentCommonModule, CdkTableModule, MatAutocompleteModule, MatButtonModule, MatButtonToggleModule, MatCardModule, MatCheckboxModule, MatChipsModule, MatDatepickerModule, MatDialogModule, MatExpansionModule, MatGridListModule, MatIconModule, MatInputModule, MatListModule, MatMenuModule, MatNativeDateModule, MatPaginatorModule, MatProgressBarModule, MatProgressSpinnerModule, MatRadioModule, MatRippleModule, MatSelectModule, MatSidenavModule, MatSliderModule, MatSlideToggleModule, MatSnackBarModule, MatSortModule, MatTableModule, MatTabsModule, MatToolbarModule, MatTooltipModule, HttpClientModule, ], declarations: [], providers: [ HttpClientModule ], }) export class CoreModule {} ---- [NOTE] ==== This `CoreModule` has almost every module of the different components for *Angular Material* and *Covalent Teradata*. If you decide to use a component that is not included yet, you need to add the corresponding module here. ==== Remember that we need to import this `CoreModule` module into the `AppModule` and inside every module of the different components that use *Angular Material* and *Covalent Teradata*. If a component does not have a module, it will be imported in the `AppModule` and hence automatically have the `CoreModule`. Our `app.module.ts` should have the following content: [source, typescript] ---- import { BrowserModule } from '@angular/platform-browser'; import { NgModule, CUSTOM_ELEMENTS_SCHEMA } from '@angular/core'; // Application components and services import { AppRoutingModule } from './app-routing.module'; import { AppComponent } from './app.component'; import { CoreModule } from './shared/core.module'; @NgModule({ declarations: [ AppComponent ], imports: [ BrowserModule, AppRoutingModule, CoreModule, ], providers: [ ], bootstrap: [AppComponent], schemas: [ CUSTOM_ELEMENTS_SCHEMA ] }) export class AppModule { } ---- [NOTE] ==== Even if we setup module correctly the html file can give us this red flag: ""If 'td-layout' is a Web Component then add 'CUSTOM_ELEMENTS_SCHEMA' to the '@NgModule.schemas' of this component to suppress this message."" To solve this we add ""schemas: [ CUSTOM_ELEMENTS_SCHEMA ]"" insde the @NgModule of all the afected modules. ==== [NOTE] ==== Remember this step because you will have to repeat it for every other component from Teradata you use in your app. ==== Now we can use this layout, so let's implement it in `app.component.html`. Use the following code: [source, html] ----

Jump The Queue

app works!

---- [NOTE] ==== You have already learned about Toolbars in devon4ng https://github.com/devonfw/jump-the-queue/wiki/devon4ng-components#toolbars[here]. + You can go back and read that section again to refresh your memory. ==== [NOTE] ==== You have already learned about Toolbars in devon4ng https://github.com/devonfw/jump-the-queue/wiki/devon4ng-components#toolbars[here]. + You can go back and read that section again to refresh your memory. ==== Once this is done, our app should have a header and ""app works!"" should appear in the body of the page: image::images/devon4ng/3.BuildYourOwn/root_header.jpg[Root Header, 250] To go a step further, we have to modify the body of the root component because it should be the *output of the router*. Now it's time to prepare the routing system. First, we need to create a component to show as default which will be our access view. We will modify it later. Stop `ng serve` and run: ---- ng generate component form-login ---- It will add a folder to our project with all the files needed for a component. Now we can move on to the router task again. Run `ng serve` again to continue the development. Let's create a module that navigates between components when the Router checks for routes. The file `app-routing.module.ts` was created automatically when we chose to include Angular Routing during project creation and we only need to modify it now: [source, typescript] ---- import { NgModule } from '@angular/core'; import { RouterModule, Routes } from '@angular/router'; import { FormLoginComponent } from './form-login/form-login.component'; const appRoutes: Routes = [ { path: 'FormLogin', component: FormLoginComponent}, // Redirect if url path is /FormLogin. { path: '**', redirectTo: '/FormLogin', pathMatch: 'full' } // Redirect if url path do not match any other route. ]; @NgModule({ imports: [ RouterModule.forRoot( appRoutes, { enableTracing: true }, // <-- debugging purposes only ), ], exports: [RouterModule], }) export class AppRoutingModule {} ---- [NOTE] ==== You have already learned about Routing in devon4ng https://github.com/devonfw/jump-the-queue/wiki/devon4ng-components#routing[here]. + You can go back and read that section again to refresh your memory. ==== Finally, we remove the `

app works!

` from `app.component.html` and replace it with a `` tag. The final result of our root component will look like this: image::images/devon4ng/3.BuildYourOwn/root_router.jpg[Root Router, 250] As you can see, now the body content is the HTML of `FormLoginComponent`. This is because we told the Router to redirect to formlogin when the path is `/FormLogin`, but also, redirect to it by default if any of the other routes match the given path. For now we are going to leave the header like this. In the future we will separate it into another component inside a layout folder. === LoginForm Component As we have already created this component from the section before, let's move on to building the template of the login view. First, we need to add the Covalent Layout and the card to the file `form-login.component.html`: [source, html] ----

---- This will add a grey background to the view and a card on top of it with the title ""Login"" now that we have the basic structure of the view. Now we are going to add this image: image::images/devon4ng/3.BuildYourOwn/jumptheq.png[JumpTheQueue Logo Image, 250] In order to have it available, save it in the following path of the project: `angular/src/assets/images/` and name it `jumptheq.png`. The final code with the form added will look like this: [source, html] ----

---- This code will give us as a result similar to this: image::images/devon4ng/3.BuildYourOwn/formlogin.png[Form Login, 250] This is going to be the container for the login. + Now we will continue with the second component: Login. === Login Component Our first step will be to create the component in the exact same way we created the `FormLogin` component but this time we are going to generate it in a new folder called components inside formlogin. Putting every child component inside that folder will allow us to keep a good and clear structure. In order to do this, we use the command: ---- ng generate component form-login/components/login ---- After _Angular/CLI_ has finished generating the component, we have to create two modules, one for the form-login and one for the login: 1.- We create a new file called `login-module.ts` in the login root: [source, typescript] ---- import { NgModule, CUSTOM_ELEMENTS_SCHEMA } from '@angular/core'; import { CommonModule } from '@angular/common'; import { CoreModule } from 'src/app/shared/core.module'; import { LoginComponent } from './login.component'; @NgModule({ imports: [CommonModule, CoreModule], providers: [], declarations: [LoginComponent], exports: [LoginComponent], schemas: [ CUSTOM_ELEMENTS_SCHEMA ] }) export class LoginModule {} ---- 2.- We create a new file called `form-login-module.ts` in the form-login root: [source, typescript] ---- import { NgModule, CUSTOM_ELEMENTS_SCHEMA } from '@angular/core'; import { CommonModule } from '@angular/common'; import { FormLoginComponent } from './form-login.component'; import { CoreModule } from '../shared/core.module'; import { LoginModule } from './components/login/login-module'; @NgModule({ imports: [CommonModule, CoreModule, LoginModule], providers: [], declarations: [FormLoginComponent], exports: [FormLoginComponent], schemas: [ CUSTOM_ELEMENTS_SCHEMA ] }) export class FormLoginModule {} ---- As you can see, the `LoginModule` is already added to the `FormLoginModule`. Once this is done, we need to remove the `FormLoginComponent` and the `LoginComponent` from the `declarations` since they are already declared in their own modules. Then add the `FormLoginModule`. This will be done inside `AppModule`: [source, typescript] ---- ... import { FormLoginModule } from './form-login/form-login-module'; ... declarations: [ AppComponent, ] imports: [ BrowserModule, FormLoginModule, CoreModule, AppRoutingModule ] ... ---- [NOTE] ==== This is done so the `form-login` (container/wrapper) and the `login` stay separated allowing us to reuse the login without having the card around in other views. ==== After this, we modify the `login.component.html` and add the form: [source, typescript] ---- ---- [NOTE] ==== You have already learned about Forms in devon4ng https://github.com/devonfw/jump-the-queue/wiki/devon4ng-components#forms[here]. + You can go back and read that section again to refresh your memory. ==== This form contains two input containers from Material. The containers enclose the input with the properties listed above. We also need to add a button to send the information and redirect to the `QueueViewer` or show an error if something went wrong in the process. But for the moment, as we neither have another component nor the auth service yet, we will implement the button visually, as well as the validator to disable it if the form is not correct. We will tackle the on-click-event later. As a last step we will add this component to the `form-login-component.html`: [source, html] ----

---- Now you should see something like this: image::images/devon4ng/3.BuildYourOwn/login.png[JumpTheQueue Login Screen, 250] With two components already created, we need to use the router to navigate between them. Following the application flow of events, we are going to add a _navigate_ function to the register button. When we press it, we will be redirected to our future register component. === Register Component First, we are going to generate the register component via: ---- ng generate component register` ---- This will create our component so we can start working on it. Turning back to `login.component.html` we have to modify these lines of code: [source, html] ----

... ... ---- Two events were added. First, when we submit the form, the method `submitLogin()` is going to be called. Second, when the user clicks the button `(click)` will send an event to the function `onRegisterClick()`. This function should be inside `login.component.ts` which is going to be created now: [source, typescript] ---- ... import { Router } from '@angular/router'; ... constructor(private router: Router) { } ... onRegisterClick(): void { this.router.navigate(['Register']); } submitLogin(): void { } ---- We need to inject an instance of the Router object and declare it with the name _router_ in order to use it in the code, as we did with `onRegisterClick()`. Doing this will use the navigate function and redirect to the next view. In our case, it will redirect using the route we are going to define in `app.routing.module.ts`: [source, typescript] ---- ... import { RegisterComponent } from './register/register.component'; ... const appRoutes: Routes = [ { path: 'FormLogin', component: FormLoginComponent}, // Redirect if url path is /FormLogin. { path: 'Register', component: RegisterComponent}, // Redirect if url path is /Register. { path: '**', redirectTo: '/FormLogin', pathMatch: 'full' } // Redirect if url path do not match any other route. ]; ... ---- [NOTE] ==== You have already learned about Dependency Injection in devon4ng https://github.com/devonfw/jump-the-queue/wiki/devon4ng-services#dependency-injection[here]. + You can go back and read that section again to refresh your memory. ==== Now we are going to imitate the `login` to shape our `register.component.html`: [source, html] ----

Accept Terms And conditions

I want to receive notifications

---- Now that we have a minimum of navigation flow inside our application, we are going to generate our first service using the command: ---- ng generate service register/services/register ---- This will create a folder ""services"" inside ""register"" and create the service itself. Services are where we keep the logic that connects to our database and fetches data which is going to be used by our `component.ts`. In order to use the service, we are going to create some interface models. Let's create a folder called `backendModels` inside ""shared"" and inside this folder a file called `interfaces.ts` in which we are going to add the model interfaces that will match our backend: [source, typescript] ---- export class Visitor { id?: number; username: string; name: string; password: string; phoneNumber: string; acceptedCommercial: boolean; acceptedTerms: boolean; userType: boolean; } export class VisitorArray { content: Visitor[]; } ---- [NOTE] ==== You have already learned about creating new services in devon4ng https://github.com/devonfw/jump-the-queue/wiki/devon4ng-services#create-a-new-service[here]. + You can go back and read that section again to refresh your memory. ==== If we take a closer look, we can see that id has a `?` behind it. This indicates that the id is optional. [NOTE] ==== At this point we are going to assume that you have finished the https://github.com/devonfw/jump-the-queue/wiki/build-devon4j-application[devon4j] part of this tutorial, or have at least downloaded the project and have the back end running locally on http://localhost:8081. ==== After doing this, we are going to add an environment variable with our base-URL for the REST services. This way we won't have to change every URL when we switch to production. Inside `environments/environment.ts` we add: [source, typescript] ---- export const environment: {production: boolean, baseUrlRestServices: string} = { production: false, baseUrlRestServices: 'http://localhost:8081/jumpthequeue/services/rest' }; ---- Now in the service, we are going to add a `registerVisitor` method. To call the server in this method we are going to inject the Angular `HttpClient` class from `@angular/common/http`. This class is the standard used by Angular to perform HTTP calls. The register call demands a `Visitor` model which we created in the `interfaces` file. We are going to build a POST call and send the information to the proper URL of the server service. The call will return an observable: [source, typescript] ---- import { Injectable } from '@angular/core'; import { HttpClient } from '@angular/common/http'; import { Visitor} from 'src/app/shared/backendModels/interfaces'; import { Observable } from 'rxjs'; import { environment } from 'src/environments/environment'; @Injectable({ providedIn: 'root' }) export class RegisterService { private baseUrl = environment.baseUrlRestServices; constructor(private http: HttpClient) { } registerVisitor(visitor: Visitor): Observable { return this.http.post(`${this.baseUrl}` + '/visitormanagement/v1/visitor', visitor); } } ---- This method will send our model to the backend and return an Observable that we will use on the `component.ts`. [NOTE] ==== You have already learned about Observables and RxJs in devon4ng https://github.com/devonfw/jump-the-queue/wiki/devon4ng-services#server-communication[here]. + You can go back and read that section again to refresh your memory. ==== Now we are going to modify `register.component.ts` to call this service: [source, typescript] ---- import { Component, OnInit } from '@angular/core'; import { RegisterService } from './services/register.service'; import { Visitor } from '../shared/backendModels/interfaces'; import { Router } from '@angular/router'; import { MatSnackBar } from '@angular/material/snack-bar'; @Component({ selector: 'app-register', templateUrl: './register.component.html', styleUrls: ['./register.component.scss'] }) export class RegisterComponent implements OnInit { constructor(private registerService: RegisterService, private router: Router, public snackBar: MatSnackBar) { } submitRegister(formValue): void { const visitor: Visitor = new Visitor(); visitor.username = formValue.username; visitor.name = formValue.name; visitor.phoneNumber = formValue.phoneNumber; visitor.password = formValue.password; visitor.acceptedCommercial = formValue.acceptedCommercial; visitor.acceptedTerms = formValue.acceptedTerms; visitor.userType = false; this.registerService.registerVisitor(visitor).subscribe( (visitorResult: Visitor) => console.log(JSON.stringify(visitorResult)), // When call is received (err) => this.snackBar.open(err.error.message, 'OK', { duration: 5000, }), // When theres an error ); } ngOnInit() { } } ---- In this file we injected `RegisterService` and `Router` to use them. Then, inside the method `submitRegister`, we created a visitor that we are going to pass to the service. We called the service method `registerVisitor`, we passed the visitor and we subscribed to the `Observable`, which we returned from the service. This subscription allows us to control three things: . What to do when the data is received. . What to do when there's an error. . What to do when the call is complete. Finally, we modify the `register.component.html` to send the form values to the method: [source, html] ---- ...

... ---- image::images/devon4ng/3.BuildYourOwn/register.png[Register Page, 250] Using the method and taking a look at the browser console, we should see the visitor model being returned. == Creating Services Now that we registered a `Visitor`, it's time to create 3 important services: - AuthService - AuthGuardService - LoginService The `AuthService` will be the one that contains the login info, the `AuthGuardService` will check if a user is authorized to use a component (via the `canActivate` method), and the `LoginService` will be used to fill the `AuthService`. [NOTE] ==== To keep this tutorial simple, we are going to perform the password check client side. *THIS IS NOT CORRECT!* Usually, you would send the username and password to the backend, check that the values are correct, and create a corresponding token which you would pass in the header and use it inside the `AuthService` -- checking with some interceptors that the token is both in the `AuthService` and in the request. ==== === Login, Auth and AuthGuard Services We are going to create the 3 services via `ng generate service `: . `LoginService` via: + `ng generate service form-login/components/login/services/login` . `Auth` service via: + `ng generate service core/authentication/auth` . `AuthGuard` service via: + `ng generate service core/authentication/auth-guard` After generating the services, we are going to start modifying the interfaces. Inside `angular/src/app/shared/backendModels/interfaces` we are going to add `Role`, `FilterVisitor`, `Pageable` and a `Sort` interface: [source, typescript] ---- ... export class FilterVisitor { pageable: Pageable; username?: string; password?: string; } export class Pageable { pageSize: number; pageNumber: number; sort: Sort[]; } export class Sort { property: string; direction: string; } export class Role { name: string; permission: number; } ---- [NOTE] ==== As you can see, we added a `Pageable`, since a lot of the search methods in the backend are using `SearchCriterias`. These need pageables which specify a `paseSize` and `pageNumber`. Also, we can see that in this case `FilterVisitor` uses a pageable and adds parameters as a filter (`username` and `password`), which are optional. ==== Then we are going to create a `config.ts` file inside the root (`angular/app`). We are going to use that file to set up default config variables, for example: role names with their permission number, default pagination settings etc. For now we are just adding the roles: [source, typescript] ---- export const config: any = { roles: [ { name: 'VISITOR', permission: 0 }, { name: 'BOSS', permission: 1 }, ], }; ---- After that, we are going to modify the `auth.service.ts`: [source, typescript] ---- import { Injectable } from '@angular/core'; import { find } from 'lodash'; import { Role } from 'src/app/shared/backendModels/interfaces'; import { config } from 'src/app/config'; @Injectable({ providedIn: 'root' }) export class AuthService { private logged = false; private user = ''; private userId = 0; private currentRole = 'NONE'; private token: string; public isLogged(): boolean { return this.logged; } public setLogged(login: boolean): void { this.logged = login; } public getUser(): string { return this.user; } public setUser(username: string): void { this.user = username; } public getUserId(): number { return this.userId; } public setUserId(userId: number): void { this.userId = userId; } public getToken(): string { return this.token; } public setToken(token: string): void { this.token = token; } public setRole(role: string): void { this.currentRole = role; } public getPermission(roleName: string): number { const role: Role = find(config.roles, { name: roleName }); return role.permission; } public isPermited(userRole: string): boolean { return ( this.getPermission(this.currentRole) === this.getPermission(userRole) ); } } ---- We will use this service to fill it with information from the logged-in user once the user logs in. This will allow us to check the information of the logged-in user in any way necessary. [NOTE] ==== You have already learned about Authentication in devon4ng https://github.com/devonfw/jump-the-queue/wiki/devon4ng-services#authentication[here]. + You can go back and read that section again to refresh your memory. ==== Now we are going to use this class to fill the `auth-guard.service.ts`: [source, typescript] ---- import { Injectable } from '@angular/core'; import { CanActivate, Router, ActivatedRouteSnapshot, RouterStateSnapshot, } from '@angular/router'; import { AuthService } from './auth.service'; @Injectable({ providedIn: 'root' }) export class AuthGuardService implements CanActivate { constructor( private authService: AuthService, private router: Router, ) {} canActivate( route: ActivatedRouteSnapshot, state: RouterStateSnapshot, ): boolean { if (this.authService.isLogged() && this.authService.isPermited('VISITOR')) { // If its logged in and its role is visitor return true; } if (!this.authService.isLogged()) { // if its not logged in console.log('Error login'); } if (this.router.url === '/') { // if the router is the app route this.router.navigate(['/login']); } return false; } } ---- This service will be slightly different because we have to implement an interface called `CanActivate`. It has a method called `canActivate()` returning a boolean. This method will be called when navigating to a specified route, and -- depending on the return value of this implemented method -- the navigation will proceed or be rejected. [NOTE] ==== You have already learned about Guards in devon4ng https://github.com/devonfw/jump-the-queue/wiki/devon4ng-services#guards[here]. + You can go back and read that section again to refresh your memory. ==== Once this is done, the last step is to fill the `login.service.ts`. In this case, there's going to be three methods: . `getVisitorByUsername(username: string)`: + A method that recovers a single user corresponding to the email. . `login(username: string, password: string)`: + A method, which is going to use the previous method, to check that the username and password match the form input and then fill the `AuthService`. . `logout()`: + This is going to be used to reset the `AuthService` and log out the user. Also, we see the first use of `pipe` and `map`: + `pipe` allows us to execute a chain of functions, then `map` allows us to return the single visitor instead of all the parameters that the server will send us. [source, typescript] ---- import { map, tap } from 'rxjs/operators'; import { Injectable } from '@angular/core'; import { Observable } from 'rxjs'; import { Visitor, FilterVisitor, Pageable } from 'src/app/shared/backendModels/interfaces'; import { HttpClient } from '@angular/common/http'; import { environment } from 'src/environments/environment'; import { AuthService } from 'src/app/core/authentication/auth.service'; import { Router } from '@angular/router'; import { MatSnackBar } from '@angular/material/snack-bar'; @Injectable({ providedIn: 'root' }) export class LoginService { private baseUrl = environment.baseUrlRestServices; constructor(private router: Router, private http: HttpClient, private authService: AuthService, public snackBar: MatSnackBar) { } getVisitorByUsername(username: string): Observable { const filters: FilterVisitor = new FilterVisitor(); const pageable: Pageable = new Pageable(); pageable.pageNumber = 0; pageable.pageSize = 1; pageable.sort= []; filters.username = username; filters.pageable = pageable; return this.http.post(`${this.baseUrl}` + '/visitormanagement/v1/visitor/search', filters) .pipe( map(visitors => visitors.content[0]), ); } login(username: string, password: string): void { // Checks if given username and password are the ones aved in the database this.getVisitorByUsername(username).subscribe( (visitorFound) => { if (visitorFound.username === username && visitorFound.password === password) { this.authService.setUserId(visitorFound.id); this.authService.setLogged(true); this.authService.setUser(visitorFound.username); if (visitorFound.userType === false) { this.authService.setRole('VISITOR'); this.router.navigate(['ViewQueue']); } else { this.authService.setLogged(false); this.snackBar.open('access error', 'OK', { duration: 2000, }); } } else { this.snackBar.open('access error', 'OK', { duration: 2000, }); } }, (err: any) => { this.snackBar.open('access error', 'OK', { duration: 2000, }); }, ); } logout(): void { this.authService.setLogged(false); this.authService.setUser(''); this.authService.setUserId(0); this.router.navigate(['FormLogin']); } } ---- If you remember the devon4j tutorial, we used `Criteria` in order to filter and to search the DB. The `Criteria` require a pageable and you can add extra parameters to get specific results. In `getVisitorByUsername()` you can see the creation of a `FilterVisitor` corresponding to the `Criteria` in the backend. This `FilterVisitor` gets a `Pageable` and a `username` and will return a single result as soon as the POST call is performed. That's why we return the first page and only a single result. [NOTE] ==== For the tutorial we are only considering the visitor side of the application. That's why we `setLogged(false)` if it's `userType === true` (BOSS side). ==== Then we add to the `login-module.ts` and `LoginService`: [source, typescript] ---- ... import { LoginService } from './services/login.service'; @NgModule({ ... providers: [LoginService], ... }) ... ---- After that, we are going to add the `AuthGuard` and the `Auth` into the `shared/core-module.ts`. This will allow us to employ these two services when importing the core module avoiding having to provide these services in every component: [source, typescript] ---- ... providers: [ HttpClientModule, AuthService, AuthGuardService, ], ... ---- You need to import these modules as well, as shown earlier. Finally, we modify the `login.component.html` to send the form values to the `login.component.ts` like we did with the register form. Afterwards, we are going to modify the `register.components.ts`: When the visitor registers, we can log him in automatically to avoid any nuisances. Let's start with the `login.component.html`: [source, html] ---- ... ... ---- As you can see, in the form we just added, the values to the `ngSubmit` allow us to call the method `submitLogin()` within the logic, sending the `loginForm.form.values` which are the form's input values. In the next step we are going to modify the `login.components.ts`, adding the `submitLogin()` method. This method calls the `LoginService`, providing the service with the necessary values received from the form (i.e. the `loginFormValues`). [source, typescript] ---- ... import { LoginService } from './services/login.service'; ... export class LoginComponent implements OnInit { ... constructor(private router: Router, private loginService: LoginService) { } ... submitLogin(loginFormValues): void { this.loginService.login(loginFormValues.username, loginFormValues.password); } } ---- Finally, in the `register.components.ts` we are going to inject the `LoginService` and use it to login the visitor after registering him. This will also send the user to the `ViewQueue`, which we will create and secure later in the tutorial. [source, typescript] ---- import { LoginService } from '../form-login/components/login/services/login.service'; ... constructor(private registerService: RegisterService, private router: Router, public snackBar: MatSnackBar, private loginService: LoginService) { } ... submitRegister(formValue): void { ... this.registerService.registerVisitor(visitor).subscribe( (visitorResult: Visitor) => { this.loginService.login(visitorResult.username, visitorResult.password); }, ... ); } ... ---- == Finishing Touches Now we only need to generate two more components (`header` and `view-queue`) and services (`AccessCodeService` and `QueueService`) in order to finish the implementation of our _JumpTheQueue_ app. === Separating Header from Layout By separating the header on top of the page from the layout, we enable the reuse of this component and reach a better separation of concerns across our application. To do this, we are going to generate a new component inside `angular/src/app/layout/header` via: ---- ng generate component layout/header ---- Now we are going to add it to the main view `app.component.html`: [source, html] ---- ...

... ---- After adding the component to the header view (`app-header`), we are going to modify the HTML of the component (`header.component.html`) and the logic of the component (`header.component.ts`). As a first step, we are going to modify the HTML, adding an icon as a button, which checks whether or not the user is logged in via `*ngIf` by calling the auth service's `isLogged()` method. This will make the icon appear only if the user is logged in: [source, html] ---- Jump The Queue ---- In the header logic (`header.component.ts`) we are simply going to inject the `AuthService` and `LoginService`, then we are going call `logout()` from `LoginService` in the `OnClickLogout()`. Finally, the `AuthService` is needed because it's being used by the HTML template to control if the user is logged in with `isLogged()`: [source, typescript] ---- ... constructor(private authService: AuthService, private loginService: LoginService) { } ... onClickLogout(): void { this.loginService.logout(); } ... ---- Separating components will allow us to keep the code clean and easy to work with. === ViewQueue Component For the last view, we are going to learn how to use our Observables on the HTML template directly without having to `subscribe()` to them. First, we are going to generate the component via: ---- ng generate component view-queue ---- After that, we are going to include the component in the `app-routing.module.ts`, also adding the guard, to only allow users that are `VISITOR` to see the component. It is important to insert the following code before `{ path: '**', redirectTo: '/FormLogin', pathMatch: 'full' }`: [source, typescript] ---- ... const appRoutes: Routes = [ ... { path: 'ViewQueue', component: ViewQueueComponent, canActivate: [AuthGuardService]}, // Redirect if url path is /ViewQueue, check if canActivate() with the AuthGuardService. ... ]; ... ---- Now in order to make this view work, we are going to do these things: . Add the `Queue` and `AccessCode` interface in our `angular/src/app/shared/backendModels/interfaces` and their corresponding filters. . Generate the `QueueService` and `AccessCodeService` and add the necessary methods. . Modify the `view-queue.component.html`. . Modify the logic of the component `view-queue.component.ts`. First, we are going to add the necessary interfaces. We modify `angular/src/app/shared/backendModels/interfaces.ts` and add the `FilterQueue`, `Queue`, `FilterAccessCode`, `AccessCode`, `QueueArray` and `AccessCodeArray`. These are going to be necessary in order to communicate with the backend. [source, typescript] ---- ... export class FilterAccessCode { pageable: Pageable; visitorId?: Number; endTime?: string; } export class FilterQueue { pageable: Pageable; active: boolean; } export class AccessCode { id?: number; ticketNumber: string; creationTime: string; startTime?: string; endTime?: string; visitorId: number; queueId: number; content: any; } export class Queue { id?: number; name: string; logo: string; currentNumber: string; attentionTime: string; minAttentionTime: string; active: boolean; customers: number; content: any; } export class QueueArray { content: Queue[]; } export class AccessCodeArray { content: [{ accessCode: AccessCode }]; } ... ---- === AccessCode and Queue Services After this is done, we are going to generate the `AccessCodeService` and the `QueueService`: ---- ng generate service view-queue/services/Queue ng generate service view-queue/services/AccessCode ---- Once this is done, we are going to modify them and add the necessary methods: - For the `AccessCodeService` we are going to need a full CRUD: [source, typescript] ---- import { Injectable } from '@angular/core'; import { AuthService } from 'src/app/core/authentication/auth.service'; import { Router } from '@angular/router'; import { HttpClient } from '@angular/common/http'; import { AccessCode, Pageable, FilterAccessCode } from 'src/app/shared/backendModels/interfaces'; import { Observable } from 'rxjs'; import { environment } from 'src/environments/environment'; import { map } from 'rxjs/operators'; @Injectable({ providedIn: 'root' }) export class AccessCodeService { private baseUrl = environment.baseUrlRestServices; constructor(private router: Router, private http: HttpClient, private authService: AuthService) { } getCurrentlyAttendedAccessCode(): Observable { const filters: FilterAccessCode = new FilterAccessCode(); const pageable: Pageable = new Pageable(); filters.endTime = null; pageable.pageNumber = 0; pageable.pageSize = 1; filters.pageable = pageable; return this.http.post(`${this.baseUrl}` + '/accesscodemanagement/v1/accesscode/cto/search', filters) .pipe( map(accesscodes => { if (!accesscodes.content[0]) { // if theres no response it means theres noone in the queue return null; } else { if (accesscodes.content[0].accessCode.startTime != null) { // if start time is not null it means that hes being attended return accesscodes.content[0].accessCode; } else { // noone being attended return null; } } }), ); } getVisitorAccessCode(visitorId: number): Observable { const filters: FilterAccessCode = new FilterAccessCode(); const pageable: Pageable = new Pageable(); pageable.pageNumber = 0; pageable.pageSize = 1; filters.visitorId = visitorId; filters.pageable = pageable; return this.http.post(`${this.baseUrl}` + '/accesscodemanagement/v1/accesscode/cto/search', filters) .pipe( map(accesscodes => { if (accesscodes.content[0]) { return accesscodes.content[0].accessCode; } else { return null; } }), ); } deleteAccessCode(codeAccessId: number) { this.http.delete(`${this.baseUrl}` + '/accesscodemanagement/v1/accesscode/' + codeAccessId + '/').subscribe(); } saveAccessCode(visitorId: number, queueId: number) { const accessCode: AccessCode = new AccessCode(); accessCode.visitorId = visitorId; accessCode.queueId = queueId; return this.http.post(`${this.baseUrl}` + '/accesscodemanagement/v1/accesscode/', accessCode); } } ---- In the methods `getCurrentlyAttendedAccessCode` and `getVisitorAccessCode` we can see the use of `Pageable` and `FilterAccessCode` to match the `Criteria` in the backend like we explained in previous steps. In this case, the `getVisitorAccessCode` method will be used to see if the visitor has an `AccessCode` and the `getCurrentlyAttendedAccessCode` is going to recover the first `AccessCode` of the queue. - For the `QueueService` we are only going to need to find the active queue: [source, typescript] ---- import { Injectable } from '@angular/core'; import { HttpClient } from '@angular/common/http'; import { Router } from '@angular/router'; import { Observable } from 'rxjs'; import { Queue, FilterQueue, Pageable } from 'src/app/shared/backendModels/interfaces'; import { environment } from 'src/environments/environment'; import { map } from 'rxjs/operators'; @Injectable({ providedIn: 'root' }) export class QueueService { private baseUrl = environment.baseUrlRestServices; constructor(private router: Router, private http: HttpClient) { } getActiveQueue(): Observable { const filters: FilterQueue = new FilterQueue(); filters.active = true; const pageable: Pageable = new Pageable(); pageable.pageNumber = 0; pageable.pageSize = 1; pageable.sort = []; filters.pageable = pageable; return this.http.post(`${this.baseUrl}` + '/queuemanagement/v1/queue/search', filters) .pipe( map(queues => queues.content[0]), ); } } ---- Now we are going to create the template `view-queue.component.html` (which will use this data) and we will also introduce a new concept: ""_async pipes in templates_"". [source, html] ----

Your Number:

Currently estimate time: 10:00:00

Currently Being Attended:

The queue is not active try again later

---- If you watch closely, the starting `td-layout` has an `*ngIf` inside it. This `*ngIf` allows us to asynchronously pipe the observables that we will asign in the next steps. This solution avoids having to use `subscribe()` (as it subscribes automatically) and -- as a result -- we dont have to worry about where to `unsubscribe()` from the observables. In this HTML, we give `*ngif` another use: We use it to hide certain panels. Using `accessCodeVisitor`, we hide the ticket number panel and the ""leave the queue""-button and show the button to join the queue. On the contrary we can hide the ticket number and the ""leave the queue""-button and only show the ""join the queue""-button. [NOTE] ==== In this case, since we are using HTTP and the calls are finite, there wouldn't be any problems if you dont `unsubscribe()` from their corresponding observables. However, if -- for example -- we use an observable to keep track of an input and `subscribe()` to it but not controlling the `unsubscribe()` method, the app could end up containing a memory leak. This is because -- everytime we visit the component with the input -- it is going to create another subscription without unsubscribing from the last one. ==== Finally, to adapt the async pipe, the `ngOnInit()` method inside `view-queue.component.ts` now does not subscribe to the observable. In its place, we equal the queuers variable directly to the observable, so we can load it using `*ngIf`. [source, typescript] ---- import { Component, OnInit } from '@angular/core'; import { AccessCode, Queue } from '../shared/backendModels/interfaces'; import { Observable, timer } from 'rxjs'; import { AccessCodeService } from './services/access-code.service'; import { switchMap } from 'rxjs/operators'; import { AuthService } from '../core/authentication/auth.service'; import { QueueService } from './services/queue.service'; @Component({ selector: 'app-view-queue', templateUrl: './view-queue.component.html', styleUrls: ['./view-queue.component.scss'] }) export class ViewQueueComponent implements OnInit { accessCodeAttended$: Observable; accessCodeVisitor$: Observable; queue$: Observable; constructor(private accessCodeService: AccessCodeService, private queueService: QueueService, private authService: AuthService) { } ngOnInit() { // Every minute we are going to update accessCodeAttended$ starting instantly this.accessCodeAttended$ = timer(0, 60000).pipe( // we switchMap and give it the value necesary from the accessCodeService switchMap(() => { return this.accessCodeService.getCurrentlyAttendedAccessCode(); }) ); this.accessCodeVisitor$ = this.accessCodeService.getVisitorAccessCode(this.authService.getUserId()); this.queue$ = this.queueService.getActiveQueue(); } onJoinQueue(queueId: number): void { this.accessCodeVisitor$ = this.accessCodeService.saveAccessCode(this.authService.getUserId(), queueId); } onLeaveQueue(accessCodeId: number): void { this.accessCodeService.deleteAccessCode(accessCodeId); this.accessCodeVisitor$ = null; } } ---- In this last component we assign the `Observables` when the component is initiated. After that, when clicking the ""join the queue""-button, we assign a new `Observable` called `AccessCode` to the `accessCodeVisitor$`. Finally, when we leave the queue, we delete the `AccessCode` and set the `accessCodeVisitor` to null. Since we are using an async pipe, everytime we modify the status of the `Observables`, they are going to update the template. image::images/devon4ng/3.BuildYourOwn/withCodeAccess.png[Queue Page with Access Code, 250] image::images/devon4ng/3.BuildYourOwn/withoutCodeAccess.png[Queue Page without Access Code, 250] This is all on how to build your own devon4ng application. Now it's up to you to add features, change styles and do everything you can imagine doing with this app. As a final step to complete the tutorial, however, we are going to run the app outside of our local machine by deploying it. ''' *Next Chapter*: link:devon4ng-deployment.asciidoc[Deploy your devon4ng App] ",12303,False,2101.9947550440793,median "// Copyright 2017 The Chromium Authors. All rights reserved. // Use of this source code is governed by a BSD-style license that can be // found in the LICENSE file. #include ""ash/login/ui/login_auth_user_view.h"" #include #include #include #include ""ash/login/login_screen_controller.h"" #include ""ash/login/resources/grit/login_resources.h"" #include ""ash/login/ui/arrow_button_view.h"" #include ""ash/login/ui/horizontal_image_sequence_animation_decoder.h"" #include ""ash/login/ui/lock_screen.h"" #include ""ash/login/ui/login_display_style.h"" #include ""ash/login/ui/login_password_view.h"" #include ""ash/login/ui/login_pin_input_view.h"" #include ""ash/login/ui/login_pin_view.h"" #include ""ash/login/ui/login_user_view.h"" #include ""ash/login/ui/non_accessible_view.h"" #include ""ash/login/ui/pin_keyboard_animation.h"" #include ""ash/login/ui/pin_request_view.h"" #include ""ash/login/ui/system_label_button.h"" #include ""ash/login/ui/views_utils.h"" #include ""ash/public/cpp/login_constants.h"" #include ""ash/resources/vector_icons/vector_icons.h"" #include ""ash/session/session_controller_impl.h"" #include ""ash/shell.h"" #include ""ash/strings/grit/ash_strings.h"" #include ""ash/style/ash_color_provider.h"" #include ""ash/system/model/clock_model.h"" #include ""ash/system/model/system_tray_model.h"" #include ""ash/system/night_light/time_of_day.h"" #include ""ash/wallpaper/wallpaper_controller_impl.h"" #include ""base/bind.h"" #include ""base/i18n/time_formatting.h"" #include ""base/memory/ptr_util.h"" #include ""base/strings/utf_string_conversions.h"" #include ""base/time/time.h"" #include ""base/timer/timer.h"" #include ""components/user_manager/user.h"" #include ""ui/accessibility/ax_enums.mojom.h"" #include ""ui/accessibility/ax_node_data.h"" #include ""ui/base/l10n/l10n_util.h"" #include ""ui/base/resource/resource_bundle.h"" #include ""ui/compositor/callback_layer_animation_observer.h"" #include ""ui/compositor/layer_animation_sequence.h"" #include ""ui/compositor/layer_animator.h"" #include ""ui/compositor/scoped_layer_animation_settings.h"" #include ""ui/gfx/color_analysis.h"" #include ""ui/gfx/geometry/size.h"" #include ""ui/gfx/interpolated_transform.h"" #include ""ui/gfx/paint_vector_icon.h"" #include ""ui/gfx/vector_icon_types.h"" #include ""ui/views/background.h"" #include ""ui/views/border.h"" #include ""ui/views/controls/button/md_text_button.h"" #include ""ui/views/controls/highlight_path_generator.h"" #include ""ui/views/controls/label.h"" #include ""ui/views/layout/box_layout.h"" #include ""ui/views/layout/fill_layout.h"" #include ""ui/views/layout/flex_layout.h"" #include ""ui/views/layout/grid_layout.h"" #include ""ui/views/style/typography.h"" #include ""ui/views/view.h"" namespace ash { namespace { constexpr const char kLoginAuthUserViewClassName[] = ""LoginAuthUserView""; // Distance between the user view (ie, the icon and name) and other elements const int kDistanceBetweenUserViewAndPasswordDp = 24; const int kDistanceBetweenUserViewAndPinInputDp = 32; const int kDistanceBetweenUserViewAndOnlineSigninDp = 24; const int kDistanceBetweenUserViewAndChallengeResponseDp = 32; // Distance between the password textfield and the the pin keyboard. const int kDistanceBetweenPasswordFieldAndPinKeyboardDp = 16; // Height of button used for switching between pin and password authentication. const int kPinPasswordToggleButtonHeight = 32; const int kPinPasswordToggleButtonPaddingTop = 24; // Distance from the end of pin keyboard to the bottom of the big user view. const int kDistanceFromPinKeyboardToBigUserViewBottomDp = 50; // Distance from the top of the user view to the user icon. constexpr int kDistanceFromTopOfBigUserViewToUserIconDp = 24; // Date time format containing only the day of the week, for example: ""Tuesday"". constexpr char kDayOfWeekOnlyTimeFormat[] = ""EEEE""; constexpr int kFingerprintIconSizeDp = 28; constexpr int kResetToDefaultIconDelayMs = 1300; constexpr base::TimeDelta kResetToDefaultMessageDelayMs = base::TimeDelta::FromMilliseconds(3000); constexpr int kFingerprintIconTopSpacingDp = 20; constexpr int kSpacingBetweenFingerprintIconAndLabelDp = 15; constexpr int kFingerprintViewWidthDp = 204; constexpr int kDistanceBetweenPasswordFieldAndFingerprintViewDp = 90; constexpr int kFingerprintFailedAnimationDurationMs = 700; constexpr int kFingerprintFailedAnimationNumFrames = 45; constexpr base::TimeDelta kChallengeResponseResetAfterFailureDelay = base::TimeDelta::FromSeconds(5); constexpr int kChallengeResponseArrowSizeDp = 48; constexpr int kSpacingBetweenChallengeResponseArrowAndIconDp = 100; constexpr int kSpacingBetweenChallengeResponseIconAndLabelDp = 15; constexpr int kChallengeResponseIconSizeDp = 28; constexpr int kDistanceBetweenPwdFieldAndChallengeResponseViewDp = 0; constexpr int kDisabledAuthMessageVerticalBorderDp = 16; constexpr int kDisabledAuthMessageHorizontalBorderDp = 16; constexpr int kDisabledAuthMessageChildrenSpacingDp = 4; constexpr int kDisabledAuthMessageTimeWidthDp = 204; constexpr int kDisabledAuthMessageMultiprofileWidthDp = 304; constexpr int kDisabledAuthMessageHeightDp = 98; constexpr int kDisabledAuthMessageIconSizeDp = 24; constexpr int kDisabledAuthMessageTitleFontSizeDeltaDp = 3; constexpr int kDisabledAuthMessageContentsFontSizeDeltaDp = -1; constexpr int kDisabledAuthMessageRoundedCornerRadiusDp = 8; constexpr int kLockedTpmMessageVerticalBorderDp = 16; constexpr int kLockedTpmMessageHorizontalBorderDp = 16; constexpr int kLockedTpmMessageChildrenSpacingDp = 4; constexpr int kLockedTpmMessageWidthDp = 360; constexpr int kLockedTpmMessageHeightDp = 108; constexpr int kLockedTpmMessageIconSizeDp = 24; constexpr int kLockedTpmMessageDeltaDp = 0; constexpr int kLockedTpmMessageRoundedCornerRadiusDp = 8; constexpr int kNonEmptyWidthDp = 1; gfx::Size SizeFromHeight(int height) { return gfx::Size(kNonEmptyWidthDp, height); } // Returns an observer that will hide |view| when it fires. The observer will // delete itself after firing (by returning true). Make sure to call // |observer->SetActive()| after attaching it. ui::CallbackLayerAnimationObserver* BuildObserverToHideView(views::View* view) { return new ui::CallbackLayerAnimationObserver(base::BindRepeating( [](views::View* view, const ui::CallbackLayerAnimationObserver& observer) { // Don't hide the view if the animation is aborted, as |view| may no // longer be valid. if (observer.aborted_count()) return true; view->SetVisible(false); return true; }, view)); } ui::CallbackLayerAnimationObserver* BuildObserverToNotifyA11yLocationChanged( views::View* view) { return new ui::CallbackLayerAnimationObserver(base::BindRepeating( [](views::View* view, const ui::CallbackLayerAnimationObserver& observer) { // Don't notify a11y event if the animation is aborted, as |view| may no // longer be valid. if (observer.aborted_count()) return true; view->NotifyAccessibilityEvent(ax::mojom::Event::kLocationChanged, false /*send_native_event*/); return true; }, view)); } ui::CallbackLayerAnimationObserver* BuildObserverToNotifyA11yLocationChanged( LoginPinView* view) { return new ui::CallbackLayerAnimationObserver(base::BindRepeating( [](LoginPinView* view, const ui::CallbackLayerAnimationObserver& observer) { // Don't notify a11y event if the animation is aborted, as |view| may no // longer be valid. if (observer.aborted_count()) return true; view->NotifyAccessibilityLocationChanged(); return true; }, view)); } // Clears the password for the given |LoginPasswordView| instance, hides it, and // then deletes itself. class ClearPasswordAndHideAnimationObserver : public ui::ImplicitAnimationObserver { public: explicit ClearPasswordAndHideAnimationObserver(LoginPasswordView* view) : password_view_(view) {} ~ClearPasswordAndHideAnimationObserver() override = default; // ui::ImplicitAnimationObserver: void OnImplicitAnimationsCompleted() override { password_view_->Reset(); password_view_->SetVisible(false); delete this; } private: LoginPasswordView* const password_view_; DISALLOW_COPY_AND_ASSIGN(ClearPasswordAndHideAnimationObserver); }; // The label shown below the fingerprint icon. class FingerprintLabel : public views::Label { public: FingerprintLabel() { SetSubpixelRenderingEnabled(false); SetAutoColorReadabilityEnabled(false); SetEnabledColor(AshColorProvider::Get()->GetContentLayerColor( AshColorProvider::ContentLayerType::kTextColorSecondary)); SetMultiLine(true); SetTextBasedOnState(FingerprintState::AVAILABLE_DEFAULT, false /*can_use_pin*/); } void SetTextBasedOnAuthAttempt(bool success) { SetText(l10n_util::GetStringUTF16( success ? IDS_ASH_LOGIN_FINGERPRINT_UNLOCK_AUTH_SUCCESS : IDS_ASH_LOGIN_FINGERPRINT_UNLOCK_AUTH_FAILED)); SetAccessibleName(l10n_util::GetStringUTF16( success ? IDS_ASH_LOGIN_FINGERPRINT_UNLOCK_ACCESSIBLE_AUTH_SUCCESS : IDS_ASH_LOGIN_FINGERPRINT_UNLOCK_ACCESSIBLE_AUTH_FAILED)); } void SetTextBasedOnState(FingerprintState state, bool can_use_pin) { auto get_displayed_id = [&]() { switch (state) { case FingerprintState::UNAVAILABLE: case FingerprintState::AVAILABLE_DEFAULT: return IDS_ASH_LOGIN_FINGERPRINT_UNLOCK_AVAILABLE; case FingerprintState::AVAILABLE_WITH_TOUCH_SENSOR_WARNING: return IDS_ASH_LOGIN_FINGERPRINT_UNLOCK_TOUCH_SENSOR; case FingerprintState::DISABLED_FROM_ATTEMPTS: return IDS_ASH_LOGIN_FINGERPRINT_UNLOCK_DISABLED_FROM_ATTEMPTS; case FingerprintState::DISABLED_FROM_TIMEOUT: if (can_use_pin) return IDS_ASH_LOGIN_FINGERPRINT_UNLOCK_PIN_OR_PASSWORD_REQUIRED; return IDS_ASH_LOGIN_FINGERPRINT_UNLOCK_PASSWORD_REQUIRED; } NOTREACHED(); }; auto get_accessible_id = [&]() { if (state == FingerprintState::DISABLED_FROM_ATTEMPTS) return IDS_ASH_LOGIN_FINGERPRINT_UNLOCK_ACCESSIBLE_AUTH_DISABLED_FROM_ATTEMPTS; return get_displayed_id(); }; SetText(l10n_util::GetStringUTF16(get_displayed_id())); SetAccessibleName(l10n_util::GetStringUTF16(get_accessible_id())); } // views::View: void GetAccessibleNodeData(ui::AXNodeData* node_data) override { node_data->role = ax::mojom::Role::kStaticText; node_data->SetName(accessible_name_); } private: void SetAccessibleName(const base::string16& name) { accessible_name_ = name; NotifyAccessibilityEvent(ax::mojom::Event::kTextChanged, true /*send_native_event*/); } base::string16 accessible_name_; DISALLOW_COPY_AND_ASSIGN(FingerprintLabel); }; // The content needed to render the disabled auth message view. struct LockScreenMessage { base::string16 title; base::string16 content; const gfx::VectorIcon* icon; }; // Returns the message used when the device was locked due to a time window // limit. LockScreenMessage GetWindowLimitMessage(const base::Time& unlock_time, bool use_24hour_clock) { LockScreenMessage message; message.title = l10n_util::GetStringUTF16(IDS_ASH_LOGIN_TIME_FOR_BED_MESSAGE); base::Time local_midnight = base::Time::Now().LocalMidnight(); base::string16 time_to_display; if (use_24hour_clock) { time_to_display = base::TimeFormatTimeOfDayWithHourClockType( unlock_time, base::k24HourClock, base::kDropAmPm); } else { time_to_display = base::TimeFormatTimeOfDayWithHourClockType( unlock_time, base::k12HourClock, base::kKeepAmPm); } if (unlock_time < local_midnight + base::TimeDelta::FromDays(1)) { // Unlock time is today. message.content = l10n_util::GetStringFUTF16( IDS_ASH_LOGIN_COME_BACK_MESSAGE, time_to_display); } else if (unlock_time < local_midnight + base::TimeDelta::FromDays(2)) { // Unlock time is tomorrow. message.content = l10n_util::GetStringFUTF16( IDS_ASH_LOGIN_COME_BACK_TOMORROW_MESSAGE, time_to_display); } else { message.content = l10n_util::GetStringFUTF16( IDS_ASH_LOGIN_COME_BACK_DAY_OF_WEEK_MESSAGE, base::TimeFormatWithPattern(unlock_time, kDayOfWeekOnlyTimeFormat), time_to_display); } message.icon = &kLockScreenTimeLimitMoonIcon; return message; } // Returns the message used when the device was locked due to a time usage // limit. LockScreenMessage GetUsageLimitMessage(const base::TimeDelta& used_time) { LockScreenMessage message; // 1 minute is used instead of 0, because the device is used for a few // milliseconds before locking. if (used_time < base::TimeDelta::FromMinutes(1)) { // The device was locked all day. message.title = l10n_util::GetStringUTF16(IDS_ASH_LOGIN_TAKE_BREAK_MESSAGE); message.content = l10n_util::GetStringUTF16(IDS_ASH_LOGIN_LOCKED_ALL_DAY_MESSAGE); } else { // The usage limit is over. message.title = l10n_util::GetStringUTF16(IDS_ASH_LOGIN_TIME_IS_UP_MESSAGE); // TODO(933973): Stop displaying the hours part of the string when duration // is less than 1 hour. Example: change ""0 hours, 7 minutes"" to ""7 minutes"". base::string16 used_time_string; if (!base::TimeDurationFormat( used_time, base::DurationFormatWidth::DURATION_WIDTH_WIDE, &used_time_string)) { LOG(ERROR) << ""Failed to generate time duration string.""; return message; } message.content = l10n_util::GetStringFUTF16( IDS_ASH_LOGIN_SCREEN_TIME_USED_MESSAGE, used_time_string); } message.icon = &kLockScreenTimeLimitTimerIcon; return message; } // Returns the message used when the device was locked due to a time limit // override. LockScreenMessage GetOverrideMessage() { LockScreenMessage message; message.title = l10n_util::GetStringUTF16(IDS_ASH_LOGIN_TIME_FOR_A_BREAK_MESSAGE); message.content = l10n_util::GetStringUTF16(IDS_ASH_LOGIN_MANUAL_LOCK_MESSAGE); message.icon = &kLockScreenTimeLimitLockIcon; return message; } LockScreenMessage GetLockScreenMessage(AuthDisabledReason lock_reason, const base::Time& unlock_time, const base::TimeDelta& used_time, bool use_24hour_clock) { switch (lock_reason) { case AuthDisabledReason::kTimeWindowLimit: return GetWindowLimitMessage(unlock_time, use_24hour_clock); case AuthDisabledReason::kTimeUsageLimit: return GetUsageLimitMessage(used_time); case AuthDisabledReason::kTimeLimitOverride: return GetOverrideMessage(); default: NOTREACHED(); } } } // namespace // Consists of fingerprint icon view and a label. class LoginAuthUserView::FingerprintView : public views::View { public: FingerprintView() { SetPaintToLayer(); layer()->SetFillsBoundsOpaquely(false); SetBorder(views::CreateEmptyBorder(kFingerprintIconTopSpacingDp, 0, 0, 0)); auto* layout = SetLayoutManager(std::make_unique( views::BoxLayout::Orientation::kVertical, gfx::Insets(), kSpacingBetweenFingerprintIconAndLabelDp)); layout->set_main_axis_alignment( views::BoxLayout::MainAxisAlignment::kCenter); icon_ = new AnimatedRoundedImageView( gfx::Size(kFingerprintIconSizeDp, kFingerprintIconSizeDp), 0 /*corner_radius*/); icon_->SetImage(gfx::CreateVectorIcon( kLockScreenFingerprintIcon, kFingerprintIconSizeDp, AshColorProvider::Get()->GetContentLayerColor( AshColorProvider::ContentLayerType::kIconColorPrimary))); AddChildView(icon_); label_ = new FingerprintLabel(); AddChildView(label_); DisplayCurrentState(); } ~FingerprintView() override = default; void SetState(FingerprintState state) { if (state_ == state) return; reset_state_.Stop(); state_ = state; DisplayCurrentState(); if (ShouldFireChromeVoxAlert(state)) FireAlert(); } void SetCanUsePin(bool value) { if (can_use_pin_ == value) return; can_use_pin_ = value; label_->SetTextBasedOnState(state_, can_use_pin_); } void NotifyFingerprintAuthResult(bool success) { reset_state_.Stop(); label_->SetTextBasedOnAuthAttempt(success); if (success) { icon_->SetImage(gfx::CreateVectorIcon( kLockScreenFingerprintSuccessIcon, kFingerprintIconSizeDp, AshColorProvider::Get()->GetContentLayerColor( AshColorProvider::ContentLayerType::kIconColorPositive))); } else { SetIcon(FingerprintState::DISABLED_FROM_ATTEMPTS); // base::Unretained is safe because reset_state_ is owned by |this|. reset_state_.Start( FROM_HERE, base::TimeDelta::FromMilliseconds(kResetToDefaultIconDelayMs), base::BindOnce(&FingerprintView::DisplayCurrentState, base::Unretained(this))); FireAlert(); } } // views::View: gfx::Size CalculatePreferredSize() const override { gfx::Size size = views::View::CalculatePreferredSize(); size.set_width(kFingerprintViewWidthDp); return size; } // views::View: void OnGestureEvent(ui::GestureEvent* event) override { if (event->type() != ui::ET_GESTURE_TAP) return; if (state_ == FingerprintState::AVAILABLE_DEFAULT || state_ == FingerprintState::AVAILABLE_WITH_TOUCH_SENSOR_WARNING) { SetState(FingerprintState::AVAILABLE_WITH_TOUCH_SENSOR_WARNING); reset_state_.Start( FROM_HERE, kResetToDefaultMessageDelayMs, base::BindOnce(&FingerprintView::SetState, base::Unretained(this), FingerprintState::AVAILABLE_DEFAULT)); } } private: void DisplayCurrentState() { SetVisible(state_ != FingerprintState::UNAVAILABLE); SetIcon(state_); label_->SetTextBasedOnState(state_, can_use_pin_); } void FireAlert() { label_->NotifyAccessibilityEvent(ax::mojom::Event::kAlert, true /*send_native_event*/); } void SetIcon(FingerprintState state) { const SkColor icon_color = AshColorProvider::Get()->GetContentLayerColor( AshColorProvider::ContentLayerType::kIconColorPrimary); const SkColor color = state == FingerprintState::AVAILABLE_DEFAULT || state == FingerprintState::AVAILABLE_WITH_TOUCH_SENSOR_WARNING ? icon_color : AshColorProvider::Get()->GetDisabledColor(icon_color); switch (state) { case FingerprintState::UNAVAILABLE: case FingerprintState::AVAILABLE_DEFAULT: case FingerprintState::AVAILABLE_WITH_TOUCH_SENSOR_WARNING: case FingerprintState::DISABLED_FROM_TIMEOUT: icon_->SetImage(gfx::CreateVectorIcon(kLockScreenFingerprintIcon, kFingerprintIconSizeDp, color)); break; case FingerprintState::DISABLED_FROM_ATTEMPTS: icon_->SetAnimationDecoder( std::make_unique( *ui::ResourceBundle::GetSharedInstance().GetImageSkiaNamed( IDR_LOGIN_FINGERPRINT_UNLOCK_SPINNER), base::TimeDelta::FromMilliseconds( kFingerprintFailedAnimationDurationMs), kFingerprintFailedAnimationNumFrames), AnimatedRoundedImageView::Playback::kSingle); break; } } bool ShouldFireChromeVoxAlert(FingerprintState state) { return state == FingerprintState::DISABLED_FROM_ATTEMPTS || state == FingerprintState::DISABLED_FROM_TIMEOUT; } FingerprintLabel* label_ = nullptr; AnimatedRoundedImageView* icon_ = nullptr; base::OneShotTimer reset_state_; FingerprintState state_ = FingerprintState::AVAILABLE_DEFAULT; // Affects DISABLED_FROM_TIMEOUT message. bool can_use_pin_ = false; DISALLOW_COPY_AND_ASSIGN(FingerprintView); }; // Consists of challenge-response icon view and a label. class LoginAuthUserView::ChallengeResponseView : public views::View { public: enum class State { kInitial, kAuthenticating, kFailure }; explicit ChallengeResponseView(base::RepeatingClosure on_start_tap) : on_start_tap_(std::move(on_start_tap)) { SetPaintToLayer(); layer()->SetFillsBoundsOpaquely(false); auto* layout = SetLayoutManager(std::make_unique( views::BoxLayout::Orientation::kVertical)); layout->set_cross_axis_alignment( views::BoxLayout::CrossAxisAlignment::kCenter); auto arrow_button_view = std::make_unique( base::BindRepeating(&ChallengeResponseView::ArrowButtonPressed, base::Unretained(this)), kChallengeResponseArrowSizeDp); arrow_button_view->SetInstallFocusRingOnFocus(true); views::InstallCircleHighlightPathGenerator(arrow_button_view.get()); arrow_button_ = AddChildView(std::move(arrow_button_view)); arrow_button_->SetAccessibleName(l10n_util::GetStringUTF16( IDS_ASH_LOGIN_START_SMART_CARD_AUTH_BUTTON_ACCESSIBLE_NAME)); arrow_to_icon_spacer_ = AddChildView(std::make_unique()); arrow_to_icon_spacer_->SetPreferredSize( gfx::Size(0, kSpacingBetweenChallengeResponseArrowAndIconDp)); icon_ = AddChildView(std::make_unique()); icon_->SetImage(GetImageForIcon()); auto* icon_to_label_spacer = AddChildView(std::make_unique()); icon_to_label_spacer->SetPreferredSize( gfx::Size(0, kSpacingBetweenChallengeResponseIconAndLabelDp)); label_ = AddChildView(std::make_unique( GetTextForLabel(), views::style::CONTEXT_LABEL, views::style::STYLE_PRIMARY)); label_->SetAutoColorReadabilityEnabled(false); label_->SetEnabledColor(AshColorProvider::Get()->GetContentLayerColor( AshColorProvider::ContentLayerType::kTextColorSecondary)); label_->SetSubpixelRenderingEnabled(false); label_->SetFontList(views::Label::GetDefaultFontList().Derive( /*size_delta=*/1, gfx::Font::FontStyle::ITALIC, gfx::Font::Weight::NORMAL)); } ~ChallengeResponseView() override = default; void SetState(State state) { if (state_ == state) return; state_ = state; reset_state_timer_.Stop(); if (state == State::kFailure) { reset_state_timer_.Start( FROM_HERE, kChallengeResponseResetAfterFailureDelay, base::BindOnce(&ChallengeResponseView::SetState, base::Unretained(this), State::kInitial)); } arrow_button_->EnableLoadingAnimation(state == State::kAuthenticating); icon_->SetImage(GetImageForIcon()); label_->SetText(GetTextForLabel()); if (state == State::kFailure) { label_->NotifyAccessibilityEvent(ax::mojom::Event::kAlert, /*send_native_event=*/true); } Layout(); } void RequestFocus() override { arrow_button_->RequestFocus(); } views::Button* GetButtonForTesting() { return arrow_button_; } views::Label* GetLabelForTesting() { return label_; } private: gfx::ImageSkia GetImageForIcon() const { switch (state_) { case State::kInitial: case State::kAuthenticating: return gfx::CreateVectorIcon( kLockScreenSmartCardIcon, kChallengeResponseIconSizeDp, AshColorProvider::Get()->GetContentLayerColor( AshColorProvider::ContentLayerType::kIconColorPrimary)); case State::kFailure: return gfx::CreateVectorIcon( kLockScreenSmartCardFailureIcon, kChallengeResponseIconSizeDp, AshColorProvider::Get()->GetContentLayerColor( AshColorProvider::ContentLayerType::kIconColorAlert)); } } base::string16 GetTextForLabel() const { switch (state_) { case State::kInitial: case State::kAuthenticating: return l10n_util::GetStringUTF16( IDS_ASH_LOGIN_SMART_CARD_SIGN_IN_MESSAGE); case State::kFailure: return l10n_util::GetStringUTF16( IDS_ASH_LOGIN_SMART_CARD_SIGN_IN_FAILURE_MESSAGE); } } void ArrowButtonPressed() { // Ignore further clicks while handling the previous one. if (state_ != State::kAuthenticating) on_start_tap_.Run(); } base::RepeatingClosure on_start_tap_; State state_ = State::kInitial; ArrowButtonView* arrow_button_ = nullptr; NonAccessibleView* arrow_to_icon_spacer_ = nullptr; views::ImageView* icon_ = nullptr; views::Label* label_ = nullptr; base::OneShotTimer reset_state_timer_; DISALLOW_COPY_AND_ASSIGN(ChallengeResponseView); }; // The message shown to user when the auth method is |AUTH_DISABLED|. class LoginAuthUserView::DisabledAuthMessageView : public views::View { public: class ASH_EXPORT TestApi { public: explicit TestApi(DisabledAuthMessageView* view) : view_(view) {} ~TestApi() = default; const base::string16& GetDisabledAuthMessageContent() const { return view_->message_contents_->GetText(); } private: DisabledAuthMessageView* const view_; }; // If the reason of disabled auth is multiprofile policy, then we can already // set the text and message. Otherwise, in case of disabled auth because of // time limit exceeded on child account, we wait for SetAuthDisabledMessage to // be called. DisabledAuthMessageView(bool shown_because_of_multiprofile_policy, MultiProfileUserBehavior multiprofile_policy) : shown_because_of_multiprofile_policy_( shown_because_of_multiprofile_policy) { SetLayoutManager(std::make_unique( views::BoxLayout::Orientation::kVertical, gfx::Insets(kDisabledAuthMessageVerticalBorderDp, kDisabledAuthMessageHorizontalBorderDp), kDisabledAuthMessageChildrenSpacingDp)); SetPaintToLayer(); layer()->SetFillsBoundsOpaquely(false); SetPreferredSize(gfx::Size(shown_because_of_multiprofile_policy ? kDisabledAuthMessageMultiprofileWidthDp : kDisabledAuthMessageTimeWidthDp, kDisabledAuthMessageHeightDp)); SetFocusBehavior(FocusBehavior::ALWAYS); if (!shown_because_of_multiprofile_policy) { message_icon_ = new views::ImageView(); message_icon_->SetPreferredSize(gfx::Size( kDisabledAuthMessageIconSizeDp, kDisabledAuthMessageIconSizeDp)); message_icon_->SetImage(gfx::CreateVectorIcon( kLockScreenTimeLimitMoonIcon, kDisabledAuthMessageIconSizeDp, AshColorProvider::Get()->GetContentLayerColor( AshColorProvider::ContentLayerType::kIconColorPrimary))); AddChildView(message_icon_); } auto decorate_label = [](views::Label* label) { label->SetSubpixelRenderingEnabled(false); label->SetAutoColorReadabilityEnabled(false); label->SetEnabledColor(AshColorProvider::Get()->GetContentLayerColor( AshColorProvider::ContentLayerType::kTextColorPrimary)); label->SetFocusBehavior(FocusBehavior::ALWAYS); }; message_title_ = new views::Label(base::string16(), views::style::CONTEXT_LABEL, views::style::STYLE_PRIMARY); message_title_->SetFontList( gfx::FontList().Derive(kDisabledAuthMessageTitleFontSizeDeltaDp, gfx::Font::NORMAL, gfx::Font::Weight::MEDIUM)); decorate_label(message_title_); AddChildView(message_title_); message_contents_ = new views::Label(base::string16(), views::style::CONTEXT_LABEL, views::style::STYLE_PRIMARY); message_contents_->SetFontList( gfx::FontList().Derive(kDisabledAuthMessageContentsFontSizeDeltaDp, gfx::Font::NORMAL, gfx::Font::Weight::NORMAL)); decorate_label(message_contents_); message_contents_->SetMultiLine(true); AddChildView(message_contents_); if (shown_because_of_multiprofile_policy) { message_title_->SetText(l10n_util::GetStringUTF16( IDS_ASH_LOGIN_MULTI_PROFILES_RESTRICTED_POLICY_TITLE)); switch (multiprofile_policy) { case MultiProfileUserBehavior::PRIMARY_ONLY: message_contents_->SetText(l10n_util::GetStringUTF16( IDS_ASH_LOGIN_MULTI_PROFILES_PRIMARY_ONLY_POLICY_MSG)); break; case MultiProfileUserBehavior::NOT_ALLOWED: message_contents_->SetText(l10n_util::GetStringUTF16( IDS_ASH_LOGIN_MULTI_PROFILES_NOT_ALLOWED_POLICY_MSG)); break; case MultiProfileUserBehavior::OWNER_PRIMARY_ONLY: message_contents_->SetText(l10n_util::GetStringUTF16( IDS_ASH_LOGIN_MULTI_PROFILES_OWNER_PRIMARY_ONLY_MSG)); break; default: NOTREACHED(); } } } ~DisabledAuthMessageView() override = default; // Set the parameters needed to render the message. void SetAuthDisabledMessage(const AuthDisabledData& auth_disabled_data, bool use_24hour_clock) { // Do not do anything if message is already shown. if (shown_because_of_multiprofile_policy_) return; LockScreenMessage message = GetLockScreenMessage( auth_disabled_data.reason, auth_disabled_data.auth_reenabled_time, auth_disabled_data.device_used_time, use_24hour_clock); message_icon_->SetImage(gfx::CreateVectorIcon( *message.icon, kDisabledAuthMessageIconSizeDp, AshColorProvider::Get()->GetContentLayerColor( AshColorProvider::ContentLayerType::kIconColorPrimary))); message_title_->SetText(message.title); message_contents_->SetText(message.content); Layout(); } // views::View: void OnPaint(gfx::Canvas* canvas) override { views::View::OnPaint(canvas); cc::PaintFlags flags; flags.setStyle(cc::PaintFlags::kFill_Style); flags.setColor( PinRequestView::GetChildUserDialogColor(false /*using blur*/)); canvas->DrawRoundRect(GetContentsBounds(), kDisabledAuthMessageRoundedCornerRadiusDp, flags); } void RequestFocus() override { message_title_->RequestFocus(); } private: views::Label* message_title_; views::Label* message_contents_; views::ImageView* message_icon_; // Used in case a child account has triggered the disabled auth message // because of time limit exceeded while it also has disabled auth by // multiprofile policy. bool shown_because_of_multiprofile_policy_ = false; DISALLOW_COPY_AND_ASSIGN(DisabledAuthMessageView); }; // The message shown to user when TPM is locked. class LoginAuthUserView::LockedTpmMessageView : public views::View { public: LockedTpmMessageView() { SetLayoutManager(std::make_unique( views::BoxLayout::Orientation::kVertical, gfx::Insets(kLockedTpmMessageVerticalBorderDp, kLockedTpmMessageHorizontalBorderDp), kLockedTpmMessageChildrenSpacingDp)); SetPaintToLayer(); layer()->SetFillsBoundsOpaquely(false); SetPreferredSize( gfx::Size(kLockedTpmMessageWidthDp, kLockedTpmMessageHeightDp)); SetFocusBehavior(FocusBehavior::ALWAYS); auto message_icon = std::make_unique(); message_icon->SetPreferredSize( gfx::Size(kLockedTpmMessageIconSizeDp, kLockedTpmMessageIconSizeDp)); message_icon->SetImage(gfx::CreateVectorIcon( kLockScreenAlertIcon, AshColorProvider::Get()->GetContentLayerColor( AshColorProvider::ContentLayerType::kIconColorPrimary))); message_icon_ = AddChildView(std::move(message_icon)); message_warning_ = CreateLabel(); message_description_ = CreateLabel(); // Set content. base::string16 message_description = l10n_util::GetStringUTF16( IDS_ASH_LOGIN_POD_TPM_LOCKED_ISSUE_DESCRIPTION); message_description_->SetText(message_description); } LockedTpmMessageView(const LockedTpmMessageView&) = delete; LockedTpmMessageView& operator=(const LockedTpmMessageView&) = delete; ~LockedTpmMessageView() override = default; // Set the parameters needed to render the message. void SetRemainingTime(base::TimeDelta time_left) { base::string16 time_left_message; if (base::TimeDurationFormatWithSeconds( time_left, base::DurationFormatWidth::DURATION_WIDTH_WIDE, &time_left_message)) { base::string16 message_warning = l10n_util::GetStringFUTF16( IDS_ASH_LOGIN_POD_TPM_LOCKED_ISSUE_WARNING, time_left_message); message_warning_->SetText(message_warning); if (time_left.InMinutes() != prev_time_left_.InMinutes()) { message_warning_->NotifyAccessibilityEvent( ax::mojom::Event::kTextChanged, true); } prev_time_left_ = time_left; } } // views::View: void OnPaint(gfx::Canvas* canvas) override { views::View::OnPaint(canvas); cc::PaintFlags flags; flags.setStyle(cc::PaintFlags::kFill_Style); flags.setColor( PinRequestView::GetChildUserDialogColor(false /*using blur*/)); canvas->DrawRoundRect(GetContentsBounds(), kLockedTpmMessageRoundedCornerRadiusDp, flags); } void RequestFocus() override { message_warning_->RequestFocus(); } private: views::Label* CreateLabel() { auto label = std::make_unique(base::string16(), views::style::CONTEXT_LABEL, views::style::STYLE_PRIMARY); label->SetFontList(gfx::FontList().Derive(kLockedTpmMessageDeltaDp, gfx::Font::NORMAL, gfx::Font::Weight::NORMAL)); label->SetSubpixelRenderingEnabled(false); label->SetAutoColorReadabilityEnabled(false); label->SetEnabledColor(AshColorProvider::Get()->GetContentLayerColor( AshColorProvider::ContentLayerType::kTextColorPrimary)); label->SetFocusBehavior(FocusBehavior::ALWAYS); label->SetMultiLine(true); return AddChildView(std::move(label)); } base::TimeDelta prev_time_left_; views::Label* message_warning_; views::Label* message_description_; views::ImageView* message_icon_; }; LoginAuthUserView::AuthMethodsMetadata::AuthMethodsMetadata() = default; LoginAuthUserView::AuthMethodsMetadata::~AuthMethodsMetadata() = default; LoginAuthUserView::AuthMethodsMetadata::AuthMethodsMetadata( const AuthMethodsMetadata&) = default; struct LoginAuthUserView::UiState { explicit UiState(const LoginAuthUserView* view) { has_password = view->ShouldShowPasswordField(); has_pin_input = view->ShouldShowPinInputField(); has_pinpad = view->ShouldShowPinPad(); has_toggle = view->ShouldShowToggle(); has_fingerprint = view->HasAuthMethod(LoginAuthUserView::AUTH_FINGERPRINT); has_challenge_response = view->HasAuthMethod(LoginAuthUserView::AUTH_CHALLENGE_RESPONSE); auth_disabled = view->HasAuthMethod(LoginAuthUserView::AUTH_DISABLED); tpm_is_locked = view->HasAuthMethod(LoginAuthUserView::AUTH_DISABLED_TPM_LOCKED); force_online_sign_in = view->HasAuthMethod(LoginAuthUserView::AUTH_ONLINE_SIGN_IN); non_pin_y_start_in_screen = view->GetBoundsInScreen().y(); pin_start_in_screen = view->pin_view_->GetBoundsInScreen().origin(); } bool has_password = false; bool has_pin_input = false; bool has_pinpad = false; bool has_toggle = false; bool has_fingerprint = false; bool has_challenge_response = false; bool auth_disabled = false; bool tpm_is_locked = false; bool force_online_sign_in = false; // Used for this view's animation in `ApplyAnimationPostLayout`. int non_pin_y_start_in_screen = 0; gfx::Point pin_start_in_screen; }; LoginAuthUserView::TestApi::TestApi(LoginAuthUserView* view) : view_(view) {} LoginAuthUserView::TestApi::~TestApi() = default; LoginUserView* LoginAuthUserView::TestApi::user_view() const { return view_->user_view_; } LoginPasswordView* LoginAuthUserView::TestApi::password_view() const { return view_->password_view_; } LoginPinView* LoginAuthUserView::TestApi::pin_view() const { return view_->pin_view_; } LoginPinInputView* LoginAuthUserView::TestApi::pin_input_view() const { return view_->pin_input_view_; } views::Button* LoginAuthUserView::TestApi::pin_password_toggle() const { return view_->pin_password_toggle_; } views::Button* LoginAuthUserView::TestApi::online_sign_in_message() const { return view_->online_sign_in_message_; } views::View* LoginAuthUserView::TestApi::disabled_auth_message() const { return view_->disabled_auth_message_; } views::Button* LoginAuthUserView::TestApi::challenge_response_button() { return view_->challenge_response_view_->GetButtonForTesting(); } views::Label* LoginAuthUserView::TestApi::challenge_response_label() { return view_->challenge_response_view_->GetLabelForTesting(); } bool LoginAuthUserView::TestApi::HasAuthMethod(AuthMethods auth_method) const { return view_->HasAuthMethod(auth_method); } const base::string16& LoginAuthUserView::TestApi::GetDisabledAuthMessageContent() const { return LoginAuthUserView::DisabledAuthMessageView::TestApi( view_->disabled_auth_message_) .GetDisabledAuthMessageContent(); } LoginAuthUserView::Callbacks::Callbacks() = default; LoginAuthUserView::Callbacks::Callbacks(const Callbacks& other) = default; LoginAuthUserView::Callbacks::~Callbacks() = default; LoginAuthUserView::LoginAuthUserView(const LoginUserInfo& user, const Callbacks& callbacks) : NonAccessibleView(kLoginAuthUserViewClassName), on_auth_(callbacks.on_auth), on_tap_(callbacks.on_tap) { DCHECK(callbacks.on_auth); DCHECK(callbacks.on_tap); DCHECK(callbacks.on_remove_warning_shown); DCHECK(callbacks.on_remove); DCHECK(callbacks.on_easy_unlock_icon_hovered); DCHECK_NE(user.basic_user_info.type, user_manager::USER_TYPE_PUBLIC_ACCOUNT); // Build child views. auto user_view = std::make_unique( LoginDisplayStyle::kLarge, true /*show_dropdown*/, base::BindRepeating(&LoginAuthUserView::OnUserViewTap, base::Unretained(this)), callbacks.on_remove_warning_shown, callbacks.on_remove); user_view_ = user_view.get(); const LoginPalette palette = CreateDefaultLoginPalette(); auto password_view = std::make_unique(palette); password_view_ = password_view.get(); password_view->SetPaintToLayer(); // Needed for opacity animation. password_view->layer()->SetFillsBoundsOpaquely(false); password_view_->SetDisplayPasswordButtonVisible( user.show_display_password_button); password_view->Init( base::BindRepeating(&LoginAuthUserView::OnAuthSubmit, base::Unretained(this)), base::BindRepeating(&LoginAuthUserView::OnPasswordTextChanged, base::Unretained(this)), callbacks.on_easy_unlock_icon_hovered, callbacks.on_easy_unlock_icon_tapped); auto pin_input_view = std::make_unique(palette); pin_input_view_ = pin_input_view.get(); pin_input_view->Init(base::BindRepeating(&LoginAuthUserView::OnAuthSubmit, base::Unretained(this)), base::BindRepeating(&LoginAuthUserView::OnPinTextChanged, base::Unretained(this))); auto toggle_container = std::make_unique(); toggle_container->SetLayoutManager(std::make_unique( views::BoxLayout::Orientation::kVertical, gfx::Insets(kPinPasswordToggleButtonPaddingTop, 0, 0, 0))); pin_password_toggle_ = toggle_container->AddChildView(std::make_unique( base::BindRepeating(&LoginAuthUserView::OnSwitchButtonClicked, base::Unretained(this)), GetPinPasswordToggleText(), SystemLabelButton::DisplayType::DEFAULT, /*multiline*/ false)); pin_password_toggle_->SetMaxSize( gfx::Size(/*ignored*/ 0, kPinPasswordToggleButtonHeight)); auto pin_view = std::make_unique( LoginPinView::Style::kAlphanumeric, palette, base::BindRepeating(&LoginAuthUserView::OnPinPadInsertDigit, base::Unretained(this)), base::BindRepeating(&LoginAuthUserView::OnPinPadBackspace, base::Unretained(this))); pin_view_ = pin_view.get(); DCHECK(pin_view_->layer()); auto padding_below_password_view = std::make_unique(); padding_below_password_view->SetPreferredSize(gfx::Size( kNonEmptyWidthDp, kDistanceBetweenPasswordFieldAndPinKeyboardDp)); padding_below_password_view_ = padding_below_password_view.get(); auto padding_below_user_view = std::make_unique(); padding_below_user_view->SetPreferredSize( gfx::Size(kNonEmptyWidthDp, kDistanceBetweenUserViewAndPasswordDp)); padding_below_user_view_ = padding_below_user_view.get(); base::string16 button_message = l10n_util::GetStringUTF16(IDS_ASH_LOGIN_SIGN_IN_REQUIRED_MESSAGE); if (user.is_signed_in) { button_message = l10n_util::GetStringUTF16(IDS_ASH_LOCK_SCREEN_VERIFY_ACCOUNT_MESSAGE); } bool is_login_secondary = Shell::Get()->session_controller()->GetSessionState() == session_manager::SessionState::LOGIN_SECONDARY; auto online_sign_in_button = std::make_unique( base::BindRepeating(&LoginAuthUserView::OnOnlineSignInMessageTap, base::Unretained(this)), button_message, SystemLabelButton::DisplayType::ALERT_WITH_ICON, /*multiline*/ false); // Disable online sign-in on secondary login screen as there is no OOBE there. online_sign_in_button->SetEnabled(!is_login_secondary); online_sign_in_message_ = online_sign_in_button.get(); bool shown_because_of_multiprofile_policy = !user.is_multiprofile_allowed && is_login_secondary; auto disabled_auth_message = std::make_unique( shown_because_of_multiprofile_policy, user.multiprofile_policy); disabled_auth_message_ = disabled_auth_message.get(); auto locked_tpm_message_view = std::make_unique(); locked_tpm_message_view_ = locked_tpm_message_view.get(); auto fingerprint_view = std::make_unique(); fingerprint_view_ = fingerprint_view.get(); auto challenge_response_view = std::make_unique(base::BindRepeating( &LoginAuthUserView::AttemptAuthenticateWithChallengeResponse, weak_factory_.GetWeakPtr())); challenge_response_view_ = challenge_response_view.get(); SetPaintToLayer(ui::LayerType::LAYER_NOT_DRAWN); // Build layout. auto wrapped_password_view = login_views_utils::WrapViewForPreferredSize(std::move(password_view)); auto wrapped_online_sign_in_message_view = login_views_utils::WrapViewForPreferredSize( std::move(online_sign_in_button)); auto wrapped_disabled_auth_message_view = login_views_utils::WrapViewForPreferredSize( std::move(disabled_auth_message)); auto wrapped_locked_tpm_message_view = login_views_utils::WrapViewForPreferredSize( std::move(locked_tpm_message_view)); auto wrapped_user_view = login_views_utils::WrapViewForPreferredSize(std::move(user_view)); auto wrapped_pin_view = login_views_utils::WrapViewForPreferredSize(std::move(pin_view)); auto wrapped_pin_input_view = login_views_utils::WrapViewForPreferredSize(std::move(pin_input_view)); auto wrapped_pin_password_toggle_view = login_views_utils::WrapViewForPreferredSize(std::move(toggle_container)); auto wrapped_fingerprint_view = login_views_utils::WrapViewForPreferredSize(std::move(fingerprint_view)); auto wrapped_challenge_response_view = login_views_utils::WrapViewForPreferredSize( std::move(challenge_response_view)); auto wrapped_padding_below_password_view = login_views_utils::WrapViewForPreferredSize( std::move(padding_below_password_view)); auto wrapped_padding_below_user_view = login_views_utils::WrapViewForPreferredSize( std::move(padding_below_user_view)); // Add views in tabbing order; they are rendered in a different order below. views::View* wrapped_password_view_ptr = AddChildView(std::move(wrapped_password_view)); views::View* wrapped_online_sign_in_message_view_ptr = AddChildView(std::move(wrapped_online_sign_in_message_view)); views::View* wrapped_disabled_auth_message_view_ptr = AddChildView(std::move(wrapped_disabled_auth_message_view)); views::View* wrapped_locked_tpm_message_view_ptr = AddChildView(std::move(wrapped_locked_tpm_message_view)); views::View* wrapped_pin_input_view_ptr = AddChildView(std::move(wrapped_pin_input_view)); views::View* wrapped_pin_view_ptr = AddChildView(std::move(wrapped_pin_view)); views::View* wrapped_pin_password_toggle_view_ptr = AddChildView(std::move(wrapped_pin_password_toggle_view)); views::View* wrapped_fingerprint_view_ptr = AddChildView(std::move(wrapped_fingerprint_view)); views::View* wrapped_challenge_response_view_ptr = AddChildView(std::move(wrapped_challenge_response_view)); views::View* wrapped_user_view_ptr = AddChildView(std::move(wrapped_user_view)); views::View* wrapped_padding_below_password_view_ptr = AddChildView(std::move(wrapped_padding_below_password_view)); views::View* wrapped_padding_below_user_view_ptr = AddChildView(std::move(wrapped_padding_below_user_view)); // Use views::GridLayout instead of views::BoxLayout because views::BoxLayout // lays out children according to the view->children order. views::GridLayout* grid_layout = SetLayoutManager(std::make_unique()); views::ColumnSet* column_set = grid_layout->AddColumnSet(0); column_set->AddColumn(views::GridLayout::CENTER, views::GridLayout::LEADING, 0 /*resize_percent*/, views::GridLayout::ColumnSize::kUsePreferred, 0 /*fixed_width*/, 0 /*min_width*/); auto add_view = [&](views::View* view) { grid_layout->StartRow(0 /*vertical_resize*/, 0 /*column_set_id*/); grid_layout->AddExistingView(view); }; auto add_padding = [&](int amount) { grid_layout->AddPaddingRow(0 /*vertical_resize*/, amount /*size*/); }; // Add views in rendering order. add_padding(kDistanceFromTopOfBigUserViewToUserIconDp); add_view(wrapped_user_view_ptr); add_view(wrapped_padding_below_user_view_ptr); add_view(wrapped_locked_tpm_message_view_ptr); add_view(wrapped_password_view_ptr); add_view(wrapped_online_sign_in_message_view_ptr); add_view(wrapped_disabled_auth_message_view_ptr); add_view(wrapped_pin_input_view_ptr); add_view(wrapped_padding_below_password_view_ptr); add_view(wrapped_pin_view_ptr); add_view(wrapped_pin_password_toggle_view_ptr); add_view(wrapped_fingerprint_view_ptr); add_view(wrapped_challenge_response_view_ptr); add_padding(kDistanceFromPinKeyboardToBigUserViewBottomDp); // Update authentication UI. CaptureStateForAnimationPreLayout(); SetAuthMethods(auth_methods_); ApplyAnimationPostLayout(/*animate*/ false); user_view_->UpdateForUser(user, /*animate*/ false); } LoginAuthUserView::~LoginAuthUserView() = default; void LoginAuthUserView::SetAuthMethods( uint32_t auth_methods, const AuthMethodsMetadata& auth_metadata) { // It is an error to call this method without storing the previous state. DCHECK(previous_state_); // Apply changes and determine the new state of input fields. auth_methods_ = static_cast(auth_methods); auth_metadata_ = auth_metadata; UpdateInputFieldMode(); const UiState current_state{this}; online_sign_in_message_->SetVisible(current_state.force_online_sign_in); disabled_auth_message_->SetVisible(current_state.auth_disabled); locked_tpm_message_view_->SetVisible(current_state.tpm_is_locked); if (current_state.tpm_is_locked && auth_metadata.time_until_tpm_unlock.has_value()) locked_tpm_message_view_->SetRemainingTime( auth_metadata.time_until_tpm_unlock.value()); // Adjust the PIN keyboard visibility before the password textfield's one, so // that when both are about to be hidden the focus doesn't jump to the ""1"" // keyboard button, causing unexpected accessibility effects. pin_view_->SetVisible(current_state.has_pinpad); password_view_->SetEnabled(current_state.has_password); password_view_->SetEnabledOnEmptyPassword(HasAuthMethod(AUTH_TAP)); password_view_->SetFocusEnabledForTextfield(current_state.has_password); password_view_->SetVisible(current_state.has_password); password_view_->layer()->SetOpacity(current_state.has_password ? 1 : 0); pin_input_view_->UpdateLength(auth_metadata_.autosubmit_pin_length); pin_input_view_->SetAuthenticateWithEmptyPinOnReturnKey( HasAuthMethod(AUTH_TAP)); pin_input_view_->SetVisible(current_state.has_pin_input); pin_password_toggle_->SetVisible(current_state.has_toggle); pin_password_toggle_->SetText(GetPinPasswordToggleText()); fingerprint_view_->SetVisible(current_state.has_fingerprint); fingerprint_view_->SetCanUsePin(HasAuthMethod(AUTH_PIN)); challenge_response_view_->SetVisible(current_state.has_challenge_response); padding_below_user_view_->SetPreferredSize(GetPaddingBelowUserView()); padding_below_password_view_->SetPreferredSize(GetPaddingBelowPasswordView()); password_view_->SetPlaceholderText(GetPasswordViewPlaceholder()); const std::string& user_display_email = current_user().basic_user_info.display_email; password_view_->SetAccessibleName(l10n_util::GetStringFUTF16( IDS_ASH_LOGIN_POD_PASSWORD_FIELD_ACCESSIBLE_NAME, base::UTF8ToUTF16(user_display_email))); // Only the active auth user view has authentication methods. If that is the // case, then render the user view as if it was always focused, since clicking // on it will not do anything (such as swapping users). user_view_->SetForceOpaque(auth_methods_ != AUTH_NONE); user_view_->SetTapEnabled(auth_methods_ == AUTH_NONE); UpdateFocus(); PreferredSizeChanged(); } void LoginAuthUserView::SetEasyUnlockIcon( EasyUnlockIconId id, const base::string16& accessibility_label) { password_view_->SetEasyUnlockIcon(id, accessibility_label); const std::string& user_display_email = current_user().basic_user_info.display_email; if (id == EasyUnlockIconId::UNLOCKED) { password_view_->SetAccessibleName(l10n_util::GetStringFUTF16( IDS_ASH_LOGIN_POD_AUTH_TAP_PASSWORD_FIELD_ACCESSIBLE_NAME, base::UTF8ToUTF16(user_display_email))); } else { password_view_->SetAccessibleName(l10n_util::GetStringFUTF16( IDS_ASH_LOGIN_POD_PASSWORD_FIELD_ACCESSIBLE_NAME, base::UTF8ToUTF16(user_display_email))); } } void LoginAuthUserView::CaptureStateForAnimationPreLayout() { auto stop_animation = [](views::View* view) { if (view->layer()->GetAnimator()->is_animating()) view->layer()->GetAnimator()->StopAnimating(); }; // Stop any running animation scheduled in ApplyAnimationPostLayout. stop_animation(this); stop_animation(password_view_); stop_animation(pin_view_); stop_animation(fingerprint_view_); stop_animation(challenge_response_view_); stop_animation(pin_password_toggle_); DCHECK(!previous_state_); previous_state_ = std::make_unique(this); } void LoginAuthUserView::ApplyAnimationPostLayout(bool animate) { DCHECK(previous_state_); // Release the previous state if no animation should be performed. if (!animate) { previous_state_.reset(); return; } const UiState current_state{this}; //////// // Animate the user info (ie, icon, name) up or down the screen. { int non_pin_y_end_in_screen = GetBoundsInScreen().y(); // Transform the layer so the user view renders where it used to be. This // requires a y offset. // Note: Doing this animation via ui::ScopedLayerAnimationSettings works, // but it seems that the timing gets slightly out of sync with the PIN // animation. auto move_to_center = std::make_unique( gfx::PointF(0, previous_state_->non_pin_y_start_in_screen - non_pin_y_end_in_screen), gfx::PointF()); auto transition = ui::LayerAnimationElement::CreateInterpolatedTransformElement( std::move(move_to_center), base::TimeDelta::FromMilliseconds( login_constants::kChangeUserAnimationDurationMs)); transition->set_tween_type(gfx::Tween::Type::FAST_OUT_SLOW_IN); auto* sequence = new ui::LayerAnimationSequence(std::move(transition)); auto* observer = BuildObserverToNotifyA11yLocationChanged(this); sequence->AddObserver(observer); observer->SetActive(); layer()->GetAnimator()->StartAnimation(sequence); } //////// // Fade the password view if it is being hidden or shown. if (current_state.has_password != previous_state_->has_password) { float opacity_start = 0, opacity_end = 1; if (!current_state.has_password) std::swap(opacity_start, opacity_end); password_view_->layer()->SetOpacity(opacity_start); { ui::ScopedLayerAnimationSettings settings( password_view_->layer()->GetAnimator()); settings.SetTransitionDuration(base::TimeDelta::FromMilliseconds( login_constants::kChangeUserAnimationDurationMs)); settings.SetTweenType(gfx::Tween::Type::FAST_OUT_SLOW_IN); if (previous_state_->has_password && !current_state.has_password) { settings.AddObserver( new ClearPasswordAndHideAnimationObserver(password_view_)); } password_view_->layer()->SetOpacity(opacity_end); } } //////// // Fade the pin/pwd toggle if its being hidden or shown. if (previous_state_->has_toggle != current_state.has_toggle) { float opacity_start = 0, opacity_end = 1; if (!current_state.has_toggle) std::swap(opacity_start, opacity_end); pin_password_toggle_->layer()->SetOpacity(opacity_start); { ui::ScopedLayerAnimationSettings settings( pin_password_toggle_->layer()->GetAnimator()); settings.SetTransitionDuration(base::TimeDelta::FromMilliseconds( login_constants::kChangeUserAnimationDurationMs)); settings.SetTweenType(gfx::Tween::Type::FAST_OUT_SLOW_IN); pin_password_toggle_->layer()->SetOpacity(opacity_end); } } //////// // Grow/shrink the PIN keyboard if it is being hidden or shown. if (previous_state_->has_pinpad != current_state.has_pinpad) { if (!current_state.has_pinpad) { gfx::Point pin_end_in_screen = pin_view_->GetBoundsInScreen().origin(); gfx::Rect pin_bounds = pin_view_->bounds(); pin_bounds.set_x(previous_state_->pin_start_in_screen.x() - pin_end_in_screen.x()); pin_bounds.set_y(previous_state_->pin_start_in_screen.y() - pin_end_in_screen.y()); // Since PIN is disabled, the previous Layout() hid the PIN keyboard. // We need to redisplay it where it used to be. // pin_view_->SetVisible(true); pin_view_->SetBoundsRect(pin_bounds); } auto transition = std::make_unique( current_state.has_pinpad /*grow*/, pin_view_->height(), // TODO(https://crbug.com/955119): Implement proper animation. base::TimeDelta::FromMilliseconds( login_constants::kChangeUserAnimationDurationMs / 2.0f), gfx::Tween::FAST_OUT_SLOW_IN); auto* sequence = new ui::LayerAnimationSequence(std::move(transition)); // Hide the PIN keyboard after animation if needed. if (!current_state.has_pinpad) { auto* observer = BuildObserverToHideView(pin_view_); sequence->AddObserver(observer); observer->SetActive(); } auto* observer = BuildObserverToNotifyA11yLocationChanged(pin_view_); sequence->AddObserver(observer); observer->SetActive(); pin_view_->layer()->GetAnimator()->ScheduleAnimation(sequence); } //////// // Fade the fingerprint view if it is being hidden or shown. if (previous_state_->has_fingerprint != current_state.has_fingerprint) { float opacity_start = 0, opacity_end = 1; if (!current_state.has_fingerprint) std::swap(opacity_start, opacity_end); fingerprint_view_->layer()->SetOpacity(opacity_start); { ui::ScopedLayerAnimationSettings settings( fingerprint_view_->layer()->GetAnimator()); settings.SetTransitionDuration(base::TimeDelta::FromMilliseconds( login_constants::kChangeUserAnimationDurationMs)); settings.SetTweenType(gfx::Tween::Type::FAST_OUT_SLOW_IN); fingerprint_view_->layer()->SetOpacity(opacity_end); } } //////// // Fade the challenge response (Smart Card) if it is being hidden or shown. if (previous_state_->has_challenge_response != current_state.has_challenge_response) { float opacity_start = 0, opacity_end = 1; if (!current_state.has_challenge_response) std::swap(opacity_start, opacity_end); challenge_response_view_->layer()->SetOpacity(opacity_start); { ui::ScopedLayerAnimationSettings settings( challenge_response_view_->layer()->GetAnimator()); settings.SetTransitionDuration(base::TimeDelta::FromMilliseconds( login_constants::kChangeUserAnimationDurationMs)); settings.SetTweenType(gfx::Tween::Type::FAST_OUT_SLOW_IN); challenge_response_view_->layer()->SetOpacity(opacity_end); } } previous_state_.reset(); } void LoginAuthUserView::UpdateForUser(const LoginUserInfo& user) { const bool user_changed = current_user().basic_user_info.account_id != user.basic_user_info.account_id; user_view_->UpdateForUser(user, true /*animate*/); if (user_changed) { password_view_->Reset(); password_view_->SetDisplayPasswordButtonVisible( user.show_display_password_button); } online_sign_in_message_->SetText( l10n_util::GetStringUTF16(IDS_ASH_LOGIN_SIGN_IN_REQUIRED_MESSAGE)); } void LoginAuthUserView::SetFingerprintState(FingerprintState state) { fingerprint_view_->SetState(state); } void LoginAuthUserView::NotifyFingerprintAuthResult(bool success) { fingerprint_view_->NotifyFingerprintAuthResult(success); } void LoginAuthUserView::SetAuthDisabledMessage( const AuthDisabledData& auth_disabled_data) { disabled_auth_message_->SetAuthDisabledMessage( auth_disabled_data, current_user().use_24hour_clock); Layout(); } const LoginUserInfo& LoginAuthUserView::current_user() const { return user_view_->current_user(); } views::View* LoginAuthUserView::GetActiveInputView() { if (input_field_mode_ == InputFieldMode::PIN_WITH_TOGGLE) return pin_input_view_; return password_view_; } gfx::Size LoginAuthUserView::CalculatePreferredSize() const { gfx::Size size = views::View::CalculatePreferredSize(); // Make sure we are at least as big as the user view. If we do not do this the // view will be below minimum size when no auth methods are displayed. size.SetToMax(user_view_->GetPreferredSize()); return size; } void LoginAuthUserView::RequestFocus() { if (input_field_mode_ == InputFieldMode::PIN_WITH_TOGGLE) pin_input_view_->RequestFocus(); else password_view_->RequestFocus(); } void LoginAuthUserView::OnAuthSubmit(const base::string16& password) { // Pressing enter when the password field is empty and tap-to-unlock is // enabled should attempt unlock. if (HasAuthMethod(AUTH_TAP) && password.empty()) { Shell::Get()->login_screen_controller()->AuthenticateUserWithEasyUnlock( current_user().basic_user_info.account_id); return; } password_view_->SetReadOnly(true); pin_input_view_->SetReadOnly(true); Shell::Get()->login_screen_controller()->AuthenticateUserWithPasswordOrPin( current_user().basic_user_info.account_id, base::UTF16ToUTF8(password), ShouldAuthenticateWithPin(), base::BindOnce(&LoginAuthUserView::OnAuthComplete, weak_factory_.GetWeakPtr())); } void LoginAuthUserView::OnAuthComplete(base::Optional auth_success) { // Clear the password only if auth fails. Make sure to keep the password view // disabled even if auth succeededs, as if the user submits a password while // animating the next lock screen will not work as expected. See // https://crbug.com/808486. if (!auth_success.has_value() || !auth_success.value()) { password_view_->Reset(); password_view_->SetReadOnly(false); pin_input_view_->Reset(); pin_input_view_->SetReadOnly(false); } on_auth_.Run(auth_success.value(), /*display_error_messages=*/true); } void LoginAuthUserView::OnChallengeResponseAuthComplete( base::Optional auth_success) { if (!auth_success.has_value() || !auth_success.value()) { password_view_->Reset(); password_view_->SetReadOnly(false); // If the user canceled the PIN request during ChallengeResponse, // ChallengeResponse will fail with an unknown error. Since this is // expected, we do not show this error. if (Shell::Get() ->login_screen_controller() ->GetSecurityTokenPinRequestCanceled()) { challenge_response_view_->SetState( ChallengeResponseView::State::kInitial); } else { challenge_response_view_->SetState( ChallengeResponseView::State::kFailure); } } on_auth_.Run(auth_success.value_or(false), /*display_error_messages=*/false); } void LoginAuthUserView::OnUserViewTap() { if (HasAuthMethod(AUTH_TAP)) { Shell::Get()->login_screen_controller()->AuthenticateUserWithEasyUnlock( current_user().basic_user_info.account_id); } else if (HasAuthMethod(AUTH_ONLINE_SIGN_IN)) { // Tapping anywhere in the user view is the same with tapping the message. OnOnlineSignInMessageTap(); } else { on_tap_.Run(); } } void LoginAuthUserView::OnOnlineSignInMessageTap() { // Do not show on secondary login screen as there is no OOBE there. if (Shell::Get()->session_controller()->GetSessionState() == session_manager::SessionState::LOGIN_SECONDARY) { return; } Shell::Get()->login_screen_controller()->ShowGaiaSignin( current_user().basic_user_info.account_id); } void LoginAuthUserView::OnPinPadBackspace() { DCHECK(pin_input_view_); DCHECK(password_view_); if (input_field_mode_ == InputFieldMode::PIN_WITH_TOGGLE) pin_input_view_->Backspace(); else password_view_->Backspace(); } void LoginAuthUserView::OnPinPadInsertDigit(int digit) { DCHECK(pin_input_view_); DCHECK(password_view_); if (input_field_mode_ == InputFieldMode::PIN_WITH_TOGGLE) pin_input_view_->InsertDigit(digit); else password_view_->InsertNumber(digit); } void LoginAuthUserView::OnPasswordTextChanged(bool is_empty) { DCHECK(pin_view_); if (input_field_mode_ != InputFieldMode::PIN_WITH_TOGGLE) pin_view_->OnPasswordTextChanged(is_empty); } void LoginAuthUserView::OnPinTextChanged(bool is_empty) { DCHECK(pin_view_); if (input_field_mode_ == InputFieldMode::PIN_WITH_TOGGLE) pin_view_->OnPasswordTextChanged(is_empty); } bool LoginAuthUserView::HasAuthMethod(AuthMethods auth_method) const { return (auth_methods_ & auth_method) != 0; } bool LoginAuthUserView::ShouldAuthenticateWithPin() const { return input_field_mode_ == InputFieldMode::PIN_AND_PASSWORD || input_field_mode_ == InputFieldMode::PIN_WITH_TOGGLE; } void LoginAuthUserView::AttemptAuthenticateWithChallengeResponse() { challenge_response_view_->SetState( ChallengeResponseView::State::kAuthenticating); Shell::Get() ->login_screen_controller() ->AuthenticateUserWithChallengeResponse( current_user().basic_user_info.account_id, base::BindOnce(&LoginAuthUserView::OnChallengeResponseAuthComplete, weak_factory_.GetWeakPtr())); } void LoginAuthUserView::UpdateFocus() { DCHECK(previous_state_); const UiState current_state{this}; if (current_state.tpm_is_locked) { locked_tpm_message_view_->RequestFocus(); return; } // All further states are exclusive. if (current_state.auth_disabled) disabled_auth_message_->RequestFocus(); if (current_state.has_challenge_response) challenge_response_view_->RequestFocus(); if (current_state.has_password && !previous_state_->has_password) password_view_->RequestFocus(); if (current_state.has_pin_input) pin_input_view_->RequestFocus(); // Tapping the user view will trigger the online sign-in flow when // |force_online_sign_in| is true. if (current_state.force_online_sign_in) user_view_->RequestFocus(); } void LoginAuthUserView::OnSwitchButtonClicked() { // Ignore events from the switch button if no longer present. if (input_field_mode_ != InputFieldMode::PIN_WITH_TOGGLE && input_field_mode_ != InputFieldMode::PWD_WITH_TOGGLE) { return; } // Clear both input fields. password_view_->Reset(); pin_input_view_->Reset(); // Cache the current state of the UI. CaptureStateForAnimationPreLayout(); // Same auth methods, but the input field mode has changed. input_field_mode_ = (input_field_mode_ == InputFieldMode::PIN_WITH_TOGGLE) ? InputFieldMode::PWD_WITH_TOGGLE : InputFieldMode::PIN_WITH_TOGGLE; SetAuthMethods(auth_methods_, auth_metadata_); // Layout and animate. Layout(); ApplyAnimationPostLayout(/*animate*/ true); } void LoginAuthUserView::UpdateInputFieldMode() { // There isn't an input field when any of the following is true: // - Challenge response is active (Smart Card) // - Online sign in message shown // - Disabled message shown // - No password auth available if (HasAuthMethod(AUTH_CHALLENGE_RESPONSE) || HasAuthMethod(AUTH_ONLINE_SIGN_IN) || HasAuthMethod(AUTH_DISABLED) || !HasAuthMethod(AUTH_PASSWORD)) { input_field_mode_ = InputFieldMode::NONE; return; } if (!HasAuthMethod(AUTH_PIN)) { input_field_mode_ = InputFieldMode::PASSWORD_ONLY; return; } // Default to combined password/pin if autosubmit is disabled. const int pin_length = auth_metadata_.autosubmit_pin_length; if (!LoginPinInputView::IsAutosubmitSupported(pin_length)) { input_field_mode_ = InputFieldMode::PIN_AND_PASSWORD; return; } // Defaults to PIN + switch button if not showing the switch button already. if (input_field_mode_ != InputFieldMode::PIN_WITH_TOGGLE && input_field_mode_ != InputFieldMode::PWD_WITH_TOGGLE) { input_field_mode_ = InputFieldMode::PIN_WITH_TOGGLE; return; } } bool LoginAuthUserView::ShouldShowPinPad() const { if (auth_metadata_.virtual_keyboard_visible) return false; switch (input_field_mode_) { case InputFieldMode::NONE: return false; case InputFieldMode::PASSWORD_ONLY: case InputFieldMode::PWD_WITH_TOGGLE: return auth_metadata_.show_pinpad_for_pw; case InputFieldMode::PIN_AND_PASSWORD: case InputFieldMode::PIN_WITH_TOGGLE: return true; } } bool LoginAuthUserView::ShouldShowPasswordField() const { return input_field_mode_ == InputFieldMode::PASSWORD_ONLY || input_field_mode_ == InputFieldMode::PIN_AND_PASSWORD || input_field_mode_ == InputFieldMode::PWD_WITH_TOGGLE; } bool LoginAuthUserView::ShouldShowPinInputField() const { return input_field_mode_ == InputFieldMode::PIN_WITH_TOGGLE; } bool LoginAuthUserView::ShouldShowToggle() const { return input_field_mode_ == InputFieldMode::PIN_WITH_TOGGLE || input_field_mode_ == InputFieldMode::PWD_WITH_TOGGLE; } gfx::Size LoginAuthUserView::GetPaddingBelowUserView() const { const UiState state{this}; if (state.has_password) return SizeFromHeight(kDistanceBetweenUserViewAndPasswordDp); if (state.has_pin_input) return SizeFromHeight(kDistanceBetweenUserViewAndPinInputDp); if (state.force_online_sign_in) return SizeFromHeight(kDistanceBetweenUserViewAndOnlineSigninDp); if (state.has_challenge_response) return SizeFromHeight(kDistanceBetweenUserViewAndChallengeResponseDp); return SizeFromHeight(0); } gfx::Size LoginAuthUserView::GetPaddingBelowPasswordView() const { const UiState state{this}; if (state.has_pinpad) return SizeFromHeight(kDistanceBetweenPasswordFieldAndPinKeyboardDp); if (state.has_fingerprint) return SizeFromHeight(kDistanceBetweenPasswordFieldAndFingerprintViewDp); if (state.has_challenge_response) return SizeFromHeight(kDistanceBetweenPwdFieldAndChallengeResponseViewDp); return SizeFromHeight(0); } base::string16 LoginAuthUserView::GetPinPasswordToggleText() { if (input_field_mode_ == InputFieldMode::PWD_WITH_TOGGLE) return l10n_util::GetStringUTF16(IDS_ASH_LOGIN_SWITCH_TO_PIN); else return l10n_util::GetStringUTF16(IDS_ASH_LOGIN_SWITCH_TO_PASSWORD); } base::string16 LoginAuthUserView::GetPasswordViewPlaceholder() const { // Note: |AUTH_TAP| must have higher priority than |AUTH_PIN| when // determining the placeholder. if (HasAuthMethod(AUTH_TAP)) return l10n_util::GetStringUTF16( IDS_ASH_LOGIN_POD_PASSWORD_TAP_PLACEHOLDER); if (input_field_mode_ == InputFieldMode::PIN_AND_PASSWORD) return l10n_util::GetStringUTF16( IDS_ASH_LOGIN_POD_PASSWORD_PIN_PLACEHOLDER); return l10n_util::GetStringUTF16(IDS_ASH_LOGIN_POD_PASSWORD_PLACEHOLDER); } } // namespace ash ",16232,True,2799.8098347798605,median "CLASS zcl_abapgit_object_fugr DEFINITION PUBLIC INHERITING FROM zcl_abapgit_objects_program FINAL. PUBLIC SECTION. INTERFACES zif_abapgit_object. ALIASES mo_files FOR zif_abapgit_object~mo_files. PROTECTED SECTION. PRIVATE SECTION. TYPES: ty_rs38l_incl_tt TYPE STANDARD TABLE OF rs38l_incl WITH DEFAULT KEY . TYPES: BEGIN OF ty_function, funcname TYPE rs38l_fnam, global_flag TYPE rs38l-global, remote_call TYPE rs38l-remote, update_task TYPE rs38l-utask, short_text TYPE tftit-stext, remote_basxml TYPE rs38l-basxml_enabled, import TYPE STANDARD TABLE OF rsimp WITH DEFAULT KEY, changing TYPE STANDARD TABLE OF rscha WITH DEFAULT KEY, export TYPE STANDARD TABLE OF rsexp WITH DEFAULT KEY, tables TYPE STANDARD TABLE OF rstbl WITH DEFAULT KEY, exception TYPE STANDARD TABLE OF rsexc WITH DEFAULT KEY, documentation TYPE STANDARD TABLE OF rsfdo WITH DEFAULT KEY, exception_classes TYPE abap_bool, END OF ty_function . TYPES: ty_function_tt TYPE STANDARD TABLE OF ty_function WITH DEFAULT KEY . TYPES: ty_sobj_name_tt TYPE STANDARD TABLE OF sobj_name WITH DEFAULT KEY . TYPES: BEGIN OF ty_tpool_i18n, language TYPE langu, textpool TYPE zif_abapgit_definitions=>ty_tpool_tt, END OF ty_tpool_i18n . TYPES: tt_tpool_i18n TYPE STANDARD TABLE OF ty_tpool_i18n . METHODS check_rfc_parameters IMPORTING !is_function TYPE ty_function RAISING zcx_abapgit_exception . METHODS update_where_used IMPORTING !it_includes TYPE ty_sobj_name_tt . METHODS main_name RETURNING VALUE(rv_program) TYPE program RAISING zcx_abapgit_exception . METHODS functions RETURNING VALUE(rt_functab) TYPE ty_rs38l_incl_tt RAISING zcx_abapgit_exception . METHODS includes RETURNING VALUE(rt_includes) TYPE ty_sobj_name_tt RAISING zcx_abapgit_exception . METHODS serialize_functions RETURNING VALUE(rt_functions) TYPE ty_function_tt RAISING zcx_abapgit_exception . METHODS deserialize_functions IMPORTING !it_functions TYPE ty_function_tt !ii_log TYPE REF TO zif_abapgit_log RAISING zcx_abapgit_exception . METHODS serialize_xml IMPORTING !io_xml TYPE REF TO zcl_abapgit_xml_output RAISING zcx_abapgit_exception . METHODS deserialize_xml IMPORTING !io_xml TYPE REF TO zcl_abapgit_xml_input !iv_package TYPE devclass RAISING zcx_abapgit_exception . METHODS serialize_includes RAISING zcx_abapgit_exception . METHODS deserialize_includes IMPORTING !io_xml TYPE REF TO zcl_abapgit_xml_input !iv_package TYPE devclass !ii_log TYPE REF TO zif_abapgit_log RAISING zcx_abapgit_exception . METHODS are_exceptions_class_based IMPORTING !iv_function_name TYPE rs38l_fnam RETURNING VALUE(rv_return) TYPE abap_bool RAISING zcx_abapgit_exception . METHODS is_function_group_locked RETURNING VALUE(rv_is_functions_group_locked) TYPE abap_bool RAISING zcx_abapgit_exception . METHODS is_any_include_locked RETURNING VALUE(rv_is_any_include_locked) TYPE abap_bool RAISING zcx_abapgit_exception . METHODS is_any_function_module_locked RETURNING VALUE(rv_any_function_module_locked) TYPE abap_bool RAISING zcx_abapgit_exception . METHODS get_abap_version IMPORTING !io_xml TYPE REF TO zcl_abapgit_xml_input RETURNING VALUE(rv_abap_version) TYPE progdir-uccheck RAISING zcx_abapgit_exception . METHODS update_func_group_short_text IMPORTING !iv_group TYPE rs38l-area !iv_short_text TYPE tftit-stext . METHODS serialize_texts IMPORTING !iv_prog_name TYPE programm !io_xml TYPE REF TO zcl_abapgit_xml_output RAISING zcx_abapgit_exception . METHODS deserialize_texts IMPORTING !iv_prog_name TYPE programm !io_xml TYPE REF TO zcl_abapgit_xml_input RAISING zcx_abapgit_exception . ENDCLASS. CLASS ZCL_ABAPGIT_OBJECT_FUGR IMPLEMENTATION. METHOD are_exceptions_class_based. DATA: lt_dokumentation TYPE TABLE OF funct, lt_exception_list TYPE TABLE OF rsexc, lt_export_parameter TYPE TABLE OF rsexp, lt_import_parameter TYPE TABLE OF rsimp, lt_tables_parameter TYPE TABLE OF rstbl. CALL FUNCTION 'FUNCTION_IMPORT_DOKU' EXPORTING funcname = iv_function_name IMPORTING exception_class = rv_return TABLES dokumentation = lt_dokumentation exception_list = lt_exception_list export_parameter = lt_export_parameter import_parameter = lt_import_parameter tables_parameter = lt_tables_parameter EXCEPTIONS error_message = 1 function_not_found = 2 invalid_name = 3 OTHERS = 4. IF sy-subrc <> 0. zcx_abapgit_exception=>raise( 'Error from FUNCTION_IMPORT_DOKU' ). ENDIF. ENDMETHOD. METHOD check_rfc_parameters. * function module RS_FUNCTIONMODULE_INSERT does the same deep down, but the right error * message is not returned to the user, this is a workaround to give a proper error * message to the user DATA: ls_parameter TYPE rsfbpara, lt_fupa TYPE rsfb_param, ls_fupa LIKE LINE OF lt_fupa. IF is_function-remote_call = 'R'. cl_fb_parameter_conversion=>convert_parameter_old_to_fupa( EXPORTING functionname = is_function-funcname import = is_function-import export = is_function-export change = is_function-changing tables = is_function-tables except = is_function-exception IMPORTING fupararef = lt_fupa ). LOOP AT lt_fupa INTO ls_fupa WHERE paramtype = 'I' OR paramtype = 'E' OR paramtype = 'C' OR paramtype = 'T'. cl_fb_parameter_conversion=>convert_intern_to_extern( EXPORTING parameter_db = ls_fupa IMPORTING parameter_vis = ls_parameter ). CALL FUNCTION 'RS_FB_CHECK_PARAMETER_REMOTE' EXPORTING parameter = ls_parameter basxml_enabled = is_function-remote_basxml EXCEPTIONS not_remote_compatible = 1 OTHERS = 2. IF sy-subrc <> 0. zcx_abapgit_exception=>raise_t100( ). ENDIF. ENDLOOP. ENDIF. ENDMETHOD. METHOD deserialize_functions. DATA: lv_include TYPE rs38l-include, lv_area TYPE rs38l-area, lv_group TYPE rs38l-area, lv_namespace TYPE rs38l-namespace, lt_source TYPE TABLE OF abaptxt255, lv_msg TYPE string, lx_error TYPE REF TO zcx_abapgit_exception, lv_corrnum TYPE e070use-ordernum. FIELD-SYMBOLS: LIKE LINE OF it_functions. lv_corrnum = zcl_abapgit_default_transport=>get_instance( )->get( )-ordernum. LOOP AT it_functions ASSIGNING . lt_source = mo_files->read_abap( iv_extra = -funcname ). lv_area = ms_item-obj_name. CALL FUNCTION 'FUNCTION_INCLUDE_SPLIT' EXPORTING complete_area = lv_area IMPORTING namespace = lv_namespace group = lv_group EXCEPTIONS OTHERS = 12. IF sy-subrc <> 0. MESSAGE ID sy-msgid TYPE 'S' NUMBER sy-msgno WITH sy-msgv1 sy-msgv2 sy-msgv3 sy-msgv4 INTO lv_msg. ii_log->add_error( iv_msg = |Function module { -funcname }: { lv_msg }| is_item = ms_item ). CONTINUE. ""with next function module ENDIF. CALL FUNCTION 'FUNCTION_EXISTS' EXPORTING funcname = -funcname IMPORTING include = lv_include EXCEPTIONS function_not_exist = 1. IF sy-subrc = 0. * delete the function module to make sure the parameters are updated * havent found a nice way to update the paramters CALL FUNCTION 'FUNCTION_DELETE' EXPORTING funcname = -funcname suppress_success_message = abap_true EXCEPTIONS error_message = 1 OTHERS = 2. IF sy-subrc <> 0. MESSAGE ID sy-msgid TYPE 'S' NUMBER sy-msgno WITH sy-msgv1 sy-msgv2 sy-msgv3 sy-msgv4 INTO lv_msg. ii_log->add_error( iv_msg = |Function module { -funcname }: { lv_msg }| is_item = ms_item ). CONTINUE. ""with next function module ENDIF. ENDIF. TRY. check_rfc_parameters( ). CATCH zcx_abapgit_exception INTO lx_error. ii_log->add_error( iv_msg = |Function module { -funcname }: { lx_error->get_text( ) }| is_item = ms_item ). CONTINUE. ""with next function module ENDTRY. CALL FUNCTION 'RS_FUNCTIONMODULE_INSERT' EXPORTING funcname = -funcname function_pool = lv_group interface_global = -global_flag remote_call = -remote_call short_text = -short_text update_task = -update_task exception_class = -exception_classes namespace = lv_namespace remote_basxml_supported = -remote_basxml corrnum = lv_corrnum IMPORTING function_include = lv_include TABLES import_parameter = -import export_parameter = -export tables_parameter = -tables changing_parameter = -changing exception_list = -exception parameter_docu = -documentation EXCEPTIONS double_task = 1 error_message = 2 function_already_exists = 3 invalid_function_pool = 4 invalid_name = 5 too_many_functions = 6 no_modify_permission = 7 no_show_permission = 8 enqueue_system_failure = 9 canceled_in_corr = 10 OTHERS = 11. IF sy-subrc <> 0. MESSAGE ID sy-msgid TYPE 'S' NUMBER sy-msgno WITH sy-msgv1 sy-msgv2 sy-msgv3 sy-msgv4 INTO lv_msg. ii_log->add_error( iv_msg = |Function module { -funcname }: { lv_msg }| is_item = ms_item ). CONTINUE. ""with next function module ENDIF. INSERT REPORT lv_include FROM lt_source. ii_log->add_success( iv_msg = |Function module { -funcname } imported| is_item = ms_item ). ENDLOOP. ENDMETHOD. METHOD deserialize_includes. DATA: lo_xml TYPE REF TO zcl_abapgit_xml_input, ls_progdir TYPE ty_progdir, lt_includes TYPE ty_sobj_name_tt, lt_tpool TYPE textpool_table, lt_tpool_ext TYPE zif_abapgit_definitions=>ty_tpool_tt, lt_source TYPE TABLE OF abaptxt255, lx_exc TYPE REF TO zcx_abapgit_exception. FIELD-SYMBOLS: LIKE LINE OF lt_includes. tadir_insert( iv_package ). io_xml->read( EXPORTING iv_name = 'INCLUDES' CHANGING cg_data = lt_includes ). LOOP AT lt_includes ASSIGNING . ""ignore simple transformation includes (as long as they remain in existing repositories) IF strlen( ) = 33 AND +30(3) = 'XTI'. ii_log->add_warning( iv_msg = |Simple Transformation include { } ignored| is_item = ms_item ). CONTINUE. ENDIF. TRY. lt_source = mo_files->read_abap( iv_extra = ). lo_xml = mo_files->read_xml( ). lo_xml->read( EXPORTING iv_name = 'PROGDIR' CHANGING cg_data = ls_progdir ). lo_xml->read( EXPORTING iv_name = 'TPOOL' CHANGING cg_data = lt_tpool_ext ). lt_tpool = read_tpool( lt_tpool_ext ). deserialize_program( is_progdir = ls_progdir it_source = lt_source it_tpool = lt_tpool iv_package = iv_package ). deserialize_textpool( iv_program = it_tpool = lt_tpool iv_is_include = abap_true ). ii_log->add_success( iv_msg = |Include { ls_progdir-name } imported| is_item = ms_item ). CATCH zcx_abapgit_exception INTO lx_exc. ii_log->add_exception( ix_exc = lx_exc is_item = ms_item ). CONTINUE. ENDTRY. ENDLOOP. ENDMETHOD. METHOD deserialize_texts. DATA: lt_tpool_i18n TYPE tt_tpool_i18n, lt_tpool TYPE textpool_table. FIELD-SYMBOLS LIKE LINE OF lt_tpool_i18n. io_xml->read( EXPORTING iv_name = 'I18N_TPOOL' CHANGING cg_data = lt_tpool_i18n ). LOOP AT lt_tpool_i18n ASSIGNING . lt_tpool = read_tpool( -textpool ). deserialize_textpool( iv_program = iv_prog_name iv_language = -language it_tpool = lt_tpool ). ENDLOOP. ENDMETHOD. METHOD deserialize_xml. DATA: lv_complete TYPE rs38l-area, lv_namespace TYPE rs38l-namespace, lv_areat TYPE tlibt-areat, lv_stext TYPE tftit-stext, lv_group TYPE rs38l-area, lv_abap_version TYPE trdir-uccheck, lv_corrnum TYPE e070use-ordernum. lv_abap_version = get_abap_version( io_xml ). lv_complete = ms_item-obj_name. CALL FUNCTION 'FUNCTION_INCLUDE_SPLIT' EXPORTING complete_area = lv_complete IMPORTING namespace = lv_namespace group = lv_group EXCEPTIONS include_not_exists = 1 group_not_exists = 2 no_selections = 3 no_function_include = 4 no_function_pool = 5 delimiter_wrong_position = 6 no_customer_function_group = 7 no_customer_function_include = 8 reserved_name_customer = 9 namespace_too_long = 10 area_length_error = 11 OTHERS = 12. IF sy-subrc <> 0. zcx_abapgit_exception=>raise( 'error from FUNCTION_INCLUDE_SPLIT' ). ENDIF. io_xml->read( EXPORTING iv_name = 'AREAT' CHANGING cg_data = lv_areat ). lv_stext = lv_areat. lv_corrnum = zcl_abapgit_default_transport=>get_instance( )->get( )-ordernum. CALL FUNCTION 'RS_FUNCTION_POOL_INSERT' EXPORTING function_pool = lv_group short_text = lv_stext namespace = lv_namespace devclass = iv_package unicode_checks = lv_abap_version corrnum = lv_corrnum suppress_corr_check = abap_false EXCEPTIONS name_already_exists = 1 name_not_correct = 2 function_already_exists = 3 invalid_function_pool = 4 invalid_name = 5 too_many_functions = 6 no_modify_permission = 7 no_show_permission = 8 enqueue_system_failure = 9 canceled_in_corr = 10 undefined_error = 11 OTHERS = 12. CASE sy-subrc. WHEN 0. "" Everything is ok WHEN 1 OR 3. "" If the function group exists we need to manually update the short text update_func_group_short_text( iv_group = lv_group iv_short_text = lv_stext ). WHEN OTHERS. zcx_abapgit_exception=>raise( |error from RS_FUNCTION_POOL_INSERT, code: { sy-subrc }| ). ENDCASE. ENDMETHOD. METHOD functions. DATA: lv_area TYPE rs38l-area. lv_area = ms_item-obj_name. CALL FUNCTION 'RS_FUNCTION_POOL_CONTENTS' EXPORTING function_pool = lv_area TABLES functab = rt_functab EXCEPTIONS function_pool_not_found = 1 OTHERS = 2. IF sy-subrc <> 0. zcx_abapgit_exception=>raise( 'Error from RS_FUNCTION_POOL_CONTENTS' ). ENDIF. SORT rt_functab BY funcname ASCENDING. DELETE ADJACENT DUPLICATES FROM rt_functab COMPARING funcname. ENDMETHOD. METHOD get_abap_version. DATA: lt_includes TYPE ty_sobj_name_tt, ls_progdir TYPE ty_progdir, lo_xml TYPE REF TO zcl_abapgit_xml_input. FIELD-SYMBOLS: LIKE LINE OF lt_includes. io_xml->read( EXPORTING iv_name = 'INCLUDES' CHANGING cg_data = lt_includes ). LOOP AT lt_includes ASSIGNING . lo_xml = mo_files->read_xml( ). lo_xml->read( EXPORTING iv_name = 'PROGDIR' CHANGING cg_data = ls_progdir ). IF ls_progdir-uccheck IS INITIAL. CONTINUE. ELSEIF rv_abap_version IS INITIAL. rv_abap_version = ls_progdir-uccheck. CONTINUE. ELSEIF rv_abap_version <> ls_progdir-uccheck. *** All includes need to have the same ABAP language version zcx_abapgit_exception=>raise( 'different ABAP Language Versions' ). ENDIF. ENDLOOP. IF rv_abap_version IS INITIAL. rv_abap_version = 'X'. ENDIF. ENDMETHOD. METHOD includes. TYPES: BEGIN OF ty_reposrc, progname TYPE reposrc-progname, cnam TYPE reposrc-cnam, END OF ty_reposrc. DATA: lt_reposrc TYPE STANDARD TABLE OF ty_reposrc WITH DEFAULT KEY, ls_reposrc LIKE LINE OF lt_reposrc, lv_program TYPE program, lv_maintviewname LIKE LINE OF rt_includes, lv_offset_ns TYPE i, lv_tabix LIKE sy-tabix, lt_functab TYPE ty_rs38l_incl_tt, lt_tadir_includes TYPE HASHED TABLE OF objname WITH UNIQUE KEY table_line. FIELD-SYMBOLS: LIKE LINE OF rt_includes, LIKE LINE OF lt_functab. lv_program = main_name( ). lt_functab = functions( ). CALL FUNCTION 'RS_GET_ALL_INCLUDES' EXPORTING program = lv_program * WITH_RESERVED_INCLUDES = * WITH_CLASS_INCLUDES = ' ' hmm, todo TABLES includetab = rt_includes EXCEPTIONS not_existent = 1 no_program = 2 OTHERS = 3. IF sy-subrc <> 0. zcx_abapgit_exception=>raise( 'Error from RS_GET_ALL_INCLUDES' ). ENDIF. LOOP AT lt_functab ASSIGNING . DELETE TABLE rt_includes FROM -include. ENDLOOP. * handle generated maintenance views IF ms_item-obj_name(1) <> '/'. ""FGroup name does not contain a namespace lv_maintviewname = |L{ ms_item-obj_name }T00|. ELSE. ""FGroup name contains a namespace lv_offset_ns = find( val = ms_item-obj_name+1 sub = '/' ). lv_offset_ns = lv_offset_ns + 2. lv_maintviewname = |{ ms_item-obj_name(lv_offset_ns) }L{ ms_item-obj_name+lv_offset_ns }T00|. ENDIF. READ TABLE rt_includes WITH KEY table_line = lv_maintviewname TRANSPORTING NO FIELDS. IF sy-subrc <> 0. APPEND lv_maintviewname TO rt_includes. ENDIF. IF lines( rt_includes ) > 0. "" check which includes have their own tadir entry "" these includes might reside in a different package or might be shared between multiple function groups "" or other programs and are hence no part of the to serialized FUGR object "" they will be handled as individual objects when serializing their package "" in addition, referenced XTI includes referencing (simple) transformations must be ignored SELECT obj_name INTO TABLE lt_tadir_includes FROM tadir FOR ALL ENTRIES IN rt_includes WHERE pgmid = 'R3TR' AND object = 'PROG' AND obj_name = rt_includes-table_line. LOOP AT rt_includes ASSIGNING . "" skip autogenerated includes from Table Maintenance Generator IF CP 'LSVIM*'. DELETE rt_includes INDEX sy-tabix. CONTINUE. ENDIF. READ TABLE lt_tadir_includes WITH KEY table_line = TRANSPORTING NO FIELDS. IF sy-subrc = 0. DELETE rt_includes. CONTINUE. ENDIF. IF strlen( ) = 33 AND +30(3) = 'XTI'. ""ignore referenced (simple) transformation includes DELETE rt_includes. CONTINUE. ENDIF. ENDLOOP. SELECT progname cnam FROM reposrc INTO TABLE lt_reposrc FOR ALL ENTRIES IN rt_includes WHERE progname = rt_includes-table_line AND r3state = 'A'. SORT lt_reposrc BY progname ASCENDING. ENDIF. LOOP AT rt_includes ASSIGNING . lv_tabix = sy-tabix. * make sure the include exists READ TABLE lt_reposrc INTO ls_reposrc WITH KEY progname = BINARY SEARCH. IF sy-subrc <> 0. DELETE rt_includes INDEX lv_tabix. ENDIF. ENDLOOP. APPEND lv_program TO rt_includes. ENDMETHOD. METHOD is_any_function_module_locked. DATA: lt_functions TYPE ty_rs38l_incl_tt. FIELD-SYMBOLS: TYPE rs38l_incl. TRY. lt_functions = functions( ). CATCH zcx_abapgit_exception. RETURN. ENDTRY. LOOP AT lt_functions ASSIGNING . IF exists_a_lock_entry_for( iv_lock_object = 'ESFUNCTION' iv_argument = |{ -funcname }| ) = abap_true. rv_any_function_module_locked = abap_true. EXIT. ENDIF. ENDLOOP. ENDMETHOD. METHOD is_any_include_locked. DATA: lt_includes TYPE ty_sobj_name_tt. FIELD-SYMBOLS: TYPE sobj_name. TRY. lt_includes = includes( ). CATCH zcx_abapgit_exception. RETURN. ENDTRY. LOOP AT lt_includes ASSIGNING . IF exists_a_lock_entry_for( iv_lock_object = 'ESRDIRE' iv_argument = |{ }| ) = abap_true. rv_is_any_include_locked = abap_true. EXIT. ENDIF. ENDLOOP. ENDMETHOD. METHOD is_function_group_locked. DATA: lv_object TYPE eqegraarg. lv_object = |FG{ ms_item-obj_name }|. OVERLAY lv_object WITH ' '. lv_object = lv_object && '*'. rv_is_functions_group_locked = exists_a_lock_entry_for( iv_lock_object = 'EEUDB' iv_argument = lv_object ). ENDMETHOD. METHOD main_name. DATA: lv_area TYPE rs38l-area, lv_namespace TYPE rs38l-namespace, lv_group TYPE rs38l-area. lv_area = ms_item-obj_name. CALL FUNCTION 'FUNCTION_INCLUDE_SPLIT' EXPORTING complete_area = lv_area IMPORTING namespace = lv_namespace group = lv_group EXCEPTIONS include_not_exists = 1 group_not_exists = 2 no_selections = 3 no_function_include = 4 no_function_pool = 5 delimiter_wrong_position = 6 no_customer_function_group = 7 no_customer_function_include = 8 reserved_name_customer = 9 namespace_too_long = 10 area_length_error = 11 OTHERS = 12. IF sy-subrc <> 0. zcx_abapgit_exception=>raise( 'Error from FUNCTION_INCLUDE_SPLIT' ). ENDIF. CONCATENATE lv_namespace 'SAPL' lv_group INTO rv_program. ENDMETHOD. METHOD serialize_functions. DATA: lt_source TYPE TABLE OF rssource, lt_functab TYPE ty_rs38l_incl_tt, lt_new_source TYPE rsfb_source, ls_function LIKE LINE OF rt_functions. FIELD-SYMBOLS: LIKE LINE OF lt_functab, TYPE LINE OF ty_function-documentation. lt_functab = functions( ). LOOP AT lt_functab ASSIGNING . * fm RPY_FUNCTIONMODULE_READ does not support source code * lines longer than 72 characters CLEAR ls_function. MOVE-CORRESPONDING TO ls_function. CLEAR lt_new_source. CLEAR lt_source. CALL FUNCTION 'RPY_FUNCTIONMODULE_READ_NEW' EXPORTING functionname = -funcname IMPORTING global_flag = ls_function-global_flag remote_call = ls_function-remote_call update_task = ls_function-update_task short_text = ls_function-short_text remote_basxml_supported = ls_function-remote_basxml TABLES import_parameter = ls_function-import changing_parameter = ls_function-changing export_parameter = ls_function-export tables_parameter = ls_function-tables exception_list = ls_function-exception documentation = ls_function-documentation source = lt_source CHANGING new_source = lt_new_source EXCEPTIONS error_message = 1 function_not_found = 2 invalid_name = 3 OTHERS = 4. IF sy-subrc = 2. CONTINUE. ELSEIF sy-subrc <> 0. zcx_abapgit_exception=>raise( 'Error from RPY_FUNCTIONMODULE_READ_NEW' ). ENDIF. LOOP AT ls_function-documentation ASSIGNING . CLEAR -index. ENDLOOP. ls_function-exception_classes = are_exceptions_class_based( -funcname ). APPEND ls_function TO rt_functions. IF NOT lt_new_source IS INITIAL. mo_files->add_abap( iv_extra = -funcname it_abap = lt_new_source ). ELSE. mo_files->add_abap( iv_extra = -funcname it_abap = lt_source ). ENDIF. ENDLOOP. ENDMETHOD. METHOD serialize_includes. DATA: lt_includes TYPE ty_sobj_name_tt. FIELD-SYMBOLS: LIKE LINE OF lt_includes. lt_includes = includes( ). LOOP AT lt_includes ASSIGNING . * todo, filename is not correct, a include can be used in several programs serialize_program( is_item = ms_item io_files = mo_files iv_program = iv_extra = ). ENDLOOP. ENDMETHOD. METHOD serialize_texts. DATA: lt_tpool_i18n TYPE tt_tpool_i18n, lt_tpool TYPE textpool_table. FIELD-SYMBOLS LIKE LINE OF lt_tpool_i18n. IF io_xml->i18n_params( )-serialize_master_lang_only = abap_true. RETURN. ENDIF. "" Table d010tinf stores info. on languages in which program is maintained "" Select all active translations of program texts "" Skip master language - it was already serialized SELECT DISTINCT language INTO CORRESPONDING FIELDS OF TABLE lt_tpool_i18n FROM d010tinf WHERE r3state = 'A' AND prog = iv_prog_name AND language <> mv_language ##TOO_MANY_ITAB_FIELDS. SORT lt_tpool_i18n BY language ASCENDING. LOOP AT lt_tpool_i18n ASSIGNING . READ TEXTPOOL iv_prog_name LANGUAGE -language INTO lt_tpool. -textpool = add_tpool( lt_tpool ). ENDLOOP. IF lines( lt_tpool_i18n ) > 0. io_xml->add( iv_name = 'I18N_TPOOL' ig_data = lt_tpool_i18n ). ENDIF. ENDMETHOD. METHOD serialize_xml. DATA: lt_includes TYPE ty_sobj_name_tt, lv_areat TYPE tlibt-areat. SELECT SINGLE areat INTO lv_areat FROM tlibt WHERE spras = mv_language AND area = ms_item-obj_name. ""#EC CI_GENBUFF ""#EC CI_SUBRC lt_includes = includes( ). io_xml->add( iv_name = 'AREAT' ig_data = lv_areat ). io_xml->add( iv_name = 'INCLUDES' ig_data = lt_includes ). ENDMETHOD. METHOD update_func_group_short_text. "" We update the short text directly. "" SE80 does the same in "" Program SAPLSEUF / LSEUFF07 "" FORM GROUP_CHANGE UPDATE tlibt SET areat = iv_short_text WHERE spras = mv_language AND area = iv_group. ENDMETHOD. METHOD update_where_used. * make extra sure the where-used list is updated after deletion * Experienced some problems with the T00 include * this method just tries to update everything DATA: lv_include LIKE LINE OF it_includes, lo_cross TYPE REF TO cl_wb_crossreference. LOOP AT it_includes INTO lv_include. CREATE OBJECT lo_cross EXPORTING p_name = lv_include p_include = lv_include. lo_cross->index_actualize( ). ENDLOOP. ENDMETHOD. METHOD zif_abapgit_object~changed_by. TYPES: BEGIN OF ty_stamps, user TYPE xubname, date TYPE d, time TYPE t, END OF ty_stamps. DATA: lt_stamps TYPE STANDARD TABLE OF ty_stamps WITH DEFAULT KEY, lv_program TYPE program, lt_includes TYPE ty_sobj_name_tt. FIELD-SYMBOLS: LIKE LINE OF lt_stamps, LIKE LINE OF lt_includes. lv_program = main_name( ). CALL FUNCTION 'RS_GET_ALL_INCLUDES' EXPORTING program = lv_program TABLES includetab = lt_includes EXCEPTIONS not_existent = 1 no_program = 2 OTHERS = 3. IF sy-subrc <> 0. zcx_abapgit_exception=>raise( 'Error from RS_GET_ALL_INCLUDES' ). ENDIF. SELECT unam AS user udat AS date utime AS time FROM reposrc APPENDING CORRESPONDING FIELDS OF TABLE lt_stamps WHERE progname = lv_program AND r3state = 'A'. ""#EC CI_SUBRC LOOP AT lt_includes ASSIGNING . SELECT unam AS user udat AS date utime AS time FROM reposrc APPENDING CORRESPONDING FIELDS OF TABLE lt_stamps WHERE progname = AND r3state = 'A'. ""#EC CI_SUBRC ENDLOOP. SELECT unam AS user udat AS date utime AS time FROM repotext "" Program text pool APPENDING CORRESPONDING FIELDS OF TABLE lt_stamps WHERE progname = lv_program AND r3state = 'A'. ""#EC CI_SUBRC SELECT vautor AS user vdatum AS date vzeit AS time FROM eudb "" GUI APPENDING CORRESPONDING FIELDS OF TABLE lt_stamps WHERE relid = 'CU' AND name = lv_program AND srtf2 = 0 ##TOO_MANY_ITAB_FIELDS. * Screens: username not stored in D020S database table SORT lt_stamps BY date DESCENDING time DESCENDING. READ TABLE lt_stamps INDEX 1 ASSIGNING . IF sy-subrc = 0. rv_user = -user. ELSE. rv_user = c_user_unknown. ENDIF. ENDMETHOD. METHOD zif_abapgit_object~delete. DATA: lv_area TYPE rs38l-area, lt_includes TYPE ty_sobj_name_tt, lv_corrnum TYPE e070use-ordernum. lt_includes = includes( ). lv_area = ms_item-obj_name. lv_corrnum = zcl_abapgit_default_transport=>get_instance( )->get( )-ordernum. CALL FUNCTION 'RS_FUNCTION_POOL_DELETE' EXPORTING area = lv_area suppress_popups = abap_true skip_progress_ind = abap_true corrnum = lv_corrnum EXCEPTIONS canceled_in_corr = 1 enqueue_system_failure = 2 function_exist = 3 not_executed = 4 no_modify_permission = 5 no_show_permission = 6 permission_failure = 7 pool_not_exist = 8 cancelled = 9 OTHERS = 10. IF sy-subrc <> 0. zcx_abapgit_exception=>raise( 'error from RS_FUNCTION_POOL_DELETE' ). ENDIF. update_where_used( lt_includes ). ENDMETHOD. METHOD zif_abapgit_object~deserialize. DATA: lv_program_name TYPE programm, lt_functions TYPE ty_function_tt, lt_dynpros TYPE ty_dynpro_tt, ls_cua TYPE ty_cua. deserialize_xml( io_xml = io_xml iv_package = iv_package ). io_xml->read( EXPORTING iv_name = 'FUNCTIONS' CHANGING cg_data = lt_functions ). deserialize_functions( it_functions = lt_functions ii_log = ii_log ). deserialize_includes( io_xml = io_xml iv_package = iv_package ii_log = ii_log ). lv_program_name = main_name( ). deserialize_texts( iv_prog_name = lv_program_name io_xml = io_xml ). io_xml->read( EXPORTING iv_name = 'DYNPROS' CHANGING cg_data = lt_dynpros ). deserialize_dynpros( lt_dynpros ). io_xml->read( EXPORTING iv_name = 'CUA' CHANGING cg_data = ls_cua ). deserialize_cua( iv_program_name = lv_program_name is_cua = ls_cua ). ENDMETHOD. METHOD zif_abapgit_object~exists. DATA: lv_pool TYPE tlibg-area. lv_pool = ms_item-obj_name. CALL FUNCTION 'RS_FUNCTION_POOL_EXISTS' EXPORTING function_pool = lv_pool EXCEPTIONS pool_not_exists = 1. rv_bool = boolc( sy-subrc <> 1 ). ENDMETHOD. METHOD zif_abapgit_object~get_comparator. RETURN. ENDMETHOD. METHOD zif_abapgit_object~get_deserialize_steps. APPEND zif_abapgit_object=>gc_step_id-abap TO rt_steps. ENDMETHOD. METHOD zif_abapgit_object~get_metadata. rs_metadata = get_metadata( ). ENDMETHOD. METHOD zif_abapgit_object~is_active. rv_active = is_active( ). ENDMETHOD. METHOD zif_abapgit_object~is_locked. DATA: lv_program TYPE program. lv_program = main_name( ). IF is_function_group_locked( ) = abap_true OR is_any_include_locked( ) = abap_true OR is_any_function_module_locked( ) = abap_true OR is_any_dynpro_locked( lv_program ) = abap_true OR is_cua_locked( lv_program ) = abap_true OR is_text_locked( lv_program ) = abap_true. rv_is_locked = abap_true. ENDIF. ENDMETHOD. METHOD zif_abapgit_object~jump. CALL FUNCTION 'RS_TOOL_ACCESS' EXPORTING operation = 'SHOW' object_name = ms_item-obj_name object_type = 'FUGR' in_new_window = abap_true. ENDMETHOD. METHOD zif_abapgit_object~serialize. * function group SEUF * function group SIFP * function group SUNI DATA: lt_functions TYPE ty_function_tt, ls_progdir TYPE ty_progdir, lv_program_name TYPE programm, lt_dynpros TYPE ty_dynpro_tt, ls_cua TYPE ty_cua. IF zif_abapgit_object~exists( ) = abap_false. RETURN. ENDIF. serialize_xml( io_xml ). lt_functions = serialize_functions( ). io_xml->add( iv_name = 'FUNCTIONS' ig_data = lt_functions ). serialize_includes( ). lv_program_name = main_name( ). ls_progdir = read_progdir( lv_program_name ). serialize_texts( iv_prog_name = lv_program_name io_xml = io_xml ). IF ls_progdir-subc = 'F'. lt_dynpros = serialize_dynpros( lv_program_name ). io_xml->add( iv_name = 'DYNPROS' ig_data = lt_dynpros ). ls_cua = serialize_cua( lv_program_name ). io_xml->add( iv_name = 'CUA' ig_data = ls_cua ). ENDIF. ENDMETHOD. ENDCLASS. ",9231,False,1880.1414151067568,median "/*************************************************************************/ /* particles_material.cpp */ /*************************************************************************/ /* This file is part of: */ /* GODOT ENGINE */ /* https://godotengine.org */ /*************************************************************************/ /* Copyright (c) 2007-2020 Juan Linietsky, Ariel Manzur. */ /* Copyright (c) 2014-2020 Godot Engine contributors (cf. AUTHORS.md). */ /* */ /* Permission is hereby granted, free of charge, to any person obtaining */ /* a copy of this software and associated documentation files (the */ /* ""Software""), to deal in the Software without restriction, including */ /* without limitation the rights to use, copy, modify, merge, publish, */ /* distribute, sublicense, and/or sell copies of the Software, and to */ /* permit persons to whom the Software is furnished to do so, subject to */ /* the following conditions: */ /* */ /* The above copyright notice and this permission notice shall be */ /* included in all copies or substantial portions of the Software. */ /* */ /* THE SOFTWARE IS PROVIDED ""AS IS"", WITHOUT WARRANTY OF ANY KIND, */ /* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF */ /* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.*/ /* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY */ /* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, */ /* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE */ /* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */ /*************************************************************************/ #include ""particles_material.h"" Mutex ParticlesMaterial::material_mutex; SelfList::List *ParticlesMaterial::dirty_materials = nullptr; Map ParticlesMaterial::shader_map; ParticlesMaterial::ShaderNames *ParticlesMaterial::shader_names = nullptr; void ParticlesMaterial::init_shaders() { dirty_materials = memnew(SelfList::List); shader_names = memnew(ShaderNames); shader_names->direction = ""direction""; shader_names->spread = ""spread""; shader_names->flatness = ""flatness""; shader_names->initial_linear_velocity = ""initial_linear_velocity""; shader_names->initial_angle = ""initial_angle""; shader_names->angular_velocity = ""angular_velocity""; shader_names->orbit_velocity = ""orbit_velocity""; shader_names->linear_accel = ""linear_accel""; shader_names->radial_accel = ""radial_accel""; shader_names->tangent_accel = ""tangent_accel""; shader_names->damping = ""damping""; shader_names->scale = ""scale""; shader_names->hue_variation = ""hue_variation""; shader_names->anim_speed = ""anim_speed""; shader_names->anim_offset = ""anim_offset""; shader_names->initial_linear_velocity_random = ""initial_linear_velocity_random""; shader_names->initial_angle_random = ""initial_angle_random""; shader_names->angular_velocity_random = ""angular_velocity_random""; shader_names->orbit_velocity_random = ""orbit_velocity_random""; shader_names->linear_accel_random = ""linear_accel_random""; shader_names->radial_accel_random = ""radial_accel_random""; shader_names->tangent_accel_random = ""tangent_accel_random""; shader_names->damping_random = ""damping_random""; shader_names->scale_random = ""scale_random""; shader_names->hue_variation_random = ""hue_variation_random""; shader_names->anim_speed_random = ""anim_speed_random""; shader_names->anim_offset_random = ""anim_offset_random""; shader_names->angle_texture = ""angle_texture""; shader_names->angular_velocity_texture = ""angular_velocity_texture""; shader_names->orbit_velocity_texture = ""orbit_velocity_texture""; shader_names->linear_accel_texture = ""linear_accel_texture""; shader_names->radial_accel_texture = ""radial_accel_texture""; shader_names->tangent_accel_texture = ""tangent_accel_texture""; shader_names->damping_texture = ""damping_texture""; shader_names->scale_texture = ""scale_texture""; shader_names->hue_variation_texture = ""hue_variation_texture""; shader_names->anim_speed_texture = ""anim_speed_texture""; shader_names->anim_offset_texture = ""anim_offset_texture""; shader_names->color = ""color_value""; shader_names->color_ramp = ""color_ramp""; shader_names->emission_sphere_radius = ""emission_sphere_radius""; shader_names->emission_box_extents = ""emission_box_extents""; shader_names->emission_texture_point_count = ""emission_texture_point_count""; shader_names->emission_texture_points = ""emission_texture_points""; shader_names->emission_texture_normal = ""emission_texture_normal""; shader_names->emission_texture_color = ""emission_texture_color""; shader_names->trail_divisor = ""trail_divisor""; shader_names->trail_size_modifier = ""trail_size_modifier""; shader_names->trail_color_modifier = ""trail_color_modifier""; shader_names->gravity = ""gravity""; shader_names->lifetime_randomness = ""lifetime_randomness""; } void ParticlesMaterial::finish_shaders() { memdelete(dirty_materials); dirty_materials = nullptr; memdelete(shader_names); } void ParticlesMaterial::_update_shader() { dirty_materials->remove(&element); MaterialKey mk = _compute_key(); if (mk.key == current_key.key) return; //no update required in the end if (shader_map.has(current_key)) { shader_map[current_key].users--; if (shader_map[current_key].users == 0) { //deallocate shader, as it's no longer in use RS::get_singleton()->free(shader_map[current_key].shader); shader_map.erase(current_key); } } current_key = mk; if (shader_map.has(mk)) { RS::get_singleton()->material_set_shader(_get_material(), shader_map[mk].shader); shader_map[mk].users++; return; } //must create a shader! String code = ""shader_type particles;\\n""; code += ""uniform vec3 direction;\\n""; code += ""uniform float spread;\\n""; code += ""uniform float flatness;\\n""; code += ""uniform float initial_linear_velocity;\\n""; code += ""uniform float initial_angle;\\n""; code += ""uniform float angular_velocity;\\n""; code += ""uniform float orbit_velocity;\\n""; code += ""uniform float linear_accel;\\n""; code += ""uniform float radial_accel;\\n""; code += ""uniform float tangent_accel;\\n""; code += ""uniform float damping;\\n""; code += ""uniform float scale;\\n""; code += ""uniform float hue_variation;\\n""; code += ""uniform float anim_speed;\\n""; code += ""uniform float anim_offset;\\n""; code += ""uniform float initial_linear_velocity_random;\\n""; code += ""uniform float initial_angle_random;\\n""; code += ""uniform float angular_velocity_random;\\n""; code += ""uniform float orbit_velocity_random;\\n""; code += ""uniform float linear_accel_random;\\n""; code += ""uniform float radial_accel_random;\\n""; code += ""uniform float tangent_accel_random;\\n""; code += ""uniform float damping_random;\\n""; code += ""uniform float scale_random;\\n""; code += ""uniform float hue_variation_random;\\n""; code += ""uniform float anim_speed_random;\\n""; code += ""uniform float anim_offset_random;\\n""; code += ""uniform float lifetime_randomness;\\n""; switch (emission_shape) { case EMISSION_SHAPE_POINT: { //do none } break; case EMISSION_SHAPE_SPHERE: { code += ""uniform float emission_sphere_radius;\\n""; } break; case EMISSION_SHAPE_BOX: { code += ""uniform vec3 emission_box_extents;\\n""; } break; case EMISSION_SHAPE_DIRECTED_POINTS: { code += ""uniform sampler2D emission_texture_normal : hint_black;\\n""; [[fallthrough]]; } case EMISSION_SHAPE_POINTS: { code += ""uniform sampler2D emission_texture_points : hint_black;\\n""; code += ""uniform int emission_texture_point_count;\\n""; if (emission_color_texture.is_valid()) { code += ""uniform sampler2D emission_texture_color : hint_white;\\n""; } } break; case EMISSION_SHAPE_MAX: { // Max value for validity check. break; } } code += ""uniform vec4 color_value : hint_color;\\n""; code += ""uniform int trail_divisor;\\n""; code += ""uniform vec3 gravity;\\n""; if (color_ramp.is_valid()) code += ""uniform sampler2D color_ramp;\\n""; if (tex_parameters[PARAM_INITIAL_LINEAR_VELOCITY].is_valid()) code += ""uniform sampler2D linear_velocity_texture;\\n""; if (tex_parameters[PARAM_ORBIT_VELOCITY].is_valid()) code += ""uniform sampler2D orbit_velocity_texture;\\n""; if (tex_parameters[PARAM_ANGULAR_VELOCITY].is_valid()) code += ""uniform sampler2D angular_velocity_texture;\\n""; if (tex_parameters[PARAM_LINEAR_ACCEL].is_valid()) code += ""uniform sampler2D linear_accel_texture;\\n""; if (tex_parameters[PARAM_RADIAL_ACCEL].is_valid()) code += ""uniform sampler2D radial_accel_texture;\\n""; if (tex_parameters[PARAM_TANGENTIAL_ACCEL].is_valid()) code += ""uniform sampler2D tangent_accel_texture;\\n""; if (tex_parameters[PARAM_DAMPING].is_valid()) code += ""uniform sampler2D damping_texture;\\n""; if (tex_parameters[PARAM_ANGLE].is_valid()) code += ""uniform sampler2D angle_texture;\\n""; if (tex_parameters[PARAM_SCALE].is_valid()) code += ""uniform sampler2D scale_texture;\\n""; if (tex_parameters[PARAM_HUE_VARIATION].is_valid()) code += ""uniform sampler2D hue_variation_texture;\\n""; if (tex_parameters[PARAM_ANIM_SPEED].is_valid()) code += ""uniform sampler2D anim_speed_texture;\\n""; if (tex_parameters[PARAM_ANIM_OFFSET].is_valid()) code += ""uniform sampler2D anim_offset_texture;\\n""; if (trail_size_modifier.is_valid()) { code += ""uniform sampler2D trail_size_modifier;\\n""; } if (trail_color_modifier.is_valid()) { code += ""uniform sampler2D trail_color_modifier;\\n""; } //need a random function code += ""\\n\\n""; code += ""float rand_from_seed(inout uint seed) {\\n""; code += "" int k;\\n""; code += "" int s = int(seed);\\n""; code += "" if (s == 0)\\n""; code += "" s = 305420679;\\n""; code += "" k = s / 127773;\\n""; code += "" s = 16807 * (s - k * 127773) - 2836 * k;\\n""; code += "" if (s < 0)\\n""; code += "" s += 2147483647;\\n""; code += "" seed = uint(s);\\n""; code += "" return float(seed % uint(65536)) / 65535.0;\\n""; code += ""}\\n""; code += ""\\n""; code += ""float rand_from_seed_m1_p1(inout uint seed) {\\n""; code += "" return rand_from_seed(seed) * 2.0 - 1.0;\\n""; code += ""}\\n""; code += ""\\n""; //improve seed quality code += ""uint hash(uint x) {\\n""; code += "" x = ((x >> uint(16)) ^ x) * uint(73244475);\\n""; code += "" x = ((x >> uint(16)) ^ x) * uint(73244475);\\n""; code += "" x = (x >> uint(16)) ^ x;\\n""; code += "" return x;\\n""; code += ""}\\n""; code += ""\\n""; code += ""void vertex() {\\n""; code += "" uint base_number = NUMBER / uint(trail_divisor);\\n""; code += "" uint alt_seed = hash(base_number + uint(1) + RANDOM_SEED);\\n""; code += "" float angle_rand = rand_from_seed(alt_seed);\\n""; code += "" float scale_rand = rand_from_seed(alt_seed);\\n""; code += "" float hue_rot_rand = rand_from_seed(alt_seed);\\n""; code += "" float anim_offset_rand = rand_from_seed(alt_seed);\\n""; code += "" float pi = 3.14159;\\n""; code += "" float degree_to_rad = pi / 180.0;\\n""; code += ""\\n""; if (emission_shape == EMISSION_SHAPE_POINTS || emission_shape == EMISSION_SHAPE_DIRECTED_POINTS) { code += "" int point = min(emission_texture_point_count - 1, int(rand_from_seed(alt_seed) * float(emission_texture_point_count)));\\n""; code += "" ivec2 emission_tex_size = textureSize(emission_texture_points, 0);\\n""; code += "" ivec2 emission_tex_ofs = ivec2(point % emission_tex_size.x, point / emission_tex_size.x);\\n""; } code += "" bool restart = false;\\n""; code += "" if (CUSTOM.y > CUSTOM.w) {\\n""; code += "" restart = true;\\n""; code += "" }\\n\\n""; code += "" if (RESTART || restart) {\\n""; if (tex_parameters[PARAM_INITIAL_LINEAR_VELOCITY].is_valid()) code += "" float tex_linear_velocity = textureLod(linear_velocity_texture, vec2(0.0, 0.0), 0.0).r;\\n""; else code += "" float tex_linear_velocity = 0.0;\\n""; if (tex_parameters[PARAM_ANGLE].is_valid()) code += "" float tex_angle = textureLod(angle_texture, vec2(0.0, 0.0), 0.0).r;\\n""; else code += "" float tex_angle = 0.0;\\n""; if (tex_parameters[PARAM_ANIM_OFFSET].is_valid()) code += "" float tex_anim_offset = textureLod(anim_offset_texture, vec2(0.0, 0.0), 0.0).r;\\n""; else code += "" float tex_anim_offset = 0.0;\\n""; code += "" float spread_rad = spread * degree_to_rad;\\n""; if (flags[FLAG_DISABLE_Z]) { code += "" float angle1_rad = rand_from_seed_m1_p1(alt_seed) * spread_rad;\\n""; code += "" angle1_rad += direction.x != 0.0 ? atan(direction.y, direction.x) : sign(direction.y) * (pi / 2.0);\\n""; code += "" vec3 rot = vec3(cos(angle1_rad), sin(angle1_rad), 0.0);\\n""; code += "" VELOCITY = rot * initial_linear_velocity * mix(1.0, rand_from_seed(alt_seed), initial_linear_velocity_random);\\n""; } else { //initiate velocity spread in 3D code += "" float angle1_rad = rand_from_seed_m1_p1(alt_seed) * spread_rad;\\n""; code += "" float angle2_rad = rand_from_seed_m1_p1(alt_seed) * spread_rad * (1.0 - flatness);\\n""; code += "" angle1_rad += direction.z != 0.0 ? atan(direction.x, direction.z) : sign(direction.x) * (pi / 2.0);\\n""; code += "" angle2_rad += direction.z != 0.0 ? atan(direction.y, abs(direction.z)) : (direction.x != 0.0 ? atan(direction.y, abs(direction.x)) : sign(direction.y) * (pi / 2.0));\\n""; code += "" vec3 direction_xz = vec3(sin(angle1_rad), 0.0, cos(angle1_rad));\\n""; code += "" vec3 direction_yz = vec3(0.0, sin(angle2_rad), cos(angle2_rad));\\n""; code += "" direction_yz.z = direction_yz.z / max(0.0001,sqrt(abs(direction_yz.z))); // better uniform distribution\\n""; code += "" vec3 vec_direction = vec3(direction_xz.x * direction_yz.z, direction_yz.y, direction_xz.z * direction_yz.z);\\n""; code += "" vec_direction = normalize(vec_direction);\\n""; code += "" VELOCITY = vec_direction * initial_linear_velocity * mix(1.0, rand_from_seed(alt_seed), initial_linear_velocity_random);\\n""; } code += "" float base_angle = (initial_angle + tex_angle) * mix(1.0, angle_rand, initial_angle_random);\\n""; code += "" CUSTOM.x = base_angle * degree_to_rad;\\n""; // angle code += "" CUSTOM.y = 0.0;\\n""; // phase code += "" CUSTOM.w = (1.0 - lifetime_randomness * rand_from_seed(alt_seed));\\n""; code += "" CUSTOM.z = (anim_offset + tex_anim_offset) * mix(1.0, anim_offset_rand, anim_offset_random);\\n""; // animation offset (0-1) switch (emission_shape) { case EMISSION_SHAPE_POINT: { //do none } break; case EMISSION_SHAPE_SPHERE: { code += "" float s = rand_from_seed(alt_seed) * 2.0 - 1.0;\\n""; code += "" float t = rand_from_seed(alt_seed) * 2.0 * pi;\\n""; code += "" float radius = emission_sphere_radius * sqrt(1.0 - s * s);\\n""; code += "" TRANSFORM[3].xyz = vec3(radius * cos(t), radius * sin(t), emission_sphere_radius * s);\\n""; } break; case EMISSION_SHAPE_BOX: { code += "" TRANSFORM[3].xyz = vec3(rand_from_seed(alt_seed) * 2.0 - 1.0, rand_from_seed(alt_seed) * 2.0 - 1.0, rand_from_seed(alt_seed) * 2.0 - 1.0) * emission_box_extents;\\n""; } break; case EMISSION_SHAPE_POINTS: case EMISSION_SHAPE_DIRECTED_POINTS: { code += "" TRANSFORM[3].xyz = texelFetch(emission_texture_points, emission_tex_ofs, 0).xyz;\\n""; if (emission_shape == EMISSION_SHAPE_DIRECTED_POINTS) { if (flags[FLAG_DISABLE_Z]) { code += "" mat2 rotm;""; code += "" rotm[0] = texelFetch(emission_texture_normal, emission_tex_ofs, 0).xy;\\n""; code += "" rotm[1] = rotm[0].yx * vec2(1.0, -1.0);\\n""; code += "" VELOCITY.xy = rotm * VELOCITY.xy;\\n""; } else { code += "" vec3 normal = texelFetch(emission_texture_normal, emission_tex_ofs, 0).xyz;\\n""; code += "" vec3 v0 = abs(normal.z) < 0.999 ? vec3(0.0, 0.0, 1.0) : vec3(0.0, 1.0, 0.0);\\n""; code += "" vec3 tangent = normalize(cross(v0, normal));\\n""; code += "" vec3 bitangent = normalize(cross(tangent, normal));\\n""; code += "" VELOCITY = mat3(tangent, bitangent, normal) * VELOCITY;\\n""; } } } break; case EMISSION_SHAPE_MAX: { // Max value for validity check. break; } } code += "" VELOCITY = (EMISSION_TRANSFORM * vec4(VELOCITY, 0.0)).xyz;\\n""; code += "" TRANSFORM = EMISSION_TRANSFORM * TRANSFORM;\\n""; if (flags[FLAG_DISABLE_Z]) { code += "" VELOCITY.z = 0.0;\\n""; code += "" TRANSFORM[3].z = 0.0;\\n""; } code += "" } else {\\n""; code += "" CUSTOM.y += DELTA / LIFETIME;\\n""; if (tex_parameters[PARAM_INITIAL_LINEAR_VELOCITY].is_valid()) code += "" float tex_linear_velocity = textureLod(linear_velocity_texture, vec2(CUSTOM.y, 0.0), 0.0).r;\\n""; else code += "" float tex_linear_velocity = 0.0;\\n""; if (flags[FLAG_DISABLE_Z]) { if (tex_parameters[PARAM_ORBIT_VELOCITY].is_valid()) code += "" float tex_orbit_velocity = textureLod(orbit_velocity_texture, vec2(CUSTOM.y, 0.0), 0.0).r;\\n""; else code += "" float tex_orbit_velocity = 0.0;\\n""; } if (tex_parameters[PARAM_ANGULAR_VELOCITY].is_valid()) code += "" float tex_angular_velocity = textureLod(angular_velocity_texture, vec2(CUSTOM.y, 0.0), 0.0).r;\\n""; else code += "" float tex_angular_velocity = 0.0;\\n""; if (tex_parameters[PARAM_LINEAR_ACCEL].is_valid()) code += "" float tex_linear_accel = textureLod(linear_accel_texture, vec2(CUSTOM.y, 0.0), 0.0).r;\\n""; else code += "" float tex_linear_accel = 0.0;\\n""; if (tex_parameters[PARAM_RADIAL_ACCEL].is_valid()) code += "" float tex_radial_accel = textureLod(radial_accel_texture, vec2(CUSTOM.y, 0.0), 0.0).r;\\n""; else code += "" float tex_radial_accel = 0.0;\\n""; if (tex_parameters[PARAM_TANGENTIAL_ACCEL].is_valid()) code += "" float tex_tangent_accel = textureLod(tangent_accel_texture, vec2(CUSTOM.y, 0.0), 0.0).r;\\n""; else code += "" float tex_tangent_accel = 0.0;\\n""; if (tex_parameters[PARAM_DAMPING].is_valid()) code += "" float tex_damping = textureLod(damping_texture, vec2(CUSTOM.y, 0.0), 0.0).r;\\n""; else code += "" float tex_damping = 0.0;\\n""; if (tex_parameters[PARAM_ANGLE].is_valid()) code += "" float tex_angle = textureLod(angle_texture, vec2(CUSTOM.y, 0.0), 0.0).r;\\n""; else code += "" float tex_angle = 0.0;\\n""; if (tex_parameters[PARAM_ANIM_SPEED].is_valid()) code += "" float tex_anim_speed = textureLod(anim_speed_texture, vec2(CUSTOM.y, 0.0), 0.0).r;\\n""; else code += "" float tex_anim_speed = 0.0;\\n""; if (tex_parameters[PARAM_ANIM_OFFSET].is_valid()) code += "" float tex_anim_offset = textureLod(anim_offset_texture, vec2(CUSTOM.y, 0.0), 0.0).r;\\n""; else code += "" float tex_anim_offset = 0.0;\\n""; code += "" vec3 force = gravity;\\n""; code += "" vec3 pos = TRANSFORM[3].xyz;\\n""; if (flags[FLAG_DISABLE_Z]) { code += "" pos.z = 0.0;\\n""; } code += "" // apply linear acceleration\\n""; code += "" force += length(VELOCITY) > 0.0 ? normalize(VELOCITY) * (linear_accel + tex_linear_accel) * mix(1.0, rand_from_seed(alt_seed), linear_accel_random) : vec3(0.0);\\n""; code += "" // apply radial acceleration\\n""; code += "" vec3 org = EMISSION_TRANSFORM[3].xyz;\\n""; code += "" vec3 diff = pos - org;\\n""; code += "" force += length(diff) > 0.0 ? normalize(diff) * (radial_accel + tex_radial_accel) * mix(1.0, rand_from_seed(alt_seed), radial_accel_random) : vec3(0.0);\\n""; code += "" // apply tangential acceleration;\\n""; if (flags[FLAG_DISABLE_Z]) { code += "" force += length(diff.yx) > 0.0 ? vec3(normalize(diff.yx * vec2(-1.0, 1.0)), 0.0) * ((tangent_accel + tex_tangent_accel) * mix(1.0, rand_from_seed(alt_seed), tangent_accel_random)) : vec3(0.0);\\n""; } else { code += "" vec3 crossDiff = cross(normalize(diff), normalize(gravity));\\n""; code += "" force += length(crossDiff) > 0.0 ? normalize(crossDiff) * ((tangent_accel + tex_tangent_accel) * mix(1.0, rand_from_seed(alt_seed), tangent_accel_random)) : vec3(0.0);\\n""; } code += "" // apply attractor forces\\n""; code += "" VELOCITY += force * DELTA;\\n""; code += "" // orbit velocity\\n""; if (flags[FLAG_DISABLE_Z]) { code += "" float orbit_amount = (orbit_velocity + tex_orbit_velocity) * mix(1.0, rand_from_seed(alt_seed), orbit_velocity_random);\\n""; code += "" if (orbit_amount != 0.0) {\\n""; code += "" float ang = orbit_amount * DELTA * pi * 2.0;\\n""; code += "" mat2 rot = mat2(vec2(cos(ang), -sin(ang)), vec2(sin(ang), cos(ang)));\\n""; code += "" TRANSFORM[3].xy -= diff.xy;\\n""; code += "" TRANSFORM[3].xy += rot * diff.xy;\\n""; code += "" }\\n""; } if (tex_parameters[PARAM_INITIAL_LINEAR_VELOCITY].is_valid()) { code += "" VELOCITY = normalize(VELOCITY) * tex_linear_velocity;\\n""; } code += "" if (damping + tex_damping > 0.0) {\\n""; code += "" float v = length(VELOCITY);\\n""; code += "" float damp = (damping + tex_damping) * mix(1.0, rand_from_seed(alt_seed), damping_random);\\n""; code += "" v -= damp * DELTA;\\n""; code += "" if (v < 0.0) {\\n""; code += "" VELOCITY = vec3(0.0);\\n""; code += "" } else {\\n""; code += "" VELOCITY = normalize(VELOCITY) * v;\\n""; code += "" }\\n""; code += "" }\\n""; code += "" float base_angle = (initial_angle + tex_angle) * mix(1.0, angle_rand, initial_angle_random);\\n""; code += "" base_angle += CUSTOM.y * LIFETIME * (angular_velocity + tex_angular_velocity) * mix(1.0, rand_from_seed(alt_seed) * 2.0 - 1.0, angular_velocity_random);\\n""; code += "" CUSTOM.x = base_angle * degree_to_rad;\\n""; // angle code += "" CUSTOM.z = (anim_offset + tex_anim_offset) * mix(1.0, anim_offset_rand, anim_offset_random) + CUSTOM.y * (anim_speed + tex_anim_speed) * mix(1.0, rand_from_seed(alt_seed), anim_speed_random);\\n""; // angle code += "" }\\n""; // apply color // apply hue rotation if (tex_parameters[PARAM_SCALE].is_valid()) code += "" float tex_scale = textureLod(scale_texture, vec2(CUSTOM.y, 0.0), 0.0).r;\\n""; else code += "" float tex_scale = 1.0;\\n""; if (tex_parameters[PARAM_HUE_VARIATION].is_valid()) code += "" float tex_hue_variation = textureLod(hue_variation_texture, vec2(CUSTOM.y, 0.0), 0.0).r;\\n""; else code += "" float tex_hue_variation = 0.0;\\n""; code += "" float hue_rot_angle = (hue_variation + tex_hue_variation) * pi * 2.0 * mix(1.0, hue_rot_rand * 2.0 - 1.0, hue_variation_random);\\n""; code += "" float hue_rot_c = cos(hue_rot_angle);\\n""; code += "" float hue_rot_s = sin(hue_rot_angle);\\n""; code += "" mat4 hue_rot_mat = mat4(vec4(0.299, 0.587, 0.114, 0.0),\\n""; code += "" vec4(0.299, 0.587, 0.114, 0.0),\\n""; code += "" vec4(0.299, 0.587, 0.114, 0.0),\\n""; code += "" vec4(0.000, 0.000, 0.000, 1.0)) +\\n""; code += "" mat4(vec4(0.701, -0.587, -0.114, 0.0),\\n""; code += "" vec4(-0.299, 0.413, -0.114, 0.0),\\n""; code += "" vec4(-0.300, -0.588, 0.886, 0.0),\\n""; code += "" vec4(0.000, 0.000, 0.000, 0.0)) * hue_rot_c +\\n""; code += "" mat4(vec4(0.168, 0.330, -0.497, 0.0),\\n""; code += "" vec4(-0.328, 0.035, 0.292, 0.0),\\n""; code += "" vec4(1.250, -1.050, -0.203, 0.0),\\n""; code += "" vec4(0.000, 0.000, 0.000, 0.0)) * hue_rot_s;\\n""; if (color_ramp.is_valid()) { code += "" COLOR = hue_rot_mat * textureLod(color_ramp, vec2(CUSTOM.y, 0.0), 0.0);\\n""; } else { code += "" COLOR = hue_rot_mat * color_value;\\n""; } if (emission_color_texture.is_valid() && (emission_shape == EMISSION_SHAPE_POINTS || emission_shape == EMISSION_SHAPE_DIRECTED_POINTS)) { code += "" COLOR *= texelFetch(emission_texture_color, emission_tex_ofs, 0);\\n""; } if (trail_color_modifier.is_valid()) { code += "" if (trail_divisor > 1) {\\n""; code += "" COLOR *= textureLod(trail_color_modifier, vec2(float(int(NUMBER) % trail_divisor) / float(trail_divisor - 1), 0.0), 0.0);\\n""; code += "" }\\n""; } code += ""\\n""; if (flags[FLAG_DISABLE_Z]) { if (flags[FLAG_ALIGN_Y_TO_VELOCITY]) { code += "" if (length(VELOCITY) > 0.0) {\\n""; code += "" TRANSFORM[1].xyz = normalize(VELOCITY);\\n""; code += "" } else {\\n""; code += "" TRANSFORM[1].xyz = normalize(TRANSFORM[1].xyz);\\n""; code += "" }\\n""; code += "" TRANSFORM[0].xyz = normalize(cross(TRANSFORM[1].xyz, TRANSFORM[2].xyz));\\n""; code += "" TRANSFORM[2] = vec4(0.0, 0.0, 1.0, 0.0);\\n""; } else { code += "" TRANSFORM[0] = vec4(cos(CUSTOM.x), -sin(CUSTOM.x), 0.0, 0.0);\\n""; code += "" TRANSFORM[1] = vec4(sin(CUSTOM.x), cos(CUSTOM.x), 0.0, 0.0);\\n""; code += "" TRANSFORM[2] = vec4(0.0, 0.0, 1.0, 0.0);\\n""; } } else { // orient particle Y towards velocity if (flags[FLAG_ALIGN_Y_TO_VELOCITY]) { code += "" if (length(VELOCITY) > 0.0) {\\n""; code += "" TRANSFORM[1].xyz = normalize(VELOCITY);\\n""; code += "" } else {\\n""; code += "" TRANSFORM[1].xyz = normalize(TRANSFORM[1].xyz);\\n""; code += "" }\\n""; code += "" if (TRANSFORM[1].xyz == normalize(TRANSFORM[0].xyz)) {\\n""; code += "" TRANSFORM[0].xyz = normalize(cross(normalize(TRANSFORM[1].xyz), normalize(TRANSFORM[2].xyz)));\\n""; code += "" TRANSFORM[2].xyz = normalize(cross(normalize(TRANSFORM[0].xyz), normalize(TRANSFORM[1].xyz)));\\n""; code += "" } else {\\n""; code += "" TRANSFORM[2].xyz = normalize(cross(normalize(TRANSFORM[0].xyz), normalize(TRANSFORM[1].xyz)));\\n""; code += "" TRANSFORM[0].xyz = normalize(cross(normalize(TRANSFORM[1].xyz), normalize(TRANSFORM[2].xyz)));\\n""; code += "" }\\n""; } else { code += "" TRANSFORM[0].xyz = normalize(TRANSFORM[0].xyz);\\n""; code += "" TRANSFORM[1].xyz = normalize(TRANSFORM[1].xyz);\\n""; code += "" TRANSFORM[2].xyz = normalize(TRANSFORM[2].xyz);\\n""; } // turn particle by rotation in Y if (flags[FLAG_ROTATE_Y]) { code += "" TRANSFORM = TRANSFORM * mat4(vec4(cos(CUSTOM.x), 0.0, -sin(CUSTOM.x), 0.0), vec4(0.0, 1.0, 0.0, 0.0), vec4(sin(CUSTOM.x), 0.0, cos(CUSTOM.x), 0.0), vec4(0.0, 0.0, 0.0, 1.0));\\n""; } } //scale by scale code += "" float base_scale = tex_scale * mix(scale, 1.0, scale_random * scale_rand);\\n""; code += "" if (base_scale < 0.000001) {\\n""; code += "" base_scale = 0.000001;\\n""; code += "" }\\n""; if (trail_size_modifier.is_valid()) { code += "" if (trail_divisor > 1) {\\n""; code += "" base_scale *= textureLod(trail_size_modifier, vec2(float(int(NUMBER) % trail_divisor) / float(trail_divisor - 1), 0.0), 0.0).r;\\n""; code += "" }\\n""; } code += "" TRANSFORM[0].xyz *= base_scale;\\n""; code += "" TRANSFORM[1].xyz *= base_scale;\\n""; code += "" TRANSFORM[2].xyz *= base_scale;\\n""; if (flags[FLAG_DISABLE_Z]) { code += "" VELOCITY.z = 0.0;\\n""; code += "" TRANSFORM[3].z = 0.0;\\n""; } code += "" if (CUSTOM.y > CUSTOM.w) {""; code += "" ACTIVE = false;\\n""; code += "" }\\n""; code += ""}\\n""; code += ""\\n""; ShaderData shader_data; shader_data.shader = RS::get_singleton()->shader_create(); shader_data.users = 1; RS::get_singleton()->shader_set_code(shader_data.shader, code); shader_map[mk] = shader_data; RS::get_singleton()->material_set_shader(_get_material(), shader_data.shader); } void ParticlesMaterial::flush_changes() { MutexLock lock(material_mutex); while (dirty_materials->first()) { dirty_materials->first()->self()->_update_shader(); } } void ParticlesMaterial::_queue_shader_change() { MutexLock lock(material_mutex); if (!element.in_list()) { dirty_materials->add(&element); } } bool ParticlesMaterial::_is_shader_dirty() const { MutexLock lock(material_mutex); return element.in_list(); } void ParticlesMaterial::set_direction(Vector3 p_direction) { direction = p_direction; RenderingServer::get_singleton()->material_set_param(_get_material(), shader_names->direction, direction); } Vector3 ParticlesMaterial::get_direction() const { return direction; } void ParticlesMaterial::set_spread(float p_spread) { spread = p_spread; RenderingServer::get_singleton()->material_set_param(_get_material(), shader_names->spread, p_spread); } float ParticlesMaterial::get_spread() const { return spread; } void ParticlesMaterial::set_flatness(float p_flatness) { flatness = p_flatness; RenderingServer::get_singleton()->material_set_param(_get_material(), shader_names->flatness, p_flatness); } float ParticlesMaterial::get_flatness() const { return flatness; } void ParticlesMaterial::set_param(Parameter p_param, float p_value) { ERR_FAIL_INDEX(p_param, PARAM_MAX); parameters[p_param] = p_value; switch (p_param) { case PARAM_INITIAL_LINEAR_VELOCITY: { RenderingServer::get_singleton()->material_set_param(_get_material(), shader_names->initial_linear_velocity, p_value); } break; case PARAM_ANGULAR_VELOCITY: { RenderingServer::get_singleton()->material_set_param(_get_material(), shader_names->angular_velocity, p_value); } break; case PARAM_ORBIT_VELOCITY: { RenderingServer::get_singleton()->material_set_param(_get_material(), shader_names->orbit_velocity, p_value); } break; case PARAM_LINEAR_ACCEL: { RenderingServer::get_singleton()->material_set_param(_get_material(), shader_names->linear_accel, p_value); } break; case PARAM_RADIAL_ACCEL: { RenderingServer::get_singleton()->material_set_param(_get_material(), shader_names->radial_accel, p_value); } break; case PARAM_TANGENTIAL_ACCEL: { RenderingServer::get_singleton()->material_set_param(_get_material(), shader_names->tangent_accel, p_value); } break; case PARAM_DAMPING: { RenderingServer::get_singleton()->material_set_param(_get_material(), shader_names->damping, p_value); } break; case PARAM_ANGLE: { RenderingServer::get_singleton()->material_set_param(_get_material(), shader_names->initial_angle, p_value); } break; case PARAM_SCALE: { RenderingServer::get_singleton()->material_set_param(_get_material(), shader_names->scale, p_value); } break; case PARAM_HUE_VARIATION: { RenderingServer::get_singleton()->material_set_param(_get_material(), shader_names->hue_variation, p_value); } break; case PARAM_ANIM_SPEED: { RenderingServer::get_singleton()->material_set_param(_get_material(), shader_names->anim_speed, p_value); } break; case PARAM_ANIM_OFFSET: { RenderingServer::get_singleton()->material_set_param(_get_material(), shader_names->anim_offset, p_value); } break; case PARAM_MAX: break; // Can't happen, but silences warning } } float ParticlesMaterial::get_param(Parameter p_param) const { ERR_FAIL_INDEX_V(p_param, PARAM_MAX, 0); return parameters[p_param]; } void ParticlesMaterial::set_param_randomness(Parameter p_param, float p_value) { ERR_FAIL_INDEX(p_param, PARAM_MAX); randomness[p_param] = p_value; switch (p_param) { case PARAM_INITIAL_LINEAR_VELOCITY: { RenderingServer::get_singleton()->material_set_param(_get_material(), shader_names->initial_linear_velocity_random, p_value); } break; case PARAM_ANGULAR_VELOCITY: { RenderingServer::get_singleton()->material_set_param(_get_material(), shader_names->angular_velocity_random, p_value); } break; case PARAM_ORBIT_VELOCITY: { RenderingServer::get_singleton()->material_set_param(_get_material(), shader_names->orbit_velocity_random, p_value); } break; case PARAM_LINEAR_ACCEL: { RenderingServer::get_singleton()->material_set_param(_get_material(), shader_names->linear_accel_random, p_value); } break; case PARAM_RADIAL_ACCEL: { RenderingServer::get_singleton()->material_set_param(_get_material(), shader_names->radial_accel_random, p_value); } break; case PARAM_TANGENTIAL_ACCEL: { RenderingServer::get_singleton()->material_set_param(_get_material(), shader_names->tangent_accel_random, p_value); } break; case PARAM_DAMPING: { RenderingServer::get_singleton()->material_set_param(_get_material(), shader_names->damping_random, p_value); } break; case PARAM_ANGLE: { RenderingServer::get_singleton()->material_set_param(_get_material(), shader_names->initial_angle_random, p_value); } break; case PARAM_SCALE: { RenderingServer::get_singleton()->material_set_param(_get_material(), shader_names->scale_random, p_value); } break; case PARAM_HUE_VARIATION: { RenderingServer::get_singleton()->material_set_param(_get_material(), shader_names->hue_variation_random, p_value); } break; case PARAM_ANIM_SPEED: { RenderingServer::get_singleton()->material_set_param(_get_material(), shader_names->anim_speed_random, p_value); } break; case PARAM_ANIM_OFFSET: { RenderingServer::get_singleton()->material_set_param(_get_material(), shader_names->anim_offset_random, p_value); } break; case PARAM_MAX: break; // Can't happen, but silences warning } } float ParticlesMaterial::get_param_randomness(Parameter p_param) const { ERR_FAIL_INDEX_V(p_param, PARAM_MAX, 0); return randomness[p_param]; } static void _adjust_curve_range(const Ref &p_texture, float p_min, float p_max) { Ref curve_tex = p_texture; if (!curve_tex.is_valid()) return; curve_tex->ensure_default_setup(p_min, p_max); } void ParticlesMaterial::set_param_texture(Parameter p_param, const Ref &p_texture) { ERR_FAIL_INDEX(p_param, PARAM_MAX); tex_parameters[p_param] = p_texture; switch (p_param) { case PARAM_INITIAL_LINEAR_VELOCITY: { //do none for this one } break; case PARAM_ANGULAR_VELOCITY: { RenderingServer::get_singleton()->material_set_param(_get_material(), shader_names->angular_velocity_texture, p_texture); _adjust_curve_range(p_texture, -360, 360); } break; case PARAM_ORBIT_VELOCITY: { RenderingServer::get_singleton()->material_set_param(_get_material(), shader_names->orbit_velocity_texture, p_texture); _adjust_curve_range(p_texture, -500, 500); } break; case PARAM_LINEAR_ACCEL: { RenderingServer::get_singleton()->material_set_param(_get_material(), shader_names->linear_accel_texture, p_texture); _adjust_curve_range(p_texture, -200, 200); } break; case PARAM_RADIAL_ACCEL: { RenderingServer::get_singleton()->material_set_param(_get_material(), shader_names->radial_accel_texture, p_texture); _adjust_curve_range(p_texture, -200, 200); } break; case PARAM_TANGENTIAL_ACCEL: { RenderingServer::get_singleton()->material_set_param(_get_material(), shader_names->tangent_accel_texture, p_texture); _adjust_curve_range(p_texture, -200, 200); } break; case PARAM_DAMPING: { RenderingServer::get_singleton()->material_set_param(_get_material(), shader_names->damping_texture, p_texture); _adjust_curve_range(p_texture, 0, 100); } break; case PARAM_ANGLE: { RenderingServer::get_singleton()->material_set_param(_get_material(), shader_names->angle_texture, p_texture); _adjust_curve_range(p_texture, -360, 360); } break; case PARAM_SCALE: { RenderingServer::get_singleton()->material_set_param(_get_material(), shader_names->scale_texture, p_texture); _adjust_curve_range(p_texture, 0, 1); } break; case PARAM_HUE_VARIATION: { RenderingServer::get_singleton()->material_set_param(_get_material(), shader_names->hue_variation_texture, p_texture); _adjust_curve_range(p_texture, -1, 1); } break; case PARAM_ANIM_SPEED: { RenderingServer::get_singleton()->material_set_param(_get_material(), shader_names->anim_speed_texture, p_texture); _adjust_curve_range(p_texture, 0, 200); } break; case PARAM_ANIM_OFFSET: { RenderingServer::get_singleton()->material_set_param(_get_material(), shader_names->anim_offset_texture, p_texture); } break; case PARAM_MAX: break; // Can't happen, but silences warning } _queue_shader_change(); } Ref ParticlesMaterial::get_param_texture(Parameter p_param) const { ERR_FAIL_INDEX_V(p_param, PARAM_MAX, Ref()); return tex_parameters[p_param]; } void ParticlesMaterial::set_color(const Color &p_color) { RenderingServer::get_singleton()->material_set_param(_get_material(), shader_names->color, p_color); color = p_color; } Color ParticlesMaterial::get_color() const { return color; } void ParticlesMaterial::set_color_ramp(const Ref &p_texture) { color_ramp = p_texture; RenderingServer::get_singleton()->material_set_param(_get_material(), shader_names->color_ramp, p_texture); _queue_shader_change(); _change_notify(); } Ref ParticlesMaterial::get_color_ramp() const { return color_ramp; } void ParticlesMaterial::set_flag(Flags p_flag, bool p_enable) { ERR_FAIL_INDEX(p_flag, FLAG_MAX); flags[p_flag] = p_enable; _queue_shader_change(); if (p_flag == FLAG_DISABLE_Z) { _change_notify(); } } bool ParticlesMaterial::get_flag(Flags p_flag) const { ERR_FAIL_INDEX_V(p_flag, FLAG_MAX, false); return flags[p_flag]; } void ParticlesMaterial::set_emission_shape(EmissionShape p_shape) { ERR_FAIL_INDEX(p_shape, EMISSION_SHAPE_MAX); emission_shape = p_shape; _change_notify(); _queue_shader_change(); } void ParticlesMaterial::set_emission_sphere_radius(float p_radius) { emission_sphere_radius = p_radius; RenderingServer::get_singleton()->material_set_param(_get_material(), shader_names->emission_sphere_radius, p_radius); } void ParticlesMaterial::set_emission_box_extents(Vector3 p_extents) { emission_box_extents = p_extents; RenderingServer::get_singleton()->material_set_param(_get_material(), shader_names->emission_box_extents, p_extents); } void ParticlesMaterial::set_emission_point_texture(const Ref &p_points) { emission_point_texture = p_points; RenderingServer::get_singleton()->material_set_param(_get_material(), shader_names->emission_texture_points, p_points); } void ParticlesMaterial::set_emission_normal_texture(const Ref &p_normals) { emission_normal_texture = p_normals; RenderingServer::get_singleton()->material_set_param(_get_material(), shader_names->emission_texture_normal, p_normals); } void ParticlesMaterial::set_emission_color_texture(const Ref &p_colors) { emission_color_texture = p_colors; RenderingServer::get_singleton()->material_set_param(_get_material(), shader_names->emission_texture_color, p_colors); _queue_shader_change(); } void ParticlesMaterial::set_emission_point_count(int p_count) { emission_point_count = p_count; RenderingServer::get_singleton()->material_set_param(_get_material(), shader_names->emission_texture_point_count, p_count); } ParticlesMaterial::EmissionShape ParticlesMaterial::get_emission_shape() const { return emission_shape; } float ParticlesMaterial::get_emission_sphere_radius() const { return emission_sphere_radius; } Vector3 ParticlesMaterial::get_emission_box_extents() const { return emission_box_extents; } Ref ParticlesMaterial::get_emission_point_texture() const { return emission_point_texture; } Ref ParticlesMaterial::get_emission_normal_texture() const { return emission_normal_texture; } Ref ParticlesMaterial::get_emission_color_texture() const { return emission_color_texture; } int ParticlesMaterial::get_emission_point_count() const { return emission_point_count; } void ParticlesMaterial::set_trail_divisor(int p_divisor) { trail_divisor = p_divisor; RenderingServer::get_singleton()->material_set_param(_get_material(), shader_names->trail_divisor, p_divisor); } int ParticlesMaterial::get_trail_divisor() const { return trail_divisor; } void ParticlesMaterial::set_trail_size_modifier(const Ref &p_trail_size_modifier) { trail_size_modifier = p_trail_size_modifier; Ref curve = trail_size_modifier; if (curve.is_valid()) { curve->ensure_default_setup(); } RenderingServer::get_singleton()->material_set_param(_get_material(), shader_names->trail_size_modifier, curve); _queue_shader_change(); } Ref ParticlesMaterial::get_trail_size_modifier() const { return trail_size_modifier; } void ParticlesMaterial::set_trail_color_modifier(const Ref &p_trail_color_modifier) { trail_color_modifier = p_trail_color_modifier; RenderingServer::get_singleton()->material_set_param(_get_material(), shader_names->trail_color_modifier, p_trail_color_modifier); _queue_shader_change(); } Ref ParticlesMaterial::get_trail_color_modifier() const { return trail_color_modifier; } void ParticlesMaterial::set_gravity(const Vector3 &p_gravity) { gravity = p_gravity; Vector3 gset = gravity; if (gset == Vector3()) { gset = Vector3(0, -0.000001, 0); //as gravity is used as upvector in some calculations } RenderingServer::get_singleton()->material_set_param(_get_material(), shader_names->gravity, gset); } Vector3 ParticlesMaterial::get_gravity() const { return gravity; } void ParticlesMaterial::set_lifetime_randomness(float p_lifetime) { lifetime_randomness = p_lifetime; RenderingServer::get_singleton()->material_set_param(_get_material(), shader_names->lifetime_randomness, lifetime_randomness); } float ParticlesMaterial::get_lifetime_randomness() const { return lifetime_randomness; } RID ParticlesMaterial::get_shader_rid() const { ERR_FAIL_COND_V(!shader_map.has(current_key), RID()); return shader_map[current_key].shader; } void ParticlesMaterial::_validate_property(PropertyInfo &property) const { if (property.name == ""color"" && color_ramp.is_valid()) { property.usage = 0; } if (property.name == ""emission_sphere_radius"" && emission_shape != EMISSION_SHAPE_SPHERE) { property.usage = 0; } if (property.name == ""emission_box_extents"" && emission_shape != EMISSION_SHAPE_BOX) { property.usage = 0; } if ((property.name == ""emission_point_texture"" || property.name == ""emission_color_texture"") && (emission_shape < EMISSION_SHAPE_POINTS)) { property.usage = 0; } if (property.name == ""emission_normal_texture"" && emission_shape != EMISSION_SHAPE_DIRECTED_POINTS) { property.usage = 0; } if (property.name == ""emission_point_count"" && (emission_shape != EMISSION_SHAPE_POINTS && emission_shape != EMISSION_SHAPE_DIRECTED_POINTS)) { property.usage = 0; } if (property.name.begins_with(""orbit_"") && !flags[FLAG_DISABLE_Z]) { property.usage = 0; } } Shader::Mode ParticlesMaterial::get_shader_mode() const { return Shader::MODE_PARTICLES; } void ParticlesMaterial::_bind_methods() { ClassDB::bind_method(D_METHOD(""set_direction"", ""degrees""), &ParticlesMaterial::set_direction); ClassDB::bind_method(D_METHOD(""get_direction""), &ParticlesMaterial::get_direction); ClassDB::bind_method(D_METHOD(""set_spread"", ""degrees""), &ParticlesMaterial::set_spread); ClassDB::bind_method(D_METHOD(""get_spread""), &ParticlesMaterial::get_spread); ClassDB::bind_method(D_METHOD(""set_flatness"", ""amount""), &ParticlesMaterial::set_flatness); ClassDB::bind_method(D_METHOD(""get_flatness""), &ParticlesMaterial::get_flatness); ClassDB::bind_method(D_METHOD(""set_param"", ""param"", ""value""), &ParticlesMaterial::set_param); ClassDB::bind_method(D_METHOD(""get_param"", ""param""), &ParticlesMaterial::get_param); ClassDB::bind_method(D_METHOD(""set_param_randomness"", ""param"", ""randomness""), &ParticlesMaterial::set_param_randomness); ClassDB::bind_method(D_METHOD(""get_param_randomness"", ""param""), &ParticlesMaterial::get_param_randomness); ClassDB::bind_method(D_METHOD(""set_param_texture"", ""param"", ""texture""), &ParticlesMaterial::set_param_texture); ClassDB::bind_method(D_METHOD(""get_param_texture"", ""param""), &ParticlesMaterial::get_param_texture); ClassDB::bind_method(D_METHOD(""set_color"", ""color""), &ParticlesMaterial::set_color); ClassDB::bind_method(D_METHOD(""get_color""), &ParticlesMaterial::get_color); ClassDB::bind_method(D_METHOD(""set_color_ramp"", ""ramp""), &ParticlesMaterial::set_color_ramp); ClassDB::bind_method(D_METHOD(""get_color_ramp""), &ParticlesMaterial::get_color_ramp); ClassDB::bind_method(D_METHOD(""set_flag"", ""flag"", ""enable""), &ParticlesMaterial::set_flag); ClassDB::bind_method(D_METHOD(""get_flag"", ""flag""), &ParticlesMaterial::get_flag); ClassDB::bind_method(D_METHOD(""set_emission_shape"", ""shape""), &ParticlesMaterial::set_emission_shape); ClassDB::bind_method(D_METHOD(""get_emission_shape""), &ParticlesMaterial::get_emission_shape); ClassDB::bind_method(D_METHOD(""set_emission_sphere_radius"", ""radius""), &ParticlesMaterial::set_emission_sphere_radius); ClassDB::bind_method(D_METHOD(""get_emission_sphere_radius""), &ParticlesMaterial::get_emission_sphere_radius); ClassDB::bind_method(D_METHOD(""set_emission_box_extents"", ""extents""), &ParticlesMaterial::set_emission_box_extents); ClassDB::bind_method(D_METHOD(""get_emission_box_extents""), &ParticlesMaterial::get_emission_box_extents); ClassDB::bind_method(D_METHOD(""set_emission_point_texture"", ""texture""), &ParticlesMaterial::set_emission_point_texture); ClassDB::bind_method(D_METHOD(""get_emission_point_texture""), &ParticlesMaterial::get_emission_point_texture); ClassDB::bind_method(D_METHOD(""set_emission_normal_texture"", ""texture""), &ParticlesMaterial::set_emission_normal_texture); ClassDB::bind_method(D_METHOD(""get_emission_normal_texture""), &ParticlesMaterial::get_emission_normal_texture); ClassDB::bind_method(D_METHOD(""set_emission_color_texture"", ""texture""), &ParticlesMaterial::set_emission_color_texture); ClassDB::bind_method(D_METHOD(""get_emission_color_texture""), &ParticlesMaterial::get_emission_color_texture); ClassDB::bind_method(D_METHOD(""set_emission_point_count"", ""point_count""), &ParticlesMaterial::set_emission_point_count); ClassDB::bind_method(D_METHOD(""get_emission_point_count""), &ParticlesMaterial::get_emission_point_count); ClassDB::bind_method(D_METHOD(""set_trail_divisor"", ""divisor""), &ParticlesMaterial::set_trail_divisor); ClassDB::bind_method(D_METHOD(""get_trail_divisor""), &ParticlesMaterial::get_trail_divisor); ClassDB::bind_method(D_METHOD(""set_trail_size_modifier"", ""texture""), &ParticlesMaterial::set_trail_size_modifier); ClassDB::bind_method(D_METHOD(""get_trail_size_modifier""), &ParticlesMaterial::get_trail_size_modifier); ClassDB::bind_method(D_METHOD(""set_trail_color_modifier"", ""texture""), &ParticlesMaterial::set_trail_color_modifier); ClassDB::bind_method(D_METHOD(""get_trail_color_modifier""), &ParticlesMaterial::get_trail_color_modifier); ClassDB::bind_method(D_METHOD(""get_gravity""), &ParticlesMaterial::get_gravity); ClassDB::bind_method(D_METHOD(""set_gravity"", ""accel_vec""), &ParticlesMaterial::set_gravity); ClassDB::bind_method(D_METHOD(""set_lifetime_randomness"", ""randomness""), &ParticlesMaterial::set_lifetime_randomness); ClassDB::bind_method(D_METHOD(""get_lifetime_randomness""), &ParticlesMaterial::get_lifetime_randomness); ADD_GROUP(""Time"", """"); ADD_PROPERTY(PropertyInfo(Variant::FLOAT, ""lifetime_randomness"", PROPERTY_HINT_RANGE, ""0,1,0.01""), ""set_lifetime_randomness"", ""get_lifetime_randomness""); ADD_GROUP(""Trail"", ""trail_""); ADD_PROPERTY(PropertyInfo(Variant::INT, ""trail_divisor"", PROPERTY_HINT_RANGE, ""1,1000000,1""), ""set_trail_divisor"", ""get_trail_divisor""); ADD_PROPERTY(PropertyInfo(Variant::OBJECT, ""trail_size_modifier"", PROPERTY_HINT_RESOURCE_TYPE, ""CurveTexture""), ""set_trail_size_modifier"", ""get_trail_size_modifier""); ADD_PROPERTY(PropertyInfo(Variant::OBJECT, ""trail_color_modifier"", PROPERTY_HINT_RESOURCE_TYPE, ""GradientTexture""), ""set_trail_color_modifier"", ""get_trail_color_modifier""); ADD_GROUP(""Emission Shape"", ""emission_""); ADD_PROPERTY(PropertyInfo(Variant::INT, ""emission_shape"", PROPERTY_HINT_ENUM, ""Point,Sphere,Box,Points,Directed Points""), ""set_emission_shape"", ""get_emission_shape""); ADD_PROPERTY(PropertyInfo(Variant::FLOAT, ""emission_sphere_radius"", PROPERTY_HINT_RANGE, ""0.01,128,0.01,or_greater""), ""set_emission_sphere_radius"", ""get_emission_sphere_radius""); ADD_PROPERTY(PropertyInfo(Variant::VECTOR3, ""emission_box_extents""), ""set_emission_box_extents"", ""get_emission_box_extents""); ADD_PROPERTY(PropertyInfo(Variant::OBJECT, ""emission_point_texture"", PROPERTY_HINT_RESOURCE_TYPE, ""Texture2D""), ""set_emission_point_texture"", ""get_emission_point_texture""); ADD_PROPERTY(PropertyInfo(Variant::OBJECT, ""emission_normal_texture"", PROPERTY_HINT_RESOURCE_TYPE, ""Texture2D""), ""set_emission_normal_texture"", ""get_emission_normal_texture""); ADD_PROPERTY(PropertyInfo(Variant::OBJECT, ""emission_color_texture"", PROPERTY_HINT_RESOURCE_TYPE, ""Texture2D""), ""set_emission_color_texture"", ""get_emission_color_texture""); ADD_PROPERTY(PropertyInfo(Variant::INT, ""emission_point_count"", PROPERTY_HINT_RANGE, ""0,1000000,1""), ""set_emission_point_count"", ""get_emission_point_count""); ADD_GROUP(""Flags"", ""flag_""); ADD_PROPERTYI(PropertyInfo(Variant::BOOL, ""flag_align_y""), ""set_flag"", ""get_flag"", FLAG_ALIGN_Y_TO_VELOCITY); ADD_PROPERTYI(PropertyInfo(Variant::BOOL, ""flag_rotate_y""), ""set_flag"", ""get_flag"", FLAG_ROTATE_Y); ADD_PROPERTYI(PropertyInfo(Variant::BOOL, ""flag_disable_z""), ""set_flag"", ""get_flag"", FLAG_DISABLE_Z); ADD_GROUP(""Direction"", """"); ADD_PROPERTY(PropertyInfo(Variant::VECTOR3, ""direction""), ""set_direction"", ""get_direction""); ADD_PROPERTY(PropertyInfo(Variant::FLOAT, ""spread"", PROPERTY_HINT_RANGE, ""0,180,0.01""), ""set_spread"", ""get_spread""); ADD_PROPERTY(PropertyInfo(Variant::FLOAT, ""flatness"", PROPERTY_HINT_RANGE, ""0,1,0.01""), ""set_flatness"", ""get_flatness""); ADD_GROUP(""Gravity"", """"); ADD_PROPERTY(PropertyInfo(Variant::VECTOR3, ""gravity""), ""set_gravity"", ""get_gravity""); ADD_GROUP(""Initial Velocity"", ""initial_""); ADD_PROPERTYI(PropertyInfo(Variant::FLOAT, ""initial_velocity"", PROPERTY_HINT_RANGE, ""0,1000,0.01,or_lesser,or_greater""), ""set_param"", ""get_param"", PARAM_INITIAL_LINEAR_VELOCITY); ADD_PROPERTYI(PropertyInfo(Variant::FLOAT, ""initial_velocity_random"", PROPERTY_HINT_RANGE, ""0,1,0.01""), ""set_param_randomness"", ""get_param_randomness"", PARAM_INITIAL_LINEAR_VELOCITY); ADD_GROUP(""Angular Velocity"", ""angular_""); ADD_PROPERTYI(PropertyInfo(Variant::FLOAT, ""angular_velocity"", PROPERTY_HINT_RANGE, ""-720,720,0.01,or_lesser,or_greater""), ""set_param"", ""get_param"", PARAM_ANGULAR_VELOCITY); ADD_PROPERTYI(PropertyInfo(Variant::FLOAT, ""angular_velocity_random"", PROPERTY_HINT_RANGE, ""0,1,0.01""), ""set_param_randomness"", ""get_param_randomness"", PARAM_ANGULAR_VELOCITY); ADD_PROPERTYI(PropertyInfo(Variant::OBJECT, ""angular_velocity_curve"", PROPERTY_HINT_RESOURCE_TYPE, ""CurveTexture""), ""set_param_texture"", ""get_param_texture"", PARAM_ANGULAR_VELOCITY); ADD_GROUP(""Orbit Velocity"", ""orbit_""); ADD_PROPERTYI(PropertyInfo(Variant::FLOAT, ""orbit_velocity"", PROPERTY_HINT_RANGE, ""-1000,1000,0.01,or_lesser,or_greater""), ""set_param"", ""get_param"", PARAM_ORBIT_VELOCITY); ADD_PROPERTYI(PropertyInfo(Variant::FLOAT, ""orbit_velocity_random"", PROPERTY_HINT_RANGE, ""0,1,0.01""), ""set_param_randomness"", ""get_param_randomness"", PARAM_ORBIT_VELOCITY); ADD_PROPERTYI(PropertyInfo(Variant::OBJECT, ""orbit_velocity_curve"", PROPERTY_HINT_RESOURCE_TYPE, ""CurveTexture""), ""set_param_texture"", ""get_param_texture"", PARAM_ORBIT_VELOCITY); ADD_GROUP(""Linear Accel"", ""linear_""); ADD_PROPERTYI(PropertyInfo(Variant::FLOAT, ""linear_accel"", PROPERTY_HINT_RANGE, ""-100,100,0.01,or_lesser,or_greater""), ""set_param"", ""get_param"", PARAM_LINEAR_ACCEL); ADD_PROPERTYI(PropertyInfo(Variant::FLOAT, ""linear_accel_random"", PROPERTY_HINT_RANGE, ""0,1,0.01""), ""set_param_randomness"", ""get_param_randomness"", PARAM_LINEAR_ACCEL); ADD_PROPERTYI(PropertyInfo(Variant::OBJECT, ""linear_accel_curve"", PROPERTY_HINT_RESOURCE_TYPE, ""CurveTexture""), ""set_param_texture"", ""get_param_texture"", PARAM_LINEAR_ACCEL); ADD_GROUP(""Radial Accel"", ""radial_""); ADD_PROPERTYI(PropertyInfo(Variant::FLOAT, ""radial_accel"", PROPERTY_HINT_RANGE, ""-100,100,0.01,or_lesser,or_greater""), ""set_param"", ""get_param"", PARAM_RADIAL_ACCEL); ADD_PROPERTYI(PropertyInfo(Variant::FLOAT, ""radial_accel_random"", PROPERTY_HINT_RANGE, ""0,1,0.01""), ""set_param_randomness"", ""get_param_randomness"", PARAM_RADIAL_ACCEL); ADD_PROPERTYI(PropertyInfo(Variant::OBJECT, ""radial_accel_curve"", PROPERTY_HINT_RESOURCE_TYPE, ""CurveTexture""), ""set_param_texture"", ""get_param_texture"", PARAM_RADIAL_ACCEL); ADD_GROUP(""Tangential Accel"", ""tangential_""); ADD_PROPERTYI(PropertyInfo(Variant::FLOAT, ""tangential_accel"", PROPERTY_HINT_RANGE, ""-100,100,0.01,or_lesser,or_greater""), ""set_param"", ""get_param"", PARAM_TANGENTIAL_ACCEL); ADD_PROPERTYI(PropertyInfo(Variant::FLOAT, ""tangential_accel_random"", PROPERTY_HINT_RANGE, ""0,1,0.01""), ""set_param_randomness"", ""get_param_randomness"", PARAM_TANGENTIAL_ACCEL); ADD_PROPERTYI(PropertyInfo(Variant::OBJECT, ""tangential_accel_curve"", PROPERTY_HINT_RESOURCE_TYPE, ""CurveTexture""), ""set_param_texture"", ""get_param_texture"", PARAM_TANGENTIAL_ACCEL); ADD_GROUP(""Damping"", """"); ADD_PROPERTYI(PropertyInfo(Variant::FLOAT, ""damping"", PROPERTY_HINT_RANGE, ""0,100,0.01,or_greater""), ""set_param"", ""get_param"", PARAM_DAMPING); ADD_PROPERTYI(PropertyInfo(Variant::FLOAT, ""damping_random"", PROPERTY_HINT_RANGE, ""0,1,0.01""), ""set_param_randomness"", ""get_param_randomness"", PARAM_DAMPING); ADD_PROPERTYI(PropertyInfo(Variant::OBJECT, ""damping_curve"", PROPERTY_HINT_RESOURCE_TYPE, ""CurveTexture""), ""set_param_texture"", ""get_param_texture"", PARAM_DAMPING); ADD_GROUP(""Angle"", """"); ADD_PROPERTYI(PropertyInfo(Variant::FLOAT, ""angle"", PROPERTY_HINT_RANGE, ""-720,720,0.1,or_lesser,or_greater""), ""set_param"", ""get_param"", PARAM_ANGLE); ADD_PROPERTYI(PropertyInfo(Variant::FLOAT, ""angle_random"", PROPERTY_HINT_RANGE, ""0,1,0.01""), ""set_param_randomness"", ""get_param_randomness"", PARAM_ANGLE); ADD_PROPERTYI(PropertyInfo(Variant::OBJECT, ""angle_curve"", PROPERTY_HINT_RESOURCE_TYPE, ""CurveTexture""), ""set_param_texture"", ""get_param_texture"", PARAM_ANGLE); ADD_GROUP(""Scale"", """"); ADD_PROPERTYI(PropertyInfo(Variant::FLOAT, ""scale"", PROPERTY_HINT_RANGE, ""0,1000,0.01,or_greater""), ""set_param"", ""get_param"", PARAM_SCALE); ADD_PROPERTYI(PropertyInfo(Variant::FLOAT, ""scale_random"", PROPERTY_HINT_RANGE, ""0,1,0.01""), ""set_param_randomness"", ""get_param_randomness"", PARAM_SCALE); ADD_PROPERTYI(PropertyInfo(Variant::OBJECT, ""scale_curve"", PROPERTY_HINT_RESOURCE_TYPE, ""CurveTexture""), ""set_param_texture"", ""get_param_texture"", PARAM_SCALE); ADD_GROUP(""Color"", """"); ADD_PROPERTY(PropertyInfo(Variant::COLOR, ""color""), ""set_color"", ""get_color""); ADD_PROPERTY(PropertyInfo(Variant::OBJECT, ""color_ramp"", PROPERTY_HINT_RESOURCE_TYPE, ""GradientTexture""), ""set_color_ramp"", ""get_color_ramp""); ADD_GROUP(""Hue Variation"", ""hue_""); ADD_PROPERTYI(PropertyInfo(Variant::FLOAT, ""hue_variation"", PROPERTY_HINT_RANGE, ""-1,1,0.01""), ""set_param"", ""get_param"", PARAM_HUE_VARIATION); ADD_PROPERTYI(PropertyInfo(Variant::FLOAT, ""hue_variation_random"", PROPERTY_HINT_RANGE, ""0,1,0.01""), ""set_param_randomness"", ""get_param_randomness"", PARAM_HUE_VARIATION); ADD_PROPERTYI(PropertyInfo(Variant::OBJECT, ""hue_variation_curve"", PROPERTY_HINT_RESOURCE_TYPE, ""CurveTexture""), ""set_param_texture"", ""get_param_texture"", PARAM_HUE_VARIATION); ADD_GROUP(""Animation"", ""anim_""); ADD_PROPERTYI(PropertyInfo(Variant::FLOAT, ""anim_speed"", PROPERTY_HINT_RANGE, ""0,128,0.01,or_greater""), ""set_param"", ""get_param"", PARAM_ANIM_SPEED); ADD_PROPERTYI(PropertyInfo(Variant::FLOAT, ""anim_speed_random"", PROPERTY_HINT_RANGE, ""0,1,0.01""), ""set_param_randomness"", ""get_param_randomness"", PARAM_ANIM_SPEED); ADD_PROPERTYI(PropertyInfo(Variant::OBJECT, ""anim_speed_curve"", PROPERTY_HINT_RESOURCE_TYPE, ""CurveTexture""), ""set_param_texture"", ""get_param_texture"", PARAM_ANIM_SPEED); ADD_PROPERTYI(PropertyInfo(Variant::FLOAT, ""anim_offset"", PROPERTY_HINT_RANGE, ""0,1,0.01""), ""set_param"", ""get_param"", PARAM_ANIM_OFFSET); ADD_PROPERTYI(PropertyInfo(Variant::FLOAT, ""anim_offset_random"", PROPERTY_HINT_RANGE, ""0,1,0.01""), ""set_param_randomness"", ""get_param_randomness"", PARAM_ANIM_OFFSET); ADD_PROPERTYI(PropertyInfo(Variant::OBJECT, ""anim_offset_curve"", PROPERTY_HINT_RESOURCE_TYPE, ""CurveTexture""), ""set_param_texture"", ""get_param_texture"", PARAM_ANIM_OFFSET); BIND_ENUM_CONSTANT(PARAM_INITIAL_LINEAR_VELOCITY); BIND_ENUM_CONSTANT(PARAM_ANGULAR_VELOCITY); BIND_ENUM_CONSTANT(PARAM_ORBIT_VELOCITY); BIND_ENUM_CONSTANT(PARAM_LINEAR_ACCEL); BIND_ENUM_CONSTANT(PARAM_RADIAL_ACCEL); BIND_ENUM_CONSTANT(PARAM_TANGENTIAL_ACCEL); BIND_ENUM_CONSTANT(PARAM_DAMPING); BIND_ENUM_CONSTANT(PARAM_ANGLE); BIND_ENUM_CONSTANT(PARAM_SCALE); BIND_ENUM_CONSTANT(PARAM_HUE_VARIATION); BIND_ENUM_CONSTANT(PARAM_ANIM_SPEED); BIND_ENUM_CONSTANT(PARAM_ANIM_OFFSET); BIND_ENUM_CONSTANT(PARAM_MAX); BIND_ENUM_CONSTANT(FLAG_ALIGN_Y_TO_VELOCITY); BIND_ENUM_CONSTANT(FLAG_ROTATE_Y); BIND_ENUM_CONSTANT(FLAG_DISABLE_Z); BIND_ENUM_CONSTANT(FLAG_MAX); BIND_ENUM_CONSTANT(EMISSION_SHAPE_POINT); BIND_ENUM_CONSTANT(EMISSION_SHAPE_SPHERE); BIND_ENUM_CONSTANT(EMISSION_SHAPE_BOX); BIND_ENUM_CONSTANT(EMISSION_SHAPE_POINTS); BIND_ENUM_CONSTANT(EMISSION_SHAPE_DIRECTED_POINTS); BIND_ENUM_CONSTANT(EMISSION_SHAPE_MAX); } ParticlesMaterial::ParticlesMaterial() : element(this) { set_direction(Vector3(1, 0, 0)); set_spread(45); set_flatness(0); set_param(PARAM_INITIAL_LINEAR_VELOCITY, 0); set_param(PARAM_ANGULAR_VELOCITY, 0); set_param(PARAM_ORBIT_VELOCITY, 0); set_param(PARAM_LINEAR_ACCEL, 0); set_param(PARAM_RADIAL_ACCEL, 0); set_param(PARAM_TANGENTIAL_ACCEL, 0); set_param(PARAM_DAMPING, 0); set_param(PARAM_ANGLE, 0); set_param(PARAM_SCALE, 1); set_param(PARAM_HUE_VARIATION, 0); set_param(PARAM_ANIM_SPEED, 0); set_param(PARAM_ANIM_OFFSET, 0); set_emission_shape(EMISSION_SHAPE_POINT); set_emission_sphere_radius(1); set_emission_box_extents(Vector3(1, 1, 1)); set_trail_divisor(1); set_gravity(Vector3(0, -9.8, 0)); set_lifetime_randomness(0); emission_point_count = 1; for (int i = 0; i < PARAM_MAX; i++) { set_param_randomness(Parameter(i), 0); } for (int i = 0; i < FLAG_MAX; i++) { flags[i] = false; } set_color(Color(1, 1, 1, 1)); current_key.key = 0; current_key.invalid_key = 1; _queue_shader_change(); } ParticlesMaterial::~ParticlesMaterial() { MutexLock lock(material_mutex); if (shader_map.has(current_key)) { shader_map[current_key].users--; if (shader_map[current_key].users == 0) { //deallocate shader, as it's no longer in use RS::get_singleton()->free(shader_map[current_key].shader); shader_map.erase(current_key); } RS::get_singleton()->material_set_shader(_get_material(), RID()); } } ",16132,True,2721.843310573885,median "class ZCL_EXCEL_SHEET_SETUP definition public final create public . public section. *""* public components of class ZCL_EXCEL_SHEET_SETUP *""* do not include other source files here!!! type-pools ABAP . data BLACK_AND_WHITE type FLAG . data CELL_COMMENTS type STRINGVAL . data COPIES type INT2 . constants C_BREAK_COLUMN type ZEXCEL_BREAK value 2. ""#EC NOTEXT constants C_BREAK_NONE type ZEXCEL_BREAK value 0. ""#EC NOTEXT constants C_BREAK_ROW type ZEXCEL_BREAK value 1. ""#EC NOTEXT constants C_CC_AS_DISPLAYED type STRING value 'asDisplayed'. ""#EC NOTEXT constants C_CC_AT_END type STRING value 'atEnd'. ""#EC NOTEXT constants C_CC_NONE type STRING value 'none'. ""#EC NOTEXT constants C_ORD_DOWNTHENOVER type STRING value 'downThenOver'. ""#EC NOTEXT constants C_ORD_OVERTHENDOWN type STRING value 'overThenDown'. ""#EC NOTEXT constants C_ORIENTATION_DEFAULT type ZEXCEL_SHEET_ORIENATATION value 'default'. ""#EC NOTEXT constants C_ORIENTATION_LANDSCAPE type ZEXCEL_SHEET_ORIENATATION value 'landscape'. ""#EC NOTEXT constants C_ORIENTATION_PORTRAIT type ZEXCEL_SHEET_ORIENATATION value 'portrait'. ""#EC NOTEXT constants C_PAPERSIZE_6_3_4_ENVELOPE type ZEXCEL_SHEET_PAPER_SIZE value 38. ""#EC NOTEXT constants C_PAPERSIZE_A2_PAPER type ZEXCEL_SHEET_PAPER_SIZE value 64. ""#EC NOTEXT constants C_PAPERSIZE_A3 type ZEXCEL_SHEET_PAPER_SIZE value 8. ""#EC NOTEXT constants C_PAPERSIZE_A3_EXTRA_PAPER type ZEXCEL_SHEET_PAPER_SIZE value 61. ""#EC NOTEXT constants C_PAPERSIZE_A3_EXTRA_TV_PAPER type ZEXCEL_SHEET_PAPER_SIZE value 66. ""#EC NOTEXT constants C_PAPERSIZE_A3_TV_PAPER type ZEXCEL_SHEET_PAPER_SIZE value 65. ""#EC NOTEXT constants C_PAPERSIZE_A4 type ZEXCEL_SHEET_PAPER_SIZE value 9. ""#EC NOTEXT constants C_PAPERSIZE_A4_EXTRA_PAPER type ZEXCEL_SHEET_PAPER_SIZE value 51. ""#EC NOTEXT constants C_PAPERSIZE_A4_PLUS_PAPER type ZEXCEL_SHEET_PAPER_SIZE value 58. ""#EC NOTEXT constants C_PAPERSIZE_A4_SMALL type ZEXCEL_SHEET_PAPER_SIZE value 10. ""#EC NOTEXT constants C_PAPERSIZE_A4_TV_PAPER type ZEXCEL_SHEET_PAPER_SIZE value 53. ""#EC NOTEXT constants C_PAPERSIZE_A5 type ZEXCEL_SHEET_PAPER_SIZE value 11. ""#EC NOTEXT constants C_PAPERSIZE_A5_EXTRA_PAPER type ZEXCEL_SHEET_PAPER_SIZE value 62. ""#EC NOTEXT constants C_PAPERSIZE_A5_TV_PAPER type ZEXCEL_SHEET_PAPER_SIZE value 59. ""#EC NOTEXT constants C_PAPERSIZE_B4 type ZEXCEL_SHEET_PAPER_SIZE value 12. ""#EC NOTEXT constants C_PAPERSIZE_B4_ENVELOPE type ZEXCEL_SHEET_PAPER_SIZE value 33. ""#EC NOTEXT constants C_PAPERSIZE_B5 type ZEXCEL_SHEET_PAPER_SIZE value 13. ""#EC NOTEXT constants C_PAPERSIZE_B5_ENVELOPE type ZEXCEL_SHEET_PAPER_SIZE value 34. ""#EC NOTEXT constants C_PAPERSIZE_B6_ENVELOPE type ZEXCEL_SHEET_PAPER_SIZE value 35. ""#EC NOTEXT constants C_PAPERSIZE_C type ZEXCEL_SHEET_PAPER_SIZE value 24. ""#EC NOTEXT constants C_PAPERSIZE_C3_ENVELOPE type ZEXCEL_SHEET_PAPER_SIZE value 29. ""#EC NOTEXT constants C_PAPERSIZE_C4_ENVELOPE type ZEXCEL_SHEET_PAPER_SIZE value 30. ""#EC NOTEXT constants C_PAPERSIZE_C5_ENVELOPE type ZEXCEL_SHEET_PAPER_SIZE value 28. ""#EC NOTEXT constants C_PAPERSIZE_C65_ENVELOPE type ZEXCEL_SHEET_PAPER_SIZE value 32. ""#EC NOTEXT constants C_PAPERSIZE_C6_ENVELOPE type ZEXCEL_SHEET_PAPER_SIZE value 31. ""#EC NOTEXT constants C_PAPERSIZE_D type ZEXCEL_SHEET_PAPER_SIZE value 25. ""#EC NOTEXT constants C_PAPERSIZE_DE_LEG_FANFOLD type ZEXCEL_SHEET_PAPER_SIZE value 41. ""#EC NOTEXT constants C_PAPERSIZE_DE_STD_FANFOLD type ZEXCEL_SHEET_PAPER_SIZE value 40. ""#EC NOTEXT constants C_PAPERSIZE_DL_ENVELOPE type ZEXCEL_SHEET_PAPER_SIZE value 27. ""#EC NOTEXT constants C_PAPERSIZE_E type ZEXCEL_SHEET_PAPER_SIZE value 26. ""#EC NOTEXT constants C_PAPERSIZE_EXECUTIVE type ZEXCEL_SHEET_PAPER_SIZE value 7. ""#EC NOTEXT constants C_PAPERSIZE_FOLIO type ZEXCEL_SHEET_PAPER_SIZE value 14. ""#EC NOTEXT constants C_PAPERSIZE_INVITE_ENVELOPE type ZEXCEL_SHEET_PAPER_SIZE value 47. ""#EC NOTEXT constants C_PAPERSIZE_ISO_B4 type ZEXCEL_SHEET_PAPER_SIZE value 42. ""#EC NOTEXT constants C_PAPERSIZE_ISO_B5_EXTRA_PAPER type ZEXCEL_SHEET_PAPER_SIZE value 63. ""#EC NOTEXT constants C_PAPERSIZE_ITALY_ENVELOPE type ZEXCEL_SHEET_PAPER_SIZE value 36. ""#EC NOTEXT constants C_PAPERSIZE_JIS_B5_TV_PAPER type ZEXCEL_SHEET_PAPER_SIZE value 60. ""#EC NOTEXT constants C_PAPERSIZE_JPN_DBL_POSTCARD type ZEXCEL_SHEET_PAPER_SIZE value 43. ""#EC NOTEXT constants C_PAPERSIZE_LEDGER type ZEXCEL_SHEET_PAPER_SIZE value 4. ""#EC NOTEXT constants C_PAPERSIZE_LEGAL type ZEXCEL_SHEET_PAPER_SIZE value 5. ""#EC NOTEXT constants C_PAPERSIZE_LEGAL_EXTRA_PAPER type ZEXCEL_SHEET_PAPER_SIZE value 49. ""#EC NOTEXT constants C_PAPERSIZE_LETTER type ZEXCEL_SHEET_PAPER_SIZE value 1. ""#EC NOTEXT constants C_PAPERSIZE_LETTER_EXTRA_PAPER type ZEXCEL_SHEET_PAPER_SIZE value 48. ""#EC NOTEXT constants C_PAPERSIZE_LETTER_EXTV_PAPER type ZEXCEL_SHEET_PAPER_SIZE value 54. ""#EC NOTEXT constants C_PAPERSIZE_LETTER_PLUS_PAPER type ZEXCEL_SHEET_PAPER_SIZE value 57. ""#EC NOTEXT constants C_PAPERSIZE_LETTER_SMALL type ZEXCEL_SHEET_PAPER_SIZE value 2. ""#EC NOTEXT constants C_PAPERSIZE_LETTER_TV_PAPER type ZEXCEL_SHEET_PAPER_SIZE value 52. ""#EC NOTEXT constants C_PAPERSIZE_MONARCH_ENVELOPE type ZEXCEL_SHEET_PAPER_SIZE value 37. ""#EC NOTEXT constants C_PAPERSIZE_NO10_ENVELOPE type ZEXCEL_SHEET_PAPER_SIZE value 20. ""#EC NOTEXT constants C_PAPERSIZE_NO11_ENVELOPE type ZEXCEL_SHEET_PAPER_SIZE value 21. ""#EC NOTEXT constants C_PAPERSIZE_NO12_ENVELOPE type ZEXCEL_SHEET_PAPER_SIZE value 22. ""#EC NOTEXT constants C_PAPERSIZE_NO14_ENVELOPE type ZEXCEL_SHEET_PAPER_SIZE value 23. ""#EC NOTEXT constants C_PAPERSIZE_NO9_ENVELOPE type ZEXCEL_SHEET_PAPER_SIZE value 19. ""#EC NOTEXT constants C_PAPERSIZE_NOTE type ZEXCEL_SHEET_PAPER_SIZE value 18. ""#EC NOTEXT constants C_PAPERSIZE_QUARTO type ZEXCEL_SHEET_PAPER_SIZE value 15. ""#EC NOTEXT constants C_PAPERSIZE_STANDARD_1 type ZEXCEL_SHEET_PAPER_SIZE value 16. ""#EC NOTEXT constants C_PAPERSIZE_STANDARD_2 type ZEXCEL_SHEET_PAPER_SIZE value 17. ""#EC NOTEXT constants C_PAPERSIZE_STANDARD_PAPER_1 type ZEXCEL_SHEET_PAPER_SIZE value 44. ""#EC NOTEXT constants C_PAPERSIZE_STANDARD_PAPER_2 type ZEXCEL_SHEET_PAPER_SIZE value 45. ""#EC NOTEXT constants C_PAPERSIZE_STANDARD_PAPER_3 type ZEXCEL_SHEET_PAPER_SIZE value 46. ""#EC NOTEXT constants C_PAPERSIZE_STATEMENT type ZEXCEL_SHEET_PAPER_SIZE value 6. ""#EC NOTEXT constants C_PAPERSIZE_SUPERA_A4_PAPER type ZEXCEL_SHEET_PAPER_SIZE value 55. ""#EC NOTEXT constants C_PAPERSIZE_SUPERB_A3_PAPER type ZEXCEL_SHEET_PAPER_SIZE value 56. ""#EC NOTEXT constants C_PAPERSIZE_TABLOID type ZEXCEL_SHEET_PAPER_SIZE value 3. ""#EC NOTEXT constants C_PAPERSIZE_TABL_EXTRA_PAPER type ZEXCEL_SHEET_PAPER_SIZE value 50. ""#EC NOTEXT constants C_PAPERSIZE_US_STD_FANFOLD type ZEXCEL_SHEET_PAPER_SIZE value 39. ""#EC NOTEXT constants C_PE_BLANK type STRING value 'blank'. ""#EC NOTEXT constants C_PE_DASH type STRING value 'dash'. ""#EC NOTEXT constants C_PE_DISPLAYED type STRING value 'displayed'. ""#EC NOTEXT constants C_PE_NA type STRING value 'NA'. ""#EC NOTEXT data DIFF_ODDEVEN_HEADERFOOTER type FLAG . data DRAFT type FLAG . data ERRORS type STRINGVAL . data EVEN_FOOTER type ZEXCEL_S_WORKSHEET_HEAD_FOOT . data EVEN_HEADER type ZEXCEL_S_WORKSHEET_HEAD_FOOT . data FIRST_PAGE_NUMBER type INT2 . data FIT_TO_HEIGHT type INT2 . data FIT_TO_PAGE type FLAG . data FIT_TO_WIDTH type INT2 . data HORIZONTAL_CENTERED type FLAG . data HORIZONTAL_DPI type INT2 . data MARGIN_BOTTOM type ZEXCEL_DEC_8_2 . data MARGIN_FOOTER type ZEXCEL_DEC_8_2 . data MARGIN_HEADER type ZEXCEL_DEC_8_2 . data MARGIN_LEFT type ZEXCEL_DEC_8_2 . data MARGIN_RIGHT type ZEXCEL_DEC_8_2 . data MARGIN_TOP type ZEXCEL_DEC_8_2 . data ODD_FOOTER type ZEXCEL_S_WORKSHEET_HEAD_FOOT . data ODD_HEADER type ZEXCEL_S_WORKSHEET_HEAD_FOOT . data ORIENTATION type ZEXCEL_SHEET_ORIENATATION . data PAGE_ORDER type STRING . data PAPER_HEIGHT type STRING . data PAPER_SIZE type INT2 . data PAPER_WIDTH type STRING . data SCALE type INT2 . data USE_FIRST_PAGE_NUM type FLAG . data USE_PRINTER_DEFAULTS type FLAG . data VERTICAL_CENTERED type FLAG . data VERTICAL_DPI type INT2 . methods CONSTRUCTOR . methods SET_PAGE_MARGINS importing !IP_BOTTOM type FLOAT optional !IP_FOOTER type FLOAT optional !IP_HEADER type FLOAT optional !IP_LEFT type FLOAT optional !IP_RIGHT type FLOAT optional !IP_TOP type FLOAT optional !IP_UNIT type CSEQUENCE default 'in' . methods SET_HEADER_FOOTER importing !IP_ODD_HEADER type ZEXCEL_S_WORKSHEET_HEAD_FOOT optional !IP_ODD_FOOTER type ZEXCEL_S_WORKSHEET_HEAD_FOOT optional !IP_EVEN_HEADER type ZEXCEL_S_WORKSHEET_HEAD_FOOT optional !IP_EVEN_FOOTER type ZEXCEL_S_WORKSHEET_HEAD_FOOT optional . methods GET_HEADER_FOOTER_STRING exporting !EP_ODD_HEADER type STRING !EP_ODD_FOOTER type STRING !EP_EVEN_HEADER type STRING !EP_EVEN_FOOTER type STRING . protected section. *""* protected components of class ZCL_EXCEL_SHEET_SETUP *""* do not include other source files here!!! methods PROCESS_HEADER_FOOTER importing !IP_HEADER type ZEXCEL_S_WORKSHEET_HEAD_FOOT !IP_SIDE type STRING returning value(RV_PROCESSED_STRING) type STRING . private section. *""* private components of class ZCL_EXCEL_SHEET_SETUP *""* do not include other source files here!!! ENDCLASS. CLASS ZCL_EXCEL_SHEET_SETUP IMPLEMENTATION. method CONSTRUCTOR. orientation = me->c_orientation_default. * default margins margin_bottom = '0.75'. margin_footer = '0.3'. margin_header = '0.3'. margin_left = '0.7'. margin_right = '0.7'. margin_top = '0.75'. * clear page settings CLEAR: black_and_white, cell_comments, copies, draft, errors, first_page_number, fit_to_page, fit_to_height, fit_to_width, horizontal_dpi, orientation, page_order, paper_height, paper_size, paper_width, scale, use_first_page_num, use_printer_defaults, vertical_dpi. endmethod. method GET_HEADER_FOOTER_STRING. * ---------------------------------------------------------------------- DATA: lc_marker_left(2) TYPE c VALUE '&L' , lc_marker_right(2) TYPE c VALUE '&R' , lc_marker_center(2) TYPE c VALUE '&C' , lv_value TYPE string . * ---------------------------------------------------------------------- IF ep_odd_header IS SUPPLIED. IF me->odd_header-left_value IS NOT INITIAL. lv_value = me->process_header_footer( ip_header = me->odd_header ip_side = 'LEFT' ). CONCATENATE lc_marker_left lv_value INTO ep_odd_header. ENDIF. IF me->odd_header-center_value IS NOT INITIAL. lv_value = me->process_header_footer( ip_header = me->odd_header ip_side = 'CENTER' ). CONCATENATE ep_odd_header lc_marker_center lv_value INTO ep_odd_header. ENDIF. IF me->odd_header-right_value IS NOT INITIAL. lv_value = me->process_header_footer( ip_header = me->odd_header ip_side = 'RIGHT' ). CONCATENATE ep_odd_header lc_marker_right lv_value INTO ep_odd_header. ENDIF. ENDIF. * ---------------------------------------------------------------------- IF ep_odd_footer IS SUPPLIED. IF me->odd_footer-left_value IS NOT INITIAL. lv_value = me->process_header_footer( ip_header = me->odd_footer ip_side = 'LEFT' ). CONCATENATE lc_marker_left lv_value INTO ep_odd_footer. ENDIF. IF me->odd_footer-center_value IS NOT INITIAL. lv_value = me->process_header_footer( ip_header = me->odd_footer ip_side = 'CENTER' ). CONCATENATE ep_odd_footer lc_marker_center lv_value INTO ep_odd_footer. ENDIF. IF me->odd_footer-right_value IS NOT INITIAL. lv_value = me->process_header_footer( ip_header = me->odd_footer ip_side = 'RIGHT' ). CONCATENATE ep_odd_footer lc_marker_right lv_value INTO ep_odd_footer. ENDIF. ENDIF. * ---------------------------------------------------------------------- IF ep_even_header IS SUPPLIED. IF me->even_header-left_value IS NOT INITIAL. lv_value = me->process_header_footer( ip_header = me->even_header ip_side = 'LEFT' ). CONCATENATE lc_marker_left lv_value INTO ep_even_header. ENDIF. IF me->even_header-center_value IS NOT INITIAL. lv_value = me->process_header_footer( ip_header = me->even_header ip_side = 'CENTER' ). CONCATENATE ep_even_header lc_marker_center lv_value INTO ep_even_header. ENDIF. IF me->even_header-right_value IS NOT INITIAL. lv_value = me->process_header_footer( ip_header = me->even_header ip_side = 'RIGHT' ). CONCATENATE ep_even_header lc_marker_right lv_value INTO ep_even_header. ENDIF. ENDIF. * ---------------------------------------------------------------------- IF ep_even_footer IS SUPPLIED. IF me->even_footer-left_value IS NOT INITIAL. lv_value = me->process_header_footer( ip_header = me->even_footer ip_side = 'LEFT' ). CONCATENATE lc_marker_left lv_value INTO ep_even_footer. ENDIF. IF me->even_footer-center_value IS NOT INITIAL. lv_value = me->process_header_footer( ip_header = me->even_footer ip_side = 'CENTER' ). CONCATENATE ep_even_footer lc_marker_center lv_value INTO ep_even_footer. ENDIF. IF me->even_footer-right_value IS NOT INITIAL. lv_value = me->process_header_footer( ip_header = me->even_footer ip_side = 'RIGHT' ). CONCATENATE ep_even_footer lc_marker_right lv_value INTO ep_even_footer. ENDIF. ENDIF. * ---------------------------------------------------------------------- endmethod. method PROCESS_HEADER_FOOTER. * ---------------------------------------------------------------------- * Only Basic font/text formatting possible: * Bold (yes / no), Font Type, Font Size DATA: lv_fname(12) TYPE c , lv_string TYPE string . FIELD-SYMBOLS: TYPE string , TYPE zexcel_s_style_font . * ---------------------------------------------------------------------- CONCATENATE ip_side '_VALUE' INTO lv_fname. ASSIGN COMPONENT lv_fname OF STRUCTURE ip_header TO . CONCATENATE ip_side '_FONT' INTO lv_fname. ASSIGN COMPONENT lv_fname OF STRUCTURE ip_header TO . IF IS ASSIGNED AND IS ASSIGNED. IF -name IS NOT INITIAL. CONCATENATE '&""' -name ',' INTO rv_processed_string. ELSE. rv_processed_string = '&""-,'. ENDIF. IF -bold = abap_true. CONCATENATE rv_processed_string 'Bold""' INTO rv_processed_string. ELSE. CONCATENATE rv_processed_string 'Standard""' INTO rv_processed_string. ENDIF. IF -size IS NOT INITIAL. lv_string = -size. CONCATENATE rv_processed_string '&' lv_string INTO rv_processed_string. ENDIF. CONCATENATE rv_processed_string INTO rv_processed_string. ENDIF. * ---------------------------------------------------------------------- endmethod. method SET_HEADER_FOOTER. * Only Basic font/text formatting possible: * Bold (yes / no), Font Type, Font Size * * usefull placeholders, which can be used in header/footer value strings * '&P' - page number * '&N' - total number of pages * '&D' - Date * '&T' - Time * '&F' - File Name * '&Z' - Path * '&A' - Sheet name * new line via class constant CL_ABAP_CHAR_UTILITIES=>newline * * Example Value String 'page &P of &N' * * DO NOT USE &L , &C or &R which automatically created as position markers me->odd_header = ip_odd_header. me->odd_footer = ip_odd_footer. me->even_header = ip_even_header. me->even_footer = ip_even_footer. IF me->even_header IS NOT INITIAL OR me->even_footer IS NOT INITIAL. me->diff_oddeven_headerfooter = abap_true. ENDIF. endmethod. method SET_PAGE_MARGINS. DATA: lv_coef TYPE f, lv_unit TYPE string. lv_unit = ip_unit. TRANSLATE lv_unit TO UPPER CASE. CASE lv_unit. WHEN 'IN'. lv_coef = 1. WHEN 'CM'. lv_coef = '0.393700787'. WHEN 'MM'. lv_coef = '0.0393700787'. ENDCASE. IF ip_bottom IS SUPPLIED. margin_bottom = lv_coef * ip_bottom. ENDIF. IF ip_footer IS SUPPLIED. margin_footer = lv_coef * ip_footer. ENDIF. IF ip_header IS SUPPLIED. margin_header = lv_coef * ip_header. ENDIF. IF ip_left IS SUPPLIED. margin_left = lv_coef * ip_left. ENDIF. IF ip_right IS SUPPLIED. margin_right = lv_coef * ip_right. ENDIF. IF ip_top IS SUPPLIED. margin_top = lv_coef * ip_top. ENDIF. endmethod. ENDCLASS. ",4813,False,847.6669590732046,median "/*************************************************************************/ /* tween.cpp */ /*************************************************************************/ /* This file is part of: */ /* GODOT ENGINE */ /* https://godotengine.org */ /*************************************************************************/ /* Copyright (c) 2007-2020 Juan Linietsky, Ariel Manzur. */ /* Copyright (c) 2014-2020 Godot Engine contributors (cf. AUTHORS.md). */ /* */ /* Permission is hereby granted, free of charge, to any person obtaining */ /* a copy of this software and associated documentation files (the */ /* ""Software""), to deal in the Software without restriction, including */ /* without limitation the rights to use, copy, modify, merge, publish, */ /* distribute, sublicense, and/or sell copies of the Software, and to */ /* permit persons to whom the Software is furnished to do so, subject to */ /* the following conditions: */ /* */ /* The above copyright notice and this permission notice shall be */ /* included in all copies or substantial portions of the Software. */ /* */ /* THE SOFTWARE IS PROVIDED ""AS IS"", WITHOUT WARRANTY OF ANY KIND, */ /* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF */ /* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.*/ /* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY */ /* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, */ /* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE */ /* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */ /*************************************************************************/ #include ""tween.h"" void Tween::_add_pending_command(StringName p_key, const Variant &p_arg1, const Variant &p_arg2, const Variant &p_arg3, const Variant &p_arg4, const Variant &p_arg5, const Variant &p_arg6, const Variant &p_arg7, const Variant &p_arg8, const Variant &p_arg9, const Variant &p_arg10) { // Add a new pending command and reference it pending_commands.push_back(PendingCommand()); PendingCommand &cmd = pending_commands.back()->get(); // Update the command with the target key cmd.key = p_key; // Determine command argument count int &count = cmd.args; if (p_arg10.get_type() != Variant::NIL) { count = 10; } else if (p_arg9.get_type() != Variant::NIL) { count = 9; } else if (p_arg8.get_type() != Variant::NIL) { count = 8; } else if (p_arg7.get_type() != Variant::NIL) { count = 7; } else if (p_arg6.get_type() != Variant::NIL) { count = 6; } else if (p_arg5.get_type() != Variant::NIL) { count = 5; } else if (p_arg4.get_type() != Variant::NIL) { count = 4; } else if (p_arg3.get_type() != Variant::NIL) { count = 3; } else if (p_arg2.get_type() != Variant::NIL) { count = 2; } else if (p_arg1.get_type() != Variant::NIL) { count = 1; } else { count = 0; } // Add the specified arguments to the command if (count > 0) { cmd.arg[0] = p_arg1; } if (count > 1) { cmd.arg[1] = p_arg2; } if (count > 2) { cmd.arg[2] = p_arg3; } if (count > 3) { cmd.arg[3] = p_arg4; } if (count > 4) { cmd.arg[4] = p_arg5; } if (count > 5) { cmd.arg[5] = p_arg6; } if (count > 6) { cmd.arg[6] = p_arg7; } if (count > 7) { cmd.arg[7] = p_arg8; } if (count > 8) { cmd.arg[8] = p_arg9; } if (count > 9) { cmd.arg[9] = p_arg10; } } void Tween::_process_pending_commands() { // For each pending command... for (List::Element *E = pending_commands.front(); E; E = E->next()) { // Get the command PendingCommand &cmd = E->get(); Callable::CallError err; // Grab all of the arguments for the command Variant *arg[10] = { &cmd.arg[0], &cmd.arg[1], &cmd.arg[2], &cmd.arg[3], &cmd.arg[4], &cmd.arg[5], &cmd.arg[6], &cmd.arg[7], &cmd.arg[8], &cmd.arg[9], }; // Execute the command (and retrieve any errors) this->call(cmd.key, (const Variant **)arg, cmd.args, err); } // Clear the pending commands pending_commands.clear(); } bool Tween::_set(const StringName &p_name, const Variant &p_value) { // Set the correct attribute based on the given name String name = p_name; if (name == ""playback/speed"" || name == ""speed"") { // Backwards compatibility set_speed_scale(p_value); return true; } else if (name == ""playback/active"") { set_active(p_value); return true; } else if (name == ""playback/repeat"") { set_repeat(p_value); return true; } return false; } bool Tween::_get(const StringName &p_name, Variant &r_ret) const { // Get the correct attribute based on the given name String name = p_name; if (name == ""playback/speed"") { // Backwards compatibility r_ret = speed_scale; return true; } else if (name == ""playback/active"") { r_ret = is_active(); return true; } else if (name == ""playback/repeat"") { r_ret = is_repeat(); return true; } return false; } void Tween::_get_property_list(List *p_list) const { // Add the property info for the Tween object p_list->push_back(PropertyInfo(Variant::BOOL, ""playback/active"", PROPERTY_HINT_NONE, """")); p_list->push_back(PropertyInfo(Variant::BOOL, ""playback/repeat"", PROPERTY_HINT_NONE, """")); p_list->push_back(PropertyInfo(Variant::FLOAT, ""playback/speed"", PROPERTY_HINT_RANGE, ""-64,64,0.01"")); } void Tween::_notification(int p_what) { // What notification did we receive? switch (p_what) { case NOTIFICATION_ENTER_TREE: { // Are we not already active? if (!is_active()) { // Make sure that a previous process state was not saved // Only process if ""processing"" is set set_physics_process_internal(false); set_process_internal(false); } } break; case NOTIFICATION_READY: { // Do nothing } break; case NOTIFICATION_INTERNAL_PROCESS: { // Are we processing during physics time? if (tween_process_mode == TWEEN_PROCESS_PHYSICS) { // Do nothing since we aren't aligned with physics when we should be break; } // Should we update? if (is_active()) { // Update the tweens _tween_process(get_process_delta_time()); } } break; case NOTIFICATION_INTERNAL_PHYSICS_PROCESS: { // Are we processing during 'regular' time? if (tween_process_mode == TWEEN_PROCESS_IDLE) { // Do nothing since we would only process during idle time break; } // Should we update? if (is_active()) { // Update the tweens _tween_process(get_physics_process_delta_time()); } } break; case NOTIFICATION_EXIT_TREE: { // We've left the tree. Stop all tweens stop_all(); } break; } } void Tween::_bind_methods() { // Bind getters and setters ClassDB::bind_method(D_METHOD(""is_active""), &Tween::is_active); ClassDB::bind_method(D_METHOD(""set_active"", ""active""), &Tween::set_active); ClassDB::bind_method(D_METHOD(""is_repeat""), &Tween::is_repeat); ClassDB::bind_method(D_METHOD(""set_repeat"", ""repeat""), &Tween::set_repeat); ClassDB::bind_method(D_METHOD(""set_speed_scale"", ""speed""), &Tween::set_speed_scale); ClassDB::bind_method(D_METHOD(""get_speed_scale""), &Tween::get_speed_scale); ClassDB::bind_method(D_METHOD(""set_tween_process_mode"", ""mode""), &Tween::set_tween_process_mode); ClassDB::bind_method(D_METHOD(""get_tween_process_mode""), &Tween::get_tween_process_mode); // Bind the various Tween control methods ClassDB::bind_method(D_METHOD(""start""), &Tween::start); ClassDB::bind_method(D_METHOD(""reset"", ""object"", ""key""), &Tween::reset, DEFVAL("""")); ClassDB::bind_method(D_METHOD(""reset_all""), &Tween::reset_all); ClassDB::bind_method(D_METHOD(""stop"", ""object"", ""key""), &Tween::stop, DEFVAL("""")); ClassDB::bind_method(D_METHOD(""stop_all""), &Tween::stop_all); ClassDB::bind_method(D_METHOD(""resume"", ""object"", ""key""), &Tween::resume, DEFVAL("""")); ClassDB::bind_method(D_METHOD(""resume_all""), &Tween::resume_all); ClassDB::bind_method(D_METHOD(""remove"", ""object"", ""key""), &Tween::remove, DEFVAL("""")); ClassDB::bind_method(D_METHOD(""_remove_by_uid"", ""uid""), &Tween::_remove_by_uid); ClassDB::bind_method(D_METHOD(""remove_all""), &Tween::remove_all); ClassDB::bind_method(D_METHOD(""seek"", ""time""), &Tween::seek); ClassDB::bind_method(D_METHOD(""tell""), &Tween::tell); ClassDB::bind_method(D_METHOD(""get_runtime""), &Tween::get_runtime); // Bind interpolation and follow methods ClassDB::bind_method(D_METHOD(""interpolate_property"", ""object"", ""property"", ""initial_val"", ""final_val"", ""duration"", ""trans_type"", ""ease_type"", ""delay""), &Tween::interpolate_property, DEFVAL(TRANS_LINEAR), DEFVAL(EASE_IN_OUT), DEFVAL(0)); ClassDB::bind_method(D_METHOD(""interpolate_method"", ""object"", ""method"", ""initial_val"", ""final_val"", ""duration"", ""trans_type"", ""ease_type"", ""delay""), &Tween::interpolate_method, DEFVAL(TRANS_LINEAR), DEFVAL(EASE_IN_OUT), DEFVAL(0)); ClassDB::bind_method(D_METHOD(""interpolate_callback"", ""object"", ""duration"", ""callback"", ""arg1"", ""arg2"", ""arg3"", ""arg4"", ""arg5""), &Tween::interpolate_callback, DEFVAL(Variant()), DEFVAL(Variant()), DEFVAL(Variant()), DEFVAL(Variant()), DEFVAL(Variant())); ClassDB::bind_method(D_METHOD(""interpolate_deferred_callback"", ""object"", ""duration"", ""callback"", ""arg1"", ""arg2"", ""arg3"", ""arg4"", ""arg5""), &Tween::interpolate_deferred_callback, DEFVAL(Variant()), DEFVAL(Variant()), DEFVAL(Variant()), DEFVAL(Variant()), DEFVAL(Variant())); ClassDB::bind_method(D_METHOD(""follow_property"", ""object"", ""property"", ""initial_val"", ""target"", ""target_property"", ""duration"", ""trans_type"", ""ease_type"", ""delay""), &Tween::follow_property, DEFVAL(TRANS_LINEAR), DEFVAL(EASE_IN_OUT), DEFVAL(0)); ClassDB::bind_method(D_METHOD(""follow_method"", ""object"", ""method"", ""initial_val"", ""target"", ""target_method"", ""duration"", ""trans_type"", ""ease_type"", ""delay""), &Tween::follow_method, DEFVAL(TRANS_LINEAR), DEFVAL(EASE_IN_OUT), DEFVAL(0)); ClassDB::bind_method(D_METHOD(""targeting_property"", ""object"", ""property"", ""initial"", ""initial_val"", ""final_val"", ""duration"", ""trans_type"", ""ease_type"", ""delay""), &Tween::targeting_property, DEFVAL(TRANS_LINEAR), DEFVAL(EASE_IN_OUT), DEFVAL(0)); ClassDB::bind_method(D_METHOD(""targeting_method"", ""object"", ""method"", ""initial"", ""initial_method"", ""final_val"", ""duration"", ""trans_type"", ""ease_type"", ""delay""), &Tween::targeting_method, DEFVAL(TRANS_LINEAR), DEFVAL(EASE_IN_OUT), DEFVAL(0)); // Add the Tween signals ADD_SIGNAL(MethodInfo(""tween_started"", PropertyInfo(Variant::OBJECT, ""object""), PropertyInfo(Variant::NODE_PATH, ""key""))); ADD_SIGNAL(MethodInfo(""tween_step"", PropertyInfo(Variant::OBJECT, ""object""), PropertyInfo(Variant::NODE_PATH, ""key""), PropertyInfo(Variant::FLOAT, ""elapsed""), PropertyInfo(Variant::OBJECT, ""value""))); ADD_SIGNAL(MethodInfo(""tween_completed"", PropertyInfo(Variant::OBJECT, ""object""), PropertyInfo(Variant::NODE_PATH, ""key""))); ADD_SIGNAL(MethodInfo(""tween_all_completed"")); // Add the properties and tie them to the getters and setters ADD_PROPERTY(PropertyInfo(Variant::BOOL, ""repeat""), ""set_repeat"", ""is_repeat""); ADD_PROPERTY(PropertyInfo(Variant::INT, ""playback_process_mode"", PROPERTY_HINT_ENUM, ""Physics,Idle""), ""set_tween_process_mode"", ""get_tween_process_mode""); ADD_PROPERTY(PropertyInfo(Variant::FLOAT, ""playback_speed"", PROPERTY_HINT_RANGE, ""-64,64,0.01""), ""set_speed_scale"", ""get_speed_scale""); // Bind Idle vs Physics process BIND_ENUM_CONSTANT(TWEEN_PROCESS_PHYSICS); BIND_ENUM_CONSTANT(TWEEN_PROCESS_IDLE); // Bind the Transition type constants BIND_ENUM_CONSTANT(TRANS_LINEAR); BIND_ENUM_CONSTANT(TRANS_SINE); BIND_ENUM_CONSTANT(TRANS_QUINT); BIND_ENUM_CONSTANT(TRANS_QUART); BIND_ENUM_CONSTANT(TRANS_QUAD); BIND_ENUM_CONSTANT(TRANS_EXPO); BIND_ENUM_CONSTANT(TRANS_ELASTIC); BIND_ENUM_CONSTANT(TRANS_CUBIC); BIND_ENUM_CONSTANT(TRANS_CIRC); BIND_ENUM_CONSTANT(TRANS_BOUNCE); BIND_ENUM_CONSTANT(TRANS_BACK); // Bind the easing constants BIND_ENUM_CONSTANT(EASE_IN); BIND_ENUM_CONSTANT(EASE_OUT); BIND_ENUM_CONSTANT(EASE_IN_OUT); BIND_ENUM_CONSTANT(EASE_OUT_IN); } Variant Tween::_get_initial_val(const InterpolateData &p_data) const { // What type of data are we interpolating? switch (p_data.type) { case INTER_PROPERTY: case INTER_METHOD: case FOLLOW_PROPERTY: case FOLLOW_METHOD: // Simply use the given initial value return p_data.initial_val; case TARGETING_PROPERTY: case TARGETING_METHOD: { // Get the object that is being targeted Object *object = ObjectDB::get_instance(p_data.target_id); ERR_FAIL_COND_V(object == nullptr, p_data.initial_val); // Are we targeting a property or a method? Variant initial_val; if (p_data.type == TARGETING_PROPERTY) { // Get the property from the target object bool valid = false; initial_val = object->get_indexed(p_data.target_key, &valid); ERR_FAIL_COND_V(!valid, p_data.initial_val); } else { // Call the method and get the initial value from it Callable::CallError error; initial_val = object->call(p_data.target_key[0], nullptr, 0, error); ERR_FAIL_COND_V(error.error != Callable::CallError::CALL_OK, p_data.initial_val); } return initial_val; } case INTER_CALLBACK: // Callback does not have a special initial value break; } // If we've made it here, just return the delta value as the initial value return p_data.delta_val; } Variant Tween::_get_final_val(const InterpolateData &p_data) const { switch (p_data.type) { case FOLLOW_PROPERTY: case FOLLOW_METHOD: { // Get the object that is being followed Object *target = ObjectDB::get_instance(p_data.target_id); ERR_FAIL_COND_V(target == nullptr, p_data.initial_val); // We want to figure out the final value Variant final_val; if (p_data.type == FOLLOW_PROPERTY) { // Read the property as-is bool valid = false; final_val = target->get_indexed(p_data.target_key, &valid); ERR_FAIL_COND_V(!valid, p_data.initial_val); } else { // We're looking at a method. Call the method on the target object Callable::CallError error; final_val = target->call(p_data.target_key[0], nullptr, 0, error); ERR_FAIL_COND_V(error.error != Callable::CallError::CALL_OK, p_data.initial_val); } // If we're looking at an INT value, instead convert it to a FLOAT // This is better for interpolation if (final_val.get_type() == Variant::INT) { final_val = final_val.operator real_t(); } return final_val; } default: { // If we're not following a final value/method, use the final value from the data return p_data.final_val; } } } Variant &Tween::_get_delta_val(InterpolateData &p_data) { // What kind of data are we interpolating? switch (p_data.type) { case INTER_PROPERTY: case INTER_METHOD: // Simply return the given delta value return p_data.delta_val; case FOLLOW_PROPERTY: case FOLLOW_METHOD: { // We're following an object, so grab that instance Object *target = ObjectDB::get_instance(p_data.target_id); ERR_FAIL_COND_V(target == nullptr, p_data.initial_val); // We want to figure out the final value Variant final_val; if (p_data.type == FOLLOW_PROPERTY) { // Read the property as-is bool valid = false; final_val = target->get_indexed(p_data.target_key, &valid); ERR_FAIL_COND_V(!valid, p_data.initial_val); } else { // We're looking at a method. Call the method on the target object Callable::CallError error; final_val = target->call(p_data.target_key[0], nullptr, 0, error); ERR_FAIL_COND_V(error.error != Callable::CallError::CALL_OK, p_data.initial_val); } // If we're looking at an INT value, instead convert it to a FLOAT // This is better for interpolation if (final_val.get_type() == Variant::INT) { final_val = final_val.operator real_t(); } // Calculate the delta based on the initial value and the final value _calc_delta_val(p_data.initial_val, final_val, p_data.delta_val); return p_data.delta_val; } case TARGETING_PROPERTY: case TARGETING_METHOD: { // Grab the initial value from the data to calculate delta Variant initial_val = _get_initial_val(p_data); // If we're looking at an INT value, instead convert it to a FLOAT // This is better for interpolation if (initial_val.get_type() == Variant::INT) { initial_val = initial_val.operator real_t(); } // Calculate the delta based on the initial value and the final value _calc_delta_val(initial_val, p_data.final_val, p_data.delta_val); return p_data.delta_val; } case INTER_CALLBACK: // Callbacks have no special delta break; } // If we've made it here, use the initial value as the delta return p_data.initial_val; } Variant Tween::_run_equation(InterpolateData &p_data) { // Get the initial and delta values from the data Variant initial_val = _get_initial_val(p_data); Variant &delta_val = _get_delta_val(p_data); Variant result; #define APPLY_EQUATION(element) \\ r.element = _run_equation(p_data.trans_type, p_data.ease_type, p_data.elapsed - p_data.delay, i.element, d.element, p_data.duration); // What type of data are we interpolating? switch (initial_val.get_type()) { case Variant::BOOL: // Run the boolean specific equation (checking if it is at least 0.5) result = (_run_equation(p_data.trans_type, p_data.ease_type, p_data.elapsed - p_data.delay, initial_val, delta_val, p_data.duration)) >= 0.5; break; case Variant::INT: // Run the integer specific equation result = (int)_run_equation(p_data.trans_type, p_data.ease_type, p_data.elapsed - p_data.delay, (int)initial_val, (int)delta_val, p_data.duration); break; case Variant::FLOAT: // Run the FLOAT specific equation result = _run_equation(p_data.trans_type, p_data.ease_type, p_data.elapsed - p_data.delay, (real_t)initial_val, (real_t)delta_val, p_data.duration); break; case Variant::VECTOR2: { // Get vectors for initial and delta values Vector2 i = initial_val; Vector2 d = delta_val; Vector2 r; // Execute the equation and mutate the r vector // This uses the custom APPLY_EQUATION macro defined above APPLY_EQUATION(x); APPLY_EQUATION(y); result = r; } break; case Variant::RECT2: { // Get the Rect2 for initial and delta value Rect2 i = initial_val; Rect2 d = delta_val; Rect2 r; // Execute the equation for the position and size of Rect2 APPLY_EQUATION(position.x); APPLY_EQUATION(position.y); APPLY_EQUATION(size.x); APPLY_EQUATION(size.y); result = r; } break; case Variant::VECTOR3: { // Get vectors for initial and delta values Vector3 i = initial_val; Vector3 d = delta_val; Vector3 r; // Execute the equation and mutate the r vector // This uses the custom APPLY_EQUATION macro defined above APPLY_EQUATION(x); APPLY_EQUATION(y); APPLY_EQUATION(z); result = r; } break; case Variant::TRANSFORM2D: { // Get the transforms for initial and delta values Transform2D i = initial_val; Transform2D d = delta_val; Transform2D r; // Execute the equation on the transforms and mutate the r transform // This uses the custom APPLY_EQUATION macro defined above APPLY_EQUATION(elements[0][0]); APPLY_EQUATION(elements[0][1]); APPLY_EQUATION(elements[1][0]); APPLY_EQUATION(elements[1][1]); APPLY_EQUATION(elements[2][0]); APPLY_EQUATION(elements[2][1]); result = r; } break; case Variant::QUAT: { // Get the quaternian for the initial and delta values Quat i = initial_val; Quat d = delta_val; Quat r; // Execute the equation on the quaternian values and mutate the r quaternian // This uses the custom APPLY_EQUATION macro defined above APPLY_EQUATION(x); APPLY_EQUATION(y); APPLY_EQUATION(z); APPLY_EQUATION(w); result = r; } break; case Variant::AABB: { // Get the AABB's for the initial and delta values AABB i = initial_val; AABB d = delta_val; AABB r; // Execute the equation for the position and size of the AABB's and mutate the r AABB // This uses the custom APPLY_EQUATION macro defined above APPLY_EQUATION(position.x); APPLY_EQUATION(position.y); APPLY_EQUATION(position.z); APPLY_EQUATION(size.x); APPLY_EQUATION(size.y); APPLY_EQUATION(size.z); result = r; } break; case Variant::BASIS: { // Get the basis for initial and delta values Basis i = initial_val; Basis d = delta_val; Basis r; // Execute the equation on all the basis and mutate the r basis // This uses the custom APPLY_EQUATION macro defined above APPLY_EQUATION(elements[0][0]); APPLY_EQUATION(elements[0][1]); APPLY_EQUATION(elements[0][2]); APPLY_EQUATION(elements[1][0]); APPLY_EQUATION(elements[1][1]); APPLY_EQUATION(elements[1][2]); APPLY_EQUATION(elements[2][0]); APPLY_EQUATION(elements[2][1]); APPLY_EQUATION(elements[2][2]); result = r; } break; case Variant::TRANSFORM: { // Get the transforms for the initial and delta values Transform i = initial_val; Transform d = delta_val; Transform r; // Execute the equation for each of the transforms and their origin and mutate the r transform // This uses the custom APPLY_EQUATION macro defined above APPLY_EQUATION(basis.elements[0][0]); APPLY_EQUATION(basis.elements[0][1]); APPLY_EQUATION(basis.elements[0][2]); APPLY_EQUATION(basis.elements[1][0]); APPLY_EQUATION(basis.elements[1][1]); APPLY_EQUATION(basis.elements[1][2]); APPLY_EQUATION(basis.elements[2][0]); APPLY_EQUATION(basis.elements[2][1]); APPLY_EQUATION(basis.elements[2][2]); APPLY_EQUATION(origin.x); APPLY_EQUATION(origin.y); APPLY_EQUATION(origin.z); result = r; } break; case Variant::COLOR: { // Get the Color for initial and delta value Color i = initial_val; Color d = delta_val; Color r; // Apply the equation on the Color RGBA, and mutate the r color // This uses the custom APPLY_EQUATION macro defined above APPLY_EQUATION(r); APPLY_EQUATION(g); APPLY_EQUATION(b); APPLY_EQUATION(a); result = r; } break; default: { // If unknown, just return the initial value result = initial_val; } break; }; #undef APPLY_EQUATION // Return the result that was computed return result; } bool Tween::_apply_tween_value(InterpolateData &p_data, Variant &value) { // Get the object we want to apply the new value to Object *object = ObjectDB::get_instance(p_data.id); ERR_FAIL_COND_V(object == nullptr, false); // What kind of data are we mutating? switch (p_data.type) { case INTER_PROPERTY: case FOLLOW_PROPERTY: case TARGETING_PROPERTY: { // Simply set the property on the object bool valid = false; object->set_indexed(p_data.key, value, &valid); return valid; } case INTER_METHOD: case FOLLOW_METHOD: case TARGETING_METHOD: { // We want to call the method on the target object Callable::CallError error; // Do we have a non-nil value passed in? if (value.get_type() != Variant::NIL) { // Pass it as an argument to the function call Variant *arg[1] = { &value }; object->call(p_data.key[0], (const Variant **)arg, 1, error); } else { // Don't pass any argument object->call(p_data.key[0], nullptr, 0, error); } // Did we get an error from the function call? return error.error == Callable::CallError::CALL_OK; } case INTER_CALLBACK: // Nothing to apply for a callback break; }; // No issues found! return true; } void Tween::_tween_process(float p_delta) { // Process all of the pending commands _process_pending_commands(); // If the scale is 0, make no progress on the tweens if (speed_scale == 0) { return; } // Update the delta and whether we are pending an update p_delta *= speed_scale; pending_update++; // Are we repeating the interpolations? if (repeat) { // For each interpolation... bool repeats_finished = true; for (List::Element *E = interpolates.front(); E; E = E->next()) { // Get the data from it InterpolateData &data = E->get(); // Is not finished? if (!data.finish) { // We aren't finished yet, no need to check the rest repeats_finished = false; break; } } // If we are all finished, we can reset all of the tweens if (repeats_finished) { reset_all(); } } // Are all of the tweens complete? int any_unfinished = 0; // For each tween we wish to interpolate... for (List::Element *E = interpolates.front(); E; E = E->next()) { // Get the data from it InterpolateData &data = E->get(); // Is the data not active or already finished? No need to go any further if (!data.active || data.finish) { continue; } // Track if we hit one that isn't finished yet any_unfinished++; // Get the target object for this interpolation Object *object = ObjectDB::get_instance(data.id); if (object == nullptr) { continue; } // Are we still delaying this tween? bool prev_delaying = data.elapsed <= data.delay; data.elapsed += p_delta; if (data.elapsed < data.delay) { continue; } else if (prev_delaying) { // We can apply the tween's value to the data and emit that the tween has started _apply_tween_value(data, data.initial_val); emit_signal(""tween_started"", object, NodePath(Vector(), data.key, false)); } // Are we at the end of the tween? if (data.elapsed > (data.delay + data.duration)) { // Set the elapsed time to the end and mark this one as finished data.elapsed = data.delay + data.duration; data.finish = true; } // Are we interpolating a callback? if (data.type == INTER_CALLBACK) { // Is the tween completed? if (data.finish) { // Are we calling this callback deferred or immediately? if (data.call_deferred) { // Run the deferred function callback, applying the correct number of arguments switch (data.args) { case 0: object->call_deferred(data.key[0]); break; case 1: object->call_deferred(data.key[0], data.arg[0]); break; case 2: object->call_deferred(data.key[0], data.arg[0], data.arg[1]); break; case 3: object->call_deferred(data.key[0], data.arg[0], data.arg[1], data.arg[2]); break; case 4: object->call_deferred(data.key[0], data.arg[0], data.arg[1], data.arg[2], data.arg[3]); break; case 5: object->call_deferred(data.key[0], data.arg[0], data.arg[1], data.arg[2], data.arg[3], data.arg[4]); break; } } else { // Call the function directly with the arguments Callable::CallError error; Variant *arg[5] = { &data.arg[0], &data.arg[1], &data.arg[2], &data.arg[3], &data.arg[4], }; object->call(data.key[0], (const Variant **)arg, data.args, error); } } } else { // We can apply the value directly Variant result = _run_equation(data); _apply_tween_value(data, result); // Emit that the tween has taken a step emit_signal(""tween_step"", object, NodePath(Vector(), data.key, false), data.elapsed, result); } // Is the tween now finished? if (data.finish) { // Set it to the final value directly Variant final_val = _get_final_val(data); _apply_tween_value(data, final_val); // Mark the tween as completed and emit the signal data.elapsed = 0; emit_signal(""tween_completed"", object, NodePath(Vector(), data.key, false)); // If we are not repeating the tween, remove it if (!repeat) { call_deferred(""_remove_by_uid"", data.uid); any_unfinished--; } } } // One less update left to go pending_update--; // If all tweens are completed, we no longer need to be active if (any_unfinished == 0) { set_active(false); emit_signal(""tween_all_completed""); } } void Tween::set_tween_process_mode(TweenProcessMode p_mode) { tween_process_mode = p_mode; } Tween::TweenProcessMode Tween::get_tween_process_mode() const { return tween_process_mode; } bool Tween::is_active() const { return is_processing_internal() || is_physics_processing_internal(); } void Tween::set_active(bool p_active) { // Do nothing if it's the same active mode that we currently are if (is_active() == p_active) { return; } // Depending on physics or idle, set processing switch (tween_process_mode) { case TWEEN_PROCESS_IDLE: set_process_internal(p_active); break; case TWEEN_PROCESS_PHYSICS: set_physics_process_internal(p_active); break; } } bool Tween::is_repeat() const { return repeat; } void Tween::set_repeat(bool p_repeat) { repeat = p_repeat; } void Tween::set_speed_scale(float p_speed) { speed_scale = p_speed; } float Tween::get_speed_scale() const { return speed_scale; } void Tween::start() { ERR_FAIL_COND_MSG(!is_inside_tree(), ""Tween was not added to the SceneTree!""); // Are there any pending updates? if (pending_update != 0) { // Start the tweens after deferring call_deferred(""start""); return; } // We want to be activated set_active(true); } void Tween::reset(Object *p_object, StringName p_key) { // Find all interpolations that use the same object and target string pending_update++; for (List::Element *E = interpolates.front(); E; E = E->next()) { // Get the target object InterpolateData &data = E->get(); Object *object = ObjectDB::get_instance(data.id); if (object == nullptr) { continue; } // Do we have the correct object and key? if (object == p_object && (data.concatenated_key == p_key || p_key == """")) { // Reset the tween to the initial state data.elapsed = 0; data.finish = false; // Also apply the initial state if there isn't a delay if (data.delay == 0) { _apply_tween_value(data, data.initial_val); } } } pending_update--; } void Tween::reset_all() { // Go through all interpolations pending_update++; for (List::Element *E = interpolates.front(); E; E = E->next()) { // Get the target data and set it back to the initial state InterpolateData &data = E->get(); data.elapsed = 0; data.finish = false; // If there isn't a delay, apply the value to the object if (data.delay == 0) { _apply_tween_value(data, data.initial_val); } } pending_update--; } void Tween::stop(Object *p_object, StringName p_key) { // Find the tween that has the given target object and string key pending_update++; for (List::Element *E = interpolates.front(); E; E = E->next()) { // Get the object the tween is targeting InterpolateData &data = E->get(); Object *object = ObjectDB::get_instance(data.id); if (object == nullptr) { continue; } // Is this the correct object and does it have the given key? if (object == p_object && (data.concatenated_key == p_key || p_key == """")) { // Disable the tween data.active = false; } } pending_update--; } void Tween::stop_all() { // We no longer need to be active since all tweens have been stopped set_active(false); // For each interpolation... pending_update++; for (List::Element *E = interpolates.front(); E; E = E->next()) { // Simply set it inactive InterpolateData &data = E->get(); data.active = false; } pending_update--; } void Tween::resume(Object *p_object, StringName p_key) { // We need to be activated // TODO: What if no tween is found?? set_active(true); // Find the tween that uses the given target object and string key pending_update++; for (List::Element *E = interpolates.front(); E; E = E->next()) { // Grab the object InterpolateData &data = E->get(); Object *object = ObjectDB::get_instance(data.id); if (object == nullptr) { continue; } // If the object and string key match, activate it if (object == p_object && (data.concatenated_key == p_key || p_key == """")) { data.active = true; } } pending_update--; } void Tween::resume_all() { // Set ourselves active so we can process tweens // TODO: What if there are no tweens? We get set to active for no reason! set_active(true); // For each interpolation... pending_update++; for (List::Element *E = interpolates.front(); E; E = E->next()) { // Simply grab it and set it to active InterpolateData &data = E->get(); data.active = true; } pending_update--; } void Tween::remove(Object *p_object, StringName p_key) { // If we are still updating, call this function again later if (pending_update != 0) { call_deferred(""remove"", p_object, p_key); return; } // For each interpolation... List::Element *> for_removal; for (List::Element *E = interpolates.front(); E; E = E->next()) { // Get the target object InterpolateData &data = E->get(); Object *object = ObjectDB::get_instance(data.id); if (object == nullptr) { continue; } // If the target object and string key match, queue it for removal if (object == p_object && (data.concatenated_key == p_key || p_key == """")) { for_removal.push_back(E); } } // For each interpolation we wish to remove... for (List::Element *>::Element *E = for_removal.front(); E; E = E->next()) { // Erase it interpolates.erase(E->get()); } } void Tween::_remove_by_uid(int uid) { // If we are still updating, call this function again later if (pending_update != 0) { call_deferred(""_remove_by_uid"", uid); return; } // Find the interpolation that matches the given UID for (List::Element *E = interpolates.front(); E; E = E->next()) { if (uid == E->get().uid) { // It matches, erase it and stop looking E->erase(); break; } } } void Tween::_push_interpolate_data(InterpolateData &p_data) { pending_update++; // Add the new interpolation p_data.uid = ++uid; interpolates.push_back(p_data); pending_update--; } void Tween::remove_all() { // If we are still updating, call this function again later if (pending_update != 0) { call_deferred(""remove_all""); return; } // We no longer need to be active set_active(false); // Clear out all interpolations and reset the uid interpolates.clear(); uid = 0; } void Tween::seek(real_t p_time) { // Go through each interpolation... pending_update++; for (List::Element *E = interpolates.front(); E; E = E->next()) { // Get the target data InterpolateData &data = E->get(); // Update the elapsed data to be set to the target time data.elapsed = p_time; // Are we at the end? if (data.elapsed < data.delay) { // There is still time left to go data.finish = false; continue; } else if (data.elapsed >= (data.delay + data.duration)) { // We are past the end of it, set the elapsed time to the end and mark as finished data.elapsed = (data.delay + data.duration); data.finish = true; } else { // We are not finished with this interpolation yet data.finish = false; } // If we are a callback, do nothing special if (data.type == INTER_CALLBACK) { continue; } // Run the equation on the data and apply the value Variant result = _run_equation(data); _apply_tween_value(data, result); } pending_update--; } real_t Tween::tell() const { // We want to grab the position of the furthest along tween pending_update++; real_t pos = 0; // For each interpolation... for (const List::Element *E = interpolates.front(); E; E = E->next()) { // Get the data and figure out if it's position is further along than the previous ones const InterpolateData &data = E->get(); if (data.elapsed > pos) { // Save it if so pos = data.elapsed; } } pending_update--; return pos; } real_t Tween::get_runtime() const { // If the tween isn't moving, it'll last forever if (speed_scale == 0) { return INFINITY; } pending_update++; // For each interpolation... real_t runtime = 0; for (const List::Element *E = interpolates.front(); E; E = E->next()) { // Get the tween data and see if it's runtime is greater than the previous tweens const InterpolateData &data = E->get(); real_t t = data.delay + data.duration; if (t > runtime) { // This is the longest running tween runtime = t; } } pending_update--; // Adjust the runtime for the current speed scale return runtime / speed_scale; } bool Tween::_calc_delta_val(const Variant &p_initial_val, const Variant &p_final_val, Variant &p_delta_val) { // Get the initial, final, and delta values const Variant &initial_val = p_initial_val; const Variant &final_val = p_final_val; Variant &delta_val = p_delta_val; // What kind of data are we interpolating? switch (initial_val.get_type()) { case Variant::BOOL: // We'll treat booleans just like integers case Variant::INT: // Compute the integer delta delta_val = (int)final_val - (int)initial_val; break; case Variant::FLOAT: // Convert to FLOAT and find the delta delta_val = (real_t)final_val - (real_t)initial_val; break; case Variant::VECTOR2: // Convert to Vectors and find the delta delta_val = final_val.operator Vector2() - initial_val.operator Vector2(); break; case Variant::RECT2: { // Build a new Rect2 and use the new position and sizes to make a delta Rect2 i = initial_val; Rect2 f = final_val; delta_val = Rect2(f.position - i.position, f.size - i.size); } break; case Variant::VECTOR3: // Convert to Vectors and find the delta delta_val = final_val.operator Vector3() - initial_val.operator Vector3(); break; case Variant::TRANSFORM2D: { // Build a new transform which is the difference between the initial and final values Transform2D i = initial_val; Transform2D f = final_val; Transform2D d = Transform2D(); d[0][0] = f.elements[0][0] - i.elements[0][0]; d[0][1] = f.elements[0][1] - i.elements[0][1]; d[1][0] = f.elements[1][0] - i.elements[1][0]; d[1][1] = f.elements[1][1] - i.elements[1][1]; d[2][0] = f.elements[2][0] - i.elements[2][0]; d[2][1] = f.elements[2][1] - i.elements[2][1]; delta_val = d; } break; case Variant::QUAT: // Convert to quaternianls and find the delta delta_val = final_val.operator Quat() - initial_val.operator Quat(); break; case Variant::AABB: { // Build a new AABB and use the new position and sizes to make a delta AABB i = initial_val; AABB f = final_val; delta_val = AABB(f.position - i.position, f.size - i.size); } break; case Variant::BASIS: { // Build a new basis which is the delta between the initial and final values Basis i = initial_val; Basis f = final_val; delta_val = Basis(f.elements[0][0] - i.elements[0][0], f.elements[0][1] - i.elements[0][1], f.elements[0][2] - i.elements[0][2], f.elements[1][0] - i.elements[1][0], f.elements[1][1] - i.elements[1][1], f.elements[1][2] - i.elements[1][2], f.elements[2][0] - i.elements[2][0], f.elements[2][1] - i.elements[2][1], f.elements[2][2] - i.elements[2][2]); } break; case Variant::TRANSFORM: { // Build a new transform which is the difference between the initial and final values Transform i = initial_val; Transform f = final_val; Transform d; d.set(f.basis.elements[0][0] - i.basis.elements[0][0], f.basis.elements[0][1] - i.basis.elements[0][1], f.basis.elements[0][2] - i.basis.elements[0][2], f.basis.elements[1][0] - i.basis.elements[1][0], f.basis.elements[1][1] - i.basis.elements[1][1], f.basis.elements[1][2] - i.basis.elements[1][2], f.basis.elements[2][0] - i.basis.elements[2][0], f.basis.elements[2][1] - i.basis.elements[2][1], f.basis.elements[2][2] - i.basis.elements[2][2], f.origin.x - i.origin.x, f.origin.y - i.origin.y, f.origin.z - i.origin.z); delta_val = d; } break; case Variant::COLOR: { // Make a new color which is the difference between each the color's RGBA attributes Color i = initial_val; Color f = final_val; delta_val = Color(f.r - i.r, f.g - i.g, f.b - i.b, f.a - i.a); } break; default: { static Variant::Type supported_types[] = { Variant::BOOL, Variant::INT, Variant::FLOAT, Variant::VECTOR2, Variant::RECT2, Variant::VECTOR3, Variant::TRANSFORM2D, Variant::QUAT, Variant::AABB, Variant::BASIS, Variant::TRANSFORM, Variant::COLOR, }; int length = *(&supported_types + 1) - supported_types; String error_msg = ""Invalid parameter type. Supported types are: ""; for (int i = 0; i < length; i++) { if (i != 0) { error_msg += "", ""; } error_msg += Variant::get_type_name(supported_types[i]); } error_msg += "".""; ERR_PRINT(error_msg); return false; } }; return true; } void Tween::_build_interpolation(InterpolateType p_interpolation_type, Object *p_object, NodePath *p_property, StringName *p_method, Variant p_initial_val, Variant p_final_val, real_t p_duration, TransitionType p_trans_type, EaseType p_ease_type, real_t p_delay) { // TODO: Add initialization+implementation for remaining interpolation types // TODO: Fix this method's organization to take advantage of the type // Make a new interpolation data InterpolateData data; data.active = true; data.type = p_interpolation_type; data.finish = false; data.elapsed = 0; // Validate and apply interpolation data // Give it the object ERR_FAIL_COND_MSG(p_object == nullptr, ""Invalid object provided to Tween.""); data.id = p_object->get_instance_id(); // Validate the initial and final values ERR_FAIL_COND_MSG(p_initial_val.get_type() != p_final_val.get_type(), ""Initial value type '"" + Variant::get_type_name(p_initial_val.get_type()) + ""' does not match final value type '"" + Variant::get_type_name(p_final_val.get_type()) + ""'.""); data.initial_val = p_initial_val; data.final_val = p_final_val; // Check the Duration ERR_FAIL_COND_MSG(p_duration < 0, ""Only non-negative duration values allowed in Tweens.""); data.duration = p_duration; // Tween Delay ERR_FAIL_COND_MSG(p_delay < 0, ""Only non-negative delay values allowed in Tweens.""); data.delay = p_delay; // Transition type ERR_FAIL_COND_MSG(p_trans_type < 0 || p_trans_type >= TRANS_COUNT, ""Invalid transition type provided to Tween.""); data.trans_type = p_trans_type; // Easing type ERR_FAIL_COND_MSG(p_ease_type < 0 || p_ease_type >= EASE_COUNT, ""Invalid easing type provided to Tween.""); data.ease_type = p_ease_type; // Is the property defined? if (p_property) { // Check that the object actually contains the given property bool prop_valid = false; p_object->get_indexed(p_property->get_subnames(), &prop_valid); ERR_FAIL_COND_MSG(!prop_valid, ""Tween target object has no property named: "" + p_property->get_concatenated_subnames() + "".""); data.key = p_property->get_subnames(); data.concatenated_key = p_property->get_concatenated_subnames(); } // Is the method defined? if (p_method) { // Does the object even have the requested method? ERR_FAIL_COND_MSG(!p_object->has_method(*p_method), ""Tween target object has no method named: "" + *p_method + "".""); data.key.push_back(*p_method); data.concatenated_key = *p_method; } // Is there not a valid delta? if (!_calc_delta_val(data.initial_val, data.final_val, data.delta_val)) { return; } // Add this interpolation to the total _push_interpolate_data(data); } void Tween::interpolate_property(Object *p_object, NodePath p_property, Variant p_initial_val, Variant p_final_val, real_t p_duration, TransitionType p_trans_type, EaseType p_ease_type, real_t p_delay) { // If we are busy updating, call this function again later if (pending_update != 0) { _add_pending_command(""interpolate_property"", p_object, p_property, p_initial_val, p_final_val, p_duration, p_trans_type, p_ease_type, p_delay); return; } // Get the property from the node path p_property = p_property.get_as_property_path(); // If no initial value given, grab the initial value from the object // TODO: Is this documented? This is very useful and removes a lot of clutter from tweens! if (p_initial_val.get_type() == Variant::NIL) { p_initial_val = p_object->get_indexed(p_property.get_subnames()); } // Convert any integers into REALs as they are better for interpolation if (p_initial_val.get_type() == Variant::INT) { p_initial_val = p_initial_val.operator real_t(); } if (p_final_val.get_type() == Variant::INT) { p_final_val = p_final_val.operator real_t(); } // Build the interpolation data _build_interpolation(INTER_PROPERTY, p_object, &p_property, nullptr, p_initial_val, p_final_val, p_duration, p_trans_type, p_ease_type, p_delay); } void Tween::interpolate_method(Object *p_object, StringName p_method, Variant p_initial_val, Variant p_final_val, real_t p_duration, TransitionType p_trans_type, EaseType p_ease_type, real_t p_delay) { // If we are busy updating, call this function again later if (pending_update != 0) { _add_pending_command(""interpolate_method"", p_object, p_method, p_initial_val, p_final_val, p_duration, p_trans_type, p_ease_type, p_delay); return; } // Convert any integers into REALs as they are better for interpolation if (p_initial_val.get_type() == Variant::INT) { p_initial_val = p_initial_val.operator real_t(); } if (p_final_val.get_type() == Variant::INT) { p_final_val = p_final_val.operator real_t(); } // Build the interpolation data _build_interpolation(INTER_METHOD, p_object, nullptr, &p_method, p_initial_val, p_final_val, p_duration, p_trans_type, p_ease_type, p_delay); } void Tween::interpolate_callback(Object *p_object, real_t p_duration, String p_callback, VARIANT_ARG_DECLARE) { // If we are already updating, call this function again later if (pending_update != 0) { _add_pending_command(""interpolate_callback"", p_object, p_duration, p_callback, p_arg1, p_arg2, p_arg3, p_arg4, p_arg5); return; } // Check that the target object is valid ERR_FAIL_COND(p_object == nullptr); // Duration cannot be negative ERR_FAIL_COND(p_duration < 0); // Check whether the object even has the callback ERR_FAIL_COND_MSG(!p_object->has_method(p_callback), ""Object has no callback named: "" + p_callback + "".""); // Build a new InterpolationData InterpolateData data; data.active = true; data.type = INTER_CALLBACK; data.finish = false; data.call_deferred = false; data.elapsed = 0; // Give the data it's configuration data.id = p_object->get_instance_id(); data.key.push_back(p_callback); data.concatenated_key = p_callback; data.duration = p_duration; data.delay = 0; // Add arguments to the interpolation int args = 0; if (p_arg5.get_type() != Variant::NIL) { args = 5; } else if (p_arg4.get_type() != Variant::NIL) { args = 4; } else if (p_arg3.get_type() != Variant::NIL) { args = 3; } else if (p_arg2.get_type() != Variant::NIL) { args = 2; } else if (p_arg1.get_type() != Variant::NIL) { args = 1; } else { args = 0; } data.args = args; data.arg[0] = p_arg1; data.arg[1] = p_arg2; data.arg[2] = p_arg3; data.arg[3] = p_arg4; data.arg[4] = p_arg5; // Add the new interpolation _push_interpolate_data(data); } void Tween::interpolate_deferred_callback(Object *p_object, real_t p_duration, String p_callback, VARIANT_ARG_DECLARE) { // If we are already updating, call this function again later if (pending_update != 0) { _add_pending_command(""interpolate_deferred_callback"", p_object, p_duration, p_callback, p_arg1, p_arg2, p_arg3, p_arg4, p_arg5); return; } // Check that the target object is valid ERR_FAIL_COND(p_object == nullptr); // No negative durations allowed ERR_FAIL_COND(p_duration < 0); // Confirm the callback exists on the object ERR_FAIL_COND_MSG(!p_object->has_method(p_callback), ""Object has no callback named: "" + p_callback + "".""); // Create a new InterpolateData for the callback InterpolateData data; data.active = true; data.type = INTER_CALLBACK; data.finish = false; data.call_deferred = true; data.elapsed = 0; // Give the data it's configuration data.id = p_object->get_instance_id(); data.key.push_back(p_callback); data.concatenated_key = p_callback; data.duration = p_duration; data.delay = 0; // Collect arguments for the callback int args = 0; if (p_arg5.get_type() != Variant::NIL) { args = 5; } else if (p_arg4.get_type() != Variant::NIL) { args = 4; } else if (p_arg3.get_type() != Variant::NIL) { args = 3; } else if (p_arg2.get_type() != Variant::NIL) { args = 2; } else if (p_arg1.get_type() != Variant::NIL) { args = 1; } else { args = 0; } data.args = args; data.arg[0] = p_arg1; data.arg[1] = p_arg2; data.arg[2] = p_arg3; data.arg[3] = p_arg4; data.arg[4] = p_arg5; // Add the new interpolation _push_interpolate_data(data); } void Tween::follow_property(Object *p_object, NodePath p_property, Variant p_initial_val, Object *p_target, NodePath p_target_property, real_t p_duration, TransitionType p_trans_type, EaseType p_ease_type, real_t p_delay) { // If we are already updating, call this function again later if (pending_update != 0) { _add_pending_command(""follow_property"", p_object, p_property, p_initial_val, p_target, p_target_property, p_duration, p_trans_type, p_ease_type, p_delay); return; } // Get the two properties from their paths p_property = p_property.get_as_property_path(); p_target_property = p_target_property.get_as_property_path(); // If no initial value is given, grab it from the source object // TODO: Is this documented? It's really helpful for decluttering tweens if (p_initial_val.get_type() == Variant::NIL) { p_initial_val = p_object->get_indexed(p_property.get_subnames()); } // Convert initial INT values to FLOAT as they are better for interpolation if (p_initial_val.get_type() == Variant::INT) { p_initial_val = p_initial_val.operator real_t(); } // Confirm the source and target objects are valid ERR_FAIL_COND(p_object == nullptr); ERR_FAIL_COND(p_target == nullptr); // No negative durations ERR_FAIL_COND(p_duration < 0); // Ensure transition and easing types are valid ERR_FAIL_COND(p_trans_type < 0 || p_trans_type >= TRANS_COUNT); ERR_FAIL_COND(p_ease_type < 0 || p_ease_type >= EASE_COUNT); // No negative delays ERR_FAIL_COND(p_delay < 0); // Confirm the source and target objects have the desired properties bool prop_valid = false; p_object->get_indexed(p_property.get_subnames(), &prop_valid); ERR_FAIL_COND(!prop_valid); bool target_prop_valid = false; Variant target_val = p_target->get_indexed(p_target_property.get_subnames(), &target_prop_valid); ERR_FAIL_COND(!target_prop_valid); // Convert target INT to FLOAT since it is better for interpolation if (target_val.get_type() == Variant::INT) { target_val = target_val.operator real_t(); } // Verify that the target value and initial value are the same type ERR_FAIL_COND(target_val.get_type() != p_initial_val.get_type()); // Create a new InterpolateData InterpolateData data; data.active = true; data.type = FOLLOW_PROPERTY; data.finish = false; data.elapsed = 0; // Give the InterpolateData it's configuration data.id = p_object->get_instance_id(); data.key = p_property.get_subnames(); data.concatenated_key = p_property.get_concatenated_subnames(); data.initial_val = p_initial_val; data.target_id = p_target->get_instance_id(); data.target_key = p_target_property.get_subnames(); data.duration = p_duration; data.trans_type = p_trans_type; data.ease_type = p_ease_type; data.delay = p_delay; // Add the interpolation _push_interpolate_data(data); } void Tween::follow_method(Object *p_object, StringName p_method, Variant p_initial_val, Object *p_target, StringName p_target_method, real_t p_duration, TransitionType p_trans_type, EaseType p_ease_type, real_t p_delay) { // If we are currently updating, call this function again later if (pending_update != 0) { _add_pending_command(""follow_method"", p_object, p_method, p_initial_val, p_target, p_target_method, p_duration, p_trans_type, p_ease_type, p_delay); return; } // Convert initial INT values to FLOAT as they are better for interpolation if (p_initial_val.get_type() == Variant::INT) { p_initial_val = p_initial_val.operator real_t(); } // Verify the source and target objects are valid ERR_FAIL_COND(p_object == nullptr); ERR_FAIL_COND(p_target == nullptr); // No negative durations ERR_FAIL_COND(p_duration < 0); // Ensure that the transition and ease types are valid ERR_FAIL_COND(p_trans_type < 0 || p_trans_type >= TRANS_COUNT); ERR_FAIL_COND(p_ease_type < 0 || p_ease_type >= EASE_COUNT); // No negative delays ERR_FAIL_COND(p_delay < 0); // Confirm both objects have the target methods ERR_FAIL_COND_MSG(!p_object->has_method(p_method), ""Object has no method named: "" + p_method + "".""); ERR_FAIL_COND_MSG(!p_target->has_method(p_target_method), ""Target has no method named: "" + p_target_method + "".""); // Call the method to get the target value Callable::CallError error; Variant target_val = p_target->call(p_target_method, nullptr, 0, error); ERR_FAIL_COND(error.error != Callable::CallError::CALL_OK); // Convert target INT values to FLOAT as they are better for interpolation if (target_val.get_type() == Variant::INT) { target_val = target_val.operator real_t(); } ERR_FAIL_COND(target_val.get_type() != p_initial_val.get_type()); // Make the new InterpolateData for the method follow InterpolateData data; data.active = true; data.type = FOLLOW_METHOD; data.finish = false; data.elapsed = 0; // Give the data it's configuration data.id = p_object->get_instance_id(); data.key.push_back(p_method); data.concatenated_key = p_method; data.initial_val = p_initial_val; data.target_id = p_target->get_instance_id(); data.target_key.push_back(p_target_method); data.duration = p_duration; data.trans_type = p_trans_type; data.ease_type = p_ease_type; data.delay = p_delay; // Add the new interpolation _push_interpolate_data(data); } void Tween::targeting_property(Object *p_object, NodePath p_property, Object *p_initial, NodePath p_initial_property, Variant p_final_val, real_t p_duration, TransitionType p_trans_type, EaseType p_ease_type, real_t p_delay) { // If we are currently updating, call this function again later if (pending_update != 0) { _add_pending_command(""targeting_property"", p_object, p_property, p_initial, p_initial_property, p_final_val, p_duration, p_trans_type, p_ease_type, p_delay); return; } // Grab the target property and the target property p_property = p_property.get_as_property_path(); p_initial_property = p_initial_property.get_as_property_path(); // Convert the initial INT values to FLOAT as they are better for Interpolation if (p_final_val.get_type() == Variant::INT) { p_final_val = p_final_val.operator real_t(); } // Verify both objects are valid ERR_FAIL_COND(p_object == nullptr); ERR_FAIL_COND(p_initial == nullptr); // No negative durations ERR_FAIL_COND(p_duration < 0); // Ensure transition and easing types are valid ERR_FAIL_COND(p_trans_type < 0 || p_trans_type >= TRANS_COUNT); ERR_FAIL_COND(p_ease_type < 0 || p_ease_type >= EASE_COUNT); // No negative delays ERR_FAIL_COND(p_delay < 0); // Ensure the initial and target properties exist on their objects bool prop_valid = false; p_object->get_indexed(p_property.get_subnames(), &prop_valid); ERR_FAIL_COND(!prop_valid); bool initial_prop_valid = false; Variant initial_val = p_initial->get_indexed(p_initial_property.get_subnames(), &initial_prop_valid); ERR_FAIL_COND(!initial_prop_valid); // Convert the initial INT value to FLOAT as it is better for interpolation if (initial_val.get_type() == Variant::INT) { initial_val = initial_val.operator real_t(); } ERR_FAIL_COND(initial_val.get_type() != p_final_val.get_type()); // Build the InterpolateData object InterpolateData data; data.active = true; data.type = TARGETING_PROPERTY; data.finish = false; data.elapsed = 0; // Give the data it's configuration data.id = p_object->get_instance_id(); data.key = p_property.get_subnames(); data.concatenated_key = p_property.get_concatenated_subnames(); data.target_id = p_initial->get_instance_id(); data.target_key = p_initial_property.get_subnames(); data.initial_val = initial_val; data.final_val = p_final_val; data.duration = p_duration; data.trans_type = p_trans_type; data.ease_type = p_ease_type; data.delay = p_delay; // Ensure there is a valid delta if (!_calc_delta_val(data.initial_val, data.final_val, data.delta_val)) { return; } // Add the interpolation _push_interpolate_data(data); } void Tween::targeting_method(Object *p_object, StringName p_method, Object *p_initial, StringName p_initial_method, Variant p_final_val, real_t p_duration, TransitionType p_trans_type, EaseType p_ease_type, real_t p_delay) { // If we are currently updating, call this function again later if (pending_update != 0) { _add_pending_command(""targeting_method"", p_object, p_method, p_initial, p_initial_method, p_final_val, p_duration, p_trans_type, p_ease_type, p_delay); return; } // Convert final INT values to FLOAT as they are better for interpolation if (p_final_val.get_type() == Variant::INT) { p_final_val = p_final_val.operator real_t(); } // Make sure the given objects are valid ERR_FAIL_COND(p_object == nullptr); ERR_FAIL_COND(p_initial == nullptr); // No negative durations ERR_FAIL_COND(p_duration < 0); // Ensure transition and easing types are valid ERR_FAIL_COND(p_trans_type < 0 || p_trans_type >= TRANS_COUNT); ERR_FAIL_COND(p_ease_type < 0 || p_ease_type >= EASE_COUNT); // No negative delays ERR_FAIL_COND(p_delay < 0); // Make sure both objects have the given method ERR_FAIL_COND_MSG(!p_object->has_method(p_method), ""Object has no method named: "" + p_method + "".""); ERR_FAIL_COND_MSG(!p_initial->has_method(p_initial_method), ""Initial Object has no method named: "" + p_initial_method + "".""); // Call the method to get the initial value Callable::CallError error; Variant initial_val = p_initial->call(p_initial_method, nullptr, 0, error); ERR_FAIL_COND(error.error != Callable::CallError::CALL_OK); // Convert initial INT values to FLOAT as they aer better for interpolation if (initial_val.get_type() == Variant::INT) { initial_val = initial_val.operator real_t(); } ERR_FAIL_COND(initial_val.get_type() != p_final_val.get_type()); // Build the new InterpolateData object InterpolateData data; data.active = true; data.type = TARGETING_METHOD; data.finish = false; data.elapsed = 0; // Configure the data data.id = p_object->get_instance_id(); data.key.push_back(p_method); data.concatenated_key = p_method; data.target_id = p_initial->get_instance_id(); data.target_key.push_back(p_initial_method); data.initial_val = initial_val; data.final_val = p_final_val; data.duration = p_duration; data.trans_type = p_trans_type; data.ease_type = p_ease_type; data.delay = p_delay; // Ensure there is a valid delta if (!_calc_delta_val(data.initial_val, data.final_val, data.delta_val)) { return; } // Add the interpolation _push_interpolate_data(data); } Tween::Tween() { // Initialize tween attributes tween_process_mode = TWEEN_PROCESS_IDLE; repeat = false; speed_scale = 1; pending_update = 0; uid = 0; } Tween::~Tween() { } ",16142,True,2819.1693446187105,median "[[salesforce-component]] = Salesforce Component :page-source: components/camel-salesforce/camel-salesforce-component/src/main/docs/salesforce-component.adoc *Available as of Camel version 2.12* This component supports producer and consumer endpoints to communicate with Salesforce using Java DTOs. + There is a companion maven plugin Camel Salesforce Plugin that generates these DTOs (see further below). Maven users will need to add the following dependency to their `pom.xml` for this component: [source,xml] ---- org.apache.camel camel-salesforce x.x.x ---- NOTE: Developers wishing to contribute to the component are instructed to look at the https://github.com/apache/camel/tree/master/components/camel-salesforce/camel-salesforce-component/README.md[README.md] file on instructions on how to get started and setup your environment for running integration tests. == Authenticating to Salesforce The component supports three OAuth authentication flows: * https://help.salesforce.com/articleView?id=remoteaccess_oauth_username_password_flow.htm[OAuth 2.0 Username-Password Flow] * https://help.salesforce.com/articleView?id=remoteaccess_oauth_refresh_token_flow.htm[OAuth 2.0 Refresh Token Flow] * https://help.salesforce.com/articleView?id=remoteaccess_oauth_jwt_flow.htm[OAuth 2.0 JWT Bearer Token Flow] For each of the flow different set of properties needs to be set: .Properties to set for each authentication flow |=== | Property | Where to find it on Salesforce | Flow | clientId | Connected App, Consumer Key | All flows | clientSecret | Connected App, Consumer Secret | Username-Password, Refresh Token | userName | Salesforce user username | Username-Password, JWT Bearer Token | password | Salesforce user password | Username-Password | refreshToken | From OAuth flow callback | Refresh Token | keystore | Connected App, Digital Certificate | JWT Bearer Token |=== The component auto determines what flow you're trying to configure, to be remove ambiguity set the `authenticationType` property. NOTE: Using Username-Password Flow in production is not encouraged. NOTE: The certificate used in JWT Bearer Token Flow can be a selfsigned certificate. The KeyStore holding the certificate and the private key must contain only single certificate-private key entry. == URI format When used as a consumer, receiving streaming events, the URI scheme is: [source,java] ---- salesforce:topic?options ---- When used as a producer, invoking the Salesforce REST APIs, the URI scheme is: [source,java] ---- salesforce:operationName?options ---- You can append query options to the URI in the following format, `?option=value&option=value&...` == Passing in Salesforce headers and fetching Salesforce response headers There is support to pass https://developer.salesforce.com/docs/atlas.en-us.api_rest.meta/api_rest/headers.htm[Salesforce headers] via inbound message headers, header names that start with `Sforce` or `x-sfdc` on the Camel message will be passed on in the request, and response headers that start with `Sforce` will be present in the outbound message headers. For example to fetch API limits you can specify: [source,java] ---- // in your Camel route set the header before Salesforce endpoint //... .setHeader(""Sforce-Limit-Info"", constant(""api-usage"")) .to(""salesforce:getGlobalObjects"") .to(myProcessor); // myProcessor will receive `Sforce-Limit-Info` header on the outbound // message class MyProcessor implements Processor { public void process(Exchange exchange) throws Exception { Message in = exchange.getIn(); String apiLimits = in.getHeader(""Sforce-Limit-Info"", String.class); } } ---- == Supported Salesforce APIs The component supports the following Salesforce APIs Producer endpoints can use the following APIs. Most of the APIs process one record at a time, the Query API can retrieve multiple Records. === Rest API You can use the following for `operationName`: * getVersions - Gets supported Salesforce REST API versions * getResources - Gets available Salesforce REST Resource endpoints * getGlobalObjects - Gets metadata for all available SObject types * getBasicInfo - Gets basic metadata for a specific SObject type * getDescription - Gets comprehensive metadata for a specific SObject type * getSObject - Gets an SObject using its Salesforce Id * createSObject - Creates an SObject * updateSObject - Updates an SObject using Id * deleteSObject - Deletes an SObject using Id * getSObjectWithId - Gets an SObject using an external (user defined) id field * upsertSObject - Updates or inserts an SObject using an external id * deleteSObjectWithId - Deletes an SObject using an external id * query - Runs a Salesforce SOQL query * queryMore - Retrieves more results (in case of large number of results) using result link returned from the 'query' API * search - Runs a Salesforce SOSL query * limits - fetching organization API usage limits * recent - fetching recent items * approval - submit a record or records (batch) for approval process * approvals - fetch a list of all approval processes * composite - submit up to 25 possibly related REST requests and receive individual responses * composite-tree - create up to 200 records with parent-child relationships (up to 5 levels) in one go * composite-batch - submit a composition of requests in batch * queryAll - Runs a SOQL query. It returns the results that are deleted because of a merge or delete. Also returns the information about archived Task and Event records. * getBlobField - Retrieves the specified blob field from an individual record. * apexCall - Executes a user defined APEX REST API call. For example, the following producer endpoint uses the upsertSObject API, with the sObjectIdName parameter specifying 'Name' as the external id field. The request message body should be an SObject DTO generated using the maven plugin. The response message will either be `null` if an existing record was updated, or `CreateSObjectResult` with an id of the new record, or a list of errors while creating the new object. [source,java] ---- ...to(""salesforce:upsertSObject?sObjectIdName=Name"")... ---- === Rest Bulk API Producer endpoints can use the following APIs. All Job data formats, i.e. xml, csv, zip/xml, and zip/csv are supported. + The request and response have to be marshalled/unmarshalled by the route. Usually the request will be some stream source like a CSV file, + and the response may also be saved to a file to be correlated with the request. You can use the following for `operationName`: * createJob - Creates a Salesforce Bulk Job * getJob - Gets a Job using its Salesforce Id * closeJob - Closes a Job * abortJob - Aborts a Job * createBatch - Submits a Batch within a Bulk Job * getBatch - Gets a Batch using Id * getAllBatches - Gets all Batches for a Bulk Job Id * getRequest - Gets Request data (XML/CSV) for a Batch * getResults - Gets the results of the Batch when its complete * createBatchQuery - Creates a Batch from an SOQL query * getQueryResultIds - Gets a list of Result Ids for a Batch Query * getQueryResult - Gets results for a Result Id * getRecentReports - Gets up to 200 of the reports you most recently viewed by sending a GET request to the Report List resource. * getReportDescription - Retrieves the report, report type, and related metadata for a report, either in a tabular or summary or matrix format. * executeSyncReport - Runs a report synchronously with or without changing filters and returns the latest summary data. * executeAsyncReport - Runs an instance of a report asynchronously with or without filters and returns the summary data with or without details. * getReportInstances - Returns a list of instances for a report that you requested to be run asynchronously. Each item in the list is treated as a separate instance of the report. * getReportResults: Contains the results of running a report. For example, the following producer endpoint uses the createBatch API to create a Job Batch. The in message must contain a body that can be converted into an `InputStream` (usually UTF-8 CSV or XML content from a file, etc.) and header fields 'jobId' for the Job and 'contentType' for the Job content type, which can be XML, CSV, ZIP_XML or ZIP_CSV. The put message body will contain `BatchInfo` on success, or throw a `SalesforceException` on error. [source,java] ---- ...to(""salesforce:createBatchJob"").. ---- === Rest Streaming API Consumer endpoints can use the following syntax for streaming endpoints to receive Salesforce notifications on create/update. To create and subscribe to a topic [source,java] ---- from(""salesforce:CamelTestTopic?notifyForFields=ALL¬ifyForOperations=ALL&sObjectName=Merchandise__c&updateTopic=true&sObjectQuery=SELECT Id, Name FROM Merchandise__c"")... ---- To subscribe to an existing topic [source,java] ---- from(""salesforce:CamelTestTopic&sObjectName=Merchandise__c"")... ---- === Platform events To emit a platform event use `createSObject` operation. And set the message body can be JSON string or InputStream with key-value data -- in that case `sObjectName` needs to be set to the API name of the event, or a class that extends from AbstractDTOBase with the appropriate class name for the event. For example using a DTO: [source,java] ---- class Order_Event__e extends AbstractDTOBase { @JsonProperty(""OrderNumber"") private String orderNumber; // ... other properties and getters/setters } from(""timer:tick"") .process(exchange -> { final Message in = exchange.getIn(); String orderNumber = ""ORD"" + String.valueOf(in.getHeader(Exchange.TIMER_COUNTER)); Order_Event__e event = new Order_Event__e(); event.setOrderNumber(orderNumber); in.setBody(event); }) .to(""salesforce:createSObject""); ---- Or using JSON event data: [source,java] ---- from(""timer:tick"") .process(exchange -> { final Message in = exchange.getIn(); String orderNumber = ""ORD"" + String.valueOf(in.getHeader(Exchange.TIMER_COUNTER)); in.setBody(""{\\""OrderNumber\\"":\\"""" + orderNumber + ""\\""}""); }) .to(""salesforce:createSObject?sObjectName=Order_Event__e""); ---- To receive platform events use the consumer endpoint with the API name of the platform event prefixed with `event/` (or `/event/`), e.g.: `salesforce:events/Order_Event__e`. Processor consuming from that endpoint will receive either `org.apache.camel.component.salesforce.api.dto.PlatformEvent` object or `org.cometd.bayeux.Message` in the body depending on the `rawPayload` being `false` or `true` respectively. For example, in the simplest form to consume one event: [source,java] ---- PlatformEvent event = consumer.receiveBody(""salesforce:event/Order_Event__e"", PlatformEvent.class); ---- === Change data capture events On the one hand, Salesforce could be configured to emit notifications for record changes of select objects. On the other hand, the Camel Salesforce component could react to such notifications, allowing for instance to https://trailhead.salesforce.com/en/content/learn/modules/change-data-capture/understand-change-data-capture[synchronize those changes into an external system]. The notifications of interest could be specified in the `from(""salesforce:XXX"")` clause of a Camel route via the subscription channel, e.g: [source,java] ---- from(""salesforce:data/ChangeEvents?replayId=-1"").log(""being notified of all change events"") from(""salesforce:data/AccountChangeEvent?replayId=-1"").log(""being notified of change events for Account records"") from(""salesforce:data/Employee__ChangeEvent?replayId=-1"").log(""being notified of change events for Employee__c custom object"") ---- The received message contains either `java.util.Map` or `org.cometd.bayeux.Message` in the body depending on the `rawPayload` being `false` or `true` respectively. The `CamelSalesforceChangeType` header could be valued to one of `CREATE`, `UPDATE`, `DELETE` or `UNDELETE`. More details about how to use the Camel Salesforce component change data capture capabilities could be found in the https://github.com/apache/camel/tree/master/components/camel-salesforce/camel-salesforce-component/src/test/java/org/apache/camel/component/salesforce/ChangeEventsConsumerIntegrationTest.java[ChangeEventsConsumerIntegrationTest]. The https://developer.salesforce.com/docs/atlas.en-us.change_data_capture.meta/change_data_capture/cdc_intro.htm[Salesforce developer guide] is a good fit to better know the subtleties of implementing a change data capture integration application. The dynamic nature of change event body fields, high level replication steps as well as security considerations could be of interest. == Examples === Uploading a document to a ContentWorkspace Create the ContentVersion in Java, using a Processor instance: [source,java] ---- public class ContentProcessor implements Processor { public void process(Exchange exchange) throws Exception { Message message = exchange.getIn(); ContentVersion cv = new ContentVersion(); ContentWorkspace cw = getWorkspace(exchange); cv.setFirstPublishLocationId(cw.getId()); cv.setTitle(""test document""); cv.setPathOnClient(""test_doc.html""); byte[] document = message.getBody(byte[].class); ObjectMapper mapper = new ObjectMapper(); String enc = mapper.convertValue(document, String.class); cv.setVersionDataUrl(enc); message.setBody(cv); } protected ContentWorkspace getWorkSpace(Exchange exchange) { // Look up the content workspace somehow, maybe use enrich() to add it to a // header that can be extracted here .... } } ---- Give the output from the processor to the Salesforce component: [source,java] ---- from(""file:///home/camel/library"") .to(new ContentProcessor()) // convert bytes from the file into a ContentVersion SObject // for the salesforce component .to(""salesforce:createSObject""); ---- == Using Salesforce Limits API With `salesforce:limits` operation you can fetch of API limits from Salesforce and then act upon that data received. The result of `salesforce:limits` operation is mapped to `org.apache.camel.component.salesforce.api.dto.Limits` class and can be used in a custom processors or expressions. For instance, consider that you need to limit the API usage of Salesforce so that 10% of daily API requests is left for other routes. The body of output message contains an instance of `org.apache.camel.component.salesforce.api.dto.Limits` object that can be used in conjunction with Content Based Router and Content Based Router and xref:spel-language.adoc[Spring Expression Language (SpEL)] to choose when to perform queries. Notice how multiplying `1.0` with the integer value held in `body.dailyApiRequests.remaining` makes the expression evaluate as with floating point arithmetic, without it - it would end up making integral division which would result with either `0` (some API limits consumed) or `1` (no API limits consumed). [source,java] ---- from(""direct:querySalesforce"") .to(""salesforce:limits"") .choice() .when(spel(""#{1.0 * body.dailyApiRequests.remaining / body.dailyApiRequests.max < 0.1}"")) .to(""salesforce:query?..."") .otherwise() .setBody(constant(""Used up Salesforce API limits, leaving 10% for critical routes"")) .endChoice() ---- == Working with approvals All the properties are named exactly the same as in the Salesforce REST API prefixed with `approval.`. You can set approval properties by setting `approval.PropertyName` of the Endpoint these will be used as template -- meaning that any property not present in either body or header will be taken from the Endpoint configuration. Or you can set the approval template on the Endpoint by assigning `approval` property to a reference onto a bean in the Registry. You can also provide header values using the same `approval.PropertyName` in the incoming message headers. And finally body can contain one `AprovalRequest` or an `Iterable` of `ApprovalRequest` objects to process as a batch. The important thing to remember is the priority of the values specified in these three mechanisms: . value in body takes precedence before any other . value in message header takes precedence before template value . value in template is set if no other value in header or body was given For example to send one record for approval using values in headers use: Given a route: [source,java] ---- from(""direct:example1"")// .setHeader(""approval.ContextId"", simple(""${body['contextId']}"")) .setHeader(""approval.NextApproverIds"", simple(""${body['nextApproverIds']}"")) .to(""salesforce:approval?""// + ""approval.actionType=Submit""// + ""&approval.comments=this is a test""// + ""&approval.processDefinitionNameOrId=Test_Account_Process""// + ""&approval.skipEntryCriteria=true""); ---- You could send a record for approval using: [source,java] ---- final Map body = new HashMap<>(); body.put(""contextId"", accountIds.iterator().next()); body.put(""nextApproverIds"", userId); final ApprovalResult result = template.requestBody(""direct:example1"", body, ApprovalResult.class); ---- == Using Salesforce Recent Items API To fetch the recent items use `salesforce:recent` operation. This operation returns an `java.util.List` of `org.apache.camel.component.salesforce.api.dto.RecentItem` objects (`List`) that in turn contain the `Id`, `Name` and `Attributes` (with `type` and `url` properties). You can limit the number of returned items by specifying `limit` parameter set to maximum number of records to return. For example: [source,java] ---- from(""direct:fetchRecentItems"") to(""salesforce:recent"") .split().body() .log(""${body.name} at ${body.attributes.url}""); ---- == Using Salesforce Composite API to submit SObject tree To create up to 200 records including parent-child relationships use `salesforce:composite-tree` operation. This requires an instance of `org.apache.camel.component.salesforce.api.dto.composite.SObjectTree` in the input message and returns the same tree of objects in the output message. The `org.apache.camel.component.salesforce.api.dto.AbstractSObjectBase` instances within the tree get updated with the identifier values (`Id` property) or their corresponding `org.apache.camel.component.salesforce.api.dto.composite.SObjectNode` is populated with `errors` on failure. Note that for some records operation can succeed and for some it can fail -- so you need to manually check for errors. Easiest way to use this functionality is to use the DTOs generated by the `camel-salesforce-maven-plugin`, but you also have the option of customizing the references that identify the each object in the tree, for instance primary keys from your database. Lets look at an example: [source,java] ---- Account account = ... Contact president = ... Contact marketing = ... Account anotherAccount = ... Contact sales = ... Asset someAsset = ... // build the tree SObjectTree request = new SObjectTree(); request.addObject(account).addChildren(president, marketing); request.addObject(anotherAccount).addChild(sales).addChild(someAsset); final SObjectTree response = template.requestBody(""salesforce:composite-tree"", tree, SObjectTree.class); final Map> result = response.allNodes() .collect(Collectors.groupingBy(SObjectNode::hasErrors)); final List withErrors = result.get(true); final List succeeded = result.get(false); final String firstId = succeeded.get(0).getId(); ---- == Using Salesforce Composite API to submit multiple requests in a batch The Composite API batch operation (`composite-batch`) allows you to accumulate multiple requests in a batch and then submit them in one go, saving the round trip cost of multiple individual requests. Each response is then received in a list of responses with the order preserved, so that the n-th requests response is in the n-th place of the response. NOTE: The results can vary from API to API so the result of the request is given as a `java.lang.Object`. In most cases the result will be a `java.util.Map` with string keys and values or other `java.util.Map` as value. Requests made in JSON format hold some type information (i.e. it is known what values are strings and what values are numbers), so in general those will be more type friendly. Note that the responses will vary between XML and JSON, this is due to the responses from Salesforce API being different. So be careful if you switch between formats without changing the response handling code. Lets look at an example: [source,java] ---- final String acountId = ... final SObjectBatch batch = new SObjectBatch(""38.0""); final Account updates = new Account(); updates.setName(""NewName""); batch.addUpdate(""Account"", accountId, updates); final Account newAccount = new Account(); newAccount.setName(""Account created from Composite batch API""); batch.addCreate(newAccount); batch.addGet(""Account"", accountId, ""Name"", ""BillingPostalCode""); batch.addDelete(""Account"", accountId); final SObjectBatchResponse response = template.requestBody(""salesforce:composite-batch?format=JSON"", batch, SObjectBatchResponse.class); boolean hasErrors = response.hasErrors(); // if any of the requests has resulted in either 4xx or 5xx HTTP status final List results = response.getResults(); // results of three operations sent in batch final SObjectBatchResult updateResult = results.get(0); // update result final int updateStatus = updateResult.getStatusCode(); // probably 204 final Object updateResultData = updateResult.getResult(); // probably null final SObjectBatchResult createResult = results.get(1); // create result @SuppressWarnings(""unchecked"") final Map createData = (Map) createResult.getResult(); final String newAccountId = createData.get(""id""); // id of the new account, this is for JSON, for XML it would be createData.get(""Result"").get(""id"") final SObjectBatchResult retrieveResult = results.get(2); // retrieve result @SuppressWarnings(""unchecked"") final Map retrieveData = (Map) retrieveResult.getResult(); final String accountName = retrieveData.get(""Name""); // Name of the retrieved account, this is for JSON, for XML it would be createData.get(""Account"").get(""Name"") final String accountBillingPostalCode = retrieveData.get(""BillingPostalCode""); // Name of the retrieved account, this is for JSON, for XML it would be createData.get(""Account"").get(""BillingPostalCode"") final SObjectBatchResult deleteResult = results.get(3); // delete result final int updateStatus = deleteResult.getStatusCode(); // probably 204 final Object updateResultData = deleteResult.getResult(); // probably null ---- == Using Salesforce Composite API to submit multiple chained requests The `composite` operation allows submitting up to 25 requests that can be chained together, for instance identifier generated in previous request can be used in subsequent request. Individual requests and responses are linked with the provided _reference_. NOTE: Composite API supports only JSON payloads. NOTE: As with the batch API the results can vary from API to API so the result of the request is given as a `java.lang.Object`. In most cases the result will be a `java.util.Map` with string keys and values or other `java.util.Map` as value. Requests made in JSON format hold some type information (i.e. it is known what values are strings and what values are numbers), so in general those will be more type friendly. Lets look at an example: [source,java] ---- SObjectComposite composite = new SObjectComposite(""38.0"", true); // first insert operation via an external id final Account updateAccount = new TestAccount(); updateAccount.setName(""Salesforce""); updateAccount.setBillingStreet(""Landmark @ 1 Market Street""); updateAccount.setBillingCity(""San Francisco""); updateAccount.setBillingState(""California""); updateAccount.setIndustry(Account_IndustryEnum.TECHNOLOGY); composite.addUpdate(""Account"", ""001xx000003DIpcAAG"", updateAccount, ""UpdatedAccount""); final Contact newContact = new TestContact(); newContact.setLastName(""John Doe""); newContact.setPhone(""1234567890""); composite.addCreate(newContact, ""NewContact""); final AccountContactJunction__c junction = new AccountContactJunction__c(); junction.setAccount__c(""001xx000003DIpcAAG""); junction.setContactId__c(""@{NewContact.id}""); composite.addCreate(junction, ""JunctionRecord""); final SObjectCompositeResponse response = template.requestBody(""salesforce:composite?format=JSON"", composite, SObjectCompositeResponse.class); final List results = response.getCompositeResponse(); final SObjectCompositeResult accountUpdateResult = results.stream().filter(r -> ""UpdatedAccount"".equals(r.getReferenceId())).findFirst().get() final int statusCode = accountUpdateResult.getHttpStatusCode(); // should be 200 final Map accountUpdateBody = accountUpdateResult.getBody(); final SObjectCompositeResult contactCreationResult = results.stream().filter(r -> ""JunctionRecord"".equals(r.getReferenceId())).findFirst().get() ---- == Sending null values to salesforce By default, SObject fields with null values are not sent to salesforce. In order to send null values to salesforce, use the `fieldsToNull` property, as follows: [source,java] ---- accountSObject.getFieldsToNull().add(""Site""); ---- == Generating SOQL query strings `org.apache.camel.component.salesforce.api.utils.QueryHelper` contains helper methods to generate SOQL queries. For instance to fetch all custom fields from _Account_ SObject you can simply generate the SOQL SELECT by invoking: [source,java] ---- String allCustomFieldsQuery = QueryHelper.queryToFetchFilteredFieldsOf(new Account(), SObjectField::isCustom); ---- == Camel Salesforce Maven Plugin This Maven plugin generates DTOs for the Camel. For obvious security reasons it is recommended that the clientId, clientSecret, userName and password fields be not set in the pom.xml. The plugin should be configured for the rest of the properties, and can be executed using the following command: [source,java] ---- mvn camel-salesforce:generate -DcamelSalesforce.clientId= -DcamelSalesforce.clientSecret= \\ -DcamelSalesforce.userName= -DcamelSalesforce.password= ---- The generated DTOs use Jackson and XStream annotations. All Salesforce field types are supported. Date and time fields are mapped to `java.time.ZonedDateTime` by default, and picklist fields are mapped to generated Java Enumerations. Please refer to https://github.com/apache/camel/tree/master/components/camel-salesforce/camel-salesforce-maven-plugin[README.md] for details on how to generate the DTO. == Options // component options: START The Salesforce component supports 31 options, which are listed below. [width=""100%"",cols=""2,5,^1,2"",options=""header""] |=== | Name | Description | Default | Type | *authenticationType* (security) | Explicit authentication method to be used, one of USERNAME_PASSWORD, REFRESH_TOKEN or JWT. Salesforce component can auto-determine the authentication method to use from the properties set, set this property to eliminate any ambiguity. | | AuthenticationType | *loginConfig* (security) | All authentication configuration in one nested bean, all properties set there can be set directly on the component as well | | SalesforceLoginConfig | *instanceUrl* (security) | URL of the Salesforce instance used after authentication, by default received from Salesforce on successful authentication | | String | *loginUrl* (security) | *Required* URL of the Salesforce instance used for authentication, by default set to \\https://login.salesforce.com | https://login.salesforce.com | String | *clientId* (security) | *Required* OAuth Consumer Key of the connected app configured in the Salesforce instance setup. Typically a connected app needs to be configured but one can be provided by installing a package. | | String | *clientSecret* (security) | OAuth Consumer Secret of the connected app configured in the Salesforce instance setup. | | String | *keystore* (security) | KeyStore parameters to use in OAuth JWT flow. The KeyStore should contain only one entry with private key and certificate. Salesforce does not verify the certificate chain, so this can easily be a selfsigned certificate. Make sure that you upload the certificate to the corresponding connected app. | | KeyStoreParameters | *refreshToken* (security) | Refresh token already obtained in the refresh token OAuth flow. One needs to setup a web application and configure a callback URL to receive the refresh token, or configure using the builtin callback at \\https://login.salesforce.com/services/oauth2/success or \\https://test.salesforce.com/services/oauth2/success and then retrive the refresh_token from the URL at the end of the flow. Note that in development organizations Salesforce allows hosting the callback web application at localhost. | | String | *userName* (security) | Username used in OAuth flow to gain access to access token. It's easy to get started with password OAuth flow, but in general one should avoid it as it is deemed less secure than other flows. | | String | *password* (security) | Password used in OAuth flow to gain access to access token. It's easy to get started with password OAuth flow, but in general one should avoid it as it is deemed less secure than other flows. Make sure that you append security token to the end of the password if using one. | | String | *lazyLogin* (security) | If set to true prevents the component from authenticating to Salesforce with the start of the component. You would generally set this to the (default) false and authenticate early and be immediately aware of any authentication issues. | false | boolean | *config* (common) | Global endpoint configuration - use to set values that are common to all endpoints | | SalesforceEndpointConfig | *httpClientProperties* (common) | Used to set any properties that can be configured on the underlying HTTP client. Have a look at properties of SalesforceHttpClient and the Jetty HttpClient for all available options. | | Map | *longPollingTransport Properties* (common) | Used to set any properties that can be configured on the LongPollingTransport used by the BayeuxClient (CometD) used by the streaming api | | Map | *sslContextParameters* (security) | SSL parameters to use, see SSLContextParameters class for all available options. | | SSLContextParameters | *useGlobalSslContext Parameters* (security) | Enable usage of global SSL context parameters | false | boolean | *httpClientIdleTimeout* (common) | Timeout used by the HttpClient when waiting for response from the Salesforce server. | 10000 | long | *httpClientConnection Timeout* (common) | Connection timeout used by the HttpClient when connecting to the Salesforce server. | 60000 | long | *httpProxyHost* (proxy) | Hostname of the HTTP proxy server to use. | | String | *httpProxyPort* (proxy) | Port number of the HTTP proxy server to use. | | Integer | *httpProxyUsername* (security) | Username to use to authenticate against the HTTP proxy server. | | String | *httpProxyPassword* (security) | Password to use to authenticate against the HTTP proxy server. | | String | *isHttpProxySocks4* (proxy) | If set to true the configures the HTTP proxy to use as a SOCKS4 proxy. | false | boolean | *isHttpProxySecure* (security) | If set to false disables the use of TLS when accessing the HTTP proxy. | true | boolean | *httpProxyIncluded Addresses* (proxy) | A list of addresses for which HTTP proxy server should be used. | | Set | *httpProxyExcluded Addresses* (proxy) | A list of addresses for which HTTP proxy server should not be used. | | Set | *httpProxyAuthUri* (security) | Used in authentication against the HTTP proxy server, needs to match the URI of the proxy server in order for the httpProxyUsername and httpProxyPassword to be used for authentication. | | String | *httpProxyRealm* (security) | Realm of the proxy server, used in preemptive Basic/Digest authentication methods against the HTTP proxy server. | | String | *httpProxyUseDigest Auth* (security) | If set to true Digest authentication will be used when authenticating to the HTTP proxy,otherwise Basic authorization method will be used | false | boolean | *packages* (common) | In what packages are the generated DTO classes. Typically the classes would be generated using camel-salesforce-maven-plugin. Set it if using the generated DTOs to gain the benefit of using short SObject names in parameters/header values. | | String[] | *basicPropertyBinding* (advanced) | Whether the component should use basic property binding (Camel 2.x) or the newer property binding with additional capabilities | false | boolean |=== // component options: END // endpoint options: START The Salesforce endpoint is configured using URI syntax: ---- salesforce:operationName:topicName ---- with the following path and query parameters: === Path Parameters (2 parameters): [width=""100%"",cols=""2,5,^1,2"",options=""header""] |=== | Name | Description | Default | Type | *operationName* | The operation to use | | OperationName | *topicName* | The name of the topic/channel to use | | String |=== === Query Parameters (45 parameters): [width=""100%"",cols=""2,5,^1,2"",options=""header""] |=== | Name | Description | Default | Type | *apexMethod* (common) | APEX method name | | String | *apexQueryParams* (common) | Query params for APEX method | | Map | *apexUrl* (common) | APEX method URL | | String | *apiVersion* (common) | Salesforce API version, defaults to SalesforceEndpointConfig.DEFAULT_VERSION | | String | *backoffIncrement* (common) | Backoff interval increment for Streaming connection restart attempts for failures beyond CometD auto-reconnect. | | long | *batchId* (common) | Bulk API Batch ID | | String | *contentType* (common) | Bulk API content type, one of XML, CSV, ZIP_XML, ZIP_CSV | | ContentType | *defaultReplayId* (common) | Default replayId setting if no value is found in initialReplayIdMap | | Long | *format* (common) | Payload format to use for Salesforce API calls, either JSON or XML, defaults to JSON | | PayloadFormat | *httpClient* (common) | Custom Jetty Http Client to use to connect to Salesforce. | | SalesforceHttpClient | *includeDetails* (common) | Include details in Salesforce1 Analytics report, defaults to false. | | Boolean | *initialReplayIdMap* (common) | Replay IDs to start from per channel name. | | Map | *instanceId* (common) | Salesforce1 Analytics report execution instance ID | | String | *jobId* (common) | Bulk API Job ID | | String | *limit* (common) | Limit on number of returned records. Applicable to some of the API, check the Salesforce documentation. | | Integer | *maxBackoff* (common) | Maximum backoff interval for Streaming connection restart attempts for failures beyond CometD auto-reconnect. | | long | *notFoundBehaviour* (common) | Sets the behaviour of 404 not found status received from Salesforce API. Should the body be set to NULL NotFoundBehaviour#NULL or should a exception be signaled on the exchange NotFoundBehaviour#EXCEPTION - the default. | | NotFoundBehaviour | *notifyForFields* (common) | Notify for fields, options are ALL, REFERENCED, SELECT, WHERE | | NotifyForFieldsEnum | *notifyForOperationCreate* (common) | Notify for create operation, defaults to false (API version = 29.0) | | Boolean | *notifyForOperationDelete* (common) | Notify for delete operation, defaults to false (API version = 29.0) | | Boolean | *notifyForOperations* (common) | Notify for operations, options are ALL, CREATE, EXTENDED, UPDATE (API version 29.0) | | NotifyForOperationsEnum | *notifyForOperationUndelete* (common) | Notify for un-delete operation, defaults to false (API version = 29.0) | | Boolean | *notifyForOperationUpdate* (common) | Notify for update operation, defaults to false (API version = 29.0) | | Boolean | *objectMapper* (common) | Custom Jackson ObjectMapper to use when serializing/deserializing Salesforce objects. | | ObjectMapper | *rawPayload* (common) | Use raw payload String for request and response (either JSON or XML depending on format), instead of DTOs, false by default | false | boolean | *reportId* (common) | Salesforce1 Analytics report Id | | String | *reportMetadata* (common) | Salesforce1 Analytics report metadata for filtering | | ReportMetadata | *resultId* (common) | Bulk API Result ID | | String | *sObjectBlobFieldName* (common) | SObject blob field name | | String | *sObjectClass* (common) | Fully qualified SObject class name, usually generated using camel-salesforce-maven-plugin | | String | *sObjectFields* (common) | SObject fields to retrieve | | String | *sObjectId* (common) | SObject ID if required by API | | String | *sObjectIdName* (common) | SObject external ID field name | | String | *sObjectIdValue* (common) | SObject external ID field value | | String | *sObjectName* (common) | SObject name if required or supported by API | | String | *sObjectQuery* (common) | Salesforce SOQL query string | | String | *sObjectSearch* (common) | Salesforce SOSL search string | | String | *updateTopic* (common) | Whether to update an existing Push Topic when using the Streaming API, defaults to false | false | boolean | *bridgeErrorHandler* (consumer) | Allows for bridging the consumer to the Camel routing Error Handler, which mean any exceptions occurred while the consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions, that will be logged at WARN or ERROR level and ignored. | false | boolean | *replayId* (consumer) | The replayId value to use when subscribing | | Long | *exceptionHandler* (consumer) | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this option is not in use. By default the consumer will deal with exceptions, that will be logged at WARN or ERROR level and ignored. | | ExceptionHandler | *exchangePattern* (consumer) | Sets the exchange pattern when the consumer creates an exchange. | | ExchangePattern | *lazyStartProducer* (producer) | Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel's routing error handlers. Beware that when the first message is processed then creating and starting the producer may take a little time and prolong the total processing time of the processing. | false | boolean | *basicPropertyBinding* (advanced) | Whether the endpoint should use basic property binding (Camel 2.x) or the newer property binding with additional capabilities | false | boolean | *synchronous* (advanced) | Sets whether synchronous processing should be strictly used, or Camel is allowed to use asynchronous processing (if supported). | false | boolean |=== // endpoint options: END // spring-boot-auto-configure options: START == Spring Boot Auto-Configuration When using Spring Boot make sure to use the following Maven dependency to have support for auto configuration: [source,xml] ---- org.apache.camel camel-salesforce-starter x.x.x ---- The component supports 86 options, which are listed below. [width=""100%"",cols=""2,5,^1,2"",options=""header""] |=== | Name | Description | Default | Type | *camel.component.salesforce.authentication-type* | Explicit authentication method to be used, one of USERNAME_PASSWORD, REFRESH_TOKEN or JWT. Salesforce component can auto-determine the authentication method to use from the properties set, set this property to eliminate any ambiguity. | | AuthenticationType | *camel.component.salesforce.basic-property-binding* | Whether the component should use basic property binding (Camel 2.x) or the newer property binding with additional capabilities | false | Boolean | *camel.component.salesforce.client-id* | OAuth Consumer Key of the connected app configured in the Salesforce instance setup. Typically a connected app needs to be configured but one can be provided by installing a package. | | String | *camel.component.salesforce.client-secret* | OAuth Consumer Secret of the connected app configured in the Salesforce instance setup. | | String | *camel.component.salesforce.config.apex-method* | APEX method name | | String | *camel.component.salesforce.config.apex-query-params* | Query params for APEX method | | Map | *camel.component.salesforce.config.apex-url* | APEX method URL | | String | *camel.component.salesforce.config.api-version* | Salesforce API version, defaults to SalesforceEndpointConfig.DEFAULT_VERSION | | String | *camel.component.salesforce.config.approval* | The approval request for Approval API. | | ApprovalRequest | *camel.component.salesforce.config.approval-action-type* | Represents the kind of action to take: Submit, Approve, or Reject. | | ApprovalRequest$Action | *camel.component.salesforce.config.approval-comments* | The comment to add to the history step associated with this request. | | String | *camel.component.salesforce.config.approval-context-actor-id* | The ID of the submitter who’s requesting the approval record. | | String | *camel.component.salesforce.config.approval-context-id* | The ID of the item that is being acted upon. | | String | *camel.component.salesforce.config.approval-next-approver-ids* | If the process requires specification of the next approval, the ID of the user to be assigned the next request. | | List | *camel.component.salesforce.config.approval-process-definition-name-or-id* | The developer name or ID of the process definition. | | String | *camel.component.salesforce.config.approval-skip-entry-criteria* | Determines whether to evaluate the entry criteria for the process (true) or not (false) if the process definition name or ID isn’t null. If the process definition name or ID isn’t specified, this argument is ignored, and standard evaluation is followed based on process order. By default, the entry criteria isn’t skipped if it’s not set by this request. | | Boolean | *camel.component.salesforce.config.backoff-increment* | Backoff interval increment for Streaming connection restart attempts for failures beyond CometD auto-reconnect. | | Long | *camel.component.salesforce.config.batch-id* | Bulk API Batch ID | | String | *camel.component.salesforce.config.content-type* | Bulk API content type, one of XML, CSV, ZIP_XML, ZIP_CSV | | ContentType | *camel.component.salesforce.config.default-replay-id* | Default replayId setting if no value is found in {@link #initialReplayIdMap} | | Long | *camel.component.salesforce.config.format* | Payload format to use for Salesforce API calls, either JSON or XML, defaults to JSON | | PayloadFormat | *camel.component.salesforce.config.http-client* | Custom Jetty Http Client to use to connect to Salesforce. | | SalesforceHttpClient | *camel.component.salesforce.config.include-details* | Include details in Salesforce1 Analytics report, defaults to false. | | Boolean | *camel.component.salesforce.config.initial-replay-id-map* | Replay IDs to start from per channel name. | | Map | *camel.component.salesforce.config.instance-id* | Salesforce1 Analytics report execution instance ID | | String | *camel.component.salesforce.config.job-id* | Bulk API Job ID | | String | *camel.component.salesforce.config.limit* | Limit on number of returned records. Applicable to some of the API, check the Salesforce documentation. | | Integer | *camel.component.salesforce.config.max-backoff* | Maximum backoff interval for Streaming connection restart attempts for failures beyond CometD auto-reconnect. | | Long | *camel.component.salesforce.config.not-found-behaviour* | Sets the behaviour of 404 not found status received from Salesforce API. Should the body be set to NULL {@link NotFoundBehaviour#NULL} or should a exception be signaled on the exchange {@link NotFoundBehaviour#EXCEPTION} - the default. | | NotFoundBehaviour | *camel.component.salesforce.config.notify-for-fields* | Notify for fields, options are ALL, REFERENCED, SELECT, WHERE | | NotifyForFieldsEnum | *camel.component.salesforce.config.notify-for-operation-create* | Notify for create operation, defaults to false (API version >= 29.0) | | Boolean | *camel.component.salesforce.config.notify-for-operation-delete* | Notify for delete operation, defaults to false (API version >= 29.0) | | Boolean | *camel.component.salesforce.config.notify-for-operation-undelete* | Notify for un-delete operation, defaults to false (API version >= 29.0) | | Boolean | *camel.component.salesforce.config.notify-for-operation-update* | Notify for update operation, defaults to false (API version >= 29.0) | | Boolean | *camel.component.salesforce.config.notify-for-operations* | Notify for operations, options are ALL, CREATE, EXTENDED, UPDATE (API version < 29.0) | | NotifyForOperationsEnum | *camel.component.salesforce.config.object-mapper* | Custom Jackson ObjectMapper to use when serializing/deserializing Salesforce objects. | | ObjectMapper | *camel.component.salesforce.config.raw-payload* | Use raw payload {@link String} for request and response (either JSON or XML depending on {@code format}), instead of DTOs, false by default | false | Boolean | *camel.component.salesforce.config.report-id* | Salesforce1 Analytics report Id | | String | *camel.component.salesforce.config.report-metadata* | Salesforce1 Analytics report metadata for filtering | | ReportMetadata | *camel.component.salesforce.config.result-id* | Bulk API Result ID | | String | *camel.component.salesforce.config.s-object-blob-field-name* | SObject blob field name | | String | *camel.component.salesforce.config.s-object-class* | Fully qualified SObject class name, usually generated using camel-salesforce-maven-plugin | | String | *camel.component.salesforce.config.s-object-fields* | SObject fields to retrieve | | String | *camel.component.salesforce.config.s-object-id* | SObject ID if required by API | | String | *camel.component.salesforce.config.s-object-id-name* | SObject external ID field name | | String | *camel.component.salesforce.config.s-object-id-value* | SObject external ID field value | | String | *camel.component.salesforce.config.s-object-name* | SObject name if required or supported by API | | String | *camel.component.salesforce.config.s-object-query* | Salesforce SOQL query string | | String | *camel.component.salesforce.config.s-object-search* | Salesforce SOSL search string | | String | *camel.component.salesforce.config.update-topic* | Whether to update an existing Push Topic when using the Streaming API, defaults to false | false | Boolean | *camel.component.salesforce.enabled* | Enable salesforce component | true | Boolean | *camel.component.salesforce.http-client-connection-timeout* | Connection timeout used by the HttpClient when connecting to the Salesforce server. | 60000 | Long | *camel.component.salesforce.http-client-idle-timeout* | Timeout used by the HttpClient when waiting for response from the Salesforce server. | 10000 | Long | *camel.component.salesforce.http-client-properties* | Used to set any properties that can be configured on the underlying HTTP client. Have a look at properties of SalesforceHttpClient and the Jetty HttpClient for all available options. | | Map | *camel.component.salesforce.http-proxy-auth-uri* | Used in authentication against the HTTP proxy server, needs to match the URI of the proxy server in order for the httpProxyUsername and httpProxyPassword to be used for authentication. | | String | *camel.component.salesforce.http-proxy-excluded-addresses* | A list of addresses for which HTTP proxy server should not be used. | | Set | *camel.component.salesforce.http-proxy-host* | Hostname of the HTTP proxy server to use. | | String | *camel.component.salesforce.http-proxy-included-addresses* | A list of addresses for which HTTP proxy server should be used. | | Set | *camel.component.salesforce.http-proxy-password* | Password to use to authenticate against the HTTP proxy server. | | String | *camel.component.salesforce.http-proxy-port* | Port number of the HTTP proxy server to use. | | Integer | *camel.component.salesforce.http-proxy-realm* | Realm of the proxy server, used in preemptive Basic/Digest authentication methods against the HTTP proxy server. | | String | *camel.component.salesforce.http-proxy-use-digest-auth* | If set to true Digest authentication will be used when authenticating to the HTTP proxy,otherwise Basic authorization method will be used | false | Boolean | *camel.component.salesforce.http-proxy-username* | Username to use to authenticate against the HTTP proxy server. | | String | *camel.component.salesforce.instance-url* | URL of the Salesforce instance used after authentication, by default received from Salesforce on successful authentication | | String | *camel.component.salesforce.is-http-proxy-secure* | If set to false disables the use of TLS when accessing the HTTP proxy. | true | Boolean | *camel.component.salesforce.is-http-proxy-socks4* | If set to true the configures the HTTP proxy to use as a SOCKS4 proxy. | false | Boolean | *camel.component.salesforce.keystore* | KeyStore parameters to use in OAuth JWT flow. The KeyStore should contain only one entry with private key and certificate. Salesforce does not verify the certificate chain, so this can easily be a selfsigned certificate. Make sure that you upload the certificate to the corresponding connected app. The option is a org.apache.camel.support.jsse.KeyStoreParameters type. | | String | *camel.component.salesforce.lazy-login* | If set to true prevents the component from authenticating to Salesforce with the start of the component. You would generally set this to the (default) false and authenticate early and be immediately aware of any authentication issues. | false | Boolean | *camel.component.salesforce.login-config.client-id* | Salesforce connected application Consumer Key | | String | *camel.component.salesforce.login-config.client-secret* | Salesforce connected application Consumer Secret | | String | *camel.component.salesforce.login-config.instance-url* | Configuration object for Salesforce login properties | | String | *camel.component.salesforce.login-config.keystore* | Keystore parameters for keystore containing certificate and private key needed for OAuth 2.0 JWT Bearer Token Flow. | | KeyStoreParameters | *camel.component.salesforce.login-config.lazy-login* | Flag to enable/disable lazy OAuth, default is false. When enabled, OAuth token retrieval or generation is not done until the first API call | false | Boolean | *camel.component.salesforce.login-config.login-url* | Salesforce login URL, defaults to \\https://login.salesforce.com | https://login.salesforce.com | String | *camel.component.salesforce.login-config.password* | Salesforce account password | | String | *camel.component.salesforce.login-config.refresh-token* | Salesforce connected application Consumer token | | String | *camel.component.salesforce.login-config.type* | Salesforce connected application Consumer token | | AuthenticationType | *camel.component.salesforce.login-config.user-name* | Salesforce account user name | | String | *camel.component.salesforce.login-url* | URL of the Salesforce instance used for authentication, by default set to \\https://login.salesforce.com | https://login.salesforce.com | String | *camel.component.salesforce.long-polling-transport-properties* | Used to set any properties that can be configured on the LongPollingTransport used by the BayeuxClient (CometD) used by the streaming api | | Map | *camel.component.salesforce.packages* | In what packages are the generated DTO classes. Typically the classes would be generated using camel-salesforce-maven-plugin. Set it if using the generated DTOs to gain the benefit of using short SObject names in parameters/header values. | | String[] | *camel.component.salesforce.password* | Password used in OAuth flow to gain access to access token. It's easy to get started with password OAuth flow, but in general one should avoid it as it is deemed less secure than other flows. Make sure that you append security token to the end of the password if using one. | | String | *camel.component.salesforce.refresh-token* | Refresh token already obtained in the refresh token OAuth flow. One needs to setup a web application and configure a callback URL to receive the refresh token, or configure using the builtin callback at \\https://login.salesforce.com/services/oauth2/success or \\https://test.salesforce.com/services/oauth2/success and then retrive the refresh_token from the URL at the end of the flow. Note that in development organizations Salesforce allows hosting the callback web application at localhost. | | String | *camel.component.salesforce.ssl-context-parameters* | SSL parameters to use, see SSLContextParameters class for all available options. The option is a org.apache.camel.support.jsse.SSLContextParameters type. | | String | *camel.component.salesforce.use-global-ssl-context-parameters* | Enable usage of global SSL context parameters | false | Boolean | *camel.component.salesforce.user-name* | Username used in OAuth flow to gain access to access token. It's easy to get started with password OAuth flow, but in general one should avoid it as it is deemed less secure than other flows. | | String |=== // spring-boot-auto-configure options: END ",12158,False,2156.007867465547,median "=== 9 Manía ==== Notas clínicas .Afecto Expresiones de vida media corta reflejas de contingencias emocionales momentáneas. .Humor Emociones sostenidas sentidas interiormente .Humor patológico Desproporcionado al estresor o a la situación concurrente, no responde a continentación, mantenido por semanas / meses / años, juicio alterado por severa influencia del humor. Endoreactivo: demasiado intenso, disregulación permanente dada por (1) la facilidad con que se alcanza un intenso estado de humor ante un estrés y (2) persiste autónomamente cuando el estresor cesa. ==== Encare Motivos de consulta: traído por terceros (trastorno de conductas basales o complejas y pragmatismos), complicación medicolegal, abandono de medicación. ===== En suma Paciente de sexo X, con AF de trastornos afectivos o sus equivalentes (alcoholismo), con AP de episodios de humor en más (y/o en menos), con tratamientos que (mantuvo / abandonó), con (buena/mala) adaptación pragmática interepisódica, que es traído (por terceros, en general no por cuenta propia) a la consulta por alteraciones de conducta / alteración de CB / pragmatismos con un cuadro centrado en el humor que pasamos a analizar. ===== Agrupación sindromática ====== Síndrome de exaltación del humor Centra el cuadro clínico, de X tiempo de evolución (en general desarrollo rápido en 1-2 semanas), que se presenta luego de icon:paperclip[] (60% tienen como antecedente algún estresor psicosocial), en el que se aprecia una aceleración de los procesos psíquicos, evidenciado por los elemento que se detallan. .Humor Central en el cuadro. Humor predominantemente expansivo y exaltado, que pareciera optimista, pero de tonalidad inestable y oscilante y que puede llegar a colérico, eufórico e irritable, con una tendencia a dominar el encuentro y ridiculizar al entrevistador, con elementos eróticos, con una afectividad que se presenta lábil, con oscilaciones, con llantos y risas. Puede presentar un síndrome de ansiedad que reconocemos como parte integrante de este cuadro del humor (puede describirse aparte si la magnitud lo permite). .Presentación Un acortamiento del espacio interpersonal, confianza excesiva, el paciente es invasivo, nos tutea, nos toca, nos interrumpe, usa un tono de voz alta, tiende a dominar la entrevista, está inquieto, alegre, canta, baila, grita, desinhibido, se desnuda, porte desprolijo o desaliñado, facies animado, alegre o furioso, habla sin cesar, está en continuo movimiento y parece no cansarse. .Mímica y gestualidad Aumentadas, congreuentes con las oscilaciones del humor. .Actitud Inadecuada, lúdica, expansiva. .Cognición Se distrae fácilmente por estímulos periféricos, tiene dificultad para fijar la atención voluntaria y espontánea en algo en particular (hipoprosexia), con alteraciones de la memoria reciente, con dificultades para reconstruir el pasado reciente, pero con una exaltación de la memoria lejana. En general está BOTE (puede no estar por falta de atención). Carencia de insight. Sin conciencia de morbidez. .Pensamiento Forma: lenguaje con logorrea, un flujo del habla incontrolable, excesivo, que invade y domina la conversación. Un curso acelerado, con verborrea, configurando una taquipsiquia, acompañada de una fuga de ideas, pues el paciente comienza un relato que no concluye para pasar de inmediato a otro diferente mediante la asociación por asonancia, es decir una asociación superficial y efímera de ideas que se presenta por lo tanto como un pensamiento no finalista. La taquipsiquia y la fuga de ideas (o fuga de temas) dan cuenta de la exaltación del ser psíquico en su totalidad. Contenido: reconocemos ideas sobrevaloradas, exageradas, condicionadas afectivamente, comprensibles en la vida del paciente, pero no compartibles, con calor afectivo, de las cuales puede no tener una verdadera convicción, son fugaces, admiten críticas, enmarcadas en un entorno lúdico, parecen delirantes pero tienen menor intensidad. Centradas en grandiosidad, omnipotencia e hiperoptimismo. icon:sticky-note[] Si las ideas exceden lo sobrevalorado icon:arrow-right[] Síndrome delirante. .Psicomotricidad Se presenta exaltada, no puede estar quieto, con necesidad imperiosa de actividad, volcado al ambiente, camina, cambia las cosas de lugar, canta, baila, se sienta, se levanta, con un actitud lúdica, pero que es improductiva, estéril y sin cansancio físico proporcional, con menor necesidad de dormir. Llega a realizar estos actos sin finalidad, desordenados. Toma elementos del ambiente. .Conductual En las conductas basales destacamos adelgazamiento, disminución de la necesidad de dormir, anorexia o hiperorexia con polidipsia y polifagia (pueden ser prodromos). En los pragmatismos destacamos la esterilidad e la hiperactividad con deterioro laboral, social y familiar (pobre juicio social), hipersexualidad con riesgo de ETS, llamadas excesivas inadecuadas. En las conductas complejas: agresividad, derroche, malos negocios, prodigalidad, compromiso excesivo en actividades placenteras, consumo de sustancias/OH (dentro y fuera del episodio actual), juegos de azar, casamiento impulsivo, actos con repercusión medicolegal. ====== Síndrome delirante / síndrome de alteración del pensamiento En ocasiones las ideas dejan de ser sobrevaloradas para ser delirantes. En este caso son ideas mórbidas, permanentes, incompartibles, irreductibles a la lógica, con defensa con convicción y con generación de conductas. .Formal Curso acelerado, asociación de ideas rápida y superficial, asociaciones frágiles, flujo continuo de frases rápidas, mal hilvanadas. Salta de un tema a otro (idea a otra) constituyendo una taquipsiquia con fuga de ideas que traduce la exaltación del ser psíquico en su totalidad. Esta hiperactividad de los procesos psíquicos leva a una incapacidad de fijarse en una idea concreta con fijación a estímulos irrelevantes. Esta ""volatilidad"" es responsable de trastornos en atención (voluntaria y espontánea), memoria y orientación. .Contenido * Temática: megalomaníaca (capacidades especiales, identidad grandiosa, riqueza, misión especial), mística, filiatoria, erótica, persecutoria, de envidia. * Mecanismo: principalmente intuitivo, pero puede ser imaginativo, interpretativo, alucinatorio. * Sistematización: mala sistematización: con escaso orden, coherencia y claridad. * Conductas: le genera conductas (compras, gastos, sexo, violencia, robos, consumo de sustancias, alcohol). Se configura un delirio móvil, cambiante, desorganizado. * Congruencia: puede ser congruente o incongruente con el estado de ánimo expansivo. ====== Síndrome de ansiedad-angustia Ansiedad masiva, invasiva, desestructurante e incompartible, por lo que la catalogamos como ansiedad psicótica. ====== Síndrome de alteración de la conciencia Evidenciado por la imposibilidad del paciente de adaptar el campo fenomenológico de la conciencia al momento presente, lo que configura para la Teoría Organodinámica de Ey una desestructuración de conciencia de primer grado o nivel ético-temporal. Carece de conciencia mórbida. No presentifica el encuentro con el médico psiquiatra. Dificultad para reconstruir el pasado inmediato con alteración de la atención espontánea y voluntaria, dejándose llevar por estímulos ambientales. ====== Síndrome somático Evidenciado por las repercusiones de los cambios de apetito y sueño, así como de las conductas (consumo de sustancias, exposición a clima adverso). Destacar elementos metabólicos (adelgazamiento, deshidratación, hipertermina), neurológicos y endocrinológicos relevantes. ====== Síndrome depresivo Puede darse en retrospectiva (ver encare correspondiente) o bien con elementos depresivos dentro del cuadro actual (en ese caso, puede que haya que plantear episodio mixto). ===== Personalidad y nivel ====== Nivel icon:paste[] Nivel en diferido. ====== Personalidad Lo evaluaremos luego de remitido el cuadro actual. ===== Diagnóstico positivo ====== Nosografía clásica icon:paste[] Psicosis. icon:paste[] Psicosis aguda .Crisis de manía Por presentar una exaltación del humor como elemento central del cuadro clínico, del que se destaca la fuga de ideas, la exaltación psicomotriz con actitud lúdica e hiperactividad desordenada (y en caso de presentarlas destacar las ideas deliroides o delirantes), que ha repercutido negativamente en los desempeños y funcionamiento vital. .Forma clínica Las diferentes formas clínicas son un continuum dinámico, según fluctuaciones de superficialización o pofundización de la alteración de conciencia. * Manía franca (simple o aguda): es el cuadro clásico. Carece de delirio y alucinaciones. Pero como la imaginación está exaltada puede darse, en las formas con más desestructuración de la conciencia, ideas de convicción subdelirantes o fabulatorias, como un delirio en estado naciente que no se consolida dada la gran hiperactividad y aceleración de los procesos mentales. * Manía delirante: al desestructurarse la conciencia más profundamente se pasa a esta forma clínica. En ella se reconoce un delirio, una ""experiencia delirante"", aunque no de las características de la ""experiencia delirante primaria"" de la PDA. Este es cambiante, móvil, mínimamente sistematizado. Es un delirio verbalizado más que vivido (como en las PDA). * Furor maníaco: es el grado máximo de exaltación psicomotriz. Se presenta como una exaltación de la expresión principalmente motora, con oscurecimiento de la conciencia. Puede haber rechazo del alimento y signos orgánicos graves de agotamiento, deshidratación e hipertermia. * Estados mixtos: en todo episodio coexisten elementos maníacos y depresivos, pero en ocasiones esta mezcla es un rasgo principal del cuadro. * Hipomanía: caracterizada por la fuga de temas (la idea llega a desarrollarse o formar un tema), un humor jovial, eufórico, hiperactivo, con múltiples inciativas y proyectos que no llegan a finalizar, prodigalidad, hipersexualidad. Menor deterioro funcional. * Manía confusa: desorientación TE, alteraciones mnésicas, trastornos del pensamiento. .Diagnóstico nosológico Este acceso maníaco se inscribe en una enfermedad crónica, de manifestación episódica: Psicosis Maníaco-Depresiva. Esta se define por la presencia de uno o más episodios de manía, generalmente acompañado por uno o más episodios depresivos, en el contexto de antecedentes personales y familiares destacados. ====== Según sistemas de clasificación (DSM IV) .Diagnóstico del episodio Episodio maníaco A. Período diferenciado de estado de ánimo anormalmente y persistentemente elevado, expansivo o irritable, de al menos 1 semana de duración (o cualquier duración si se hospitaliza). B. Al menos 3 de estos síntomas: megalomanía, insomnio, verborrea, fuga de ideas, distraibilidad, hiperactividad, humor lúdico. C. Malestar o deterioro clínicamente significativo D. No cumple criterios para episodio mixto E. Se excluye cuadro provocado por sustancias, enfermedad médica, tratamiento farmacológico, trastorno por déficit atencional con hiperactividad, EDM con irritabilidad. Especificadores del episodio * Gravedad: leve, moderado, grave, con/sin síntomas psicóticos. * Curso: en curso, remisión parcial / total. * Síntomas psicóticos: congruentes / no congruentes con el estado de ánimo. * Síntomas catatónicos. * Inicio: inicio en postparto. Episodio Hipomaníaco Requiere: A y B: igual que manía, pero duración de al menos 4 días + A. Igual que manía B. Igual que manía C. Cambio con respecto a humor habitual + D. Cambio observable por terceros + E. Sin alteración importante de pragmatismos + F. Descartar sustancias, medicamentos, enfermedad médica. Episodio Mixto Requiere: A. Se cumplen criterios para episodio maníaco y para episodio depresivo mayor casi cada día x 1 período mayor a 1 semana + B. Alteración de pragmatismos + C. Descartar sustancias, enfermedad médica. Episodio Depresivo Ver encares de depresión .Diagnóstico nosológico Trastorno Bipolar I • Requiere: al menos 1 episodio maníaco o mixto (previo o actual). • Especificar: último episodio + especificadores del último episodio. • Especificadores de curso longitudinal: recuperación interepisódica (si/no), patrón estacional (si/no), ciclos rápidos (si/no). Tipos: • TB I episodio maníaco único • TB I episodio más reciente X (hipomaníaco, maníaco, mixto, depresivo) Trastorno Bipolar II • Requiere: al menos 1 episodio hipomaníaco + historia de uno o más episodios depresivos (SIN historia de episodios maníacos o mixtos). • Especificar: último episodio + especificadores de curso longitudinal. • Trastorno ciclotímico • Requiere: A. historia de 2 años de varios episodios hipomaníacos + episodios depresivos que no cumplen criterios de EDM + B. Nunca asintomático x más de 2 meses + C. Dos primeros años sin EDM, episodio maníaco o mixto (si aparecen luego de los 2 años, codifican los 2 trastornos) + D. Descartar esquizoafectivo, esquizofrenia, esquizofreniforme, trastorno delirante + E. Descartar sustancias, enfermedad médica + F. Alteración de pragmatismos. Especificadores del trastorno Curso: . ciclos rápidos (al menos 4 episodios en 12 meses, 15-20% de los bipolares) . con/sin patrón estacional . con/sin recuperación interepisódica total. Promotores del ciclado: * Hipotiroidismo subclínico * Sustancias/alcohol * Alteraciones del ciclo sueño/vigilia * Fármacos: antidepresivos, corticoides * Lesiones cerebrales ===== Diagnóstico diferencial ====== Del episodio .Con otras psicosis agudas . Manía secundaria a causa orgánica: si el cuadro se presenta a edad tardía, con trastorno de conciencia, desorientación, UISP, primer episodio, elementos atípicos: .. Causa: tóxica: anfetaminas, cocaína, alcohol, intoxicación o abstinencia. .. Fármacos: antidepresivos, corticoides. .. Endocrinológicas: hipertiroidismo, Cushing, encefalopatía hepática. .. Neurológica: epilepsia parcial compleja, esclerosis múltiple, corea, tumores, TEC. .. Infeccionsa: neurosífilis, HIV .. Metabólica .. Neoplasias: páncreas, pulmón .. Autoinmune. . PDA / Trastorno psicótico breve: tienen cosas en común (episodio agudo, desestructuración de conciencia y afectos, delirio, experiencia sensible y actual), pero con diferencias (predominio del humor exaltado y de la fuga de ideas, con actitud lúdica, ideas delirantes secundarias al trastorno del ánimo, AF, AP), le falta elementos (delirio polimorfo, alteración de conciencia más profunda, de tipo oniroide). . Confusión mental: tiene cosas en común (desestructuración de conciencia). En contra: menor profundidad de la desestructuración, delirio onírico en la confusión, falta de perplejidad, conservación de la orientación temporoespacial. No pensamos que este cuadro sea icon:paperclip[], por los AF, los AP de episodios maníacos y melancólicos y por el abandono de medicación determinando cuadros similares. Por la paraclínica descartaremos algunas de estas causas. ====== Del trastorno .Con psicosis crónicas En el joven se pueden ver debut clínico de Esquizofrenia o de un Trastorno Esquizoafectivo con un episodio maníaco. A factor: deterioro en el curso evolutivo, el hipopragmatismo o el corte existencial, el delirio incongruente con el estado de ánimo. En contra: prima la alteración del humor por sobre la del pensamiento, no elementos del Síndrome Disociativo-Discordante, por los AF y los AP. .Demencias En el paciente añoso se puede ver el debut clínico de un cuadro Demencial, alejándonos los AF y AP, la ausencia de causa orgánica y la falta de un deterioro global cognitivo. .Trastorno de la personalidad Tanto DD como comorbilidad. ===== Diagnóstico etiopatogénico y psicopatológico Destacar elementos del cuadro clínico del paciente en particular, agregando observaciones teóricas SOBRE el cuadro clínico. ====== Diagnóstico etiopatogénico Se plantea una causa multifactorial. Existen múltiples niveles complementarios e integrativos de comprensión e intento de explicación de esta enfermedad. La vía final es la interacción estrés-diátesis. .Comprensión biológica . Genética: hay una carga genética predisponente, dada la frecuencia de AF de trastornos afectivos, alcoholismo, IAE, comprobándose asociaciones con algunos cromosomas específicos. Pero la concordancia entre gemelos no es del 100%, por lo cual no es un factor determinante. . Constitucional: desde las descripciones clásicas se plantea la asociación con el biotipo pícnico (Kretschmer), lo cual se ve reforzado por la constatación de una mayor prevalencia de alteraciones metabólicas. . Hipótesis catecolaminérgica: involucra los neurotransmisores dopamina y noradrenalina, planteada en 1965 por Bunney y Davis. . Hipótesis serotinérgica: planteada por Coppen y Lappin en 1969. Cambios primarios en los sistemas monoaminérgicos y cambios en la modulación realizada por el sistema serotoninérgico. Existiría una disregulación en estas vías. . Existiría una alteración de la carga alostérica al estrés, es decir la capacidad de conservar la estabilidad. Sería una enfermedad de la respuesta, del retorno a la normalidad. . Se postula la existencia de un fenómeno de kindling límbico-amigdalino-prefrontal: en los sucesivos episodios, el desencadenante exógeno es menor y finalmente el fenómeno adquiere autonomía de las causas externas. . Se detectan también cambios neuroendócrinos en: CRH, RCRH, VSP, ACTH, cortisol. Una causa frecuente de descompensación es el abandono de medicación. .Comprensión psicológica Puede encontrarse dificultad para superar pérdidas y para adaptarse a situaciones nuevas. Sobre un terreno de vulnerabilidad actúan factores psicosociales: pérdidas, dificultades interpersonales. Hay etapas vitales con mayor riesgo de síntomas afectivos: adolescencia, embarazo, puerperio, climaterio, menopausia, envejecimineto, duelo. .Comprensión social Estresores sociales como factor exterior sobre la vulnerabilidad de base. Pérdida de roles laborales, pérdida de posición social. ====== Diagnóstico psicopatológico Para Binswanger se trata de una modalidad regresiva global con modificación de la estructura temporal de la vida psíquica, con desencadenamiento de los impulsos. Para la Teoría Organodinámica de Ey de la desestructuración de conciencia (el Ser Consciente), el maníaco presenta una desestructuración del orden del cuerpo mental en su nivel ético-temporal (de 1° grado). Etico por la incapacidad de postergar la realización de los deseos y temporal por la estrechez del presente en un punto virtual siempre renovado y sin trascendencia, con distensión, laxitud, relajamiento de la continuidad histórica del individuo. Determina una pérdida de la capacidad de adaptación a las exigencias del aquí y ahora. Comporta un aspecto negativo (regresivo o deficitario) y aspecto positivo, de liberación de instancias inferiores. Para los psicoanalistas se trata de una regresión a las etapas infantiles del desarrollo psicosexual, anteriores a toda frustración exterior. Las pulsiones se liberan, especialmente las pregenitales. En este sentido, sería lo contrario del melancólico, pues el maníaco se precipita a la satisfacción inmediata de las pulsiones como una forma de escapar de la angustia. Sus mecanismos de defensa son la negación de la pérdida de objeto (mal manejo de una pérdida) y la omnipotencia ante la melancolía (en todo maníaco hay un fondo nuclear melancólico). ===== Paraclínica El diagnóstico es clínico. La paraclínica está destinada a realizar una valoración general del paciente, descartar diagnósticos diferenciales y con miras a los diferentes recursos terapéuticos de los que disponemos. Lo solicitaremos desde un punto de vista integral: biológico, psicológico y social. Solicitaremos la historia clínica previa o su resumen para objetivar los antecedentes clínicos y de recursos terapéuticos. En caso que sea necesario se pedirá información al juez o a la policía. ====== Biológico .Valoración general Realizaremos una anamnesis médica general al paciente y terceros. Un examen físico completo con énfasis en el aspecto neurológico (con el paciente sedado, si corresponde), buscando elementos de organicidad que nos pongan en la pista de una patología reversible determinante de la expresión clínica actual. En particular buscaremos elementos de hipertensión endocraneana (fondo de ojo), estigmas de UISP, focos infecciosos. Solicitaremos exámenes de valoración general: . Metabólica: glicemia, perfil lipídico (para establecer línea de base ante el eventual uso de fármacos con repercusión metabólica). . Hematológica: hemograma . Renal: función renal . Infecciosa: HIV, VDRL y si la situación clínica lo determina: HVB, HVC . Hepática: funcional y enzimograma hepático . Tóxica: screening de sustancias psicoactivas en orina Si es pertinente: test de embarazo. Si es clínicamente necesario: TAC, consulta con neurólogo, enzimograma cardíaco (cocaína). Se solicitarán consultas con especialistas según hallazgos. .Con miras a posibles tratamientos Litio: examen de orina, función renal (contraindicado en insuficiencia renal), función tiroidea (por comorbilidad, por factor causal y como línea de base por efecto secundario del litio), test de embarazo (el litio es teratogénico), ionograma (hiponatremia aumenta probabilidades de intoxicación por litio), hemograma (litio da leucocitosis), ECG (por efectos sobre la conducción cardíaca). Descartar estados que lleven a balance negativo de Na (dieta hiposódica, diuréticos) ya que en su eliminación, el LI se intercambia por Na a nivel renal y un déficit de este ion puede llevar a un aumento de la litemia con el consiguiente riesgo de intoxicación. ECT: ECG y consulta con cardiólogo para descartar IAM reciente o arritmias ventriculares graves que contraindicarían su realización). Rx Tx (para descartar aneurisma de aorta). Fondo de ojo/TAC: para descartar hipertensión endocraneana. En algunos casos puede plantearse la realización de EEG. En pacientes añosos y según el caso clínico puede solicitarse una evaluación del estado cognitivo basal. TIP: Contraindicaciones de ECT: IAM reciente, arritmias inestables, aneurisma de aorta, PEIC con HTEC. Carbamazepina: hemograma (por ser depresor de la médula ósea, contraindicado en caso de citopenia), funcional y enzimograma hepático (por determinar movilización enzimática y potencial toxicidad hepática). Acido valproico: funcional y enzimograma hepático, hemograma. ====== Psicológico Será diferido hasta superada la agudeza del cuadro actual, salvo la existencia de dudas diagnósticas. Realizaremos entrevistas para evaluar las características propias del paciente y sus capacidades para en un futuro integrarse a grupos de psicoterapia. Realizaremos tests de personalidad proyectivos (Rorscharch y TAT) y no proyectivos (Minessota), que nos informarán sobre los mecanismos de defensa, integridad yoica, manejo de la agresividad y rasgos de personalidad. Realizaremos test de nivel, si hay dudas. La realización de tests no es imprescindible y no retrasará el inicio del tratamiento. ====== Social Realizaremos entrevistas con familiares a los efectos de valorar: red de soporte y vínculos, características de los tratamientos previos y sus resultados, funcionamiento premórbido e intercrítico, antededentes de corte existencial, inventario de eventos vitales, valorar medio socio-económico-cultural. Informaremos a la familia sobre los diagnósticos positivos y diferenciales, las dudas, los tratamientos disponibles, sus riesgos y beneficios y nuestra opinión sobre lo mejor para este paciente en este momento. La información será transmitida siempre con un objetivo de psicoeducación. Pediremos consentimiento informado por la posibilidad de ECT. ===== Tratamiento El tratamiento será dinámico, adaptado constantemente a la evolución clínica y a la aparición de complicaciones, integrado por recursos farmacológicos, psicológicos y sociales. . Objetivos inmediatos: remitir rápidamente el cuadro actual, descartar causa orgánica, prevenir complicaciones. . Objetivos mediatos: compensar la enfermedad de fondo, prevenir futuras recaídas, prolongar los períodos de remisión, reinsertar al paciente en su mejor nivel de funcionamiento. Lo internaremos en sala de patología aguda de hospital psiquiátrico por: gran exaltación, presencia de un delirio, agresividad, ansiedad, riesgo suicida, alteración de las conductas basales, carencia de continencia familiar. Lo ideal es internarlo en sala individual, en un entorno con poca estimulación, sin elementos de riesgo (ventanas, espejos), con asistencia de enfermería especializada las 24 horas y acompañante continentador a permanencia. Límites claros y firmes. Evitar interacciones provocativas. La internación será en sala de hospital general si reconocemos una causa determinante orgánica tratable y reversible que necesite de medios asistenciales más complejos. Será dentro de lo posible con su consentimiento, pero debemos hacerla aún de forma compulsiva, evaluando riesgo/beneficio. La internación es una medida de protección del paciente y de terceros. De esta forma lograremos: continentar al paciente calmando su sufrimiento psíquico, tratar su excitación / ansiedad / delirio, acortar la duración de la crisis actual, mejorando el pronóstico; ajustar la medicación; proteger al paciente y terceros de las posibles complicaciones medicolegales, vigilar fugas e IAEs, descartar causa orgánica. Se llevará adelante por un equipo interdisciplinario. Indicaremos controles de enfermería especializada. Permitiremos visitas de figuras continentadoras. Realizaremos adecuado aporte nutricional. Se verificará la toma de medicación. ====== Farmacológico .Tratamiento del episodio Tratamiento de la fase aguda, busca la remisión de síntomas específicos. Depende de la situación clínica: 1. Manía típica (eufórica) sin síntomas psicóticos: Litio (o Divalproato) icon:arrow-right[] + benzodiacepina icon:arrow-right[] + Antipsicótico atípico icon:arrow-right[] DVP + Litio icon:arrow-right[] Cambiar de antipsicótico icon:arrow-right[] DVP + Li + CBZ icon:arrow-right[] ECT 2. Manía mixta (disfórica): Divalproato icon:arrow-right[] mismo esquema que manía típica. 3. Hipomanía: mismo esquema que manía eufórica (con menos énfasis en el uso de antipsicóticos). 4. Manía con síntomas psicóticos: Divalproato (o Litio) + AAP (o CAP) icon:arrow-right[] cambiar AAP o + BZD icon:arrow-right[] DVP + LI icon:arrow-right[] cambiar AAP o AAP + CAP icon:arrow-right[] ECT icon:arrow-right[] DVP + LI + CBZ (o agregar Clozapina) 5. Manía en paciente con ciclado rápido: DVP icon:arrow-right[] DVP + (LI o CBZ) icon:arrow-right[] + AAP icon:arrow-right[] DVP + LI + CBZ icon:arrow-right[] Clozapina icon:arrow-right[] Lamotrigina icon:arrow-right[] Gabapentina icon:arrow-right[] ECT 6. Depresión en bipolar (no psicótica - no ciclos rápidos) sin medicación previa moderado: Li icon:arrow-right[] +AD 7. Depresión en bipolar (no psicótica - no ciclos rápidos) sin medicación previa severo: LI (o DVP) + AD icon:arrow-right[] LI + DVP. 8. Si estaba con estabilizador: maximizar estabilizador como primer paso icon:arrow-right[] Li + DVP icon:arrow-right[] + AD o Lamotrigina icon:arrow-right[] + AD si no tenía (o cambiarlo). 9. Si hay refractariedad en la depresión: ECT icon:arrow-right[] T3 icon:arrow-right[] Otros estabilizadores icon:arrow-right[] Clozapina o estimulante o fototerapia. 10. Episodio depresivo psicótico: igual pauta, con más énfasis en antipsicóticos atípicos (ECT a cualquier altura del algoritmo). 11. Depresión en paciente con ciclado rápido: DVP icon:arrow-right[] + (Li o CBZ o Lamotrigina) icon:arrow-right[] + AD icon:arrow-right[] cambio de AD icon:arrow-right[] T3/T4 o AAP icon:arrow-right[] Gabapentina o Clozapina o Fototerapia -> ECT. TIP: Regla general: LIT en manía típica, DVL en el resto (por se de más fácil manejo). icon:notes-medical[] Ansiedad y angustia Inicialmente usaremos benzodiacepinas, como el Lorazepam (del cual contamos con presentación parenteral de ser necesario). Iniciamos con dosis de 2 a 4 mg i/m o v/o según la clínica, cada 6-8 horas. Una alternativa es el uso de Clonazepam a dosis de 2 a 4 mg c/8-12 horas, pudiendo llegar a 12 mg/día (con efecto sobre la disforia y la impulsividad). Ambos fármacos actúan sobre receptores GABA. icon:notes-medical[] Excitación psicomotriz De nos ser suficiente con la benzodiacepina, utlizaremos antipsicóticos sedativos, sustityéndola o como complemento. Indicaremos Levomepromazina 25 mg i/m c/8 horas con un posible refuerzo de dosis nocturno (50 mg H 20) evaluando el pasaje a v/o, atentos a los efectos anticolinérgicos e hipotensión postural. icon:notes-medical[] Delirio Escenario 1: vía IM. Indicaremos neurolépticos incisivos antidelirantes del grupo de las butirofenonas, como el Haloperidol, que actúa bloqueando los receptores dopaminérgicos D2 córtico-mesolímbicos, comenzando con dosis de 5 mg i/m horas 8 y 20 a fin de lograr la seguridad en la toma de medicación y niveles terapéuticos adecuados en los sitios de acción. Destacamos además el efecto antimaníaco de esta medicación además de la acción sobre la excitación y los síntomas psicóticos. La dosis y la vía se ajustarán según respuesta clínica. El Haloperidol puede elevarse a dosis de 15-20 mg/día si la evaluación clínica lo indica. Pasaremos la totalidad de la dosis a la noche, en lo posible. Estaremos atentos a la aparición de efectos secundarios de los neurolépticos. En caso de un paciente de riesgo (varón, menor de 35 años, AF de Enfermedad de Parkinson), indicaremos Biperideno de forma preventiva a dosis de 2 mg H 8 y H14 por v/o por vía i/m. Las formas de liberación prolongada se pueden dar solamente en la mañana. De aparecer distonía aguda, acatisia, síntomas extrapiramidales (rigidez, rueda dentada, bradiquinesia, temblor) comenzaremos con Biperideno, evaluando la posibilidad de disminuir las dosis del antispsicótico (y/o concentrar la dosis en la noche) y discontinuándolo en un plazo de 3 meses si la evolución lo permite. Mantendremos el Haloperidol i/m de 3 a 5 días y pasaremos luego a v/o según disminuya la exaltación y el delirio. Debemos retirarlo completamente lo antes posible por riesgo de viraje hacia la depresión, con aumento de frecuencia de crisis y reducción de períodos intercríticos. Debemos considerar además que los paciente con trastornos afectivos tienen también mayor riesgo de presentar disquinesias tardías. Escenario 2: VO Consideramos de elección el uso de antipsicóticos atípicos por la menor incidencia de efectos secundarios. Solo en caso de que se requiera medicación intramuscular, usaremos Haloperidol i/m que pasaremos luego a vía oral. Olanzapina (primera línea, con o sin síntomas psicóticos): iniciando con 5 mg/día en toma única, aumentando a 10 si hay buena tolerancia, pudiendo aumentar hasta 20 mg/día. Propiedades como antipsicótico y como estabilizador del humor. Risperidona: comenzamos con 2 mg/día v/o en 2 tomas, aumentando hasta 4.5 mg/día en 2 tomas. Luego 1 semana puede administrarse en una única toma nocturna. Máximo: 6 mg/día (dosis más altas aumentan el riesgo de efectos secundarios). icon:notes-medical[] Insomnio De persistir el insomnio a pesar de los ansiolíticos, indicaremos Midazolam i/m, o si la situación lo permite, Flunitrazepam 2 mg v/o a la noche. La restauración de un ciclo sueño-vigilia normal es fundamental para la recuperación clínica. icon:bolt[] ECT Si en 10-15 días no obtenemos mejoría (disminución de exaltación, disminución de entrega a la experiencia maníaca) evaluaremos las posibles causas y consideraremos el aumento de la dosis de los fármacos y evaluaremos la realización de ECT, para lo cual solicitaremos consentimiento informado a familiar. La ECT se considera de primera línea en caso de afectación severa de conductas basales (rechazo de alimentos), repercusión general, mal estado general y cuando los fármacos están contraindicados por algún motivo. El mecanismo de acción de la ECT es desconocido. Indicaremos una serie inicial de 8 a 10 sesiones, una día por medio, realizadas con asistencia de anestesista, psiquiatra y enfermería especializada, bajo monitoreo ECG y EEG. Descartaremos previamente elementos que la contraindiquen, como se especificó en el apartado Paraclínica. Puede ser necesario la suspensión de benzodiacepinas en las horas previas dado que éstas aumentan el umbral convulsivo (se puede sustituir por Levomepromazina). La dosis de litio de la mañana se postergará por mayor riesgo de confusión mental y amnesia post ECT. .Tratamiento de la enfermedad de fondo El tratamiento de la fase aguda será seguido de un tratamiento de continuación (4-12 meses) donde se busca mantener el control del episodio actual y se comienza la fase de prevenir o atenuar futuros episodios. icon:pills[] Litio De primera elección en manías típicas (sin estados mixtos, sin ciclado rápido, sin abuso de sustancias). Indicaremos desde el inicio del tratamiento. Pese a su latencia de 8-10 días proporciona un efecto antimaníaco más específico, además de ser estabilizador del humor y profiláctico de recidivas. Comenzaremos con 300 mg v/o c/8 horas, con las comidas, probando tolerancia, ya que al inicio son frecuentes los trastornos digestivos leves que, al igual que la sintomatología neurológica inespecífica (letargia, fatiga, debilidad muscular y temblor fino distal), polidpsia y poliuria, son todos fenómenos reversibles y transitorios. Indicaremos abundantes líquidos v/o. Estaremos atentos a la aparición de estos síntomas. Controlaremos la aparición de signos incipientes de toxicidad: ataxia, temblor grueso, disartria, fasciculaciones. WARNING: Atentos a los signos de intoxicación por litio (ATeGDiF): ataxia, temblor grueso, disartria, fasciculaciones Si el paciente es añoso, o con problemas renales, o sensible a efectos secundarios: comenzar con 150 mg v/o c/8. Probablemente lleguemos a un rango de dosis de 900 a 1800 mg). La posología en 1 o 2 tomas diarias no modifica la eficacia y puede minimizar algunos efectos adversos, además de favorecer el cumplimiento con el tratamiento. A los 5-7 días (tiempo en que se tarda en llegar al estado de meseta) realizaremos la primera litemia (12 horas luego de la última toma, por la variación pico-valle) y según ella iremos ajustando la dosis hasta llegar al rango terapéutico establecido de 0.8-1.2 mEq/l (según el paciente aprox 900-1800 mg/día). La litemia se repetirá semanalmente el primer mes y luego mensual durante el primer semestre. La dosis se ajustará según concentraciones séricas y cuadro clínico. El nivel plasmático depende de muchos factores, entre ellos: masa corporal, filtrado glomerular e idiosincrasia farmacológica individual. Para la crisis de manía se postula un rango terapéutico de 1.0 a 1.2 mEq/l y para la profilaxis 0.8 a 1.0 mEq/l. El litio no actúa en el espacio sináptico sino intracelularmente, en los sistemas de proteína G y segundos mensajeros. Por eso la latencia de hasta 3 semanas para el inicio de los efectos terapéuticos. Las litemias se realizarán cada 3 meses o más seguido si hay efectos tóxicos o incumplimiento del tratamiento. Se realizará una función renal evaluando creatininemia cada 6 meses y ante cambios de dosis, de respuesta terapéutica o ante sospecha de falla renal. Se realizará ECG cuando sea necesario, pero solo una arritmia grave determina la suspensión del Litio. Se realizará TSH cada 6 mees si hay clínica de disfunción tiroidea. En paciente con ciclado rápido, se postula que el litio tiene menor eficacia, presentando mejor respuesta a Acido Valproico o Carbamazepina. La disfunción tiroidea puede ser un factor predisponente para el ciclado rápido WARNING: Poner predictores de buena respuesta al litio (ej. AF afectivos). icon:pills[] Acido Valproico Actúa sobre la neurotransmisión GABA. Se plantea una dosis inicial de 250 mg c/12 horas (probando tolerancia, sobre todo por efecto gastrointestinales), que se aumentará hasta dosis máxima de 20 mg/kg/día (en 2 o 3 tomas) o concentraciones plasmáticas de 50 a 125 mcg/ml. Se logra una meseta plasmática al cabo de 2 semanas. El efecto puede tener una latencia de 3 semanas. Precaución en pacientes con AP de disfunción hepática. No dar en embarazo o lactancia. Alta unión a proteínas. Ajustar dosis en insuficiencia renal y hepática, en ancianos, coagulopatías, dislipemias severas, desnutrición. Aumenta los niveles de AAS, fenitoina, carbamazepina, warfarina, diazepam, lorazepam, amitriptilina. Efectos secundarios: intolerancia digestiva, sedación, astenia, rash cutáneo, leucopenia y plaquetopenia benignas, alopecia, temblor. Puede haber como efecto idiosincrático: insuficiencia hepática y agranulocitosis. Es más eficaz en los episodios mixtos que en la manía clásica. TIP: Las presentaciones de divalproato de sodio tienen mejor tolerancia gástrica. Tienen una cobertura entérica por lo que no es recomendable partir el comprimido. Precaución: trombocitopenia, insuficiencia hepática. Realizaremos la valoración paraclínica descrita previo a su uso. icon:pills[] Carbamazepina Generalmente como coadyuvante de otro estabilizador del humor. Dosis iniciales de 200 mg v/o c/12 horas que se aumentará hasta 1200-1400 mg/día. con control de función hepática y hematológica. Se plantea lograr una concentración terapéutica de 4-12 mcg/ml de plasma. TIP: Predictores de respuesta a antivonvulsivantes: ciclado rápido, episodio mixto, pobre respuesta a litio, manía secundaria, comorbilidad con abuso de sustancias. ====== Psicológico Haremos entrevistas diarias con el paciente, con el objetivo de: crear un vínculo terapéutico cálido y continentador, evaluar la evolución y las oscilaciones diarias, investigar y reforzar los aspectos sanos, evaluar el factor desencadenante si lo hubiera, evaluar factores de vulnerabilidad para próximos episodios, darle referencias de realidad sin confrontarlo. Se fomentará la alianza terapéutica. A mediano plazo, la terapia de grupo puede ser útil para abordar el incumplimiento con el tratamiento, la adaptación a una enfermedad crónica, la regulación de la autoestima y los problemas conyugales / sociales que puede acarrear la enfermedad. ====== Social Entrevistas reiteradas con familiares con fines de psicoeducación sobre el diagnóstico y tratamiento instituido, los pronósticos y su relación con la adherencia al tratamiento, la importancia de los controles y afianzar el vínculo como aliado terapéutico. Evaluaremos el impacto de la patología en la autoestima del paciente. Facilitaremos el acceso a biblioterapia. Contactaremos a la familiar con grupos de psicoeducación de familiares de pacientes bipolares (en especial grupos que sigan el modelo propuesto por Colom y Vieta). El familiar es un aliado en la evitación del abandono del tratamiento y en la detección de signos precoces de descompensación, que llevan a la consulta precoz. Se evaluarán las condiciones laborales evitando turnos rotativos, favoreciendo la estabilidad en el ciclo sueño-vigilia. Mujer en edad genital activa: derivar a planificación familiar (potencial teratogénico de algunos fármacos, aumento de posibilidades de descompensaciones vinculadas a ciclos reproductivos). ====== Alta hospitalaria Dependerá de la respuesta al tratamiento. Se dará al haber: remisión de sintomatología psicótica, aparición de crítica, normalización de las conductas basales y el autocuidado, adquisición de conceptos básicos de psicoeducación, compromiso con el paciente y la familia en el control evolutivo en policlínica. Se retirarán, en la medida de lo posible los fármacos que no sean necesarios. A largo plazo lo ideal es la monoterapia con estabilizadores del humor. Sabemos que esto no siempre es posible que en general se recurre a una combinación de fármacos a las mismas dosis con las que se obtuvo la mejoría (ver esquema previo con secuencia de uso de fármacos de 1a, 2a y 3a linea). Es fundamental el seguimiento para el control evolutivo, el cumplimiento con el tratamiento, la dosificación de fármacos en sangre (si corresponde). WARNING: Poner control de fármacos según CANMAT ===== Evolución y pronóstico ====== Evolución Estamos ante una enfermedad crónica de manifestación episódica, estando el pronóstico supeditado al subtipo clínico, la respuesta y adhesión al tratamiento, el funcionamiento psicosocial y la presencia de estresores. Sin tratamiento evoluciona hacia el aumento de la frecuencia de las crisis, con períodos libres de síntomas más cortos, con crisis más intensas y prolongadas y con refractariedad a la terapéutica profiláctica. Espontáneamente una crisis de manía remite al cabo de 3 a 6 meses y una de melancolía al cabo de 8 a 12 meses. Con tratamiento adecuado y adherencia al mismo, se logra en un alto porcentaje de pacientes la remisión de las crisis, prolongación de períodos intercríticos, disminución de la frecuencia de las crisis, las crisis que ocurren son de menor duración y de menor intensidad, con menor necesidad de internaciones y de medicación, con menor repercusión psicológica individual, de pareja y familiar, menor compromiso laboral y en los estudios. ====== Pronóstico Pronóstico psiquiátrico inmediato: bueno con el tratamiento instituido. Pronóstico vital inmediato: supeditado a la exclusión de patologías orgánicos, al riesgo de IAE, autolesiones, conductas de riesgo y heteroagresividad. Pronóstico psiquiátrico alejado: sujeto a la adhesión al tratamiento. Pronóstico vital alejado: sujeto a descompensaciones con conductas de riesgo; agresividad UISP, alcoholismo, sexualidad (HIV, VDRL, HVB, HVC). Comorbilidad médica (insuficiencia renal, enfermedades cardíacas). Se considera refractario a un tratamiento si no ha habido respuesta significativa luego de 12 semanas de niveles terapéuticos en sangre. A mayor edad, tienden a disminuir los períodos intercríticos, con mayor frecuencia y duración de las crisis (kindling). De tratarse de una mujer en edad genital activa: control de natalidad y anticoncepción con ginecólogo. Suicidio: en el trastorno bipolar bipolar hay 30 veces más riesgo que en la población generl. Se registra un 15 % de suicidio consumado. Elementos de mal pronóstico * Presencia de comorbilidad (deterioro cognitivo, consumo de sustancias) * Alta frecuencia de episodios * Estresores ambientales / psicosociales ===== En suma Hemos visto un paciente de sexo X, de X años de edad, con un MSEC X, con AF de X, con AP de X, que consulta por X síntomas, en quien diagnosticamos un Trastorno Bipolar de tipo I / II, de características X. con un episodio actualX, con características X, en comorbilidad con X. Hemos planteado diagnósticos diferenciales con X, hemos estudiado con X, y hemos tratado con X. Planteamos una evolución buena con el tratamiento indicado, dependiendo el pronóstico a largo plazo de la adherencia al tratamiento. ",12204,False,2176.0088200185546,median "--- title: Бүлэг 18. Аюулгүй байдлын үйл явцад аудит хийх нь part: хэсэг III. Системийн Удирдлага prev: books/handbook/mac next: books/handbook/disks --- [[audit]] = Аюулгүй байдлын үйл явцад аудит хийх нь :doctype: book :toc: macro :toclevels: 1 :icons: font :sectnums: :sectnumlevels: 6 :sectnumoffset: 18 :partnums: :source-highlighter: rouge :experimental: :images-path: books/handbook/audit/ ifdef::env-beastie[] ifdef::backend-html5[] :imagesdir: ../../../../images/{images-path} endif::[] ifndef::book[] include::shared/authors.adoc[] include::shared/mirrors.adoc[] include::shared/releases.adoc[] include::shared/attributes/attributes-{{% lang %}}.adoc[] include::shared/{{% lang %}}/teams.adoc[] include::shared/{{% lang %}}/mailing-lists.adoc[] include::shared/{{% lang %}}/urls.adoc[] toc::[] endif::[] ifdef::backend-pdf,backend-epub3[] include::../../../../../shared/asciidoctor.adoc[] endif::[] endif::[] ifndef::env-beastie[] toc::[] include::../../../../../shared/asciidoctor.adoc[] endif::[] [[audit-synopsis]] == Ерөнхий агуулга FreeBSD үйлдлийн системд нягт-боловсруулсан, аюулгүй байдлын үйл явцад аудит хийх дэмжлэг орсон байгаа. Үйл явцад аудит хийх нь нэвтрэн оролтууд, тохиргооны өөрчлөлтүүд, болон файл болон сүлжээний хандалт зэрэг төрөл бүрийн аюулгүй байдлын холбогдолтой системийн үйл явцуудын хянаж бүртгэсэн бичлэгийг найдвартай, нягт-боловсруулсан, ба тохируулах боломжтойгоор хийх боломжийг бүрдүүлдэг. Эдгээр хянаж бүртгэсэн бичлэгүүд нь системийг шууд хянах, халдлага илрүүлэх, болон халдлагын дараах анализ хийхэд үнэлж баршгүй байж болох юм. FreeBSD Sun(TM)-ий гаргасан BSM API болон файлын хэлбэрийг шийдлээ болгосон бөгөөд Sun(TM)-ий Solaris болон Apple(R)-ийн Mac OS(R) X-ийн аудит шийдлүүдтэй харилцан ажиллах боломжтой. Энэ бүлэг нь үйл явцыг аудит хийхийг тохируулах болон суулгах тал дээр анхаарна. Энд аудитийн бодлогуудын талаар тайлбарлах бөгөөд аудитийн тохиргооны жишээг бас харж болно. Энэ бүлгийг уншсаны дараа, та дараах зүйлсийг мэдэх болно: * Үйл явцыг аудит хийх гэж юу вэ болон яаж ажилладаг талаар. * Хэрэглэгчид болон процессуудын үйл явцыг аудит хийхийг FreeBSD дээр яаж тохируулах талаар. * Аудитийн мөрийг аудит багасгах болон хянах хэрэгслүүдээр хэрхэн шалгах талаар. Энэ бүлгийг уншихаасаа өмнө, та дараах зүйлсийг мэдэх шаардлагатай: * UNIX(R) болон FreeBSD-ийн үндсийг ойлгох (crossref:basics[basics,Юниксийн үндэс]). * Цөмийг тохируулах/хөрвүүлэх үндэстэй танилцах (crossref:kernelconfig[kernelconfig,FreeBSD цөмийг тохируулах нь]). * Аюулгүй байдлын талаар болон түүний FreeBSD -тэй хэрхэн холбогддог талаар ойлголттой байх (crossref:security[security,Аюулгүй байдал]). [WARNING] ==== Аудит хэрэгсэл нь зарим нэг хязгаарлагдмал боломжуудтай бөгөөд тэдгээрээс дурдвал бүх аюулгүй байдлын холбогдолтой системийн үйл явцуудыг аудит хийх боломжгүй, X11 дээр үндэслэгдсэн дэлгэцийн менежерүүд болон гуравдагч дэмонууд зэрэг зарим нэвтрэх механизмууд хэрэглэгчийн нэвтрэх сессийг аудит хийх тохиргоог буруу хийдэг зэрэг болно. Аюулгүй байдлын үйл явцыг аудит хийх хэрэгсэл нь системийн ажиллагааны маш дэлгэрэнгүй бичлэгүүдийг үүсгэх чадвартай: нарийвчилсан тохиргоо хийгдсэн завгүй системд мөр бичлэгийн файлын өгөгдөл тохиргооноос хамааран зарим тохиолдолд гигабайтаас ч илүү асар их болох боломжтой. Администраторууд их хэмжээний аудит хийх тохиргоотой холбоотой дискний хэмжээний шаардлагыг тооцох ёстой. Жишээ нь, аудит бичиж байгаа файлын систем дүүрэх нөхцөлд өөр бусад файлын системүүдэд хамааралгүйгээр файлын системийг [.filename]#/var/audit# модонд зориулах нь магадгүй зохимжтой байж болох юм. ==== [[audit-inline-glossary]] == Энэ бүлгийн түлхүүр ухагдахуунууд Энэ бүлгийг уншихаас өмнө аудиттай холбоотой цөөн түлхүүр ухагдахуунуудыг тайлбарлах шаардлагатай: * _үйл явц_: Аудит хийх боломжтой үйл явц гэдэг нь аудит дэд системийн тусламжтайгаар хянаж бүртгэх боломжтой дурын үйл явцыг хэлнэ. Аюулгүй байдалтай холбоотой үйл явцуудын жишээнүүдэд файлын үүсгэлт, сүлжээний холболтыг босгох, эсвэл хэрэглэгчийн нэвтрэлтийг дурдаж болно. Үйл явцууд нь нэг бол жинхэнэ хэрэглэгч хүртэл мөрдөн гаргаж болох ""шинж чанарлаг"", эсвэл тэгж болохооргүй ""шинж чанарлаг бус "" байна. ""Шинж чанарлаг бус"" үйл явцуудын жишээнүүд гэвэл нууц үгийн буруу оролдлогууд гэх мэт нэвтрэн орох процессийн жинхэнэ эсэхийг шалгахаас өмнөх үеийн дурын үйл явцуудыг хэлж болно. * _ангилал_: Үйл явцын ангиллууд гэдэг нь холбоотой үйл явцууд бүхий хэсэг бүлгүүдийн нэр бөгөөд эдгээр нь сонголтын илэрхийллүүдэд хэрэглэгддэг. Энгийн ашиглагддаг үйл явцуудын ангиллуудад ""файл үүсгэлт"" (fc), ""ажиллуулах"" (ex) мөн ""нэвтрэх_гарах"" (lo) зэрэг орно. * _бичлэг_: Бичлэг гэдэг нь аюулгүй байдлын үйл явцыг тайлбарласан аудитийн хянан бүртгэсэн оруулга юм. Бичлэгүүд нь үйл явцын төрлийн бичлэг, субьектийн (хэрэглэгч) үйлдэл хийж байгаа тухай мэдээлэл, огноо болон цагийн мэдээлэл, дурын нэмэлт өгөгдлүүд болон обьектуудын мэдээлэл, амжилт эсвэл уналтын нөхцөлүүдийг агуулдаг. * _мөр_: Аудитийн мөр буюу хянан бүртгэлийн файл нь аюулгүй байдлын үйл явцуудыг тайлбарласан аудит бичлэгүүдийн сериэс тогтоно. Ерөнхийдөө мөрүүд нь үйл явцуудын биелж дууссан цагийн дагуу он цагийн дарааллаар байрладаг. Зөвхөн жинхэнэ процессууд аудитийн мөрд бичлэг нэмэх эрхтэй байдаг. * _сонголтын илэрхийлэл_: Сонголтын илэрхийлэл нь угтваруудын жагсаалт болон үйл явцтай тохирох аудитийн үйл явцын ангиллын нэрсээс тогтох мөр юм. * _урьдчилсан сонголт_: Энэ нь администраторын сонирхох боломж бүхий үйл явцууд, сонирхлыг татахгүй байгаа үйл явц зэргийг тайлбарласан аудитийн бичлэгүүдийг үүсгэхээс зайлсхийх зорилготойгоор ялгасан системийн процесс юм. Урьдчилсан тохиргоо нь аль хэрэглэгчийн хувьд үйл явцуудын аль ангиллуудыг таних болон жинхэнэ болон жинхэнэ биш процессуудад хамаарах глобал тохиргоонуудын сонголтын илэрхийллүүдийн серийг ашигладаг. * _хураангуйлалт_: Энэ нь байгаа аудитийн мөрнүүдээс аль бичлэгүүдийг хадгалалт, хэвлэлт болон анализ хийхээр сонгосон процесс юм. Үүний нэгэн адил аудит мөрөөс хэрэггүй аудит бичлэгүүдийг устгах процесс бас хамаарна. Хураангуйлалтыг ашиглаад администраторууд аудит өгөгдлийн хадгалалтын бодлогуудыг боловсруулах боломжтой юм. Жишээ нь, дэлгэрэнгүй аудитийн мөрнүүд нэг сарын хугацаанд хадгалагдаад дараагаар нь тэдгээр мөрнүүдийг архивын зорилгоор зөвхөн нэвтрэлтийн мэдээллийг үлдээн багасгаж болох юм. [[audit-install]] == Аудит хийх дэмжлэг суулгах нь Үйл явцыг Аудит хийх хэрэглэгчийн талбарын дэмжлэг үндсэн FreeBSD үйлдлийн системд орсон байгаа. Үйл явцыг Аудит хийх дэмжлэг анхдагчаар эмхэтгэгдэн орсон боловч яг энэ боломжийг дэмжихийн тулд дараах мөрийг цөмд оруулан хөрвүүлсэн байх шаардлагатай: [.programlisting] .... options AUDIT .... crossref:kernelconfig[kernelconfig,FreeBSD цөмийг тохируулах нь] -д тайлбарласан ердийн процессийн дагуу цөмийг дахин хөрвүүлж суулгана. Аудит идэвхжсэн цөм бүтээгдэж суулгагдаад систем дахин ачаалсны дараа дараах мөрийг man:rc.conf[5] -д нэмж аудит дэмонг идэвхжүүлнэ: [.programlisting] .... auditd_enable=""YES"" .... Тэгээд системийг дахин ачаалах замаар эсвэл гараар аудит дэмонг ажиллуулах замаар аудит дэмжлэгийг эхлүүлэх ёстой: [.programlisting] .... service auditd start .... [[audit-config]] == Аудитийн тохиргоо Аюулгүй байдлын аудитийн тохиргооны бүх файлуудыг [.filename]#/etc/security# дотроос олж болно. Дараах файлууд аудит дэмон эхлэхээс өмнө байх ёстой: * [.filename]#audit_class# - Аудитийн ангиллуудын тодорхойлолтуудыг агуулна. * [.filename]#audit_control# - Анхдагч аудитийн ангиллууд, аудитийн хянан бүртгэлтийн эзлэхүүнд үлдээх хамгийн бага дискний зай, хамгийн их аудитийн мөрийн хэмжээ гэх зэрэг аудит дэд системийн шинж чанарыг хянана. * [.filename]#audit_event# - Системийн аудит үйл явцуудын тайлбарууд, нэрс болон үйл явц болгон аль ангилалд хамаарах жагсаалт. * [.filename]#audit_user# - Нэвтрэн орох үеийн глобал анхдагчуудаас бүрдсэн зөвхөн хэрэглэгчид хамааралтай аудитийн шаардлагууд * [.filename]#audit_warn# - Аудитийн бичлэгүүдийн зай хангалтгүй болох эсвэл аудитийн мөрийн файл дахин эргэсэн зэрэг зайлшгүй шаардлагатай тохиолдолд анхааруулах мэдээллүүдийг үүсгэдэг өөрчлөх боломж бүхий auditd-ийн ашигладаг бүрхүүлийн скрипт. [WARNING] ==== Тохиргоон дахь алдаанууд үйл явцуудын буруу хянан бүртгэлд хүргэж болзошгүй тул аудитийн тохиргооны файлуудыг засварлах болон ажиллагааг хангахдаа заавал болгоомжтой байх шаардлагатай. ==== === Үйл явц сонголтын илэрхийллүүд Сонголтын илэрхийллүүд нь аль үйл явцуудыг аудит хийх ёстойг тодорхойлох аудитийн тохиргооны хэд хэдэн газар ашиглагддаг. Илэрхийллүүд нь тохирох үйл явцын ангиллуудын жагсаалтаас бүрдэх ба эдгээр тус бүр нь тохирох бичлэгүүдийг хүлээн авах ёстой юу эсвэл орхих ёстой юу гэдгийг харуулсан угтвартайгаас гадна оруулга нь амжилттай эсвэл амжилтгүй үйлдлүүдтэй тохирох ёстойг харуулах боломж бас байна. Сонголтын илэрхийллүүд нь зүүнээс баруун тийш биелэгддэг бөгөөд хоёр илэрхийллийг нэг дээр нь нөгөөг нь нэмж нийлүүлдэг. Дараах жагсаалт нь [.filename]#audit_class#-д байгаа анхдагч үйл явцын ангиллуудаас тогтоно: * `all` - _all_ - Бүх үйл явцын ангиллуудыг тааруулах(match). * `ad` - _administrative_ - Удирдлагын үйлдлүүд систем дээр бүхэлдээ гүйцэтгэгдэнэ. * `ap` - _application_ - Програмын тодорхойлсон үйлдэл. * `cl` - _file close_ - `close` системийн дуудлагыг аудит хийх. * `ex` - _exec_ - Програмын ажиллагааг аудит хийх. Тушаалын мөрийн нэмэлт өгөгдлүүд болон орчны хувьсагчуудыг `argv` ба `envv` параметрүүдийг ашиглан `policy` тохиргоонд тохиргоо хийн man:audit_control[5] -ийн тусламжтайгаар хянадаг. * `fa` - _file attribute access_ - man:stat[1], man:pathconf[2] болон бусад адил үйл явцуудын обьектийн шинж чанаруудад хандсан хандалтыг аудит хийх. * `fc` - _file create_ - Үр дүнд нь файл үүсдэг үйл явцуудыг аудит хийх. * `fd` - _file delete_ - Файлыг устгадаг үйл явцуудыг аудит хийх. * `fm` - _file attribute modify_ - man:chown[8], man:chflags[1], man:flock[2] зэрэг файлын шинж чанарын өөрчлөлт гарч байгаа үйл явцуудыг аудит хийх. * `fr` - _file read_ - Өгөгдөл уншигдаж байгаа, мөн файлуудыг уншихаар нээсэн зэрэг үйл явцуудыг аудит хийх. * `fw` - _file write_ - Өгөгдөл бичигдэж байгаа, мөн файлд бичсэн эсвэл файл өөрчлөгдсөн зэрэг үйл явцуудыг аудит хийх. * `io` - _ioctl_ - man:ioctl[2] системийн дуудлагын хэрэглээг аудит хийх. * `ip` - _ipc_ - POSIX хоолойнууд болон System V IPC үйлдлүүд зэрэг Процесс-Хоорондох Холбооны төрөл бүрийн хэлбэрүүдийг аудит хийх. * `lo` - _login_logout_ - Систем дээр болж байгаа man:login[1] ба man:logout[1] үйл явцуудыг аудит хийх. * `na` - _non attributable_ - Шинж чанаргүй үйл явцуудыг аудит хийх. * `no` - _invalid class_ - Аудит бус үйл явцуудыг тааруулах(match). * `nt` - _network_ - man:connect[2] ба man:accept[2] зэрэг сүлжээний үйлдлүүдтэй холбоотой үйл явцуудыг аудит хийх. * `ot` - _other_ - Бусад үйл явцуудыг аудит хийх. * `pc` - _process_ - man:exec[3] ба man:exit[3] зэрэг процессийн үйлдлүүдийг аудит хийх. Эдгээр аудит үйл явцын ангиллуудыг [.filename]#audit_class# болон [.filename]#audit_event# тохиргооны файлуудыг өөрчилснөөр өөрчилж болно. Жагсаалтад байгаа аудитийн ангилал бүр амжилттай/амжилтгүй үйлдлүүдийг таарсан эсэхийг болон ангилал ба төрлийн хувьд таарч байгааг нэмж байгаа эсвэл устгаж байгааг харуулсан угтвартай байна. * (none) Үйл явцын амжилттай болон амжилтгүйг аудит хийх. * `+` Энэ ангилал дахь амжилттай үйл явцуудыг аудит хийх. * `-` Энэ ангилал дахь амжилтгүй үйл явцуудыг аудит хийх. * `^` Энэ ангилал дахь амжилттай, амжилтгүй аль нь ч биш үйл явцуудыг аудит хийх. * `^+` Энэ ангилал дахь амжилттай үйл явцуудыг аудит хийхгүй. * `^-` Энэ ангилал дахь амжилтгүй үйл явцуудыг аудит хийхгүй. Дараах сонголтын мөр амжилттай ба амжилтгүй нэвтрэлт/гаралтын үйл явцуудаас гадна зөвхөн амжилттай ажиллуулсныг сонгож байна: [.programlisting] .... lo,+ex .... === Тохиргооны файлууд Аудит системийг тохируулахдаа ихэнх тохиолдолд администраторууд зөвхөн хоёр файлыг өөрчлөх хэрэгтэй: [.filename]#audit_control# болон [.filename]#audit_user#. Эхнийх нь системийн дагуух аудит өмчүүд болон бодлогуудыг хянадаг; хоёр дахь нь хэрэглэгчийн аудитийг нарийн тохируулахад ашиглагддаг. [[audit-auditcontrol]] ==== [.filename]#audit_control# файл [.filename]#audit_control# файл нь аудит дэд системийн хувьд анхдагч утгуудын тоог тодорхойлно. Энэ файлын дотор бид дараах зүйлсийг харна: [.programlisting] .... dir:/var/audit flags:lo minfree:20 naflags:lo policy:cnt filesz:0 .... `dir` тохиргоо нь аудит бүртгэлүүдийг хадгалах нэг болон хэд хэдэн санг заахад хэрэглэгдэнэ. Хэрэв нэгээс их сан байгаа бол бичигдсэн дарааллаараа ашиглагдана. Файлын систем дүүрсэн тохиолдолд аудит дэд систем болон бусад дэд системүүд бие биедээ нөлөөлж болзошгүй учир аудит бүртгэлүүдийг тусгайлан зориулсан файлын систем дээр хадгалахаар аудит системийг ихэвчлэн тохируулдаг. `flags` талбар нь системийн дагуух шинж чанар бүхий үйл явцуудад зориулсан анхдагч урьдчилан сонголтын багийг тодорхойлдог. Дээрх жишээн дээр бүх хэрэглэгчийн хувьд амжилттай болон амжилтгүй нэвтрэлт болон гаралтын үйл явцууд аудит хийгдэж байна. `minfree` тохиргоо нь аудит мөр хадгалагдах файлын системийн хувьд хамгийн бага чөлөөт зайны хувийг тодорхойлдог. Энэ тогтоосон хэмжээнээс илүү гарахад анхааруулга үүсгэгддэг. Дээрх жишээ хамгийн бага чөлөөт зайг 20 хувиар тогтоожээ. `naflags` тохиргоо нь нэвтрэн оролтын процесс болон системийн дэмонууд зэрэг шинж чанаргүй үйл явцуудыг аудит хийх аудитийн ангиллуудыг тодорхойлдог. `policy` тохиргоо нь таслалаар тусгаарлагдсан, аудитийн зан авирын төрөл бүрийн шинж чанарыг хянах бодлогын тугуудын жагсаалтыг тодорхойлдог. Анхдагч `cnt` туг нь аудит амжилтгүй болсон ч гэсэн систем ажиллагаагаа үргэлжлүүлэхийг заадаг (энэ туг зайлшгүй шаардлагатай). Өөр нэг байнга ашиглагддаг туг бол `argv` бөгөөд энэ нь man:execve[2] системийн дуудлагад орж байгаа тушаалын мөрийн нэмэлт өгөгдлүүдийг тушаалын ажиллагааг аудит хийхийн хэсэг болох боломж олгодог. `filesz` тохиргоо нь мөрийн файл автоматаар төгсөх болон эргэхээс өмнөх аудит мөрийн файлын хамгийн их хэмжээг байтаар тодорхойлдог. Анхдагч утга нь 0 байх ба автоматаар эргүүлэхийг хориглосон байна. Хэрэв хүссэн файлын хэмжээ тэгээс ялгаатай ба 512k -аас бага бол түүнийг орхиж бүртгэлийн мэдээлэл үүсгэнэ. [[audit-audituser]] ==== [.filename]#audit_user# файл [.filename]#audit_user# файл нь зарим нэг хэрэглэгчдэд зориулсан аудитийн шаардлагуудыг администраторууд тодорхойлохыг зөвшөөрдөг. Мөр болгон хэрэглэгчид зориулсан аудитийг хийхийг хоёр талбараар тохируулдаг: нэг дэх нь хэрэглэгчийн хувьд үргэлж аудит хийх шаардлагатай нэг хэсэг үйл явцуудыг тодорхойлдог `alwaysaudit` талбар ба хоёр дахь нь `neveraudit` талбар бөгөөд хэрэглэгчийн хувьд хэзээ ч аудит хийх шаардлагагүй нэг хэсэг үйл явцуудыг тодорхойлдог. Дараах жишээн дээр [.filename]#audit_user# файл нь нэвтрэлт/гаралтын үйл явцууд, `root` хэрэглэгчийн амжилттай тушаалын ажиллагаа, файл үүсгэлт ба `www` хэрэглэгчийн амжилттай тушаалын ажиллагааг аудит хийж байна. Хэрэв дээрх жишээ [.filename]#audit_control# файлтай цуг ашиглагдвал `root`-ийн `lo` оруулга нь давхардах бөгөөд `www` хэрэглэгчийн нэвтрэлт/гаралтын үйл явцууд бас аудит хийгдэнэ. [.programlisting] .... root:lo,+ex:no www:fc,+ex:no .... [[audit-administration]] == Аудит дэд системийг удирдах нь === Аудит мөрүүдийг харах нь Аудит мөрүүд нь BSM хоёртын хэлбэрээр хадгалагддаг бөгөөд өөрчлөх болон текст уруу хөрвүүлэхэд тусгай хэрэгслүүд ашиглах шаардлагатай. man:praudit[1] тушаал нь мөрийн файлуудыг хялбар текст хэлбэрт хөрвүүлдэг; man:auditreduce[1] тушаал нь аудит мөрийн файлыг шинжлэх, архивлах эсвэл хэвлэх зорилгоор багасгахад ашиглагддаг. `auditreduce` нь үйл явцын төрөл, үйл явцын ангилал, үйл явцын хэрэглэгч, огноо эсвэл цаг, файлын зам эсвэл обьектийн үйлдэл үзүүлсэн зэрэг төрөл бүрийн сонголтын параметрүүдийг дэмждэг. Жишээ нь `praudit` хэрэгсэл нь заасан аудит бүртгэлийн бүх агуулгыг жирийн текстээр харуулна: [source,shell] .... # praudit /var/audit/AUDITFILE .... [.filename]#AUDITFILE# нь харуулах аудит бүртгэл юм. Аудит мөрүүд нь токенуудаас бүтэх аудит бичлэгүүдийн цувралаас тогтох бөгөөд `praudit` нь мөр болгонд нэгийг дараалуулан хэвлэнэ. Токен бүр аудит бичлэгийн толгойг агуулсан `header` эсвэл нэрийн хайлтаас гарсан файлын замыг агуулсан `path` зэрэг тусгай төрлийн байна. Дараах жишээ нь `execve` үйл явцыг харуулж байна: [.programlisting] .... header,133,10,execve(2),0,Mon Sep 25 15:58:03 2006, + 384 msec exec arg,finger,doug path,/usr/bin/finger attribute,555,root,wheel,90,24918,104944 subject,robert,root,wheel,root,wheel,38439,38032,42086,128.232.9.100 return,success,0 trailer,133 .... Энэхүү аудит нь амжилттай `execve` дуудлагыг илэрхийлж байгаа бөгөөд түүнд `finger doug` тушаал ажиллажээ. Нэмэлт өгөгдлийн токен нь цөм уруу бүрхүүлээс гарч боловсруулагдсан тушаалын мөрийг агуулна. `path` буюу замын токен нь цөмийн хайсан ажиллах файлын замыг агуулна. `attribute` буюу шинж чанарын токен нь хоёртын файлыг тайлбарлах ба тухайлбал програм setuid эсэхийг тодорхойлоход ашиглагдах файлын горимыг агуулна. `subject` буюу субьект токен нь субьект процессийг тайлбарлах бөгөөд аудит хэрэглэгчийн ID, идэвхитэй хэрэглэгчийн ID ба бүлгийн ID, жинхэнэ хэрэглэгчийн ID ба бүлгийн ID, процессийн ID, сессийн ID, портын ID болон нэвтрэлтийн хаяг гэсэн дарааллаар хадгална. Аудит хэрэглэгчийн ID ба жинхэнэ хэрэглэгчийн ID нь ялгаатайг анхаарах хэрэгтэй: `robert` гэдэг хэрэглэгч энэ тушаалыг ажиллуулахаасаа өмнө `root` бүртгэл уруу шилжсэн бөгөөд энэ нь эхний шалгуулсан хэрэглэгчийг ашиглан аудит хийгдсэн байна. Төгсгөлд нь `return` буюу буцах токен нь амжилттай ажиллагааг харуулж `trailer` нь бичлэгийг төгсгөнө. `praudit` нь бас XML гаралтын хэлбэрийг дэмждэг бөгөөд үүнийг `-x` нэмэлт өгөгдлийг ашиглан сонгож болдог. === Аудитийн мөрүүдийг багасгах нь Аудит бүртгэлүүд нь маш их байж болно, администратор зарим хэрэглэгчтэй холбоотой бичлэгүүд зэрэг хэсэг бичлэгүүдийг ашиглахын тулд шилж сонгохыг магадгүй хүснэ: [source,shell] .... # auditreduce -u trhodes /var/audit/AUDITFILE | praudit .... Энэ нь [.filename]#AUDITFILE# файлд хадгалагдсан `trhodes` хэрэглэгчийн бүх аудитийн бичлэгүүдийг сонгож байна. === Аудит хянах эрхүүдийг томилох нь `audit` бүлгийн гишүүд [.filename]#/var/audit# дахь аудит мөрүүдийг унших эрхтэй; анхандаа энэ бүлэг нь хоосон байх бөгөөд тэгэхээр зөвхөн `root` хэрэглэгч аудит мөрүүдийг уншиж чадна. Аудит хянах эрхүүдийг хэрэглэгчдэд томилохын тулд хэрэглэгчдийг `audit` бүлэгт нэмж болно. Аудитийн бүртгэлийн агуулгыг хянах чадвар нь хэрэглэгчид болон процессуудын үйл хөдлөлийн дотоод уруу нэлээн гүнзгий ханддаг учир аудит хянах эрхүүдийг томилохдоо болгоомжтой хийхийг зөвлөж байна. === Аудит хоолойнуудыг шууд монитор хийх нь Аудит хоолойнууд нь төхөөрөмжийн файлын систем дахь клон хийгдсэн псевдо төхөөрөмжүүд бөгөөд програмыг шууд явж байгаа аудит бичлэгийн урсгалд холбох боломж олгоно. Энэ нь голчлон халдлага илрүүлэх болон систем монитор хийх програмуудын зохиогчдын сонирхлыг татдаг. Гэхдээ администраторуудын хувьд аудитийн хоолойны төхөөрөмж нь аудитийн мөрийн файлын эзэмшил эсвэл үйл явцын урсгалыг зогсоох, бүртгэл эргүүлэх зэрэг асуудлуудтай холбогдолгүйгээр шууд монитор хийх эвтэйхэн боломжийг бүрдүүлдэг. Шууд явж байгаа аудитийн үйл явцын урсгалыг хянахдаа дараах тушаалын мөрийг ашиглана: [source,shell] .... # praudit /dev/auditpipe .... Анхандаа аудитийн хоолойны төхөөрөмжийн цэгүүдэд зөвхөн `root` хэрэглэгч хандах эрхтэй байдаг. `audit` бүлгийн хэрэглэгчид хандах боломжтой болгохын тулд `devfs` дүрмийг [.filename]#devfs.rules# -д нэмнэ: [.programlisting] .... add path 'auditpipe*' mode 0440 group audit .... devfs файлын системийг тохируулах талаар дэлгэрэнгүй мэдээллийг man:devfs.rules[5] -ээс харна уу. [WARNING] ==== Аудитийн үйл явцын буцааж өгөх давталтуудыг үүсгэх нь хялбар бөгөөд аудит үйл явц бүрийн үзэлт нь олон аудитийн үйл явцуудыг үүсгэхэд хүргэнэ. Жишээ нь, хэрэв сүлжээний бүх I/O аудит хийгдсэн бөгөөд man:praudit[1] нь SSH сессээс ажилласан бол үйл явц бүр хэвлэгдэхэд өөр үйл явцыг бас үүсгэх учраас үргэлжилсэн аудитийн үйл явцууд их хэмжээгээр үүсэх болно. Энэ асуудлыг бий болгохгүйн тулд нарийн тохируулаагүй I/O аудит хийх сессээс `praudit`-ийг аудитийн хоолойны төхөөрөмж дээр ажиллуулахыг зөвлөж байна. ==== === Аудит мөрийн файлуудыг эргүүлэх нь Аудит мөрүүд нь зөвхөн цөмөөр бичигдэх бөгөөд auditd аудит дэмоноор удирдагддаг. Администраторууд аудит бүртгэлүүдийг шууд эргүүлэхдээ man:newsyslog.conf[5] эсвэл бусад хэрэгслүүдийг ашиглан хийх ёсгүй юм. Харин `audit` удирдах хэрэгслийг ашиглан аудитийг унтраах, аудит системийг дахин тохируулах, болон бүртгэлийг эргүүлэх үйлдлүүдийг хийх боломжтой байдаг. Дараах тушаал аудит дэмонг шинэ аудит бүртгэл үүсгэж цөмийг шинэ бүртгэл уруу шилжихийг дохино. Хуучин бүртгэл нь төгсөж нэр нь өөрчлөгдөх бөгөөд дараагаар түүнтэй администратор ажиллах боломж бүрдэнэ. [source,shell] .... # audit -n .... [WARNING] ==== Хэрэв auditd дэмон ажиллахгүй байгаа бол энэ тушаал нь амжилтгүй болох бөгөөд алдааны мэдээлэл үүсгэнэ. ==== Дараах мөрийг [.filename]#/etc/crontab# -д нэмснээр man:cron[8] -оос арван хоёр цаг тутам эргүүлэх болно: [.programlisting] .... 0 */12 * * * root /usr/sbin/audit -n .... Шинэ [.filename]#/etc/crontab# -ийг хадгалсны дараа өөрчлөлт үйлчилж эхлэх болно. Файлын хэмжээн дээр тулгуурласан аудитийн мөрийн файлыг автоматаар эргүүлэх нь man:audit_control[5] дахь `filesz` тохиргоогоор хийгдэх боломжтой бөгөөд гарын авлагын энэ бүлгийн тохиргооны файлуудын хэсэгт тайлбарласан болно. === Аудит мөрүүдийг шахах нь Аудит мөрийн файлууд асар их болох тусам мөрүүдийг аудит дэмоноор хаалгасны дараа шахах эсвэл архивлах нь зүйтэй юм. [.filename]#audit_warn# скрипт нь аудитийн мөрүүдийг эргүүлэх үеийн цэвэр төгсгөл зэрэг төрөл бүрийн аудиттай холбоотой үйл явцуудад зориулан өөрчилсөн үйлдлүүдийг гүйцэтгэхэд ашиглагдана. Жишээ нь хаагдах үед аудит мөрүүдийг шахах дараах кодыг [.filename]#audit_warn# скриптэд нэмж болно: [.programlisting] .... # # Compress audit trail files on close. # if [ ""$1"" = closefile ]; then gzip -9 $2 fi .... Бусад архивлах идэвхүүдэд мөрийн файлуудыг төв сервер уруу хуулах, хуучин мөрийн файлуудыг устгах эсвэл хэрэггүй бичлэгүүдийг хасч аудит мөрийг багасгах зэрэг орж болно. Аудит мөрийн файлууд цэвэрхэн дууссан тохиолдолд скрипт ажиллана, тэгэхээр буруу унтраасны дараа дуусаагүй мөрүүд дээр ажиллахгүй. ",12439,True,2674.574359152609,median "[[flowableApps]] == Flowable applications Flowable provides several ui web applications to demonstrate and leverage the functionality provided by the Flowable project: * Flowable IDM: an Identity Management application that provides single sign-on authentication functionality for all the Flowable UI applications, and, for users with the IDM administrative privilege, it also provides functionality to manage users, groups and privileges. * Flowable Modeler: an application that allows users with modeler privileges to model processes, forms, decision tables and application definitions. * Flowable Task: a runtime task application that provides functionality to start process instances, edit task forms, complete tasks and query on tasks and process instances. * Flowable Admin: an administrative application that allows users with admin privilege to query the BPMN, DMN, form and content engines and provides several options to change process instances, tasks, jobs and so on. The admin application connects to the engines through the REST API that is deployed together with the Flowable Task app and the Flowable REST app. The Flowable IDM is required for all other apps to enable authentication. The WAR files for each app can be deployed to the same servlet container (such as Apache Tomcat), but can also be deployed on different servlet containers. Because the same cookie is used for authentication with each app, the apps need to run on the same domain. Flowable also provides the `flowable-rest.war` which contains the Flowable REST API. More about this can be read in the <> chapter. The apps are Spring Boot 2.0 based, which means that that the WAR files are actually executable and can be run as a normal standalone applications. See https://docs.spring.io/spring-boot/docs/current/reference/html/build-tool-plugins-maven-plugin.html#build-tool-plugins-maven-packaging[The Executable Jar Format] in the Spring Boot reference documentation. [[uiAppInstallation]] === Flowable UI Applications installation As mentioned before, all four UI apps can be deployed together on the same Tomcat server, and to get started this is probably the easiest approach. You can choose to only install the Modeler app, for example, but make sure the Flowable IDM app is always running/deployed as well. For this installation guide we'll describe the installation of all four apps to a Tomcat server. 1. Download a recent stable version of link:$$http://tomcat.apache.org$$[Apache Tomcat]. 2. Download the latest stable link:$$http://www.flowable.org/downloads.html$$[Flowable 6 version]. 3. Copy the flowable-admin.war, flowable-idm.war, flowable-modeler.war and flowable-task.war files from the Flowable distribution __wars__ folder to the Tomcat webapps folder. 4. Startup the Tomcat server by running the bin/startup.sh (Mac OS and Linux) or bin/startup.bat (Windows) script. 5. Open a web browser and go to link:$$http://localhost:8080/flowable-modeler$$[http://localhost:8080/flowable-modeler]. All Flowable UI apps should now be running with an H2 in-memory database and the following login screen should be shown in your web browser: image::images/flowable_idm_login_screen.png[align=""center""] By default, the Flowable IDM application will create an admin user that has privileges to all the Flowable UI apps. You can login with admin/test and the browser should redirect to the Flowable Modeler application: image::images/flowable_modeler_startup_screen.png[align=""center""] Since the UI apps are Spring Boot executable apps it is possible to run them as standalone applications without the need of an application server. Starting single application looks like: ``` java -jar flowable-idm.war ``` Usually, you will want to change the default H2 in-memory database configuration to a MySQL or Postgres (or other persistent database) configuration. You can do this per app by changing the application.properties file in the _WEB-INF/classes/_ directory of each app. However, it is easier to use the Spring Boot https://docs.spring.io/spring-boot/docs/current/reference/html/boot-features-external-config.html[Externalized Configuration]. An example configuration can be found on link:$$https://github.com/flowable/flowable-engine/blob/master/modules/flowable-ui-task/flowable-ui-task-app/src/main/resources/flowable-default.properties$$[Github] To change the default configuration to MySQL the following changes are needed to the properties file: [source,linenums] ---- spring.datasource.driver-class-name=com.mysql.jdbc.Driver spring.datasource.url=jdbc:mysql://127.0.0.1:3306/flowable?characterEncoding=UTF-8 spring.datasource.username=flowable spring.datasource.password=flowable ---- This configuration will expect a flowable database to be present in the MySQL server and the UI apps will automatically generate the necessary database tables. For Postgres the following changes are necessary: [source,linenums] ---- spring.datasource.driver-class-name=org.postgresql.Driver spring.datasource.url=jdbc:postgresql://localhost:5432/flowable spring.datasource.username=flowable spring.datasource.password=flowable ---- In addition to changing the configuration, make sure the database driver is available on the classpath. Again, you could do this for every web application separately by adding the driver JAR file to the WEB-INF/lib folder, but you can also copy the JAR file once to the Tomcat lib folder. For MySQL and Postgres the database drivers can be downloaded from: * MySQL: link:$$https://dev.mysql.com/downloads/connector/j$$[https://dev.mysql.com/downloads/connector/j] * Postgres: link:$$https://jdbc.postgresql.org/$$[https://jdbc.postgresql.org/] When running the apps as standalone applications the database driver can be added by using the `loader.path` property. ``` java -Dloader.path=/location/to/your/driverfolder -jar flowable-idm.war ``` See the https://docs.spring.io/spring-boot/docs/current/reference/html/executable-jar.html#executable-jar-property-launcher-features[`PropertiesLauncher` Features] in the Spring Boot reference documentation for more information. === Flowable UI Applications Configurations As the Flowable UI apps are Spring Boot applications you can use all the properties Spring Boot provides. In order to provide custom configuration for the apps have a look at the https://docs.spring.io/spring-boot/docs/current/reference/html/boot-features-external-config.html[Externalized Configuration] section of the Spring Boot documentation. [TIP] ----- You can also use YAML based properties. ----- .Common UI App Properties [cols=""4*"",options=""header""] |=============== |Property name |Old Property |Default value |Description |flowable.common.app.idm-url |idm.app.url |- |The URL to the IDM application, used for the user info and token info REST GET calls. It's also used as a fallback for the redirect url to the login page in the UI apps. |flowable.common.app.idm-redirect-url |idm.app.redirect.url |- |The redirect URL to the IDM application, used for the login redirect when the cookie isn't set or is invalid. |flowable.common.app.redirect-on-auth-success |app.redirect.url.on.authsuccess |- |The URL to which the redirect should occur after a successful authentication. |flowable.common.app.role-prefix |- |ROLE_ |The default role prefix that needs to be used by Spring Security. |flowable.common.app.tenant-id |- |- |The static tenant id used for the DefaultTenantProvider. The modeler app uses this to determine under which tenant id to store and publish models. When not provided, empty or only contains whitespace it defaults to the user's tenant id if available otherwise it uses no tenant id. |flowable.common.app.cache-login-tokens.max-age |cache.login-tokens.max.age |30 |The max age in seconds after which the entry should be invalidated. |flowable.common.app.cache-login-tokens.max-size |cache.login-tokens.max.size |2048 |The maximum number of entries that the cache should contain. |flowable.common.app.cache-login-users.max-age |cache.login-users.max.age |30 |The max age in seconds after which the entry should be invalidated. |flowable.common.app.cache-login-users.max-size |cache.login-users.max.size |2048 |The maximum number of entries that the cache should contain. |flowable.common.app.cache-users.max-age |cache.users.max.age |30 |The max age in seconds after which the entry should be invalidated. |flowable.common.app.cache-users.max-size |cache.users.max.size |2048 |The maximum number of entries that the cache should contain. |flowable.common.app.idm-admin.password |idm.admin.password |- |The password used for executing the REST calls (with basic auth) to the IDM REST services. Default is test. |flowable.common.app.idm-admin.user |idm.admin.user |admin |The username used for executing the REST calls (with basic auth) to the IDM REST services. Default is admin |flowable.rest.app.authentication-mode |rest.authentication.mode |verify-privilege |Configures the way user credentials are verified when doing a REST API call: 'any-user' : the user needs to exist and the password need to match. Any user is allowed to do the call (this is the pre 6.3.0 behavior) 'verify-privilege' : the user needs to exist, the password needs to match and the user needs to have the 'rest-api' privilege If nothing set, defaults to 'verify-privilege' |=============== Some of the old properties have been moved to be managed by the Flowable Spring Boot starter (or Spring Boot itself) .Old properties managed by the Flowable Spring Boot Starter [cols=""4*"",options=""header""] |=============== |Property name |Old Property |Default value |Description |flowable.async-executor-activate |engine.process.asyncexecutor.activate |true |Whether the async executor should be activated. |flowable.database-schema-update |engine.process.schema.update |true |The strategy that should be used for the database schema. |flowable.history-level |engine.process.history.level |- |The history level that needs to be used. |flowable.process.servlet.name |flowable.rest-api-servlet-name |Flowable BPMN Rest API |The name of the Process servlet. |flowable.process.servlet.path |flowable.rest-api-mapping |/process-api |The context path for the Process rest servlet. |flowable.content.storage.create-root |contentstorage.fs.create-root |true |If the root folder doesn't exist, should it be created? |flowable.content.storage.root-folder |contentstorage.fs.root-folder |- |Root folder location where content files will be stored, for example, task attachments or form file uploads. |flowable.idm.enabled |flowable.db-identity-used |true |Whether the idm engine needs to be started. |flowable.idm.password-encoder |security.passwordencoder |- |The type of the password encoder that needs to be used. |flowable.idm.ldap.base-dn |ldap.basedn |- |The base 'distinguished name' (DN) from which the searches for users and groups are started. Use 'user-base-dn' or 'group-base-dn' when needing to differentiate between user and group base DN. |flowable.idm.ldap.enabled |ldap.enabled |false |Whether to enable LDAP IDM Service. |flowable.idm.ldap.password |ldap.password |- |The password that is used to connect to the LDAP system. |flowable.idm.ldap.port |ldap.port |-1 |The port on which the LDAP system is running. |flowable.idm.ldap.server |ldap.server |- |The server host on which the LDAP system can be reached. For example 'ldap://localhost'. |flowable.idm.ldap.user |ldap.user |- |The user id that is used to connect to the LDAP system. |flowable.idm.ldap.attribute.email |ldap.attribute.email |- |Name of the attribute that matches the user email. This property is used when looking for an 'org.flowable.idm.api.User' object and the mapping between the LDAP object and the Flowable 'org.flowable.idm.api.User' object is done. |flowable.idm.ldap.attribute.first-name |ldap.attribute.firstname |- |Name of the attribute that matches the user first name. This property is used when looking for a 'org.flowable.idm.api.User' object and the mapping between the LDAP object and the Flowable 'org.flowable.idm.api.User' object is done. |flowable.idm.ldap.attribute.group-id |ldap.attribute.groupid |- |Name of the attribute that matches the group id. This property is used when looking for a 'org.flowable.idm.api.Group' object and the mapping between the LDAP object and the Flowable 'org.flowable.idm.api.Group' object is done. |flowable.idm.ldap.attribute.group-name |ldap.attribute.groupname |- |Name of the attribute that matches the group name. This property is used when looking for a 'org.flowable.idm.api.Group' object and the mapping between the LDAP object and the Flowable 'org.flowable.idm.api.Group' object is done. |flowable.idm.ldap.attribute.last-name |ldap.attribute.lastname |- |Name of the attribute that matches the user last name. This property is used when looking for a 'org.flowable.idm.api.User' object and the mapping between the LDAP object and the Flowable 'org.flowable.idm.api.User' object is done. |flowable.idm.ldap.attribute.user-id |ldap.attribute.userid |- |Name of the attribute that matches the user id. This property is used when looking for a 'org.flowable.idm.api.User' object and the mapping between the LDAP object and the Flowable 'org.flowable.idm.api.User' object is done. This property is optional and is only needed if searching for 'org.flowable.idm.api.User' objects using the Flowable API. |flowable.idm.ldap.cache.group-size |ldap.cache.groupsize |-1 |Allows to set the size of the 'org.flowable.ldap.LDAPGroupCache'. This is an LRU cache that caches groups for users and thus avoids hitting the LDAP system each time the groups of a user needs to be known. The cache will not be instantiated if the value is less then zero. By default set to -1, so no caching is done. Note that the group cache is instantiated on the 'org.flowable.ldap.LDAPIdentityServiceImpl'. As such, if you have a custom implementation of the 'org.flowable.ldap.LDAPIdentityServiceImpl', do not forget to add the group cache functionality. |flowable.idm.ldap.query.all-groups |ldap.query.groupall |- |The query that is executed when searching for all groups. |flowable.idm.ldap.query.all-users |ldap.query.userall |- |The query that is executed when searching for all users. |flowable.idm.ldap.query.groups-for-user |ldap.query.groupsforuser |- |The query that is executed when searching for the groups of a specific user. For example: `(&(objectClass=groupOfUniqueNames)(uniqueMember={0}))` Here, all the objects in LDAP with the class 'groupOfUniqueNames' and where the provided DN is a 'uniqueMember' are returned. As shown in the example, the user id is injected by the typical {@link java.text.MessageFormat}, ie by using _{0}_ If setting the query alone is insufficient for your specific LDAP setup, you can alternatively plug in a different `org.flowable.ldap.LDAPQueryBuilder`, which allows for more customization than only the query. |flowable.idm.ldap.query.user-by-full-name-like |ldap.query.userbyname |- |The query that is executed when searching for a user by full name. For example: `(&(objectClass=inetOrgPerson)(\\|({0}=**{1}**)({2}={3})))` Here, all the objects in LDAP with the class 'inetOrgPerson' and who have the matching first name or last name will be returned Several things will be injected in the expression: {0} : the first name attribute {1} : the search text {2} : the last name attribute {3} : the search text If setting the query alone is insufficient for your specific LDAP setup, you can alternatively plug in a different 'org.flowable.ldap.LDAPQueryBuilder', which allows for more customization than only the query. |flowable.idm.ldap.query.user-by-id |ldap.query.userbyid |- |The query that is executed when searching for a user by userId. For example: `(&(objectClass=inetOrgPerson)(uid={0}))` Here, all the objects in LDAP with the class 'inetOrgPerson' and who have the matching 'uid' attribute value will be returned. As shown in the example, the user id is injected by the typical {@link java.text.MessageFormat}, ie by using _{0}_ If setting the query alone is insufficient for your specific LDAP setup, you can alternatively plug in a different 'org.flowable.ldap.LDAPQueryBuilder', which allows for more customization than only the query. |flowable.mail.server.host |email.host |localhost |The host of the mail server. |flowable.mail.server.password |email.password |- |The password for the mail server authentication. |flowable.mail.server.port |email.port |1025 |The port of the mail server. |flowable.mail.server.use-ssl |email.use-ssl |false |Sets whether SSL/TLS encryption should be enabled for the SMTP transport upon connection (SMTPS/POPS). |flowable.mail.server.use-tls |email.use-tls |false |Set or disable the STARTTLS encryption. |flowable.mail.server.username |email.username |- |The username that needs to be used for the mail server authentication. If empty no authentication would be used. |flowable.process.definition-cache-limit |flowable.process-definitions.cache.max |-1 |The maximum amount of process definitions available in the process definition cache. Per default it is -1 (all process definitions). |=============== .Old properties managed by Spring Boot [cols=""4*"",options=""header""] |=============== |Property name |Old Property |Default value |Description |spring.datasource.driver-class-name |datasource.driver |- |Fully qualified name of the JDBC driver. Auto-detected based on the URL by default. |spring.datasource.jndi-name |datasource.jndi.name |- |JNDI location of the datasource. Class, url, username & password are ignored when set. |spring.datasource.password |datasource.password |- |Login password of the database. |spring.datasource.url |datasource.url |- |JDBC URL of the database. |spring.datasource.username |datasource.username |- |Login username of the database. |spring.datasource.hikari.connection-test-query |datasource.preferred-test-query |- |The SQL query to be executed to test the validity of connections. |spring.datasource.hikari.connection-timeout |datasource.connection.timeout |- |The maximum number of milliseconds that a client will wait for a connection from the pool. If this time is exceeded without a connection becoming available, a SQLException will be thrown when getting a connection. |spring.datasource.hikari.idle-timeout |datasource.connection.idletimeout |- |The maximum amount of time (in milliseconds) that a connection is allowed to sit idle in the pool. Whether a connection is retired as idle or not is subject to a maximum variation of +30 seconds, and average variation of +15 seconds. A connection will never be retired as idle before this timeout. A value of 0 means that idle connections are never removed from the pool. |spring.datasource.hikari.max-lifetime |datasource.connection.maxlifetime |- |This property controls the maximum lifetime of a connection in the pool. When a connection reaches this timeout, even if recently used, it will be retired from the pool. An in-use connection will never be retired, only when it is idle will it be removed. |spring.datasource.hikari.maximum-pool-size |datasource.connection.maxpoolsize |- |The property controls the maximum size that the pool is allowed to reach, including both idle and in-use connections. Basically this value will determine the maximum number of actual connections to the database backend. When the pool reaches this size, and no idle connections are available, calls to getConnection() will block for up to connectionTimeout milliseconds before timing out. |spring.datasource.hikari.minimum-idle |datasource.connection.minidle |- |The property controls the minimum number of idle connections that HikariCP tries to maintain in the pool, including both idle and in-use connections. If the idle connections dip below this value, HikariCP will make a best effort to restore them quickly and efficiently. |spring.servlet.multipart.max-file-size |file.upload.max.size |10MB |Max file size. Values can use the suffixes ""MB"" or ""KB"" to indicate megabytes or kilobytes, respectively. |=============== .Not used old properties [cols=""2*"",options=""header""] |=============== |Old property |Description |datasource.jndi.resource-ref |Spring Boot does not support configuring JNDI resourceRef. Use entire resource reference in the name. |email.use-credentials |In case you don't want to use credentials, set the password and user to empty. |=============== [[flowableIDMApp]] === Flowable IDM application The Flowable IDM application is used by all other three Flowable web applications for authentication and authorization and is therefore required to be available when you want to run the Modeler, Task or Admin application. The Flowable IDM application is a simple identity management application and is targeted at providing single sign-on capabilities to the Flowable web applications, including providing a central place to define users, groups and privileges. The IDM application boots the IDM engine at startup and will create the identity tables as defined in the IDM engine in the datasource defined in the properties configuration. When the Flowable IDM application is deployed and started, it will check if there's a user available in the ACT_ID_USER table, and if not it will use the `flowable.common.app.idm-admin.user` property to create a new default admin user in this table. It will also add all available privileges in the Flowable project to the newly created admin user: * access-idm: provides the privilege to manage users, groups and privileges * access-admin: allows the user to login to the Flowable Admin application, manage the Flowable engines and access the Actuator endpoints of all the applications * access-modeler: enables access to the Flowable Modeler application * access-task: provides the privilege to login to the Flowable Task application * access-rest-api: allows the user to do call the REST API. Otherwise a 403 (forbidden) http status will be returned. Note that _flowable.rest.app.authentication-mode_ nees to be set to _verify-privilege_, which is the default. When logging in to link:$$http://localhost:8080/flowable-idm$$[http://localhost:8080/flowable-idm] with admin/test for the first time the following user overview screen is shown: image::images/flowable_idm_startup_screen.png[align=""center""] In this screen users can be added, removed and updated. The groups section can be used to create, delete and update groups. In the group details view you can also add and remove users to and from the group. The privilege screen allows you to add and remove privileges from users and groups: image::images/flowable_idm_privilege_screen.png[align=""center""] There's no option to define new privileges yet, but you can add and remove users and groups for the existing four privileges. This are the IDM UI App specific properties. .IDM UI App Properties [cols=""4*"",options=""header""] |=============== |Property name |Old Property |Default value |Description |flowable.idm.app.bootstrap |idm.bootstrap.enabled |true |Whether the IDM App needs to be bootstrapped. |flowable.idm.app.rest-enabled |rest.idm-app.enabled |true |Enables the REST API (this is not the REST api used by the UI, but an api that's available over basic auth authentication). |flowable.idm.app.admin.email |admin.email |- |The email of the admin user. |flowable.idm.app.admin.first-name |admin.firstname |- |The first name of the admin user. |flowable.idm.app.admin.last-name |admin.lastname |- |The last name of the admin user. |flowable.idm.app.admin.password |admin.password |- |The password for the admin user. |flowable.idm.app.admin.user-id |admin.userid |- |The id of the admin user. |flowable.idm.app.security.remember-me-key |security.rememberme.key |testKey |The hash key that is used by Spring Security to hash the password values in the applications. Make sure that you change the value of this property. |flowable.idm.app.security.user-validity-period |cache.users.recheck.period |30000 |How long should a user be cached before invalidating it in the cache for the cacheable CustomUserDetailsService. |flowable.idm.app.security.cookie.domain |security.cookie.domain |- |The domain for the cookie. |flowable.idm.app.security.cookie.max-age |security.cookie.max-age |2678400 |The max age of the security cookie in seconds. Default is 31 days. |flowable.idm.app.security.cookie.refresh-age |security.cookie.refresh-age |86400 |The refresh age of the cookie in seconds. Default is 1 day. |=============== In addition to the default identity tables, the IDM application can also be configured to use an LDAP server. To connect to a LDAP server, additional properties in the application.properties file (or any other way of configuring the application) are needed: [source,linenums] ---- # # LDAP # flowable.idm.ldap.enabled=true flowable.idm.ldap.server=ldap://localhost flowable.idm.ldap.port=10389 flowable.idm.ldap.user=uid=admin, ou=system flowable.idm.ldap.password=secret flowable.idm.ldap.base-dn=o=flowable flowable.idm.ldap.query.user-by-id=(&(objectClass=inetOrgPerson)(uid={0})) flowable.idm.ldap.query.user-by-full-name-like=(&(objectClass=inetOrgPerson)(|({0}=*{1}*)({2}=*{3}*))) flowable.idm.ldap.query.all-users=(objectClass=inetOrgPerson) flowable.idm.ldap.query.groups-for-user=(&(objectClass=groupOfUniqueNames)(uniqueMember={0})) flowable.idm.ldap.query.all-groups=(objectClass=groupOfUniqueNames) flowable.idm.ldap.query.group-by-id=(&(objectClass=groupOfUniqueNames)(uniqueId={0})) flowable.idm.ldap.attribute.user-id=uid flowable.idm.ldap.attribute.first-name=cn flowable.idm.ldap.attribute.last-name=sn flowable.idm.ldap.attribute.group-id=cn flowable.idm.ldap.attribute.group-name=cn flowable.idm.ldap.cache.group-size=10000 flowable.idm.ldap.cache.group-expiration=180000 ---- When the `flowable.idm.ldap.enabled` property is set to true, the IDM app will expect the other LDAP properties to have been filled-in. In this example configuration the server configuration + LDAP queries for the Apache Directory Server are provided. For other LDAP servers, like Active Directory, other configuration values are needed. When LDAP is configured, authentication and group retrieval for a user will be done through the LDAP server. Only privileges will still be retrieved from the Flowable identity tables. So make sure each LDAP user has the correct privileges defined in the IDM application. If the IDM application is booted with LDAP configuration the bootstrap logic will check if there are already privileges present in the Flowable identity tables. If there are no privileges (only when booting the first time), the 4 default privileges will be created and the `flowable.idm.app.admin.user-id` property value (from application.properties or configured in the environment) will be used as the user id to get all 4 privileges. So make sure that the `flowable.idm.app.admin.user-id` property value is set to a valid LDAP user, otherwise nobody will be able to login to any of the Flowable UI apps. [[flowableModelerApp]] === Flowable Modeler application The Flowable Modeler application can be used to model BPMN processes, DMN decision table, Form definitions and create app definitions. The BPMN modeler uses the same Oryx and Angular foundation as in Flowable 5, but the functionality has now been moved into a separate Modeler application. When using the Flowable Modeler application, make sure the Flowable IDM application is deployed and running as well (for authentication and authorization purposes). When you login to the Modeler application (link:$$http://localhost:8080/flowable-modeler$$[http://localhost:8080/flowable-modeler]) with your user (or the default admin/test user), you will see the process overview screen. From here you can start creating new BPMN process models by clicking on the Create Process or Import Process button. image::images/flowable_modeler_createmodel_popup.png[align=""center"", width=""600""] When creating a process model (but also any other model), it's important to think carefully about the model key value. The model key is a unique identifier for the model across the full model repository. If you choose a model key that already exists in the model repository, an error message is shown and the model is not saved. After creating the model with the popup, the BPMN modeling canvas is shown. The BPMN editor is very similar to the Flowable 5 BPMN editor that was part of the Explorer application. All BPMN elements supported by the Flowable engine are available to be used in the design of a process model. image::images/flowable_modeler_design_screen.png[align=""center""] The BPMN editor is divided into 4 parts: * Palette: the palette of BPMN elements available to design a process model * Toolbar: actions to change the model canvas, such as zooming, layout and saving a model * Model canvas: the modeling canvas on which to drag and drop BPMN elements and design the process model * Properties panel: the properties for the main process model if no element is select and otherwise the properties of the selected BPMN element For a User task element there's a _Referenced form_ property in the properties panel. If you select this property, a popup is opened where you can select a form definition from the repository or create a new form. When creating a new form, a similar create dialog to the process model create dialog is presented. After filling in the name and form model key, the form editor is opened. image::images/flowable_modeler_formdesign_screen.png[align=""center""] Form fields can be dragged from the form palette on to the form canvas. In this example, a name textfield, two date fields and a remarks multiline textfield are added to the form canvas. When editing a form field, the label, id, required status and placeholder can be filled in. image::images/flowable_modeler_editfield_popup.png[align=""center"", width=""600""] The id field is an important value, because a process variable will be created with the form field value using the id property value. When filling in the label property, the id property is automatically filled. If needed, you can also provide the id property value yourself by checking the override id checkbox. After saving the form model and closing the form editor, you are automatically navigated back to the process model (when the form editor was opened via the BPMN editor). When selecting the User task element again and clicking on the _Referenced form_ property you will see that the newly created form definition is now attached to the User task. When clicking on the _Form_ tab in the header of the Modeler application, all form definitions available in the model repository are shown. image::images/flowable_modeler_formoverview_screen.png[align=""center""] You can preview every form definition by opening the details view of a form definition. In the details view, the form name, key and description can be edited and the history of form models is available. You can also duplicate the form definition to create a new form definition with the same form fields. Now let's open the vacation request process model in the BPMN editor again and add a Script task to the process model, that will calculate the number of days between the vacation start and end dates. Click on the _Script format_ property and fill in a value of _groovy_ to instruct the Flowable engine to use the Groovy scripting engine. Now click on the _Script_ property and fill in the script that calculates the number of days. image::images/flowable_modeler_script_popup.png[align=""center"", width=""600""] Now we have a _amountOfVacationDays_ process variable we can add a Decision task to the process model. A decision task can be used to execute a DMN decision table in the Flowable DMN engine. Through the _Decision table reference_ property, a new decision table model can be created and the DMN editor is opened. image::images/flowable_modeler_dmneditor_screen.png[align=""center""] The DMN editor provides a table editor with input columns, where input conditions can be defined with the process variables available in the process context, and output columns, where output variable values can be defined. In this very simple example there's one input column using the _amountOfVacationDays_ variable that checks if it's less than 10 or higher or equal to 10. When the amount of days is less than 10, an output variable _managerApprovalNeeded_ is returned with value false, and otherwise a value of true is returned. You can define multiple input columns and have multiple input conditions per rule. It's also possible to leave an input column empty, which means that it's evaluated to true for that part of the rule. You can define one or multiple output variables. Another important part of the DMN decision table definition is the hit policy. Currently, Flowable supports the First and Any hit policy. With the First hit policy, when the first rule is found that evaluates to true the DMN execution will stop and its output variables are returned. For the Any hit policy, all rules will be executed and the output variables for the last rule that evaluates to true are returned. When the DMN editor is saved and closed, the Modeler application navigates back to the BPMN editor and the newly created DMN decision table is now attached to the Decision task. The decision task will be generated in the BPMN XML like; [source,xml,linenums] ---- ---- With the _managerApprovalNeeded_ variable available in the process instance context, we can now create an exclusive gateway with a sequence flow condition that evaluates the calculated value of the DMN Engine. image::images/flowable_modeler_sequenceflowcondition_popup.png[align=""center"", width=""500""] The full BPMN process model now looks like this: image::images/flowable_modeler_vacationrequest_screen.png[align=""center""] With the process model completed, we can now create an app definition that combines one or more process models with all their associated models (for example, decision tables and form definitions) into a single artifact. An app definition can be exported as a BAR file (zip format) that can be deployed on the Flowable engine. When creating a vacation request app definition, the app editor will look something like the screen below. image::images/flowable_modeler_appeditor_screen.png[align=""center""] In the app editor, an icon and a theme color can be selected that will be used in the Flowable Task application to show the application in the dashboard. The important step is to add the vacation request process model, and by selecting the process model, automatically include any form definitions and DMN decision tables. image::images/flowable_modeler_modelselection_popup.png[align=""center""] A process model can be selected by clicking on the model thumbnail. When one or more models are selected, you can close the popup, save the app definition and close it. When navigating to the details view of the newly created vacation request app definition, the following details screen is shown: image::images/flowable_modeler_appdetails_screen.png[align=""center""] From this view, you can download the app definition in two different formats. The first download button (with the arrow pointing downwards) can be used to download the app definition with the JSON model files for each included model. This makes it easy to share app definitions between different Flowable Modeler applications. The second download button (with the arrow point to upper right) will provide a BAR file of the app definition models, which can be deployed on the Flowable engine. In the BAR file, only the deployable artifacts are included, such as the BPMN 2.0 XML file and the DMN XML file, and not the JSON model files. All files in a BAR file deployed on a Flowable engine are stored in the database, so therefore only the deployable files are included. From the app definition details view, you can also _Publish_ the app definition directly to the Flowable engine. The Flowable Modeler uses the URL defined in the application.properties file with the _flowable.modeler.app.deployment-api-url_ property key. By default, the deployment URL is configured so the app definition will be deployed on the Flowable Task application when it's running. However, this can be changed to use the Flowable REST application, for example. Make sure the Flowable Task application is running and click on the _Publish_ button. The app definition is now deployed as a BAR file to the Flowable Task application. This are the Modeler UI App specific properties. .Modeler UI App Properties [cols=""4*"",options=""header""] |=============== |Property name |Old Property |Default value |Description |flowable.modeler.app.data-source-prefix |datasource.prefix |- |The prefix for the database tables. |flowable.modeler.app.deployment-api-url |deployment.api.url |http://localhost:8080/flowable-task/app-api |The root URI to the REST services of the Flowable engine, used by the Flowable Modeler application to deploy the application definition BAR file to the engine. Default url for the Flowable Task application is http://localhost:8080/flowable-task/app-api |flowable.modeler.app.rest-enabled |rest.modeler-app.enabled |true |Enables the REST API (this is not the REST api used by the UI, but an api that's available over basic auth authentication). |=============== [[flowableTaskApp]] === Flowable Task application The Flowable Task application is the runtime application of the Flowable project and includes the Flowable BPMN, DMN, Form and Content engines by default. With the Flowable Task application, new process instances can be started, tasks can be completed, task forms can be rendered and so on. In the previous section, the vacation request app definition was deployed on the Flowable Task application REST API, and through that deployed on the Flowable engine. If you look in the Flowable database, you can see a new deployment entry has been added to the ACT_RE_DEPLOYMENT table for the BPMN Engine. Also, new entries haven been created in the ACT_DMN_DEPLOYMENT and ACT_FO_FORM_DEPLOYMENT tables for the DMN and Form engines. On the dashboard on link:$$http://localhost:8080/flowable-task$$[http://localhost:8080/flowable-task], you can see a vacation request app in addition to the default Task app, and any other apps that have been deployed to the Flowable engine already. image::images/flowable_task_dashboard_screen.png[align=""center""] When clicking on the vacation request app, the task list for the logged-in user is shown (which is probably empty for now). image::images/flowable_task_tasklist_screen.png[align=""center""] When clicking on the _Processes_ tab you can choose to start a new process instance by clicking on the _Start a process_ button. The list of available process definitions within the context of this app definition is now displayed. In the general Task app this works in a similar way, but in the Task app, all process definitions deployed on the Flowable engine are shown. After selecting the vacation request process definition, the _Start process_ button can be clicked to start a new vacation request process instance. The Flowable Task application automatically navigates to the process instance details view. You can see the _Provide vacation information_ task is active and, for example, comments can be added and the process instance state can be shown diagrammatically using the _Show diagram_ button. image::images/flowable_task_processdetails_screen.png[align=""center""] When navigating to the task list, you can also see the _Provide vacation information_ task listed there as well. The task details are shown in this view, with the vacation info form being rendered. You can also switch to the details view by clicking on the _Show details_ button. In the details view, comments can be added, users can involved in the task and attachments can be added to the task. You can also change the due date and the assignee of a task. image::images/flowable_task_taskdetails_screen.png[align=""center""] Let's fill in the form and complete the task. First, select a start date and end date that have more than 10 days in between, so we can validate that a _Manager approval_ task is being generated. After filling in the vacation info form and clicking the _Complete_ button, the Flowable task app navigates directly to the _Manager approval_ task view. When you also complete this task (without a task form), the process instance is completed. When navigating to the _Processes_ tab and clicking on the _Showing running processes_ section, you can select an option to show completed process instances. The list of completed process instances is now shown and when clicking on the just completed vacation request process you can see the two completed tasks. image::images/flowable_task_processhistory_screen.png[align=""center""] The completed form of each task is stored in the ACT_FO_FORM_INSTANCE table of the Flowable Form engine. So it's possible to look at the values of each completed form when you navigate to the completed task. image::images/flowable_task_completedform_screen.png[align=""center""] Make sure to switch back to showing running processes instead of the completed ones, otherwise you won't see newly started process instances. You can also filter tasks in the task list view. There are options to search on the name of a task, the task state, only tasks for a specific process definition and change the assignment filter. image::images/flowable_task_taskfilter_screen.png[align=""center"", width=""400""] By default, the assignment filter is set to _Tasks where I am involved_. This doesn't show the tasks where you are a candidate, such as tasks that are available to a specific candidate group before they are assigned to a specific person. To show candidate tasks you can select the _Tasks where I am one of the candidates_ assignment filter option. This are the Task UI App specific properties. .Task UI App Properties [cols=""4*"",options=""header""] |=============== |Property name |Old Property |Default value |Description |flowable.experimental.debugger.enabled |debugger.enabled |false |Whether the process debugger should be enabled. |flowable.task.app.rest-enabled |rest.task-app.enabled |true |Enables the REST API (this is not the REST api used by the UI, but an api that's available over basic auth authentication). |flowable.form-field-validation-enabled | |false |Enable form field validation after form submission on the engine side. |=============== [[flowableAdminApp]] === Flowable Admin application The fourth UI application the Flowable project provides is the Flowable Admin application. This application provides ways to, for example, query deployments in the BPMN, DMN and Form Engines, but also shows the active state of a process instance with its active tasks and process variables. It also provides actions to assign a task to a different assignee and to complete an active task. The Flowable Admin application uses the REST API to communicate with the Flowable engines. By default, it is configured to connect to the Flowable Task REST API, but you can easily change this to use the Flowable REST app REST API instead. When going to link:$$http://localhost:8080/flowable-admin$$[http://localhost:8080/flowable-admin], the configuration screen is shown (which is also available by clicking on the arrow at the top right near the Flowable logo). image:images/flowable_admin_configuration_screen.png[align=""center""] For each engine, the REST endpoint can be configured with the basic authentication values. The configuration is done per engine, because it's possible to, for example, deploy the DMN Engine on a separate server from the BPMN Engine. When the configuration is defined with the correct values, the _Process Engine_ can be selected to administer the Flowable BPMN engine. By default, the deployments of the Flowable BPMN engine are shown. image::images/flowable_admin_deployments_screen.png[align=""center""] You can filter the deployments based on name and tenant identifier. In this view, it's also possible to deploy a new BPMN XML file or BAR file to the Flowable engine. When clicking on one of the deployments, the deployment details view is shown. image::images/flowable_admin_deploymentdetails_screen.png[align=""center""] More details of a deployment are shown here and also the process definitions that are part of this deployment on which you click to get more details. It's also possible to delete a deployment here. When you want to delete a deployed app definition, this is also the way to delete the app definition from the Flowable Task app dashboard. When clicking on one of the process definitions, the process definition details view is shown. image::images/flowable_admin_processdefinitiondetails_screen.png[align=""center""] In the process definition details view, the first page of process instances is shown, together with optional decision table definitions and form definitions that are used in the process definition. For the vacation request process definition, there's one connected decision table and one connected form definition. Clicking on the decision table definition navigates the Flowable Admin application to the DMN engine. You can always navigate back to the Process engine by clicking on the _Parent Deployment ID_ link. In addition to the deployments and definitions, you can also query on process instances, tasks, jobs and event subscriptions in the Process engine. The views all work in a similar way to what's already been described. This are the Admin UI App specific properties .Admin UI App Properties [cols=""4*"",options=""header""] |=============== |Property name |Old Property |Default value |Description |flowable.admin.app.data-source-prefix |datasource.prefix | |The prefix for the database tables. |flowable.admin.app.security.encryption.credentials-i-v-spec |security.encryption.credentials-i-v-spec |- |The string that needs to be used to create an IvParameterSpec object using it's the bytes. |flowable.admin.app.security.encryption.credentials-secret-spec |security.encryption.credentials-secret-spec |- |The string that needs to be used to create a SecretKeySpec using it's bytes. |flowable.admin.app.security.preemptive-basic-authentication | |false |Perform a preemptive basic authentication when issuing requests to the flowable REST API. **NB:** This is an experimental property and might be removed without notice. |=============== In addition to these properties, the Flowable admin application has a few more properties. The full content of the properties file can be viewed on {sc-flowable-ui-admin}/flowable-ui-admin-app/src/main/resources/application.properties[Github]. The additional properties are mainly used for defining the initial values for the REST endpoints for the different engines. The Admin application uses the initial values to make a connection to the Flowable engines, but the values can be overridden in the Admin application configuration view and these values are stored in the __ACT\\_ADM\\_SERVER\\_CONFIG__ table. An example of the BPMN Engine REST properties is shown below: [source,linenums] ---- flowable.admin.app.server-config.process.name=Flowable Process app flowable.admin.app.server-config.process.description=Flowable Process REST config flowable.admin.app.server-config.process.server-address=http://localhost flowable.admin.app.server-config.process.port=8080 flowable.admin.app.server-config.process.context-root=flowable-task flowable.admin.app.server-config.process.rest-root=process-api flowable.admin.app.server-config.process.user-name=admin flowable.admin.app.server-config.process.password=test ---- These values can be used when the Flowable Task app (with all the Flowable engines included) is managed by the Flowable Admin application. .Admin UI App Properties managed by Spring Boot [cols=""2*"",options=""header""] |=============== |Old property |Description |message.reloading.enabled |Using Spring Boot MessageSourceAutoConfiguration. Set the duration with `spring.messages.cache-duration`. |=============== === Internationalization The Flowable UI apps support internationalization (i18n). The project maintains the English translations. It is however possible to provide your own translation files in order to support other languages. The link:$$https://github.com/angular-translate/angular-translate[Angular Translate] library tries to load a specific translation file based on the browser's locale located in the _i18n_ folder (present in each UI module). When a matching translation file cannot be loaded the framework will fallback to the English translation. Mapping multiple browser locale keys to specific translations additional configuration can be provided (located in the Angular app config); [source,linenums] ---- // Initialize angular-translate $translateProvider.useStaticFilesLoader({ prefix: './i18n/', suffix: '.json' }) /* This can be used to map multiple browser language keys to a angular translate language key. */ // .registerAvailableLanguageKeys(['en'], { // 'en-*': 'en' // }) .useCookieStorage() .useSanitizeValueStrategy('sanitizeParameters') .uniformLanguageTag('bcp47') .determinePreferredLanguage(); ---- For example; your browser is configured for English (United States) and provides the language key _en-US_. Without the mapping Angular Translate will try to fetch the corresponding translation file _en-US.json_. (If this is not available it will fallback to 'en' and load the _en.json_ translation file) By uncommenting the _.registerAvailableLanguageKeys_ block you can map _en-US_ (and all other _en_ language keys) to the _en.json_ language file. === Production ready endpoints The https://docs.spring.io/spring-boot/docs/current/reference/html/production-ready-endpoints.html[Production ready endpoints] from Spring Boot are present for all applications. To have an overview of all the available Endpoints have a look at the https://docs.spring.io/spring-boot/docs/current/actuator-api/html/[Actuator Web API Documentation]. This properties are set per default: [source,linenums] ----- # Expose all actuator endpoints to the web # They are exposed, but only authenticated users can see /info and /health abd users with access-admin can see the others management.endpoints.web.exposure.include=* # Full health details should only be displayed when a user is authorized management.endpoint.health.show-details=when_authorized # Only users with role access-admin can access full health details management.endpoint.health.roles=access-admin ----- The security is configured in such way that the `info` and `health` endpoint are exposed to all authenticated users. Full details of the `health` endpoint can only be seen by users with the privilege `access-admin`. In case you want to change that you need to configure `management.endpoint.health.show-details`. All the rest of the endpoints are accessing only to users with the `access-admin` privilege. [[custom-bean-deployment]] === Custom bean deployment There are multiple ways of providing custom beans to the Flowable applications. [[custom-bean-deployment-spring-boot-auto]] ==== Using Spring Boot auto configuration The Flowable applications are Spring Boot 2 applications. Which means that normal Spring Boot auto configuration can be used to make the beans to Flowable. This can be done in the following manner ``` package com.your.own.package.configuration; @Configuration @AutoConfigureOrder(Ordered.LOWEST_PRECEDENCE) // Makes sure that this configuration will be processed last by Spring Boot @ConditionalOnBean(type = ""org.flowable.engine.ProcessEngine"") // The configuration will only be used when the ProcessEngine bean is present public class YourOwnConfiguration { @Configuration @ComponentScan (""com.your.own.package.beans"") public static class ComponentScanConfiguration { // This class is needed in order to conditionally perform the component scan (i.e. when the ProcessEngine bean is present) // It is an optional class, in case you don't need component scanning then you don't need to do this } @Bean public CustomBean customBean() { // create your bean } @Bean public EngineConfigurationConfigurer customProcessEngineConfigurationConfigurer() { return engineConfiguration -> { // You can use this to add extra configuration to the process engine } } } ``` Note that when using Spring Boot the configuration class can be under your own package and not under some Flowable package. In order to make this class an auto configuration class a file named `spring.factories` should be created in the `META-INF` folder of your jar. In this file you should add ``` org.springframework.boot.autoconfigure.EnableAutoConfiguration=\\ com.your.own.package.configuration.YourOwnCustomConfiguration ``` In order to use this approach you would need to include your jar in the `WEB-INF/lib` folder of the exploded war. Placing this jar in the lib folder of the servlet container (e.g. Tomcat) is not going to work due to the way Spring proxies the `@Configuration` classes. [[custom-bean-deployment-component-scan]] ==== Component scan Another way to provide custom Spring beans to the Flowable engine is to put them under a certain package and have the Flowable application component scan that package. Based on the used application this package is different: * `org.flowable.rest.app` for the `flowable-rest.war` * `org.flowable.ui.task.application` for the `flowable-task.war` The custom beans can be located in a single JAR and this jar should be present on the classpath when the applications are starting up. Depending where there JAR is placed, the lib folder of the servlet container (e.g. Tomcat) or the `WEB-INF/lib` folder of the exploded war, there are different possibilities. When using the lib folder of the servlet container then the created classes should be self contained, i.e. they should only use classes from within the jar. You can use any of the Spring `@Component` annotations (with the exception of `@Configuration`). The reason for not being able to use `@Configuration` classes is the fact that each configuration class is proxied by Spring with the help of the `ConfigurationClassPostProcessor`. However, the classloader loading the `@Configuration` class does not have access to the needed classes by Spring. When including the jar in the `WEB-INF/lib` folder of the exploded war then `@Configuration` classes and dependencies to other jars is possible. [[custom-bean-deployment-own-spring-boot]] ==== Creating your own Spring Boot application This approach is the most flexible and most powerful approach of all. In order to follow this approach have a look at the <> section of this documentation.",12254,False,2066.6261771612344,median "// Automatically generated by 'openshift-apidocs-gen'. Do not edit. :_content-type: ASSEMBLY [id=""job-batch-v1""] = Job [batch/v1] ifdef::product-title[] include::modules/common-attributes.adoc[] endif::[] toc::[] Description:: + -- Job represents the configuration of a single job. -- Type:: `object` == Specification [cols=""1,1,1"",options=""header""] |=== | Property | Type | Description | `apiVersion` | `string` | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources | `kind` | `string` | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | `metadata` | xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta[`ObjectMeta`] | Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata | `spec` | `object` | JobSpec describes how the job execution will look like. | `status` | `object` | JobStatus represents the current state of a Job. |=== === .spec Description:: + -- JobSpec describes how the job execution will look like. -- Type:: `object` Required:: - `template` [cols=""1,1,1"",options=""header""] |=== | Property | Type | Description | `activeDeadlineSeconds` | `integer` | Specifies the duration in seconds relative to the startTime that the job may be continuously active before the system tries to terminate it; value must be positive integer. If a Job is suspended (at creation or through an update), this timer will effectively be stopped and reset when the Job is resumed again. | `backoffLimit` | `integer` | Specifies the number of retries before marking this job failed. Defaults to 6 | `completionMode` | `string` | CompletionMode specifies how Pod completions are tracked. It can be `NonIndexed` (default) or `Indexed`. `NonIndexed` means that the Job is considered complete when there have been .spec.completions successfully completed Pods. Each Pod completion is homologous to each other. `Indexed` means that the Pods of a Job get an associated completion index from 0 to (.spec.completions - 1), available in the annotation batch.kubernetes.io/job-completion-index. The Job is considered complete when there is one successfully completed Pod for each index. When value is `Indexed`, .spec.completions must be specified and `.spec.parallelism` must be less than or equal to 10^5. In addition, The Pod name takes the form `$(job-name)-$(index)-$(random-string)`, the Pod hostname takes the form `$(job-name)-$(index)`. This field is beta-level. More completion modes can be added in the future. If the Job controller observes a mode that it doesn't recognize, the controller skips updates for the Job. | `completions` | `integer` | Specifies the desired number of successfully finished pods the job should be run with. Setting to nil means that the success of any pod signals the success of all pods, and allows parallelism to have any positive value. Setting to 1 means that parallelism is limited to 1 and the success of that pod signals the success of the job. More info: https://kubernetes.io/docs/concepts/workloads/controllers/jobs-run-to-completion/ | `manualSelector` | `boolean` | manualSelector controls generation of pod labels and pod selectors. Leave `manualSelector` unset unless you are certain what you are doing. When false or unset, the system pick labels unique to this job and appends those labels to the pod template. When true, the user is responsible for picking unique labels and specifying the selector. Failure to pick a unique label may cause this and other jobs to not function correctly. However, You may see `manualSelector=true` in jobs that were created with the old `extensions/v1beta1` API. More info: https://kubernetes.io/docs/concepts/workloads/controllers/jobs-run-to-completion/#specifying-your-own-pod-selector | `parallelism` | `integer` | Specifies the maximum desired number of pods the job should run at any given time. The actual number of pods running in steady state will be less than this number when ((.spec.completions - .status.successful) < .spec.parallelism), i.e. when the work left to do is less than max parallelism. More info: https://kubernetes.io/docs/concepts/workloads/controllers/jobs-run-to-completion/ | `selector` | xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.LabelSelector[`LabelSelector`] | A label query over pods that should match the pod count. Normally, the system sets this field for you. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#label-selectors | `suspend` | `boolean` | Suspend specifies whether the Job controller should create Pods or not. If a Job is created with suspend set to true, no Pods are created by the Job controller. If a Job is suspended after creation (i.e. the flag goes from false to true), the Job controller will delete all active Pods associated with this Job. Users must design their workload to gracefully handle this. Suspending a Job will reset the StartTime field of the Job, effectively resetting the ActiveDeadlineSeconds timer too. Defaults to false. This field is beta-level, gated by SuspendJob feature flag (enabled by default). | `template` | xref:../objects/index.adoc#io.k8s.api.core.v1.PodTemplateSpec[`PodTemplateSpec`] | Describes the pod that will be created when executing a job. More info: https://kubernetes.io/docs/concepts/workloads/controllers/jobs-run-to-completion/ | `ttlSecondsAfterFinished` | `integer` | ttlSecondsAfterFinished limits the lifetime of a Job that has finished execution (either Complete or Failed). If this field is set, ttlSecondsAfterFinished after the Job finishes, it is eligible to be automatically deleted. When the Job is being deleted, its lifecycle guarantees (e.g. finalizers) will be honored. If this field is unset, the Job won't be automatically deleted. If this field is set to zero, the Job becomes eligible to be deleted immediately after it finishes. This field is alpha-level and is only honored by servers that enable the TTLAfterFinished feature. |=== === .status Description:: + -- JobStatus represents the current state of a Job. -- Type:: `object` [cols=""1,1,1"",options=""header""] |=== | Property | Type | Description | `active` | `integer` | The number of actively running pods. | `completedIndexes` | `string` | CompletedIndexes holds the completed indexes when .spec.completionMode = ""Indexed"" in a text format. The indexes are represented as decimal integers separated by commas. The numbers are listed in increasing order. Three or more consecutive numbers are compressed and represented by the first and last element of the series, separated by a hyphen. For example, if the completed indexes are 1, 3, 4, 5 and 7, they are represented as ""1,3-5,7"". | `completionTime` | xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Time[`Time`] | Represents time when the job was completed. It is not guaranteed to be set in happens-before order across separate operations. It is represented in RFC3339 form and is in UTC. The completion time is only set when the job finishes successfully. | `conditions` | `array` | The latest available observations of an object's current state. When a Job fails, one of the conditions will have type ""Failed"" and status true. When a Job is suspended, one of the conditions will have type ""Suspended"" and status true; when the Job is resumed, the status of this condition will become false. When a Job is completed, one of the conditions will have type ""Complete"" and status true. More info: https://kubernetes.io/docs/concepts/workloads/controllers/jobs-run-to-completion/ | `conditions[]` | `object` | JobCondition describes current state of a job. | `failed` | `integer` | The number of pods which reached phase Failed. | `startTime` | xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Time[`Time`] | Represents time when the job controller started processing a job. When a Job is created in the suspended state, this field is not set until the first time it is resumed. This field is reset every time a Job is resumed from suspension. It is represented in RFC3339 form and is in UTC. | `succeeded` | `integer` | The number of pods which reached phase Succeeded. | `uncountedTerminatedPods` | `object` | UncountedTerminatedPods holds UIDs of Pods that have terminated but haven't been accounted in Job status counters. |=== === .status.conditions Description:: + -- The latest available observations of an object's current state. When a Job fails, one of the conditions will have type ""Failed"" and status true. When a Job is suspended, one of the conditions will have type ""Suspended"" and status true; when the Job is resumed, the status of this condition will become false. When a Job is completed, one of the conditions will have type ""Complete"" and status true. More info: https://kubernetes.io/docs/concepts/workloads/controllers/jobs-run-to-completion/ -- Type:: `array` === .status.conditions[] Description:: + -- JobCondition describes current state of a job. -- Type:: `object` Required:: - `type` - `status` [cols=""1,1,1"",options=""header""] |=== | Property | Type | Description | `lastProbeTime` | xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Time[`Time`] | Last time the condition was checked. | `lastTransitionTime` | xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Time[`Time`] | Last time the condition transit from one status to another. | `message` | `string` | Human readable message indicating details about last transition. | `reason` | `string` | (brief) reason for the condition's last transition. | `status` | `string` | Status of the condition, one of True, False, Unknown. | `type` | `string` | Type of job condition, Complete or Failed. |=== === .status.uncountedTerminatedPods Description:: + -- UncountedTerminatedPods holds UIDs of Pods that have terminated but haven't been accounted in Job status counters. -- Type:: `object` [cols=""1,1,1"",options=""header""] |=== | Property | Type | Description | `failed` | `array (string)` | Failed holds UIDs of failed Pods. | `succeeded` | `array (string)` | Succeeded holds UIDs of succeeded Pods. |=== == API endpoints The following API endpoints are available: * `/apis/batch/v1/jobs` - `GET`: list or watch objects of kind Job * `/apis/batch/v1/watch/jobs` - `GET`: watch individual changes to a list of Job. deprecated: use the 'watch' parameter with a list operation instead. * `/apis/batch/v1/namespaces/{namespace}/jobs` - `DELETE`: delete collection of Job - `GET`: list or watch objects of kind Job - `POST`: create a Job * `/apis/batch/v1/watch/namespaces/{namespace}/jobs` - `GET`: watch individual changes to a list of Job. deprecated: use the 'watch' parameter with a list operation instead. * `/apis/batch/v1/namespaces/{namespace}/jobs/{name}` - `DELETE`: delete a Job - `GET`: read the specified Job - `PATCH`: partially update the specified Job - `PUT`: replace the specified Job * `/apis/batch/v1/watch/namespaces/{namespace}/jobs/{name}` - `GET`: watch changes to an object of kind Job. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter. * `/apis/batch/v1/namespaces/{namespace}/jobs/{name}/status` - `GET`: read status of the specified Job - `PATCH`: partially update status of the specified Job - `PUT`: replace status of the specified Job === /apis/batch/v1/jobs .Global query parameters [cols=""1,1,2"",options=""header""] |=== | Parameter | Type | Description | `allowWatchBookmarks` | `boolean` | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | `continue` | `string` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | `fieldSelector` | `string` | A selector to restrict the list of returned objects by their fields. Defaults to everything. | `labelSelector` | `string` | A selector to restrict the list of returned objects by their labels. Defaults to everything. | `limit` | `integer` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | `pretty` | `string` | If 'true', then the output is pretty printed. | `resourceVersion` | `string` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | `resourceVersionMatch` | `string` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | `timeoutSeconds` | `integer` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | `watch` | `boolean` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |=== HTTP method:: `GET` Description:: list or watch objects of kind Job .HTTP responses [cols=""1,1"",options=""header""] |=== | HTTP code | Reponse body | 200 - OK | xref:../objects/index.adoc#io.k8s.api.batch.v1.JobList[`JobList`] schema | 401 - Unauthorized | Empty |=== === /apis/batch/v1/watch/jobs .Global query parameters [cols=""1,1,2"",options=""header""] |=== | Parameter | Type | Description | `allowWatchBookmarks` | `boolean` | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | `continue` | `string` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | `fieldSelector` | `string` | A selector to restrict the list of returned objects by their fields. Defaults to everything. | `labelSelector` | `string` | A selector to restrict the list of returned objects by their labels. Defaults to everything. | `limit` | `integer` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | `pretty` | `string` | If 'true', then the output is pretty printed. | `resourceVersion` | `string` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | `resourceVersionMatch` | `string` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | `timeoutSeconds` | `integer` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | `watch` | `boolean` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |=== HTTP method:: `GET` Description:: watch individual changes to a list of Job. deprecated: use the 'watch' parameter with a list operation instead. .HTTP responses [cols=""1,1"",options=""header""] |=== | HTTP code | Reponse body | 200 - OK | xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.WatchEvent[`WatchEvent`] schema | 401 - Unauthorized | Empty |=== === /apis/batch/v1/namespaces/{namespace}/jobs .Global path parameters [cols=""1,1,2"",options=""header""] |=== | Parameter | Type | Description | `namespace` | `string` | object name and auth scope, such as for teams and projects |=== .Global query parameters [cols=""1,1,2"",options=""header""] |=== | Parameter | Type | Description | `pretty` | `string` | If 'true', then the output is pretty printed. |=== HTTP method:: `DELETE` Description:: delete collection of Job .Query parameters [cols=""1,1,2"",options=""header""] |=== | Parameter | Type | Description | `continue` | `string` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | `dryRun` | `string` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | `fieldSelector` | `string` | A selector to restrict the list of returned objects by their fields. Defaults to everything. | `gracePeriodSeconds` | `integer` | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | `labelSelector` | `string` | A selector to restrict the list of returned objects by their labels. Defaults to everything. | `limit` | `integer` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | `orphanDependents` | `boolean` | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. | `propagationPolicy` | `string` | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground. | `resourceVersion` | `string` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | `resourceVersionMatch` | `string` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | `timeoutSeconds` | `integer` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |=== .Body parameters [cols=""1,1,2"",options=""header""] |=== | Parameter | Type | Description | `body` | xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.DeleteOptions[`DeleteOptions`] schema | |=== .HTTP responses [cols=""1,1"",options=""header""] |=== | HTTP code | Reponse body | 200 - OK | xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status[`Status`] schema | 401 - Unauthorized | Empty |=== HTTP method:: `GET` Description:: list or watch objects of kind Job .Query parameters [cols=""1,1,2"",options=""header""] |=== | Parameter | Type | Description | `allowWatchBookmarks` | `boolean` | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | `continue` | `string` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | `fieldSelector` | `string` | A selector to restrict the list of returned objects by their fields. Defaults to everything. | `labelSelector` | `string` | A selector to restrict the list of returned objects by their labels. Defaults to everything. | `limit` | `integer` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | `resourceVersion` | `string` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | `resourceVersionMatch` | `string` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | `timeoutSeconds` | `integer` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | `watch` | `boolean` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |=== .HTTP responses [cols=""1,1"",options=""header""] |=== | HTTP code | Reponse body | 200 - OK | xref:../objects/index.adoc#io.k8s.api.batch.v1.JobList[`JobList`] schema | 401 - Unauthorized | Empty |=== HTTP method:: `POST` Description:: create a Job .Query parameters [cols=""1,1,2"",options=""header""] |=== | Parameter | Type | Description | `dryRun` | `string` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | `fieldManager` | `string` | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. |=== .Body parameters [cols=""1,1,2"",options=""header""] |=== | Parameter | Type | Description | `body` | xref:../workloads_apis/job-batch-v1.adoc#job-batch-v1[`Job`] schema | |=== .HTTP responses [cols=""1,1"",options=""header""] |=== | HTTP code | Reponse body | 200 - OK | xref:../workloads_apis/job-batch-v1.adoc#job-batch-v1[`Job`] schema | 201 - Created | xref:../workloads_apis/job-batch-v1.adoc#job-batch-v1[`Job`] schema | 202 - Accepted | xref:../workloads_apis/job-batch-v1.adoc#job-batch-v1[`Job`] schema | 401 - Unauthorized | Empty |=== === /apis/batch/v1/watch/namespaces/{namespace}/jobs .Global path parameters [cols=""1,1,2"",options=""header""] |=== | Parameter | Type | Description | `namespace` | `string` | object name and auth scope, such as for teams and projects |=== .Global query parameters [cols=""1,1,2"",options=""header""] |=== | Parameter | Type | Description | `allowWatchBookmarks` | `boolean` | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | `continue` | `string` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | `fieldSelector` | `string` | A selector to restrict the list of returned objects by their fields. Defaults to everything. | `labelSelector` | `string` | A selector to restrict the list of returned objects by their labels. Defaults to everything. | `limit` | `integer` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | `pretty` | `string` | If 'true', then the output is pretty printed. | `resourceVersion` | `string` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | `resourceVersionMatch` | `string` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | `timeoutSeconds` | `integer` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | `watch` | `boolean` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |=== HTTP method:: `GET` Description:: watch individual changes to a list of Job. deprecated: use the 'watch' parameter with a list operation instead. .HTTP responses [cols=""1,1"",options=""header""] |=== | HTTP code | Reponse body | 200 - OK | xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.WatchEvent[`WatchEvent`] schema | 401 - Unauthorized | Empty |=== === /apis/batch/v1/namespaces/{namespace}/jobs/{name} .Global path parameters [cols=""1,1,2"",options=""header""] |=== | Parameter | Type | Description | `name` | `string` | name of the Job | `namespace` | `string` | object name and auth scope, such as for teams and projects |=== .Global query parameters [cols=""1,1,2"",options=""header""] |=== | Parameter | Type | Description | `pretty` | `string` | If 'true', then the output is pretty printed. |=== HTTP method:: `DELETE` Description:: delete a Job .Query parameters [cols=""1,1,2"",options=""header""] |=== | Parameter | Type | Description | `dryRun` | `string` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | `gracePeriodSeconds` | `integer` | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. | `orphanDependents` | `boolean` | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. | `propagationPolicy` | `string` | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground. |=== .Body parameters [cols=""1,1,2"",options=""header""] |=== | Parameter | Type | Description | `body` | xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.DeleteOptions[`DeleteOptions`] schema | |=== .HTTP responses [cols=""1,1"",options=""header""] |=== | HTTP code | Reponse body | 200 - OK | xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status[`Status`] schema | 202 - Accepted | xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status[`Status`] schema | 401 - Unauthorized | Empty |=== HTTP method:: `GET` Description:: read the specified Job .HTTP responses [cols=""1,1"",options=""header""] |=== | HTTP code | Reponse body | 200 - OK | xref:../workloads_apis/job-batch-v1.adoc#job-batch-v1[`Job`] schema | 401 - Unauthorized | Empty |=== HTTP method:: `PATCH` Description:: partially update the specified Job .Query parameters [cols=""1,1,2"",options=""header""] |=== | Parameter | Type | Description | `dryRun` | `string` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | `fieldManager` | `string` | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | `force` | `boolean` | Force is going to "force" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. |=== .Body parameters [cols=""1,1,2"",options=""header""] |=== | Parameter | Type | Description | `body` | xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Patch[`Patch`] schema | |=== .HTTP responses [cols=""1,1"",options=""header""] |=== | HTTP code | Reponse body | 200 - OK | xref:../workloads_apis/job-batch-v1.adoc#job-batch-v1[`Job`] schema | 201 - Created | xref:../workloads_apis/job-batch-v1.adoc#job-batch-v1[`Job`] schema | 401 - Unauthorized | Empty |=== HTTP method:: `PUT` Description:: replace the specified Job .Query parameters [cols=""1,1,2"",options=""header""] |=== | Parameter | Type | Description | `dryRun` | `string` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | `fieldManager` | `string` | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. |=== .Body parameters [cols=""1,1,2"",options=""header""] |=== | Parameter | Type | Description | `body` | xref:../workloads_apis/job-batch-v1.adoc#job-batch-v1[`Job`] schema | |=== .HTTP responses [cols=""1,1"",options=""header""] |=== | HTTP code | Reponse body | 200 - OK | xref:../workloads_apis/job-batch-v1.adoc#job-batch-v1[`Job`] schema | 201 - Created | xref:../workloads_apis/job-batch-v1.adoc#job-batch-v1[`Job`] schema | 401 - Unauthorized | Empty |=== === /apis/batch/v1/watch/namespaces/{namespace}/jobs/{name} .Global path parameters [cols=""1,1,2"",options=""header""] |=== | Parameter | Type | Description | `name` | `string` | name of the Job | `namespace` | `string` | object name and auth scope, such as for teams and projects |=== .Global query parameters [cols=""1,1,2"",options=""header""] |=== | Parameter | Type | Description | `allowWatchBookmarks` | `boolean` | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. | `continue` | `string` | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. | `fieldSelector` | `string` | A selector to restrict the list of returned objects by their fields. Defaults to everything. | `labelSelector` | `string` | A selector to restrict the list of returned objects by their labels. Defaults to everything. | `limit` | `integer` | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. | `pretty` | `string` | If 'true', then the output is pretty printed. | `resourceVersion` | `string` | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | `resourceVersionMatch` | `string` | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset | `timeoutSeconds` | `integer` | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. | `watch` | `boolean` | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |=== HTTP method:: `GET` Description:: watch changes to an object of kind Job. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter. .HTTP responses [cols=""1,1"",options=""header""] |=== | HTTP code | Reponse body | 200 - OK | xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.WatchEvent[`WatchEvent`] schema | 401 - Unauthorized | Empty |=== === /apis/batch/v1/namespaces/{namespace}/jobs/{name}/status .Global path parameters [cols=""1,1,2"",options=""header""] |=== | Parameter | Type | Description | `name` | `string` | name of the Job | `namespace` | `string` | object name and auth scope, such as for teams and projects |=== .Global query parameters [cols=""1,1,2"",options=""header""] |=== | Parameter | Type | Description | `pretty` | `string` | If 'true', then the output is pretty printed. |=== HTTP method:: `GET` Description:: read status of the specified Job .HTTP responses [cols=""1,1"",options=""header""] |=== | HTTP code | Reponse body | 200 - OK | xref:../workloads_apis/job-batch-v1.adoc#job-batch-v1[`Job`] schema | 401 - Unauthorized | Empty |=== HTTP method:: `PATCH` Description:: partially update status of the specified Job .Query parameters [cols=""1,1,2"",options=""header""] |=== | Parameter | Type | Description | `dryRun` | `string` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | `fieldManager` | `string` | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). | `force` | `boolean` | Force is going to "force" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. |=== .Body parameters [cols=""1,1,2"",options=""header""] |=== | Parameter | Type | Description | `body` | xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Patch[`Patch`] schema | |=== .HTTP responses [cols=""1,1"",options=""header""] |=== | HTTP code | Reponse body | 200 - OK | xref:../workloads_apis/job-batch-v1.adoc#job-batch-v1[`Job`] schema | 201 - Created | xref:../workloads_apis/job-batch-v1.adoc#job-batch-v1[`Job`] schema | 401 - Unauthorized | Empty |=== HTTP method:: `PUT` Description:: replace status of the specified Job .Query parameters [cols=""1,1,2"",options=""header""] |=== | Parameter | Type | Description | `dryRun` | `string` | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed | `fieldManager` | `string` | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. |=== .Body parameters [cols=""1,1,2"",options=""header""] |=== | Parameter | Type | Description | `body` | xref:../workloads_apis/job-batch-v1.adoc#job-batch-v1[`Job`] schema | |=== .HTTP responses [cols=""1,1"",options=""header""] |=== | HTTP code | Reponse body | 200 - OK | xref:../workloads_apis/job-batch-v1.adoc#job-batch-v1[`Job`] schema | 201 - Created | xref:../workloads_apis/job-batch-v1.adoc#job-batch-v1[`Job`] schema | 401 - Unauthorized | Empty |=== ",12430,True,2975.2382983442762,median "[[install-config-install-advanced-install]] = Advanced Installation {product-author} {product-version} :data-uri: :icons: :experimental: :toc: macro :toc-title: :prewrap!: toc::[] == Overview A reference configuration implemented using http://www.ansible.com[Ansible] playbooks is available as the _advanced installation_ method for installing a {product-title} cluster. Familiarity with Ansible is assumed, however you can use this configuration as a reference to create your own implementation using the configuration management tool of your choosing. [IMPORTANT] ==== While RHEL Atomic Host is supported for running containerized {product-title} services, the advanced installation method utilizes Ansible, which is not available in RHEL Atomic Host, and must therefore be run from ifdef::openshift-enterprise[] a RHEL 7 system. endif::[] ifdef::openshift-origin[] a supported version of Fedora, CentOS, or RHEL. endif::[] The host initiating the installation does not need to be intended for inclusion in the {product-title} cluster, but it can be. ==== ifdef::openshift-enterprise[] Alternatively, you can use the xref:quick_install.adoc#install-config-install-quick-install[quick installation] method if you prefer an interactive installation experience. endif::[] [NOTE] ==== To install {product-title} as a stand-alone registry, see xref:../../install_config/install/stand_alone_registry.adoc#install-config-installing-stand-alone-registry[Installing a Stand-alone Registry]. ==== [[advanced-before-you-begin]] == Before You Begin Before installing {product-title}, you must first see the xref:../../install_config/install/prerequisites.adoc#install-config-install-prerequisites[Prerequisites] topic to prepare your hosts, which includes verifying system and environment requirements per component type and properly installing and configuring Docker. It also includes installing Ansible version 2.2.0 or later, as the advanced installation method is based on Ansible playbooks and as such requires directly invoking Ansible. If you are interested in installing {product-title} using the containerized method (optional for RHEL but required for RHEL Atomic Host), see xref:../../install_config/install/rpm_vs_containerized.adoc#install-config-install-rpm-vs-containerized[Installing on Containerized Hosts] to ensure that you understand the differences between these methods, then return to this topic to continue. For large-scale installs, including suggestions for optimizing install time, see the xref:../../scaling_performance/install_practices.adoc#scaling-performance-install-best-practices[Scaling and Performance Guide]. After following the instructions in the xref:../../install_config/install/prerequisites.adoc#install-config-install-prerequisites[Prerequisites] topic and deciding between the RPM and containerized methods, you can continue in this topic to xref:configuring-ansible[Configuring Ansible]. [[configuring-ansible]] == Configuring Ansible The *_/etc/ansible/hosts_* file is Ansible's inventory file for the playbook to use during the installation. The inventory file describes the configuration for your {product-title} cluster. You must replace the default contents of the file with your desired configuration. The following sections describe commonly-used variables to set in your inventory file during an advanced installation, followed by example inventory files you can use as a starting point for your installation. The examples describe various environment topographies, including xref:multiple-masters[using multiple masters for high availability]. You can choose an example that matches your requirements, modify it to match your own environment, and use it as your inventory file when xref:running-the-advanced-installation[running the advanced installation]. [[configuring-host-variables]] === Configuring Host Variables To assign environment variables to hosts during the Ansible installation, indicate the desired variables in the *_/etc/ansible/hosts_* file after the host entry in the *[masters]* or *[nodes]* sections. For example: ---- [masters] ec2-52-6-179-239.compute-1.amazonaws.com openshift_public_hostname=ose3-master.public.example.com ---- The following table describes variables for use with the Ansible installer that can be assigned to individual host entries: [[advanced-host-variables]] .Host Variables [options=""header""] |=== |Variable |Purpose |`*openshift_hostname*` |This variable overrides the internal cluster host name for the system. Use this when the system's default IP address does not resolve to the system host name. |`*openshift_public_hostname*` |This variable overrides the system's public host name. Use this for cloud installations, or for hosts on networks using a network address translation (NAT). |`*openshift_ip*` |This variable overrides the cluster internal IP address for the system. Use this when using an interface that is not configured with the default route. |`*openshift_public_ip*` |This variable overrides the system's public IP address. Use this for cloud installations, or for hosts on networks using a network address translation (NAT). |`*containerized*` |If set to *true*, containerized {product-title} services are run on the target master and node hosts instead of installed using RPM packages. If set to *false* or unset, the default RPM method is used. RHEL Atomic Host requires the containerized method, and is automatically selected for you based on the detection of the *_/run/ostree-booted_* file. See xref:../../install_config/install/rpm_vs_containerized.adoc#install-config-install-rpm-vs-containerized[Installing on Containerized Hosts] for more details. ifdef::openshift-enterprise[] Containerized installations are supported starting in {product-title} 3.1.1. endif::[] |`*openshift_node_labels*` |This variable adds labels to nodes during installation. See xref:configuring-node-host-labels[Configuring Node Host Labels] for more details. |`*openshift_node_kubelet_args*` |This variable is used to configure `kubeletArguments` on nodes, such as arguments used in xref:../../admin_guide/garbage_collection.adoc#admin-guide-garbage-collection[container and image garbage collection], and to xref:../../admin_guide/manage_nodes.adoc#configuring-node-resources[specify resources per node]. `kubeletArguments` are key value pairs that are passed directly to the Kubelet that match the http://kubernetes.io/v1.1/docs/admin/kubelet.html[Kubelet's command line arguments]. `kubeletArguments` are not migrated or validated and may become invalid if used. These values override other settings in node configuration which may cause invalid configurations. Example usage: *{'image-gc-high-threshold': ['90'],'image-gc-low-threshold': ['80']}*. |`*openshift_hosted_router_selector*` |Default node selector for automatically deploying router pods. See xref:configuring-node-host-labels[Configuring Node Host Labels] for details. |`*openshift_registry_selector*` |Default node selector for automatically deploying registry pods. See xref:configuring-node-host-labels[Configuring Node Host Labels] for details. |`*openshift_docker_options*` |This variable configures additional Docker options within *_/etc/sysconfig/docker_*, such as options used in xref:../../install_config/install/host_preparation.adoc#managing-docker-container-logs[Managing Container Logs]. Example usage: *""--log-driver json-file --log-opt max-size=1M --log-opt max-file=3""*. |=== [[configuring-cluster-variables]] === Configuring Cluster Variables To assign environment variables during the Ansible install that apply more globally to your {product-title} cluster overall, indicate the desired variables in the *_/etc/ansible/hosts_* file on separate, single lines within the *[OSEv3:vars]* section. For example: ---- [OSEv3:vars] openshift_master_identity_providers=[{'name': 'htpasswd_auth', 'login': 'true', 'challenge': 'true', 'kind': 'HTPasswdPasswordIdentityProvider', 'filename': '/etc/origin/master/htpasswd'}] openshift_master_default_subdomain=apps.test.example.com ---- The following table describes variables for use with the Ansible installer that can be assigned cluster-wide: [[cluster-variables-table]] .Cluster Variables [options=""header""] |=== |Variable |Purpose |`*ansible_ssh_user*` |This variable sets the SSH user for the installer to use and defaults to *root*. This user should allow SSH-based authentication xref:host_preparation.adoc#ensuring-host-access[without requiring a password]. If using SSH key-based authentication, then the key should be managed by an SSH agent. |`*ansible_become*` |If `*ansible_ssh_user*` is not *root*, this variable must be set to *true* and the user must be configured for passwordless *sudo*. |`*debug_level*` a|This variable sets which INFO messages are logged to the `systemd-journald.service`. Set one of the following: * `0` to log errors and warnings only * `2` to log normal information (This is the default level.) * `4` to log debugging-level information * `6` to log API-level debugging information (request / response) * `8` to log body-level API debugging information For more information on debug log levels, see xref:../../install_config/master_node_configuration.adoc#master-node-config-logging-levels[Configuring Logging Levels]. |`*containerized*` |If set to *true*, containerized {product-title} services are run on all target master and node hosts in the cluster instead of installed using RPM packages. If set to *false* or unset, the default RPM method is used. RHEL Atomic Host requires the containerized method, and is automatically selected for you based on the detection of the *_/run/ostree-booted_* file. See xref:../../install_config/install/rpm_vs_containerized.adoc#install-config-install-rpm-vs-containerized[Installing on Containerized Hosts] for more details. ifdef::openshift-enterprise[] Containerized installations are supported starting in {product-title} 3.1.1. endif::[] |`*openshift_master_cluster_hostname*` |This variable overrides the host name for the cluster, which defaults to the host name of the master. |`*openshift_master_cluster_public_hostname*` |This variable overrides the public host name for the cluster, which defaults to the host name of the master. |`*openshift_master_cluster_method*` |Optional. This variable defines the HA method when deploying multiple masters. Supports the `native` method. See xref:multiple-masters[Multiple Masters] for more information. |`*openshift_rolling_restart_mode*` |This variable enables rolling restarts of HA masters (i.e., masters are taken down one at a time) when xref:../upgrading/automated_upgrades.adoc#running-the-upgrade-playbook-directly[running the upgrade playbook directly]. It defaults to `services`, which allows rolling restarts of services on the masters. It can instead be set to `system`, which enables rolling, full system restarts and also works for single master clusters. |`*os_sdn_network_plugin_name*` |This variable configures which xref:../../architecture/additional_concepts/sdn.adoc#architecture-additional-concepts-sdn[OpenShift SDN plug-in] to use for the pod network, which defaults to *redhat/openshift-ovs-subnet* for the standard SDN plug-in. Set the variable to *redhat/openshift-ovs-multitenant* to use the multitenant plug-in. |`*openshift_master_identity_providers*` |This variable overrides the xref:../../install_config/configuring_authentication.adoc#install-config-configuring-authentication[identity provider], which defaults to xref:../../install_config/configuring_authentication.adoc#DenyAllPasswordIdentityProvider[Deny All]. |`*openshift_master_named_certificates*` .2+.^|These variables are used to configure xref:../../install_config/certificate_customization.adoc#install-config-certificate-customization[custom certificates] which are deployed as part of the installation. See xref:advanced-install-custom-certificates[Configuring Custom Certificates] for more information. |`*openshift_master_overwrite_named_certificates*` |`*openshift_master_session_name*` .4+.^|These variables override defaults for xref:../../install_config/configuring_authentication.adoc#session-options[session options] in the OAuth configuration. See xref:advanced-install-session-options[Configuring Session Options] for more information. |`*openshift_master_session_max_seconds*` |`*openshift_master_session_auth_secrets*` |`*openshift_master_session_encryption_secrets*` |`*openshift_master_portal_net*` |This variable configures the subnet in which xref:../../architecture/core_concepts/pods_and_services.adoc#services[services] will be created within the xref:../../architecture/additional_concepts/sdn.adoc#architecture-additional-concepts-sdn[{product-title} SDN]. This network block should be private and must not conflict with any existing network blocks in your infrastructure to which pods, nodes, or the master may require access to, or the installation will fail. Defaults to *172.30.0.0/16*, and *cannot* be re-configured after deployment. If changing from the default, avoid *172.16.0.0/16*, which the *docker0* network bridge uses by default, or modify the *docker0* network. |`*openshift_master_default_subdomain*` |This variable overrides the default subdomain to use for exposed xref:../../architecture/core_concepts/routes.adoc#architecture-core-concepts-routes[routes]. |`*openshift_node_proxy_mode*` |This variable specifies the xref:../../architecture/core_concepts/pods_and_services.adoc#service-proxy-mode[service proxy mode] to use: either *iptables* for the default, pure-*iptables* implementation, or *userspace* for the user space proxy. |`*osm_default_node_selector*` |This variable overrides the node selector that projects will use by default when placing pods. |`*osm_cluster_network_cidr*` | This variable overrides the xref:../../architecture/additional_concepts/sdn.adoc#sdn-design-on-masters[SDN cluster network] CIDR block. This is the network from which pod IPs are assigned. This network block should be a private block and must not conflict with existing network blocks in your infrastructure to which pods, nodes, or the master may require access. Defaults to *10.128.0.0/14* and *cannot* be arbitrarily re-configured after deployment, although certain changes to it can be made in the xref:../configuring_sdn.adoc#configuring-the-pod-network-on-masters[SDN master configuration]. |`*osm_host_subnet_length*` |This variable specifies the size of the per host subnet allocated for pod IPs by xref:../../architecture/additional_concepts/sdn.adoc#sdn-design-on-masters[{product-title} SDN]. Defaults to *9* which means that a subnet of size /23 is allocated to each host; for example, given the default 10.128.0.0/14 cluster network, this will allocate 10.128.0.0/23, 10.128.2.0/23, 10.128.4.0/23, and so on. This *cannot* be re-configured after deployment. |`*openshift_use_flannel*` |This variable enables *flannel* as an alternative networking layer instead of the default SDN. If enabling *flannel*, disable the default SDN with the *openshift_use_openshift_sdn* variable. For more information, see xref:../configuring_sdn.adoc#using-flannel[Using Flannel]. |`*openshift_docker_additional_registries*` |{product-title} adds the specified additional registry or registries to the Docker configuration. |`*openshift_docker_insecure_registries*` |{product-title} adds the specified additional insecure registry or registries to the Docker configuration. |`*openshift_docker_blocked_registries*` |{product-title} adds the specified blocked registry or registries to the Docker configuration. |`*openshift_hosted_metrics_public_url*` |This variable sets the host name for integration with the metrics console. The default is `*https://hawkular-metrics.{{openshift_master_default_subdomain}}/hawkular/metrics*` If you alter this variable, ensure the host name is accessible via your router. |=== [[advanced-install-configuring-registry-location]] === Configuring a Registry Location If you are using an image registry other than the default at `registry.access.redhat.com`, specify the desired registry within the *_/etc/ansible/hosts_* file. ---- oreg_url=example.com/openshift3/ose-${component}:${version} openshift_examples_modify_imagestreams=true ---- .Registry Variables [options=""header""] |=== |Variable |Purpose |`*oreg_url*` |Set to the alternate image location. Necessary if you are not using the default registry at `registry.access.redhat.com`. |`*openshift_examples_modify_imagestreams*` |Set to `true` if pointing to a registry other than the default. Modifies the image stream location to the value of `*oreg_url*`. |=== [[advanced-install-configuring-global-proxy]] === Configuring Global Proxy Options If your hosts require use of a HTTP or HTTPS proxy in order to connect to external hosts, there are many components that must be configured to use the proxy, including masters, Docker, and builds. Node services only connect to the master API requiring no external access and therefore do not need to be configured to use a proxy. In order to simplify this configuration, the following Ansible variables can be specified at a cluster or host level to apply these settings uniformly across your environment. [NOTE] ==== See xref:../../install_config/build_defaults_overrides.adoc#install-config-build-defaults-overrides[Configuring Global Build Defaults and Overrides] for more information on how the proxy environment is defined for builds. ==== .Cluster Proxy Variables [options=""header""] |=== |Variable |Purpose |`*openshift_http_proxy*` |This variable specifies the `*HTTP_PROXY*` environment variable for masters and the Docker daemon. |`*openshift_https_proxy*` |This variable specifices the `*HTTPS_PROXY*` environment variable for masters and the Docker daemon. |`*openshift_no_proxy*` |This variable is used to set the `*NO_PROXY*` environment variable for masters and the Docker daemon. This value should be set to a comma separated list of host names or wildcard host names that should not use the defined proxy. This list will be augmented with the list of all defined {product-title} host names by default. |`*openshift_generate_no_proxy_hosts*` |This boolean variable specifies whether or not the names of all defined OpenShift hosts and `pass:[*.cluster.local]` should be automatically appended to the `*NO_PROXY*` list. Defaults to *true*; set it to *false* to override this option. |`*openshift_builddefaults_http_proxy*` |This variable defines the `*HTTP_PROXY*` environment variable inserted into builds using the `*BuildDefaults*` admission controller. If `*openshift_http_proxy*` is set, this variable will inherit that value; you only need to set this if you want your builds to use a different value. |`*openshift_builddefaults_https_proxy*` |This variable defines the `*HTTPS_PROXY*` environment variable inserted into builds using the `*BuildDefaults*` admission controller. If `*openshift_https_proxy*` is set, this variable will inherit that value; you only need to set this if you want your builds to use a different value. |`*openshift_builddefaults_no_proxy*` |This variable defines the `*NO_PROXY*` environment variable inserted into builds using the `*BuildDefaults*` admission controller. If `*openshift_no_proxy*` is set, this variable will inherit that value; you only need to set this if you want your builds to use a different value. |`*openshift_builddefaults_git_http_proxy*` |This variable defines the HTTP proxy used by `git clone` operations during a build, defined using the `*BuildDefaults*` admission controller. If `*openshift_builddefaults_http_proxy*` is set, this variable will inherit that value; you only need to set this if you want your `git clone` operations to use a different value. |`*openshift_builddefaults_git_https_proxy*` |This variable defines the HTTPS proxy used by `git clone` operations during a build, defined using the `*BuildDefaults*` admission controller. If `*openshift_builddefaults_https_proxy*` is set, this variable will inherit that value; you only need to set this if you want your `git clone` operations to use a different value. |=== [[configuring-node-host-labels]] === Configuring Node Host Labels You can assign xref:../../architecture/core_concepts/pods_and_services.adoc#labels[labels] to node hosts during the Ansible install by configuring the *_/etc/ansible/hosts_* file. Labels are useful for determining the placement of pods onto nodes using the xref:../../admin_guide/scheduler.adoc#configurable-predicates[scheduler]. Other than *region=infra* (discussed below), the actual label names and values are arbitrary and can be assigned however you see fit per your cluster's requirements. To assign labels to a node host during an Ansible install, use the `*openshift_node_labels*` variable with the desired labels added to the desired node host entry in the *[nodes]* section. In the following example, labels are set for a region called *primary* and a zone called *east*: ---- [nodes] node1.example.com openshift_node_labels=""{'region': 'primary', 'zone': 'east'}"" ---- The `*openshift_router_selector*` and `*openshift_registry_selector*` Ansible settings are set to *region=infra* by default: ---- # default selectors for router and registry services # openshift_router_selector='region=infra' # openshift_registry_selector='region=infra' ---- The default router and registry will be automatically deployed if nodes exist that match the selector settings above. For example: ---- [nodes] node1.example.com openshift_node_labels=""{'region':'infra','zone':'default'}"" ---- [IMPORTANT] ==== The registry and router are only able to run on node hosts with the 'region=infra' label. Ensure that at least one node host in your {product-title} environment has the 'region=infra' label. ==== [[marking-masters-as-unschedulable-nodes]] === Marking Masters as Unschedulable Nodes Any hosts you designate as masters during the installation process should also be configured as nodes by adding them to the *[nodes]* section so that the masters are configured as part of the xref:../../architecture/additional_concepts/networking.adoc#openshift-sdn[{product-title} SDN]. However, in order to ensure that your masters are not burdened with running pods, you can make them xref:../../admin_guide/manage_nodes.adoc#marking-nodes-as-unschedulable-or-schedulable[unschedulable] by adding the `*openshift_schedulable=false*` option any node that is also a master. For example: ---- [nodes] master.example.com openshift_node_labels=""{'region':'infra','zone':'default'}"" openshift_schedulable=false ---- [[advanced-install-session-options]] === Configuring Session Options xref:../../install_config/configuring_authentication.adoc#session-options[Session options] in the OAuth configuration are configurable in the inventory file. By default, Ansible populates a `*sessionSecretsFile*` with generated authentication and encryption secrets so that sessions generated by one master can be decoded by the others. The default location is *_/etc/origin/master/session-secrets.yaml_*, and this file will only be re-created if deleted on all masters. You can set the session name and maximum number of seconds with `*openshift_master_session_name*` and `*openshift_master_session_max_seconds*`: ---- openshift_master_session_name=ssn openshift_master_session_max_seconds=3600 ---- If provided, `*openshift_master_session_auth_secrets*` and `*openshift_master_encryption_secrets*` must be equal length. For `*openshift_master_session_auth_secrets*`, used to authenticate sessions using HMAC, it is recommended to use secrets with 32 or 64 bytes: ---- openshift_master_session_auth_secrets=['DONT+USE+THIS+SECRET+b4NV+pmZNSO'] ---- For `*openshift_master_encryption_secrets*`, used to encrypt sessions, secrets must be 16, 24, or 32 characters long, to select AES-128, AES-192, or AES-256: ---- openshift_master_session_encryption_secrets=['DONT+USE+THIS+SECRET+b4NV+pmZNSO'] ---- [[advanced-install-custom-certificates]] === Configuring Custom Certificates xref:../../install_config/certificate_customization.adoc#install-config-certificate-customization[Custom serving certificates] for the public host names of the {product-title} API and xref:../../architecture/infrastructure_components/web_console.adoc#architecture-infrastructure-components-web-console[web console] can be deployed during an advanced installation and are configurable in the inventory file. [NOTE] ==== Custom certificates should only be configured for the host name associated with the `*publicMasterURL*` which can be set using `*openshift_master_cluster_public_hostname*`. Using a custom serving certificate for the host name associated with the `*masterURL*` (*`openshift_master_cluster_hostname`*) will result in TLS errors as infrastructure components will attempt to contact the master API using the internal `*masterURL*` host. ==== Certificate and key file paths can be configured using the `*openshift_master_named_certificates*` cluster variable: ---- openshift_master_named_certificates=[{""certfile"": ""/path/to/custom1.crt"", ""keyfile"": ""/path/to/custom1.key""}] ---- File paths must be local to the system where Ansible will be run. Certificates are copied to master hosts and are deployed within the *_/etc/origin/master/named_certificates/_* directory. Ansible detects a certificate's `Common Name` and `Subject Alternative Names`. Detected names can be overridden by providing the `*""names""*` key when setting `*openshift_master_named_certificates*`: ---- openshift_master_named_certificates=[{""certfile"": ""/path/to/custom1.crt"", ""keyfile"": ""/path/to/custom1.key"", ""names"": [""public-master-host.com""]}] ---- Certificates configured using `*openshift_master_named_certificates*` are cached on masters, meaning that each additional Ansible run with a different set of certificates results in all previously deployed certificates remaining in place on master hosts and within the master configuration file. If you would like `*openshift_master_named_certificates*` to be overwritten with the provided value (or no value), specify the `*openshift_master_overwrite_named_certificates*` cluster variable: ---- openshift_master_overwrite_named_certificates=true ---- For a more complete example, consider the following cluster variables in an inventory file: ---- openshift_master_cluster_method=native openshift_master_cluster_hostname=lb.openshift.com openshift_master_cluster_public_hostname=custom.openshift.com ---- To overwrite the certificates on a subsequent Ansible run, you could set the following: ---- openshift_master_named_certificates=[{""certfile"": ""/root/STAR.openshift.com.crt"", ""keyfile"": ""/root/STAR.openshift.com.key"", ""names"": [""custom.openshift.com""]}] openshift_master_overwrite_named_certificates=true ---- [[advanced-install-cluster-metrics]] == Configuring Cluster Metrics Cluster metrics are not set to automatically deploy by default. Set the following to enable cluster metrics when using the advanced install: ---- [OSEv3:vars] openshift_hosted_metrics_deploy=true ---- === Metrics Storage The `*openshift_metrics_cassandra_storage_type*` variable must be set in order to use persistent storage. If `*openshift_metrics_cassandra_storage_type*` is not set, then cluster metrics data is stored in an `EmptyDir` volume, which will be deleted when the Cassandra pod terminates. There are three options for enabling cluster metrics storage when using the advanced install: *Option A - NFS Host Group* When the following variables are set, an NFS volume is created during an advanced install with path *_/_* on the host within the `[nfs]` host group. For example, the volume path using these options would be *_/exports/metrics_*: ---- [OSEv3:vars] openshift_hosted_metrics_storage_kind=nfs openshift_hosted_metrics_storage_access_modes=['ReadWriteOnce'] openshift_hosted_metrics_storage_nfs_directory=/exports openshift_hosted_metrics_storage_nfs_options='*(rw,root_squash)' openshift_hosted_metrics_storage_volume_name=metrics openshift_hosted_metrics_storage_volume_size=10Gi ---- *Option B - External NFS Host* To use an external NFS volume, one must already exist with a path of *_/_* on the storage host. ---- [OSEv3:vars] openshift_hosted_metrics_storage_kind=nfs openshift_hosted_metrics_storage_access_modes=['ReadWriteOnce'] openshift_hosted_metrics_storage_host=nfs.example.com openshift_hosted_metrics_storage_nfs_directory=/exports openshift_hosted_metrics_storage_volume_name=metrics openshift_hosted_metrics_storage_volume_size=10Gi ---- The remote volume path using the following options would be *_nfs.example.com:/exports/metrics_*. *Option C - Dynamic* Use the following variable if your {product-title} environment supports dynamic volume provisioning for your cloud platform: ---- [OSEv3:vars] #openshift_metrics_cassandra_storage_type=dynamic ---- [[advanced-install-cluster-logging]] == Configuring Cluster Logging Cluster logging is not set to automatically deploy by default. Set the following to enable cluster logging when using the advanced installation method: ---- [OSEv3:vars] openshift_hosted_logging_deploy=true ---- [[advanced-installation-logging-storage]] === Logging Storage The `openshift_hosted_logging_storage_kind` variable must be set in order to use persistent storage. If `openshift_hosted_logging_storage_kind` is not set, then cluster logging data is stored in an `emptyDir` volume, which will be deleted when the Elasticsearch pod terminates. There are three options for enabling cluster logging storage when using the advanced install: *Option A - NFS Host Group* When the following variables are set, an NFS volume is created during an advanced install with path *_/_* on the host within the `[nfs]` host group. For example, the volume path using these options would be *_/exports/logging_*: ---- [OSEv3:vars] openshift_hosted_logging_storage_kind=nfs openshift_hosted_logging_storage_access_modes=['ReadWriteOnce'] openshift_hosted_logging_storage_nfs_directory=/exports openshift_hosted_logging_storage_nfs_options='*(rw,root_squash)' openshift_hosted_logging_storage_volume_name=logging openshift_hosted_logging_storage_volume_size=10Gi ---- *Option B - External NFS Host* To use an external NFS volume, one must already exist with a path of *_/_* on the storage host. ---- [OSEv3:vars] openshift_hosted_logging_storage_kind=nfs openshift_hosted_logging_storage_access_modes=['ReadWriteOnce'] openshift_hosted_logging_storage_host=nfs.example.com openshift_hosted_logging_storage_nfs_directory=/exports openshift_hosted_logging_storage_volume_name=logging openshift_hosted_logging_storage_volume_size=10Gi ---- The remote volume path using the following options would be *_nfs.example.com:/exports/logging_*. *Option C - Dynamic* Use the following variable if your {product-title} environment supports dynamic volume provisioning for your cloud platform: ---- [OSEv3:vars] #openshift_hosted_logging_storage_kind=dynamic ---- [[single-master]] == Single Master Examples You can configure an environment with a single master and multiple nodes, and either a single or multiple number of external *etcd* hosts. [NOTE] ==== Moving from a single master cluster to multiple masters after installation is not supported. ==== [[single-master-multi-node-ai]] *Single Master and Multiple Nodes* The following table describes an example environment for a single xref:../../architecture/infrastructure_components/kubernetes_infrastructure.adoc#master[master] (with *etcd* on the same host) and two xref:../../architecture/infrastructure_components/kubernetes_infrastructure.adoc#node[nodes]: [options=""header""] |=== |Host Name |Infrastructure Component to Install |*master.example.com* |Master and node |*master.example.com* |etcd |*node1.example.com* .2+.^|Node |*node2.example.com* |=== You can see these example hosts present in the *[masters]* and *[nodes]* sections of the following example inventory file: .Single Master and Multiple Nodes Inventory File ---- # Create an OSEv3 group that contains the masters and nodes groups [OSEv3:children] masters nodes # Set variables common for all OSEv3 hosts [OSEv3:vars] # SSH user, this user should allow ssh based auth without requiring a password ansible_ssh_user=root # If ansible_ssh_user is not root, ansible_become must be set to true #ansible_become=true ifdef::openshift-enterprise[] deployment_type=openshift-enterprise endif::[] ifdef::openshift-origin[] deployment_type=origin endif::[] # uncomment the following to enable htpasswd authentication; defaults to DenyAllPasswordIdentityProvider #openshift_master_identity_providers=[{'name': 'htpasswd_auth', 'login': 'true', 'challenge': 'true', 'kind': 'HTPasswdPasswordIdentityProvider', 'filename': '/etc/origin/master/htpasswd'}] # host group for masters [masters] master.example.com # host group for etcd [etcd] master.example.com # host group for nodes, includes region info [nodes] master.example.com openshift_node_labels=""{'region': 'infra', 'zone': 'default'}"" node1.example.com openshift_node_labels=""{'region': 'primary', 'zone': 'east'}"" node2.example.com openshift_node_labels=""{'region': 'primary', 'zone': 'west'}"" ---- To use this example, modify the file to match your environment and specifications, and save it as *_/etc/ansible/hosts_*. [[single-master-multi-etcd-multi-node-ai]] *Single Master, Multiple etcd, and Multiple Nodes* The following table describes an example environment for a single xref:../../architecture/infrastructure_components/kubernetes_infrastructure.adoc#master[master], three xref:../../architecture/infrastructure_components/kubernetes_infrastructure.adoc#master[*etcd*] hosts, and two xref:../../architecture/infrastructure_components/kubernetes_infrastructure.adoc#node[nodes]: [options=""header""] |=== |Host Name |Infrastructure Component to Install |*master.example.com* |Master and node |*etcd1.example.com* .3+.^|*etcd* |*etcd2.example.com* |*etcd3.example.com* |*node1.example.com* .2+.^|Node |*node2.example.com* |=== [NOTE] ==== When specifying multiple *etcd* hosts, external *etcd* is installed and configured. Clustering of {product-title}'s embedded *etcd* is not supported. ==== You can see these example hosts present in the *[masters]*, *[nodes]*, and *[etcd]* sections of the following example inventory file: .Single Master, Multiple etcd, and Multiple Nodes Inventory File ---- # Create an OSEv3 group that contains the masters, nodes, and etcd groups [OSEv3:children] masters nodes etcd # Set variables common for all OSEv3 hosts [OSEv3:vars] ansible_ssh_user=root ifdef::openshift-enterprise[] deployment_type=openshift-enterprise endif::[] ifdef::openshift-origin[] deployment_type=origin endif::[] # uncomment the following to enable htpasswd authentication; defaults to DenyAllPasswordIdentityProvider #openshift_master_identity_providers=[{'name': 'htpasswd_auth', 'login': 'true', 'challenge': 'true', 'kind': 'HTPasswdPasswordIdentityProvider', 'filename': '/etc/origin/master/htpasswd'}] # host group for masters [masters] master.example.com # host group for etcd [etcd] etcd1.example.com etcd2.example.com etcd3.example.com # host group for nodes, includes region info [nodes] master.example.com openshift_node_labels=""{'region': 'infra', 'zone': 'default'}"" node1.example.com openshift_node_labels=""{'region': 'primary', 'zone': 'east'}"" node2.example.com openshift_node_labels=""{'region': 'primary', 'zone': 'west'}"" ---- To use this example, modify the file to match your environment and specifications, and save it as *_/etc/ansible/hosts_*. [[multiple-masters]] == Multiple Masters Examples You can configure an environment with multiple masters, multiple *etcd* hosts, and multiple nodes. Configuring xref:../../architecture/infrastructure_components/kubernetes_infrastructure.adoc#high-availability-masters[multiple masters for high availability] (HA) ensures that the cluster has no single point of failure. [NOTE] ==== Moving from a single master cluster to multiple masters after installation is not supported. ==== When configuring multiple masters, the advanced installation supports the following high availability (HA) method: [cols=""1,5""] |=== |`native` |Leverages the native HA master capabilities built into {product-title} and can be combined with any load balancing solution. If a host is defined in the *[lb]* section of the inventory file, Ansible installs and configures HAProxy automatically as the load balancing solution. If no host is defined, it is assumed you have pre-configured a load balancing solution of your choice to balance the master API (port 8443) on all master hosts. |=== For your pre-configured load balancing solution, you must have: * A pre-created load balancer VIP configured for SSL passthrough. * A domain name for VIP registered in DNS. ** The domain name will become the value of both `openshift_master_cluster_public_hostname` and `openshift_master_cluster_hostname` in the {product-title} installer. See link:https://github.com/redhat-cop/openshift-playbooks/blob/master/playbooks/installation/load_balancing.adoc[External Load Balancer Integrations] for more information. [NOTE] ==== For more on the high availability master architecture, see xref:../../architecture/infrastructure_components/kubernetes_infrastructure.adoc#master[Kubernetes Infrastructure]. ==== Note the following when using the `native` HA method: - The advanced installation method does not currently support multiple HAProxy load balancers in an active-passive setup. See the https://access.redhat.com/documentation/en-US/Red_Hat_Enterprise_Linux/7/html/Load_Balancer_Administration/ch-lvs-overview-VSA.html[Load Balancer Administration documentation] for post-installation amendments. - In a HAProxy setup, controller manager servers run as standalone processes. They elect their active leader with a lease stored in *etcd*. The lease expires after 30 seconds by default. If a failure happens on an active controller server, it will take up to this number of seconds to elect another leader. The interval can be configured with the `*osm_controller_lease_ttl*` variable. To configure multiple masters, refer to the following section. [[multi-masters-using-native-ha-ai]] *Multiple Masters with Multiple etcd, and Using Native HA* The following describes an example environment for three xref:../../architecture/infrastructure_components/kubernetes_infrastructure.adoc#master[masters], one HAProxy load balancer, three xref:../../architecture/infrastructure_components/kubernetes_infrastructure.adoc#master[*etcd*] hosts, and two xref:../../architecture/infrastructure_components/kubernetes_infrastructure.adoc#node[nodes] using the `native` HA method: [options=""header""] |=== |Host Name |Infrastructure Component to Install |*master1.example.com* .3+.^|Master (clustered using native HA) and node |*master2.example.com* |*master3.example.com* |*lb.example.com* |HAProxy to load balance API master endpoints |*etcd1.example.com* .3+.^|*etcd* |*etcd2.example.com* |*etcd3.example.com* |*node1.example.com* .2+.^|Node |*node2.example.com* |=== [NOTE] ==== When specifying multiple *etcd* hosts, external *etcd* is installed and configured. Clustering of {product-title}'s embedded *etcd* is not supported. ==== You can see these example hosts present in the *[masters]*, *[etcd]*, *[lb]*, and *[nodes]* sections of the following example inventory file: .Multiple Masters Using HAProxy Inventory File ==== ---- # Create an OSEv3 group that contains the master, nodes, etcd, and lb groups. # The lb group lets Ansible configure HAProxy as the load balancing solution. # Comment lb out if your load balancer is pre-configured. [OSEv3:children] masters nodes etcd lb # Set variables common for all OSEv3 hosts [OSEv3:vars] ansible_ssh_user=root ifdef::openshift-enterprise[] deployment_type=openshift-enterprise endif::[] ifdef::openshift-origin[] deployment_type=origin endif::[] # Uncomment the following to enable htpasswd authentication; defaults to # DenyAllPasswordIdentityProvider. #openshift_master_identity_providers=[{'name': 'htpasswd_auth', 'login': 'true', 'challenge': 'true', 'kind': 'HTPasswdPasswordIdentityProvider', 'filename': '/etc/origin/master/htpasswd'}] # Native high availbility cluster method with optional load balancer. # If no lb group is defined installer assumes that a load balancer has # been preconfigured. For installation the value of # openshift_master_cluster_hostname must resolve to the load balancer # or to one or all of the masters defined in the inventory if no load # balancer is present. openshift_master_cluster_method=native openshift_master_cluster_hostname=openshift-cluster.example.com openshift_master_cluster_public_hostname=openshift-cluster.example.com # apply updated node defaults openshift_node_kubelet_args={'pods-per-core': ['10'], 'max-pods': ['250'], 'image-gc-high-threshold': ['90'], 'image-gc-low-threshold': ['80']} # override the default controller lease ttl #osm_controller_lease_ttl=30 # enable ntp on masters to ensure proper failover openshift_clock_enabled=true # host group for masters [masters] master1.example.com master2.example.com master3.example.com # host group for etcd [etcd] etcd1.example.com etcd2.example.com etcd3.example.com # Specify load balancer host [lb] lb.example.com # host group for nodes, includes region info [nodes] master[1:3].example.com openshift_node_labels=""{'region': 'infra', 'zone': 'default'}"" node1.example.com openshift_node_labels=""{'region': 'primary', 'zone': 'east'}"" node2.example.com openshift_node_labels=""{'region': 'primary', 'zone': 'west'}"" ---- ==== To use this example, modify the file to match your environment and specifications, and save it as *_/etc/ansible/hosts_*. [[multi-masters-singel-etcd-using-native-ha]] *Multiple Masters with Master and etcd on the Same Host, and Using Native HA* The following describes an example environment for three xref:../../architecture/infrastructure_components/kubernetes_infrastructure.adoc#master[masters] with xref:../../architecture/infrastructure_components/kubernetes_infrastructure.adoc#master[*etcd*] on each host, one HAProxy load balancer, and two xref:../../architecture/infrastructure_components/kubernetes_infrastructure.adoc#node[nodes] using the `native` HA method: [options=""header""] |=== |Host Name |Infrastructure Component to Install |*master1.example.com* .3+.^|Master (clustered using native HA) and node with etcd on each host |*master2.example.com* |*master3.example.com* |*lb.example.com* |HAProxy to load balance API master endpoints |*node1.example.com* .2+.^|Node |*node2.example.com* |=== You can see these example hosts present in the *[masters]*, *[etcd]*, *[lb]*, and *[nodes]* sections of the following example inventory file: ==== ---- # Create an OSEv3 group that contains the master, nodes, etcd, and lb groups. # The lb group lets Ansible configure HAProxy as the load balancing solution. # Comment lb out if your load balancer is pre-configured. [OSEv3:children] masters nodes etcd lb # Set variables common for all OSEv3 hosts [OSEv3:vars] ansible_ssh_user=root deployment_type=openshift-enterprise # Uncomment the following to enable htpasswd authentication; defaults to # DenyAllPasswordIdentityProvider. #openshift_master_identity_providers=[{'name': 'htpasswd_auth', 'login': 'true', 'challenge': 'true', 'kind': 'HTPasswdPasswordIdentityProvider', 'filename': '/etc/origin/master/htpasswd'}] # Native high availbility cluster method with optional load balancer. # If no lb group is defined installer assumes that a load balancer has # been preconfigured. For installation the value of # openshift_master_cluster_hostname must resolve to the load balancer # or to one or all of the masters defined in the inventory if no load # balancer is present. openshift_master_cluster_method=native openshift_master_cluster_hostname=openshift-cluster.example.com openshift_master_cluster_public_hostname=openshift-cluster.example.com # override the default controller lease ttl #osm_controller_lease_ttl=30 # host group for masters [masters] master1.example.com master2.example.com master3.example.com # host group for etcd [etcd] master1.example.com master2.example.com master3.example.com # Specify load balancer host [lb] lb.example.com # host group for nodes, includes region info [nodes] master[1:3].example.com openshift_node_labels=""{'region': 'infra', 'zone': 'default'}"" node1.example.com openshift_node_labels=""{'region': 'primary', 'zone': 'east'}"" node2.example.com openshift_node_labels=""{'region': 'primary', 'zone': 'west'}"" ---- ==== To use this example, modify the file to match your environment and specifications, and save it as *_/etc/ansible/hosts_*. [[running-the-advanced-installation]] == Running the Advanced Installation After you have xref:configuring-ansible[configured Ansible] by defining an inventory file in *_/etc/ansible/hosts_*, you can run the advanced installation using the following playbook: ---- ifdef::openshift-enterprise[] # ansible-playbook /usr/share/ansible/openshift-ansible/playbooks/byo/config.yml endif::[] ifdef::openshift-origin[] # ansible-playbook ~/openshift-ansible/playbooks/byo/config.yml endif::[] ---- If for any reason the installation fails, before re-running the installer, see xref:installer-known-issues[Known Issues] to check for any specific instructions or workarounds. [[advanced-verifying-the-installation]] == Verifying the Installation // tag::verifying-the-installation[] After the installation completes: . Verify that the master is started and nodes are registered and reporting in *Ready* status. *On the master host*, run the following as root: ---- # oc get nodes NAME STATUS AGE master.example.com Ready,SchedulingDisabled 165d node1.example.com Ready 165d node2.example.com Ready 165d ---- To verify that the web console is installed correctly, use the master host name and the console port number to access the console with a web browser. For example, for a master host with a hostname of `master.openshift.com` and using the default port of `8443`, the web console would be found at: ---- https://master.openshift.com:8443/console ---- Now that the install has been verified, run the following command on each master and node host to add the *atomic-openshift* packages back to the list of yum excludes on the host: ---- # atomic-openshift-excluder exclude ---- // end::verifying-the-installation[] [NOTE] ==== The default port for the console is `8443`. If this was changed during the installation, the port can be found at *openshift_master_console_port* in the *_/etc/ansible/hosts_* file. ==== *Multiple etcd Hosts* If you installed multiple *etcd* hosts: . On a master host, verify the *etcd* cluster health, substituting for the FQDNs of your *etcd* hosts in the following: + ---- # etcdctl -C \\ https://etcd1.example.com:2379,https://etcd2.example.com:2379,https://etcd3.example.com:2379 \\ --ca-file=/etc/origin/master/master.etcd-ca.crt \\ --cert-file=/etc/origin/master/master.etcd-client.crt \\ --key-file=/etc/origin/master/master.etcd-client.key cluster-health ---- . Also verify the member list is correct: + ---- # etcdctl -C \\ https://etcd1.example.com:2379,https://etcd2.example.com:2379,https://etcd3.example.com:2379 \\ --ca-file=/etc/origin/master/master.etcd-ca.crt \\ --cert-file=/etc/origin/master/master.etcd-client.crt \\ --key-file=/etc/origin/master/master.etcd-client.key member list ---- *Multiple Masters Using HAProxy* If you installed multiple masters using HAProxy as a load balancer, browse to the following URL according to your *[lb]* section definition and check HAProxy's status: ---- http://:9000 ---- You can verify your installation by consulting the https://access.redhat.com/documentation/en-US/Red_Hat_Enterprise_Linux/7/html/Load_Balancer_Administration/ch-haproxy-setup-VSA.html[HAProxy Configuration documentation]. [[uninstalling-advanced]] == Uninstalling {product-title} You can uninstall {product-title} hosts in your cluster by running the *_uninstall.yml_* playbook. This playbook deletes {product-title} content installed by Ansible, including: - Configuration - Containers - Default templates and image streams - Images - RPM packages The playbook will delete content for any hosts defined in the inventory file that you specify when running the playbook. If you want to uninstall {product-title} across all hosts in your cluster, run the playbook using the inventory file you used when installing {product-title} initially or ran most recently: ---- ifdef::openshift-enterprise[] # ansible-playbook [-i /path/to/file] \\ /usr/share/ansible/openshift-ansible/playbooks/adhoc/uninstall.yml endif::[] ifdef::openshift-origin[] # ansible-playbook [-i /path/to/file] \\ ~/openshift-ansible/playbooks/adhoc/uninstall.yml endif::[] ---- [[uninstalling-nodes-advanced]] === Uninstalling Nodes You can also uninstall node components from specific hosts using the *_uninstall.yml_* playbook while leaving the remaining hosts and cluster alone: [WARNING] ==== This method should only be used when attempting to uninstall specific node hosts and not for specific masters or etcd hosts, which would require further configuration changes within the cluster. ==== . First follow the steps in xref:../../admin_guide/manage_nodes.adoc#deleting-nodes[Deleting Nodes] to remove the node object from the cluster, then continue with the remaining steps in this procedure. . Create a different inventory file that only references those hosts. For example, to only delete content from one node: + ---- [OSEv3:children] nodes <1> [OSEv3:vars] ansible_ssh_user=root ifdef::openshift-enterprise[] deployment_type=openshift-enterprise endif::[] ifdef::openshift-origin[] deployment_type=origin endif::[] [nodes] node3.example.com openshift_node_labels=""{'region': 'primary', 'zone': 'west'}"" <2> ---- <1> Only include the sections that pertain to the hosts you are interested in uninstalling. <2> Only include hosts that you want to uninstall. . Specify that new inventory file using the `-i` option when running the *_uninstall.yml_* playbook: + ---- ifdef::openshift-enterprise[] # ansible-playbook -i /path/to/new/file \\ /usr/share/ansible/openshift-ansible/playbooks/adhoc/uninstall.yml endif::[] ifdef::openshift-origin[] # ansible-playbook -i /path/to/new/file \\ ~/openshift-ansible/playbooks/adhoc/uninstall.yml endif::[] ---- When the playbook completes, all {product-title} content should be removed from any specified hosts. [[installer-known-issues]] == Known Issues The following are known issues for specified installation configurations. *Multiple Masters* - On failover, it is possible for the controller manager to overcorrect, which causes the system to run more pods than what was intended. However, this is a transient event and the system does correct itself over time. See https://github.com/kubernetes/kubernetes/issues/10030 for details. - On failure of the Ansible installer, you must start from a clean operating system installation. If you are using virtual machines, start from a fresh image. If you are using bare metal machines, run the following on all hosts: + ---- # yum -y remove openshift openshift-* etcd docker docker-common # rm -rf /etc/origin /var/lib/openshift /etc/etcd \\ /var/lib/etcd /etc/sysconfig/atomic-openshift* /etc/sysconfig/docker* \\ /root/.kube/config /etc/ansible/facts.d /usr/share/openshift ---- == What's Next? Now that you have a working {product-title} instance, you can: - xref:../../install_config/configuring_authentication.adoc#install-config-configuring-authentication[Configure authentication]; by default, authentication is set to ifdef::openshift-enterprise[] xref:../../install_config/configuring_authentication.adoc#DenyAllPasswordIdentityProvider[Deny All]. endif::[] ifdef::openshift-origin[] xref:../../install_config/configuring_authentication.adoc#AllowAllPasswordIdentityProvider[Allow All]. endif::[] - Deploy an xref:../registry/index.adoc#install-config-registry-overview[integrated Docker registry]. - Deploy a xref:../router/index.adoc#install-config-router-overview[router]. ifdef::openshift-origin[] - xref:../../install_config/imagestreams_templates.adoc#install-config-imagestreams-templates[Populate your {product-title} installation] with a useful set of Red Hat-provided image streams and templates. endif::[] ",12514,False,2237.8403577821464,median "/*============================================================================= Boost.Wave: A Standard compliant C++ preprocessor library http://www.boost.org/ Copyright (c) 2001 by Andrei Alexandrescu. Distributed under the Boost Software License, Version 1.0. (See accompanying file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) =============================================================================*/ // This code is taken from: // Andrei Alexandrescu, Generic: A Policy-Based basic_string // Implementation. http://www.cuj.com/documents/s=7994/cujcexp1906alexandr/ // // #HK030306: // - Moved into the namespace boost::wave::util // - Added a bunch of missing typename(s) // - Integrated with boost config // - Added a missing header include // - Added special constructors and operator= to allow CowString to be // a real COW-string (removed unnecessary data copying) // - Fixed a string terminating bug in append // // #HK040109: // - Incorporated the changes from Andrei's latest version of this class #ifndef FLEX_STRING_INC_ #define FLEX_STRING_INC_ /* //////////////////////////////////////////////////////////////////////////////// template class StoragePolicy { typedef E value_type; typedef @ iterator; typedef @ const_iterator; typedef A allocator_type; typedef @ size_type; StoragePolicy(const StoragePolicy& s); StoragePolicy(const A&); StoragePolicy(const E* s, size_type len, const A&); StoragePolicy(size_type len, E c, const A&); ~StoragePolicy(); iterator begin(); const_iterator begin() const; iterator end(); const_iterator end() const; size_type size() const; size_type max_size() const; size_type capacity() const; void reserve(size_type res_arg); void append(const E* s, size_type sz); template void append(InputIterator b, InputIterator e); void resize(size_type newSize, E fill); void swap(StoragePolicy& rhs); const E* c_str() const; const E* data() const; A get_allocator() const; }; //////////////////////////////////////////////////////////////////////////////// */ #include #include #include #include #include #include #include #include #include #include #include /////////////////////////////////////////////////////////////////////////////// namespace boost { namespace wave { namespace util { namespace flex_string_details { template inline void pod_fill(Pod* b, Pod* e, T c) { switch ((e - b) & 7) { case 0: while (b != e) { *b = c; ++b; case 7: *b = c; ++b; case 6: *b = c; ++b; case 5: *b = c; ++b; case 4: *b = c; ++b; case 3: *b = c; ++b; case 2: *b = c; ++b; case 1: *b = c; ++b; } } } template inline void pod_move(const Pod* b, const Pod* e, Pod* d) { using namespace std; memmove(d, b, (e - b) * sizeof(*b)); } template inline Pod* pod_copy(const Pod* b, const Pod* e, Pod* d) { const std::size_t s = e - b; using namespace std; memcpy(d, b, s * sizeof(*b)); return d + s; } template struct get_unsigned { typedef T result; }; template <> struct get_unsigned { typedef unsigned char result; }; template <> struct get_unsigned { typedef unsigned char result; }; template <> struct get_unsigned { typedef unsigned short int result; }; template <> struct get_unsigned { typedef unsigned int result; }; template <> struct get_unsigned { typedef unsigned long int result; }; enum Shallow {}; } template class mallocator { public: typedef T value_type; typedef value_type* pointer; typedef const value_type* const_pointer; typedef value_type& reference; typedef const value_type& const_reference; typedef std::size_t size_type; //typedef unsigned int size_type; //typedef std::ptrdiff_t difference_type; typedef int difference_type; template struct rebind { typedef mallocator other; }; mallocator() {} mallocator(const mallocator&) {} //template //mallocator(const mallocator&) {} ~mallocator() {} pointer address(reference x) const { return &x; } const_pointer address(const_reference x) const { return x; } pointer allocate(size_type n, const_pointer = 0) { using namespace std; void* p = malloc(n * sizeof(T)); if (!p) throw bad_alloc(); return static_cast(p); } void deallocate(pointer p, size_type) { using namespace std; free(p); } size_type max_size() const { return static_cast(-1) / sizeof(T); } void construct(pointer p, const value_type& x) { new(p) value_type(x); } void destroy(pointer p) { p->~value_type(); } private: void operator=(const mallocator&); }; template<> class mallocator { typedef void value_type; typedef void* pointer; typedef const void* const_pointer; template struct rebind { typedef mallocator other; }; }; template inline bool operator==(const mallocator&, const mallocator&) { return true; } template inline bool operator!=(const mallocator&, const mallocator&) { return false; } template typename Allocator::pointer Reallocate( Allocator& alloc, typename Allocator::pointer p, typename Allocator::size_type oldObjCount, typename Allocator::size_type newObjCount, void*) { // @@@ not implemented return NULL; } template typename Allocator::pointer Reallocate( Allocator& alloc, typename Allocator::pointer p, typename Allocator::size_type oldObjCount, typename Allocator::size_type newObjCount, mallocator*) { // @@@ not implemented return NULL; } //////////////////////////////////////////////////////////////////////////////// // class template SimpleStringStorage // Allocates memory with malloc //////////////////////////////////////////////////////////////////////////////// template > class SimpleStringStorage { // The ""public"" below exists because MSVC can't do template typedefs public: struct Data { Data() : pEnd_(buffer_), pEndOfMem_(buffer_) { buffer_[0] = E(0); } E* pEnd_; E* pEndOfMem_; E buffer_[1]; }; static const Data emptyString_; typedef typename A::size_type size_type; private: Data* pData_; void Init(size_type size, size_type capacity) { BOOST_ASSERT(size <= capacity); if (capacity == 0) { pData_ = const_cast(&emptyString_); } else { // 11-17-2000: comment added: // No need to allocate (capacity + 1) to // accomodate the terminating 0, because Data already // has one one character in there pData_ = static_cast( malloc(sizeof(Data) + capacity * sizeof(E))); if (!pData_) throw std::bad_alloc(); pData_->pEnd_ = pData_->buffer_ + size; pData_->pEndOfMem_ = pData_->buffer_ + capacity; } } private: // Warning - this doesn't initialize pData_. Used in reserve() SimpleStringStorage() { } public: typedef E value_type; typedef E* iterator; typedef const E* const_iterator; typedef A allocator_type; SimpleStringStorage(const SimpleStringStorage& rhs) { const size_type sz = rhs.size(); Init(sz, sz); if (sz) flex_string_details::pod_copy(rhs.begin(), rhs.end(), begin()); } SimpleStringStorage(const SimpleStringStorage& s, flex_string_details::Shallow) : pData_(s.pData_) { } SimpleStringStorage(const A&) { pData_ = const_cast(&emptyString_); } SimpleStringStorage(const E* s, size_type len, const A&) { Init(len, len); flex_string_details::pod_copy(s, s + len, begin()); } SimpleStringStorage(size_type len, E c, const A&) { Init(len, len); flex_string_details::pod_fill(begin(), end(), c); } SimpleStringStorage& operator=(const SimpleStringStorage& rhs) { const size_type sz = rhs.size(); reserve(sz); flex_string_details::pod_copy(&*rhs.begin(), &*rhs.end(), begin()); pData_->pEnd_ = &*begin() + sz; return *this; } ~SimpleStringStorage() { BOOST_ASSERT(begin() <= end()); if (pData_ != &emptyString_) free(pData_); } iterator begin() { return pData_->buffer_; } const_iterator begin() const { return pData_->buffer_; } iterator end() { return pData_->pEnd_; } const_iterator end() const { return pData_->pEnd_; } size_type size() const { return pData_->pEnd_ - pData_->buffer_; } size_type max_size() const { return std::size_t(-1) / sizeof(E) - sizeof(Data) - 1; } size_type capacity() const { return pData_->pEndOfMem_ - pData_->buffer_; } void reserve(size_type res_arg) { if (res_arg <= capacity()) { // @@@ insert shrinkage here if you wish return; } if (pData_ == &emptyString_) { Init(0, res_arg); } else { const size_type sz = size(); void* p = realloc(pData_, sizeof(Data) + res_arg * sizeof(E)); if (!p) throw std::bad_alloc(); if (p != pData_) { pData_ = static_cast(p); pData_->pEnd_ = pData_->buffer_ + sz; } pData_->pEndOfMem_ = pData_->buffer_ + res_arg; } } void append(const E* s, size_type sz) { const size_type neededCapacity = size() + sz; if (capacity() < neededCapacity) { const iterator b = begin(); static std::less_equal

app works!

app works!

Your Number:

{{data.accessCodeVisitor.ticketNumber}}

Currently Being Attended:

{{data.accessCodeAttended?.ticketNumber}}

The queue is not active try again later

$1

$1

$1

$1

{ lv_text }