The resource identifier stream processor is an extension to register a resource name with a reference in a static map and serve a static resources count for a specific resource name.
This extension is a resource batch (tumbling) window that holds a number of events based on the resource count inferred from the 'env:resourceIdentifier' extension, and with a specific attribute as the grouping key. The window is updated each time a batch of events arrive with a matching value for the grouping key, and where the number of events is equal to the resource count.
56 |
57 | ## How to Contribute
58 |
59 | * Please report issues at GitHub Issue Tracker.
60 |
61 | * Send your contributions as pull requests to master branch.
62 |
63 | ## Contact us
64 |
65 | * Post your questions with the "Siddhi" tag in Stackoverflow.
66 |
67 | * Siddhi developers can be contacted via the mailing lists:
68 |
69 | Developers List : [dev@wso2.org](mailto:dev@wso2.org)
70 |
71 | Architecture List : [architecture@wso2.org](mailto:architecture@wso2.org)
72 |
73 | ## Support
74 |
75 | * We are committed to ensuring support for this extension in production. Our unique approach ensures that all support leverages our open development methodology and is provided by the very same engineers who build the technology.
76 |
77 | * For more details and to take advantage of this unique opportunity contact us via http://wso2.com/support/.
78 |
--------------------------------------------------------------------------------
/docs/index.md:
--------------------------------------------------------------------------------
1 | Siddhi Execution Extension - Env
2 | ======================================
3 |
4 | The **siddhi-execution-env extension** is an extension to Siddhi that provides the capability to read environment properties inside Siddhi stream definitions and use it inside queries. Functions of the env extension are as follows..
5 |
6 | Find some useful links below:
7 |
8 | * Source code
9 | * Releases
10 | * Issue tracker
11 |
12 | ## Latest API Docs
13 |
14 | Latest API Docs is 1.0.13.
15 |
16 | ## How to use
17 |
18 | **Using the extension in WSO2 Stream Processor**
19 |
20 | * You can use this extension in the latest WSO2 Stream Processor that is a part of WSO2 Analytics offering, with editor, debugger and simulation support.
21 |
22 | * This extension is shipped by default with WSO2 Stream Processor, if you wish to use an alternative version of this extension you can replace the component jar that can be found in the `/lib`
23 | directory.
24 |
25 | **Using the extension as a java library**
26 |
27 | * This extension can be added as a maven dependency along with other Siddhi dependencies to your project.
28 |
29 | ```
30 |
31 | org.wso2.extension.siddhi.execution.env
32 | siddhi-execution-env
33 | x.x.x
34 |
35 | ```
36 |
37 | ## Jenkins Build Status
38 |
39 | ---
40 |
41 | | Branch | Build Status |
42 | | :------ |:------------ |
43 | | master | [](https://wso2.org/jenkins/view/All%20Builds/job/siddhi/job/siddhi-execution-env/) |
44 |
45 | ---
46 |
47 | ## Features
48 |
49 | * getEnvironmentProperty *(Function)*
This function returns the Java environment property that corresponds with the key provided
The resource identifier stream processor is an extension to register a resource name with a reference in a static map and serve a static resources count for a specific resource name.
This extension is a resource batch (tumbling) window that holds a number of events based on the resource count inferred from the 'env:resourceIdentifier' extension, and with a specific attribute as the grouping key. The window is updated each time a batch of events arrive with a matching value for the grouping key, and where the number of events is equal to the resource count.
56 |
57 | ## How to Contribute
58 |
59 | * Please report issues at GitHub Issue Tracker.
60 |
61 | * Send your contributions as pull requests to master branch.
62 |
63 | ## Contact us
64 |
65 | * Post your questions with the "Siddhi" tag in Stackoverflow.
66 |
67 | * Siddhi developers can be contacted via the mailing lists:
68 |
69 | Developers List : [dev@wso2.org](mailto:dev@wso2.org)
70 |
71 | Architecture List : [architecture@wso2.org](mailto:architecture@wso2.org)
72 |
73 | ## Support
74 |
75 | * We are committed to ensuring support for this extension in production. Our unique approach ensures that all support leverages our open development methodology and is provided by the very same engineers who build the technology.
76 |
77 | * For more details and to take advantage of this unique opportunity contact us via http://wso2.com/support/.
78 |
--------------------------------------------------------------------------------
/component/src/test/java/org/wso2/extension/siddhi/execution/env/GetOriginIPFromXForwardedFunctionTestCase.java:
--------------------------------------------------------------------------------
1 | /*
2 | * Copyright (c) 2018, WSO2 Inc. (http://www.wso2.org) All Rights Reserved.
3 | *
4 | * WSO2 Inc. licenses this file to you under the Apache License,
5 | * Version 2.0 (the "License"); you may not use this file except
6 | * in compliance with the License.
7 | * You may obtain a copy of the License at
8 | *
9 | * http://www.apache.org/licenses/LICENSE-2.0
10 | *
11 | * Unless required by applicable law or agreed to in writing,
12 | * software distributed under the License is distributed on an
13 | * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
14 | * KIND, either express or implied. See the License for the
15 | * specific language governing permissions and limitations
16 | * under the License.
17 | */
18 |
19 | package org.wso2.extension.siddhi.execution.env;
20 |
21 | import org.apache.log4j.Logger;
22 | import org.testng.AssertJUnit;
23 | import org.testng.annotations.BeforeMethod;
24 | import org.testng.annotations.Test;
25 | import org.wso2.siddhi.core.SiddhiAppRuntime;
26 | import org.wso2.siddhi.core.SiddhiManager;
27 | import org.wso2.siddhi.core.event.Event;
28 | import org.wso2.siddhi.core.query.output.callback.QueryCallback;
29 | import org.wso2.siddhi.core.stream.input.InputHandler;
30 | import org.wso2.siddhi.core.util.EventPrinter;
31 |
32 | import java.util.concurrent.atomic.AtomicInteger;
33 |
34 | public class GetOriginIPFromXForwardedFunctionTestCase {
35 | private static Logger logger = Logger.getLogger(GetOriginIPFromXForwardedFunctionTestCase.class);
36 | private AtomicInteger count = new AtomicInteger(0);
37 | private volatile boolean eventArrived;
38 |
39 | @BeforeMethod
40 | public void init() {
41 | count.set(0);
42 | eventArrived = false;
43 | }
44 |
45 | @Test
46 | public void testDefaultBehaviour1() throws Exception {
47 | logger.info("GetOriginIPFromXForwardedFunction default behaviour testCase");
48 | SiddhiManager siddhiManager = new SiddhiManager();
49 | String stream = "define stream inputStream (xForwardedHeader string);\n";
50 | String query = ("@info(name = 'query1') from inputStream \n"
51 | + "select env:getOriginIPFromXForwarded(xForwardedHeader) as originIP \n" +
52 | "insert into outputStream;");
53 | SiddhiAppRuntime siddhiAppRuntime = siddhiManager.createSiddhiAppRuntime(stream + query);
54 | siddhiAppRuntime.addCallback("query1", new QueryCallback() {
55 | @Override
56 | public void receive(long timeStamp, Event[] inEvents,
57 | Event[] removeEvents) {
58 | EventPrinter.print(timeStamp, inEvents, removeEvents);
59 | for (Event event : inEvents) {
60 | count.incrementAndGet();
61 | switch (count.get()) {
62 | case 1:
63 | AssertJUnit.assertEquals(null, event.getData(0));
64 | eventArrived = true;
65 | break;
66 | case 2:
67 | AssertJUnit.assertEquals("203.160.190.196", event.getData(0));
68 | eventArrived = true;
69 | break;
70 | case 3:
71 | AssertJUnit.assertEquals(null, event.getData(0));
72 | eventArrived = true;
73 | break;
74 | case 4:
75 | AssertJUnit.assertEquals("203.160.190.198", event.getData(0));
76 | eventArrived = true;
77 | break;
78 | case 5:
79 | AssertJUnit.assertEquals("199.207.253.101", event.getData(0));
80 | eventArrived = true;
81 | break;
82 | case 6:
83 | AssertJUnit.assertEquals("208.160.190.198", event.getData(0));
84 | eventArrived = true;
85 | break;
86 | case 7:
87 | AssertJUnit.assertEquals("210.160.190.198", event.getData(0));
88 | eventArrived = true;
89 | break;
90 | case 8:
91 | AssertJUnit.assertEquals("70.41.3.18", event.getData(0));
92 | eventArrived = true;
93 | break;
94 | case 9:
95 | AssertJUnit.assertEquals("70.41.3.18", event.getData(0));
96 | eventArrived = true;
97 | break;
98 | case 10:
99 | AssertJUnit.assertEquals("70.41.3.18", event.getData(0));
100 | eventArrived = true;
101 | break;
102 | case 11:
103 | AssertJUnit.assertEquals("14.3.49.206", event.getData(0));
104 | eventArrived = true;
105 | break;
106 | case 12:
107 | AssertJUnit.assertEquals("210.160.190.217", event.getData(0));
108 | eventArrived = true;
109 | break;
110 | case 13:
111 | AssertJUnit.assertEquals("210.160.180.117", event.getData(0));
112 | eventArrived = true;
113 | break;
114 | }
115 | }
116 | }
117 | });
118 | InputHandler inputHandler = siddhiAppRuntime.getInputHandler("inputStream");
119 | siddhiAppRuntime.start();
120 | inputHandler.send(new Object[]{" "});
121 | inputHandler.send(new Object[]{"203.160.190.196,10.1.1.1"});
122 | inputHandler.send(new String[]{"192.168.1.103"});
123 | inputHandler.send(new String[]{"192.168.1.103, 203.160.190.198"});
124 | inputHandler.send(new String[]{"10.3.49.206, 199.207.253.101"});
125 | inputHandler.send(new String[]{"10.3.49.206, 192.168.1.103, 208.160.190.198"});
126 | inputHandler.send(new String[]{"10.3.50.233, 192.168.1.103, 210.160.190.198"});
127 | inputHandler.send(new String[]{"10.4.49.234, 70.41.3.18 , 210.160.190.200"});
128 | inputHandler.send(new String[]{"10.5.49.216, 70.41.3.18, 192.168.1.103, 210.160.190.208"});
129 | inputHandler.send(new String[]{"10.3.39.226, 70.41.3.18, 192.168.1.103, a.a.a.a"});
130 | inputHandler.send(new String[]{"14.3.49.206, , 192.168.1.103, 210.160.190.208"});
131 | inputHandler.send(new String[]{", a.a.a.a, 192.168.1.103, 210.160.190.217"});
132 | inputHandler.send(new String[]{",, 192.168.1.103, 210.160.180.117"});
133 | AssertJUnit.assertEquals(13, count.get());
134 | AssertJUnit.assertTrue(eventArrived);
135 | siddhiAppRuntime.shutdown();
136 | }
137 | }
138 |
--------------------------------------------------------------------------------
/docs/images/siddhi-logo-w.svg:
--------------------------------------------------------------------------------
1 |
2 |
19 |
20 |
163 |
--------------------------------------------------------------------------------
/docs/api/1.0.0.md:
--------------------------------------------------------------------------------
1 | # API Docs - v1.0.0
2 |
3 | ## Env
4 |
5 | ### getEnvironmentProperty *(Function)*
6 |
7 |
This function returns Java environment property corresponding to the key provided
A string constant parameter expressing the data type of the propertyusing one of the following string values: int, long, float, double, string, bool.
190 |
string
191 |
STRING
192 |
No
193 |
No
194 |
195 |
196 |
default.value
197 |
This specifies the default Value to be returned if the property value is not available.
198 |
null
199 |
INT LONG DOUBLE FLOAT STRING BOOL
200 |
Yes
201 |
No
202 |
203 |
204 |
205 | Examples
206 | EXAMPLE 1
207 | ```
208 | define stream keyStream (key string);
209 | from keyStream env:getYAMLProperty(key) as FunctionOutput
210 | insert into outputStream;
211 | ```
212 |
This query returns corresponding YAML property for the corresponding key from keyStream as FunctionOutput to the outputStream
213 |
214 |
--------------------------------------------------------------------------------
/docs/license.md:
--------------------------------------------------------------------------------
1 | Copyright (c) 2018 WSO2 Inc. () All Rights Reserved.
2 |
3 | WSO2 Inc. licenses this file to you under the Apache License,
4 | Version 2.0 (the "License"); you may not use this file except
5 | in compliance with the License.
6 | You may obtain a copy of the License at
7 |
8 |
9 |
10 | Unless required by applicable law or agreed to in writing,
11 | software distributed under the License is distributed on an
12 | "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
13 | KIND, either express or implied. See the License for the
14 | specific language governing permissions and limitations
15 | under the License.
16 |
17 | ```
18 | -------------------------------------------------------------------------
19 | Apache License
20 | Version 2.0, January 2004
21 | http://www.apache.org/licenses/
22 |
23 |
24 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
25 |
26 | 1. Definitions.
27 |
28 | "License" shall mean the terms and conditions for use, reproduction,
29 | and distribution as defined by Sections 1 through 9 of this document.
30 |
31 | "Licensor" shall mean the copyright owner or entity authorized by
32 | the copyright owner that is granting the License.
33 |
34 | "Legal Entity" shall mean the union of the acting entity and all
35 | other entities that control, are controlled by, or are under common
36 | control with that entity. For the purposes of this definition,
37 | "control" means (i) the power, direct or indirect, to cause the
38 | direction or management of such entity, whether by contract or
39 | otherwise, or (ii) ownership of fifty percent (50%) or more of the
40 | outstanding shares, or (iii) beneficial ownership of such entity.
41 |
42 | "You" (or "Your") shall mean an individual or Legal Entity
43 | exercising permissions granted by this License.
44 |
45 | "Source" form shall mean the preferred form for making modifications,
46 | including but not limited to software source code, documentation
47 | source, and configuration files.
48 |
49 | "Object" form shall mean any form resulting from mechanical
50 | transformation or translation of a Source form, including but
51 | not limited to compiled object code, generated documentation,
52 | and conversions to other media types.
53 |
54 | "Work" shall mean the work of authorship, whether in Source or
55 | Object form, made available under the License, as indicated by a
56 | copyright notice that is included in or attached to the work
57 | (an example is provided in the Appendix below).
58 |
59 | "Derivative Works" shall mean any work, whether in Source or Object
60 | form, that is based on (or derived from) the Work and for which the
61 | editorial revisions, annotations, elaborations, or other modifications
62 | represent, as a whole, an original work of authorship. For the purposes
63 | of this License, Derivative Works shall not include works that remain
64 | separable from, or merely link (or bind by name) to the interfaces of,
65 | the Work and Derivative Works thereof.
66 |
67 | "Contribution" shall mean any work of authorship, including
68 | the original version of the Work and any modifications or additions
69 | to that Work or Derivative Works thereof, that is intentionally
70 | submitted to Licensor for inclusion in the Work by the copyright owner
71 | or by an individual or Legal Entity authorized to submit on behalf of
72 | the copyright owner. For the purposes of this definition, "submitted"
73 | means any form of electronic, verbal, or written communication sent
74 | to the Licensor or its representatives, including but not limited to
75 | communication on electronic mailing lists, source code control systems,
76 | and issue tracking systems that are managed by, or on behalf of, the
77 | Licensor for the purpose of discussing and improving the Work, but
78 | excluding communication that is conspicuously marked or otherwise
79 | designated in writing by the copyright owner as "Not a Contribution."
80 |
81 | "Contributor" shall mean Licensor and any individual or Legal Entity
82 | on behalf of whom a Contribution has been received by Licensor and
83 | subsequently incorporated within the Work.
84 |
85 | 2. Grant of Copyright License. Subject to the terms and conditions of
86 | this License, each Contributor hereby grants to You a perpetual,
87 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable
88 | copyright license to reproduce, prepare Derivative Works of,
89 | publicly display, publicly perform, sublicense, and distribute the
90 | Work and such Derivative Works in Source or Object form.
91 |
92 | 3. Grant of Patent License. Subject to the terms and conditions of
93 | this License, each Contributor hereby grants to You a perpetual,
94 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable
95 | (except as stated in this section) patent license to make, have made,
96 | use, offer to sell, sell, import, and otherwise transfer the Work,
97 | where such license applies only to those patent claims licensable
98 | by such Contributor that are necessarily infringed by their
99 | Contribution(s) alone or by combination of their Contribution(s)
100 | with the Work to which such Contribution(s) was submitted. If You
101 | institute patent litigation against any entity (including a
102 | cross-claim or counterclaim in a lawsuit) alleging that the Work
103 | or a Contribution incorporated within the Work constitutes direct
104 | or contributory patent infringement, then any patent licenses
105 | granted to You under this License for that Work shall terminate
106 | as of the date such litigation is filed.
107 |
108 | 4. Redistribution. You may reproduce and distribute copies of the
109 | Work or Derivative Works thereof in any medium, with or without
110 | modifications, and in Source or Object form, provided that You
111 | meet the following conditions:
112 |
113 | (a) You must give any other recipients of the Work or
114 | Derivative Works a copy of this License; and
115 |
116 | (b) You must cause any modified files to carry prominent notices
117 | stating that You changed the files; and
118 |
119 | (c) You must retain, in the Source form of any Derivative Works
120 | that You distribute, all copyright, patent, trademark, and
121 | attribution notices from the Source form of the Work,
122 | excluding those notices that do not pertain to any part of
123 | the Derivative Works; and
124 |
125 | (d) If the Work includes a "NOTICE" text file as part of its
126 | distribution, then any Derivative Works that You distribute must
127 | include a readable copy of the attribution notices contained
128 | within such NOTICE file, excluding those notices that do not
129 | pertain to any part of the Derivative Works, in at least one
130 | of the following places: within a NOTICE text file distributed
131 | as part of the Derivative Works; within the Source form or
132 | documentation, if provided along with the Derivative Works; or,
133 | within a display generated by the Derivative Works, if and
134 | wherever such third-party notices normally appear. The contents
135 | of the NOTICE file are for informational purposes only and
136 | do not modify the License. You may add Your own attribution
137 | notices within Derivative Works that You distribute, alongside
138 | or as an addendum to the NOTICE text from the Work, provided
139 | that such additional attribution notices cannot be construed
140 | as modifying the License.
141 |
142 | You may add Your own copyright statement to Your modifications and
143 | may provide additional or different license terms and conditions
144 | for use, reproduction, or distribution of Your modifications, or
145 | for any such Derivative Works as a whole, provided Your use,
146 | reproduction, and distribution of the Work otherwise complies with
147 | the conditions stated in this License.
148 |
149 | 5. Submission of Contributions. Unless You explicitly state otherwise,
150 | any Contribution intentionally submitted for inclusion in the Work
151 | by You to the Licensor shall be under the terms and conditions of
152 | this License, without any additional terms or conditions.
153 | Notwithstanding the above, nothing herein shall supersede or modify
154 | the terms of any separate license agreement you may have executed
155 | with Licensor regarding such Contributions.
156 |
157 | 6. Trademarks. This License does not grant permission to use the trade
158 | names, trademarks, service marks, or product names of the Licensor,
159 | except as required for reasonable and customary use in describing the
160 | origin of the Work and reproducing the content of the NOTICE file.
161 |
162 | 7. Disclaimer of Warranty. Unless required by applicable law or
163 | agreed to in writing, Licensor provides the Work (and each
164 | Contributor provides its Contributions) on an "AS IS" BASIS,
165 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
166 | implied, including, without limitation, any warranties or conditions
167 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
168 | PARTICULAR PURPOSE. You are solely responsible for determining the
169 | appropriateness of using or redistributing the Work and assume any
170 | risks associated with Your exercise of permissions under this License.
171 |
172 | 8. Limitation of Liability. In no event and under no legal theory,
173 | whether in tort (including negligence), contract, or otherwise,
174 | unless required by applicable law (such as deliberate and grossly
175 | negligent acts) or agreed to in writing, shall any Contributor be
176 | liable to You for damages, including any direct, indirect, special,
177 | incidental, or consequential damages of any character arising as a
178 | result of this License or out of the use or inability to use the
179 | Work (including but not limited to damages for loss of goodwill,
180 | work stoppage, computer failure or malfunction, or any and all
181 | other commercial damages or losses), even if such Contributor
182 | has been advised of the possibility of such damages.
183 |
184 | 9. Accepting Warranty or Additional Liability. While redistributing
185 | the Work or Derivative Works thereof, You may choose to offer,
186 | and charge a fee for, acceptance of support, warranty, indemnity,
187 | or other liability obligations and/or rights consistent with this
188 | License. However, in accepting such obligations, You may act only
189 | on Your own behalf and on Your sole responsibility, not on behalf
190 | of any other Contributor, and only if You agree to indemnify,
191 | defend, and hold each Contributor harmless for any liability
192 | incurred by, or claims asserted against, such Contributor by reason
193 | of your accepting any such warranty or additional liability.
194 |
195 | END OF TERMS AND CONDITIONS
196 | ```
197 |
--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
1 | Apache License
2 | Version 2.0, January 2004
3 | http://www.apache.org/licenses/
4 |
5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6 |
7 | 1. Definitions.
8 |
9 | "License" shall mean the terms and conditions for use, reproduction,
10 | and distribution as defined by Sections 1 through 9 of this document.
11 |
12 | "Licensor" shall mean the copyright owner or entity authorized by
13 | the copyright owner that is granting the License.
14 |
15 | "Legal Entity" shall mean the union of the acting entity and all
16 | other entities that control, are controlled by, or are under common
17 | control with that entity. For the purposes of this definition,
18 | "control" means (i) the power, direct or indirect, to cause the
19 | direction or management of such entity, whether by contract or
20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the
21 | outstanding shares, or (iii) beneficial ownership of such entity.
22 |
23 | "You" (or "Your") shall mean an individual or Legal Entity
24 | exercising permissions granted by this License.
25 |
26 | "Source" form shall mean the preferred form for making modifications,
27 | including but not limited to software source code, documentation
28 | source, and configuration files.
29 |
30 | "Object" form shall mean any form resulting from mechanical
31 | transformation or translation of a Source form, including but
32 | not limited to compiled object code, generated documentation,
33 | and conversions to other media types.
34 |
35 | "Work" shall mean the work of authorship, whether in Source or
36 | Object form, made available under the License, as indicated by a
37 | copyright notice that is included in or attached to the work
38 | (an example is provided in the Appendix below).
39 |
40 | "Derivative Works" shall mean any work, whether in Source or Object
41 | form, that is based on (or derived from) the Work and for which the
42 | editorial revisions, annotations, elaborations, or other modifications
43 | represent, as a whole, an original work of authorship. For the purposes
44 | of this License, Derivative Works shall not include works that remain
45 | separable from, or merely link (or bind by name) to the interfaces of,
46 | the Work and Derivative Works thereof.
47 |
48 | "Contribution" shall mean any work of authorship, including
49 | the original version of the Work and any modifications or additions
50 | to that Work or Derivative Works thereof, that is intentionally
51 | submitted to Licensor for inclusion in the Work by the copyright owner
52 | or by an individual or Legal Entity authorized to submit on behalf of
53 | the copyright owner. For the purposes of this definition, "submitted"
54 | means any form of electronic, verbal, or written communication sent
55 | to the Licensor or its representatives, including but not limited to
56 | communication on electronic mailing lists, source code control systems,
57 | and issue tracking systems that are managed by, or on behalf of, the
58 | Licensor for the purpose of discussing and improving the Work, but
59 | excluding communication that is conspicuously marked or otherwise
60 | designated in writing by the copyright owner as "Not a Contribution."
61 |
62 | "Contributor" shall mean Licensor and any individual or Legal Entity
63 | on behalf of whom a Contribution has been received by Licensor and
64 | subsequently incorporated within the Work.
65 |
66 | 2. Grant of Copyright License. Subject to the terms and conditions of
67 | this License, each Contributor hereby grants to You a perpetual,
68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69 | copyright license to reproduce, prepare Derivative Works of,
70 | publicly display, publicly perform, sublicense, and distribute the
71 | Work and such Derivative Works in Source or Object form.
72 |
73 | 3. Grant of Patent License. Subject to the terms and conditions of
74 | this License, each Contributor hereby grants to You a perpetual,
75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76 | (except as stated in this section) patent license to make, have made,
77 | use, offer to sell, sell, import, and otherwise transfer the Work,
78 | where such license applies only to those patent claims licensable
79 | by such Contributor that are necessarily infringed by their
80 | Contribution(s) alone or by combination of their Contribution(s)
81 | with the Work to which such Contribution(s) was submitted. If You
82 | institute patent litigation against any entity (including a
83 | cross-claim or counterclaim in a lawsuit) alleging that the Work
84 | or a Contribution incorporated within the Work constitutes direct
85 | or contributory patent infringement, then any patent licenses
86 | granted to You under this License for that Work shall terminate
87 | as of the date such litigation is filed.
88 |
89 | 4. Redistribution. You may reproduce and distribute copies of the
90 | Work or Derivative Works thereof in any medium, with or without
91 | modifications, and in Source or Object form, provided that You
92 | meet the following conditions:
93 |
94 | (a) You must give any other recipients of the Work or
95 | Derivative Works a copy of this License; and
96 |
97 | (b) You must cause any modified files to carry prominent notices
98 | stating that You changed the files; and
99 |
100 | (c) You must retain, in the Source form of any Derivative Works
101 | that You distribute, all copyright, patent, trademark, and
102 | attribution notices from the Source form of the Work,
103 | excluding those notices that do not pertain to any part of
104 | the Derivative Works; and
105 |
106 | (d) If the Work includes a "NOTICE" text file as part of its
107 | distribution, then any Derivative Works that You distribute must
108 | include a readable copy of the attribution notices contained
109 | within such NOTICE file, excluding those notices that do not
110 | pertain to any part of the Derivative Works, in at least one
111 | of the following places: within a NOTICE text file distributed
112 | as part of the Derivative Works; within the Source form or
113 | documentation, if provided along with the Derivative Works; or,
114 | within a display generated by the Derivative Works, if and
115 | wherever such third-party notices normally appear. The contents
116 | of the NOTICE file are for informational purposes only and
117 | do not modify the License. You may add Your own attribution
118 | notices within Derivative Works that You distribute, alongside
119 | or as an addendum to the NOTICE text from the Work, provided
120 | that such additional attribution notices cannot be construed
121 | as modifying the License.
122 |
123 | You may add Your own copyright statement to Your modifications and
124 | may provide additional or different license terms and conditions
125 | for use, reproduction, or distribution of Your modifications, or
126 | for any such Derivative Works as a whole, provided Your use,
127 | reproduction, and distribution of the Work otherwise complies with
128 | the conditions stated in this License.
129 |
130 | 5. Submission of Contributions. Unless You explicitly state otherwise,
131 | any Contribution intentionally submitted for inclusion in the Work
132 | by You to the Licensor shall be under the terms and conditions of
133 | this License, without any additional terms or conditions.
134 | Notwithstanding the above, nothing herein shall supersede or modify
135 | the terms of any separate license agreement you may have executed
136 | with Licensor regarding such Contributions.
137 |
138 | 6. Trademarks. This License does not grant permission to use the trade
139 | names, trademarks, service marks, or product names of the Licensor,
140 | except as required for reasonable and customary use in describing the
141 | origin of the Work and reproducing the content of the NOTICE file.
142 |
143 | 7. Disclaimer of Warranty. Unless required by applicable law or
144 | agreed to in writing, Licensor provides the Work (and each
145 | Contributor provides its Contributions) on an "AS IS" BASIS,
146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147 | implied, including, without limitation, any warranties or conditions
148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149 | PARTICULAR PURPOSE. You are solely responsible for determining the
150 | appropriateness of using or redistributing the Work and assume any
151 | risks associated with Your exercise of permissions under this License.
152 |
153 | 8. Limitation of Liability. In no event and under no legal theory,
154 | whether in tort (including negligence), contract, or otherwise,
155 | unless required by applicable law (such as deliberate and grossly
156 | negligent acts) or agreed to in writing, shall any Contributor be
157 | liable to You for damages, including any direct, indirect, special,
158 | incidental, or consequential damages of any character arising as a
159 | result of this License or out of the use or inability to use the
160 | Work (including but not limited to damages for loss of goodwill,
161 | work stoppage, computer failure or malfunction, or any and all
162 | other commercial damages or losses), even if such Contributor
163 | has been advised of the possibility of such damages.
164 |
165 | 9. Accepting Warranty or Additional Liability. While redistributing
166 | the Work or Derivative Works thereof, You may choose to offer,
167 | and charge a fee for, acceptance of support, warranty, indemnity,
168 | or other liability obligations and/or rights consistent with this
169 | License. However, in accepting such obligations, You may act only
170 | on Your own behalf and on Your sole responsibility, not on behalf
171 | of any other Contributor, and only if You agree to indemnify,
172 | defend, and hold each Contributor harmless for any liability
173 | incurred by, or claims asserted against, such Contributor by reason
174 | of your accepting any such warranty or additional liability.
175 |
176 | END OF TERMS AND CONDITIONS
177 |
178 | APPENDIX: How to apply the Apache License to your work.
179 |
180 | To apply the Apache License to your work, attach the following
181 | boilerplate notice, with the fields enclosed by brackets "[]"
182 | replaced with your own identifying information. (Don't include
183 | the brackets!) The text should be enclosed in the appropriate
184 | comment syntax for the file format. We also recommend that a
185 | file or class name and description of purpose be included on the
186 | same "printed page" as the copyright notice for easier
187 | identification within third-party archives.
188 |
189 | Copyright [yyyy] [name of copyright owner]
190 |
191 | Licensed under the Apache License, Version 2.0 (the "License");
192 | you may not use this file except in compliance with the License.
193 | You may obtain a copy of the License at
194 |
195 | http://www.apache.org/licenses/LICENSE-2.0
196 |
197 | Unless required by applicable law or agreed to in writing, software
198 | distributed under the License is distributed on an "AS IS" BASIS,
199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200 | See the License for the specific language governing permissions and
201 | limitations under the License.
202 |
--------------------------------------------------------------------------------
/component/src/main/java/org/wso2/extension/siddhi/execution/env/GetYAMLPropertyFunction.java:
--------------------------------------------------------------------------------
1 | /*
2 | * Copyright (c) 2018, WSO2 Inc. (http://www.wso2.org) All Rights Reserved.
3 | *
4 | * WSO2 Inc. licenses this file to you under the Apache License,
5 | * Version 2.0 (the "License"); you may not use this file except
6 | * in compliance with the License.
7 | * You may obtain a copy of the License at
8 | *
9 | * http://www.apache.org/licenses/LICENSE-2.0
10 | *
11 | * Unless required by applicable law or agreed to in writing,
12 | * software distributed under the License is distributed on an
13 | * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
14 | * KIND, either express or implied. See the License for the
15 | * specific language governing permissions and limitations
16 | * under the License.
17 | */
18 |
19 | package org.wso2.extension.siddhi.execution.env;
20 |
21 | import org.wso2.siddhi.annotation.Example;
22 | import org.wso2.siddhi.annotation.Extension;
23 | import org.wso2.siddhi.annotation.Parameter;
24 | import org.wso2.siddhi.annotation.ReturnAttribute;
25 | import org.wso2.siddhi.annotation.util.DataType;
26 | import org.wso2.siddhi.core.config.SiddhiAppContext;
27 | import org.wso2.siddhi.core.exception.SiddhiAppRuntimeException;
28 | import org.wso2.siddhi.core.executor.ConstantExpressionExecutor;
29 | import org.wso2.siddhi.core.executor.ExpressionExecutor;
30 | import org.wso2.siddhi.core.executor.function.FunctionExecutor;
31 | import org.wso2.siddhi.core.util.config.ConfigReader;
32 | import org.wso2.siddhi.query.api.definition.Attribute;
33 | import org.wso2.siddhi.query.api.exception.SiddhiAppValidationException;
34 |
35 | import java.util.Map;
36 |
37 | /**
38 | * Siddhi Function getYAMLProperty to read property values from deployment.yaml.
39 | */
40 |
41 | @Extension(
42 | name = "getYAMLProperty",
43 | namespace = "env",
44 | description = "This function returns the YAML property requested or the default values specified if such a" +
45 | "variable is not specified in the 'deployment.yaml'.",
46 | parameters = {
47 | @Parameter(name = "key",
48 | description = "This specifies key of the property to be read.",
49 | type = {DataType.STRING},
50 | optional = false),
51 | @Parameter(name = "data.type",
52 | description = "A string constant parameter expressing the data type of the property" +
53 | "using one of the following string values:\n int, long, float, double, string, bool.",
54 | type = {DataType.STRING},
55 | optional = false,
56 | defaultValue = "string"),
57 | @Parameter(name = "default.value",
58 | description = "This specifies the default value to be returned " +
59 | "if the property value is not available.",
60 | type = {DataType.INT, DataType.LONG, DataType.DOUBLE, DataType.FLOAT,
61 | DataType.STRING, DataType.BOOL},
62 | optional = true,
63 | defaultValue = "null")
64 | },
65 | returnAttributes = @ReturnAttribute(
66 | description = "The default return type is 'string', but it can also be any of the following:\n " +
67 | "'int', 'long', 'float', 'double', 'string',' bool'.",
68 | type = {org.wso2.siddhi.annotation.util.DataType.INT, org.wso2.siddhi.annotation.util.DataType.LONG,
69 | org.wso2.siddhi.annotation.util.DataType.DOUBLE, org.wso2.siddhi.annotation.util.DataType.FLOAT,
70 | org.wso2.siddhi.annotation.util.DataType.STRING, org.wso2.siddhi.annotation.util.DataType.BOOL
71 | }),
72 | examples = {
73 | @Example(
74 | syntax = "define stream KeyStream (key string);\n" +
75 | "from KeyStream env:getYAMLProperty(key) as FunctionOutput \n" +
76 | "insert into outputStream;",
77 | description = "This query returns the corresponding YAML property for the corresponding key " +
78 | "from the 'KeyStream' stream as 'FunctionOutput', and inserts it into the to the" +
79 | " 'OutputStream' stream."
80 | )
81 | }
82 | )
83 |
84 | public class GetYAMLPropertyFunction extends FunctionExecutor {
85 |
86 | private ConfigReader configReader;
87 | private Attribute.Type returnType = Attribute.Type.STRING;
88 | private boolean hasDefaultValue = false;
89 |
90 | /**
91 | * The initialization method for TheFun, this method will be called before the other methods.
92 | *
93 | * @param attributeExpressionExecutors the executors of each function parameter.
94 | * @param siddhiAppContext the context of the execution plan.
95 | */
96 | protected void init(ExpressionExecutor[] attributeExpressionExecutors, ConfigReader reader,
97 | SiddhiAppContext siddhiAppContext) {
98 | int attributeExpressionExecutorsLength = attributeExpressionExecutors.length;
99 | if ((attributeExpressionExecutorsLength > 0) && (attributeExpressionExecutorsLength < 4)) {
100 | Attribute.Type typeofKeyAttribute = attributeExpressionExecutors[0].getReturnType();
101 | checkKeyAttribute(typeofKeyAttribute);
102 | if (attributeExpressionExecutorsLength > 1) {
103 | if (!(attributeExpressionExecutors[1] instanceof ConstantExpressionExecutor)) {
104 | throw new SiddhiAppValidationException("The second argument has to be a string constant " +
105 | "specifying one of the supported data types (int, long, float, double, string, bool)");
106 | } else {
107 | String type = attributeExpressionExecutors[1].execute(null).toString();
108 | returnType = getReturnType(type);
109 | }
110 | }
111 | if (attributeExpressionExecutors.length > 2) {
112 | Attribute.Type typeofDefaultValueAttribute = attributeExpressionExecutors[2].getReturnType();
113 | if (typeofDefaultValueAttribute != returnType) {
114 | throw new SiddhiAppValidationException("Type of parameter default.Value " +
115 | "needs to match parameter data.type");
116 | }
117 | }
118 | } else {
119 | throw new SiddhiAppValidationException("Invalid no of arguments passed to " +
120 | "env:getYAMLProperty(Key, data.type, default.value) function, " +
121 | "required 1,2 or 3, but found " + attributeExpressionExecutorsLength);
122 | }
123 |
124 | this.configReader = reader;
125 | hasDefaultValue = (attributeExpressionExecutorsLength > 2);
126 | }
127 |
128 | private Attribute.Type getReturnType(String type) {
129 | Attribute.Type theReturnType;
130 | if ("int".equalsIgnoreCase(type)) {
131 | theReturnType = Attribute.Type.INT;
132 | } else if ("long".equalsIgnoreCase(type)) {
133 | theReturnType = Attribute.Type.LONG;
134 | } else if ("float".equalsIgnoreCase(type)) {
135 | theReturnType = Attribute.Type.FLOAT;
136 | } else if ("double".equalsIgnoreCase(type)) {
137 | theReturnType = Attribute.Type.DOUBLE;
138 | } else if ("bool".equalsIgnoreCase(type)) {
139 | theReturnType = Attribute.Type.BOOL;
140 | } else if ("string".equalsIgnoreCase(type)) {
141 | theReturnType = Attribute.Type.STRING;
142 | } else {
143 | throw new SiddhiAppValidationException("Type must be one of int, long, float, double, bool, " +
144 | "string");
145 | }
146 | return theReturnType;
147 | }
148 |
149 | private void checkKeyAttribute(Attribute.Type typeofKeyAttribute) {
150 | if (typeofKeyAttribute != Attribute.Type.STRING) {
151 | throw new SiddhiAppValidationException("Invalid parameter type found " +
152 | "for the argument Key of getYAMLProperty() function, " +
153 | "required " + Attribute.Type.STRING +
154 | ", but found " + typeofKeyAttribute.toString());
155 | }
156 | }
157 |
158 | /**
159 | * The main execution method which will be called upon event arrival
160 | * when there are more than one function parameter.
161 | *
162 | * @param data the runtime values of function parameters.
163 | * @return the function result.
164 | */
165 |
166 | @Override
167 | protected Object execute(Object[] data) {
168 | String key = (String) data[0];
169 | String value = configReader.readConfig(key, null);
170 | if (value != null) {
171 | try {
172 | switch (returnType) {
173 | case INT:
174 | return Integer.parseInt(value);
175 | case LONG:
176 | return Long.parseLong(value);
177 | case FLOAT:
178 | return Float.parseFloat(value);
179 | case DOUBLE:
180 | return Double.parseDouble(value);
181 | case BOOL:
182 | return Boolean.parseBoolean(value);
183 | default: // case STRING:
184 | break;
185 | }
186 | return value;
187 | } catch (NumberFormatException e) {
188 | throw new SiddhiAppRuntimeException
189 | ("The type of property value and parameter dataType does not match");
190 | }
191 | } else {
192 | return ((hasDefaultValue) ? data[2] : null);
193 | }
194 | }
195 |
196 | /**
197 | * The main execution method which will be called upon event arrival
198 | * when there are zero or one function parameter.
199 | *
200 | * @param data null if the function parameter count is zero or
201 | * runtime data value of the function parameter.
202 | * @return the function result.
203 | */
204 | @Override
205 | protected Object execute(Object data) {
206 | if (data != null) {
207 | if (data instanceof String) {
208 | String key = (String) data;
209 | return configReader.readConfig(key, null);
210 | }
211 | } else {
212 | throw new SiddhiAppRuntimeException("Input to the getYAMLProperty function cannot be null");
213 | }
214 | return null;
215 | }
216 |
217 | /**
218 | * This will be called only once and this can be used to acquire
219 | * required resources for the processing element.
220 | * This will be called after initializing the system and before
221 | * starting to process the events.
222 | */
223 |
224 | @Override
225 | public Attribute.Type getReturnType() {
226 | return returnType;
227 | }
228 |
229 | /**
230 | * Used to collect the serializable state of the processing element, that need to be
231 | * persisted for the reconstructing the element to the same state on a different point of time.
232 | *
233 | * @return stateful objects of the processing element as an array.
234 | */
235 | @Override
236 | public Map currentState() {
237 | return null;
238 | }
239 |
240 | /**
241 | * Used to restore serialized state of the processing element, for reconstructing
242 | * the element to the same state as if was on a previous point of time.
243 | *
244 | * @param state the stateful objects of the element as an array on
245 | * the same order provided by currentState().
246 | */
247 | @Override
248 | public void restoreState(Map state) {
249 | //Implement restore state logic.
250 | }
251 |
252 | }
253 |
--------------------------------------------------------------------------------
/docs/api/1.0.4.md:
--------------------------------------------------------------------------------
1 | # API Docs - v1.0.4
2 |
3 | ## Env
4 |
5 | ### getEnvironmentProperty *(Function)*
6 |
7 |
This function returns Java environment property corresponding to the key provided