|
18 | 18 | package io.openmessaging;
|
19 | 19 |
|
20 | 20 | /**
|
21 |
| - * This is the centralized source for keys that are used by {@link KeyValue}. |
| 21 | + * This is the centralized source for keys that are used for OMS standard attributes. |
22 | 22 | *
|
23 | 23 | * @version OMS 1.0.0
|
24 | 24 | * @since OMS 1.0.0
|
25 | 25 | */
|
26 | 26 | public interface OMSBuiltinKeys {
|
| 27 | + /** |
| 28 | + * The {@code DRIVER_IMPL} key represents the vendor implementation |
| 29 | + * entry of {@link MessagingAccessPoint}. |
| 30 | + */ |
27 | 31 | String DRIVER_IMPL = "DRIVER_IMPL";
|
| 32 | + |
| 33 | + /** |
| 34 | + * The {@code ACCESS_POINTS} key shows the specified access points in OMS driver schema. |
| 35 | + * @see <a href="https://github.com/openmessaging/specification/blob/master/oms_access_point_schema.md">Access Point Schema</a> |
| 36 | + */ |
28 | 37 | String ACCESS_POINTS = "ACCESS_POINTS";
|
| 38 | + |
| 39 | + /** |
| 40 | + * The {@code NAMESPACE} key defines the isolated space of resources and related operations. |
| 41 | + */ |
29 | 42 | String NAMESPACE = "NAMESPACE";
|
| 43 | + |
| 44 | + /** |
| 45 | + * The {@code ACCOUNT_ID} key shows the specified account info in OMS driver schema. |
| 46 | + */ |
30 | 47 | String ACCOUNT_ID = "ACCOUNT_ID";
|
| 48 | + |
| 49 | + /** |
| 50 | + * The {@code REGION} key shows the specified region in OMS driver schema. |
| 51 | + */ |
31 | 52 | String REGION = "REGION";
|
| 53 | + |
| 54 | + /** |
| 55 | + * The {@code PRODUCER_ID} key represents the the unique producer id of a producer instance. |
| 56 | + */ |
32 | 57 | String PRODUCER_ID = "PRODUCER_ID";
|
| 58 | + |
| 59 | + /** |
| 60 | + * The {@code CONSUMER_ID} key represents the the unique consumer id of a consumer instance. |
| 61 | + */ |
33 | 62 | String CONSUMER_ID = "CONSUMER_ID";
|
| 63 | + |
| 64 | + /** |
| 65 | + * The {@code OPERATION_TIMEOUT} key defines the timeout of almost all the method calls in OMS. |
| 66 | + */ |
34 | 67 | String OPERATION_TIMEOUT = "OPERATION_TIMEOUT";
|
35 | 68 |
|
| 69 | + /** |
| 70 | + * The {@code ROUTING_SOURCE} key shows the source queue of a {@code Routing} instance. |
| 71 | + * <p> |
| 72 | + * The {@code Routing} consists of a triple, include source queue, destination queue and expression. |
| 73 | + */ |
36 | 74 | String ROUTING_SOURCE = "ROUTING_SOURCE";
|
| 75 | + |
| 76 | + /** |
| 77 | + * The {@code ROUTING_DESTINATION} key shows the destination queue of a {@code Routing} instance. |
| 78 | + * <p> |
| 79 | + * The {@code Routing} consists of a triple, include source queue, destination queue and expression. |
| 80 | + */ |
37 | 81 | String ROUTING_DESTINATION = "ROUTING_DESTINATION";
|
38 |
| - String ROUTING_RULE = "ROUTING_RULE"; |
| 82 | + |
| 83 | + /** |
| 84 | + * The {@code ROUTING_EXPRESSION} key shows the expression of a {@code Routing} instance. |
| 85 | + * <p> |
| 86 | + * The {@code Routing} consists of a triple, include source queue, destination queue and expression. |
| 87 | + */ |
| 88 | + String ROUTING_EXPRESSION = "ROUTING_EXPRESSION"; |
39 | 89 | }
|
0 commit comments