1 /*
2 * Copyright 2013 smartics, Kronseder & Reiner GmbH
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 * http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16 package de.smartics.properties.admin.domain.model;
17
18 /**
19 * Constants to construct paths.
20 */
21 public final class Paths
22 {
23 // ********************************* Fields *********************************
24
25 // --- constants ------------------------------------------------------------
26
27 /**
28 * The path to the rest API within the server.
29 * <p>
30 * The value of this constant is {@value}.
31 * </p>
32 */
33 public static final String API_PATH = "/api";
34
35 // ... path parameters ......................................................
36
37 /**
38 * Parameter name for a configuration key.
39 * <p>
40 * The value of this constant is {@value}.
41 * </p>
42 */
43 public static final String PARAM_CONFIGURATION_KEY = "configuration";
44
45 /**
46 * Parameter name for a property key.
47 * <p>
48 * The value of this constant is {@value}.
49 * </p>
50 */
51 public static final String PARAM_PROPERTY_KEY = "key";
52
53 /**
54 * Parameter name for a property value.
55 * <p>
56 * The value of this constant is {@value}.
57 * </p>
58 */
59 public static final String PARAM_VALUE = "value";
60
61 // ... request paths ........................................................
62
63 /**
64 * Path to the configurations resource.
65 * <p>
66 * The value of this constant is {@value}.
67 * </p>
68 */
69 public static final String PATH_CONFIGURATIONS = "/configurations";
70
71 /**
72 * Path to property keys.
73 * <p>
74 * The value of this constant is {@value}.
75 * </p>
76 */
77 public static final String PATH_PROPERTY_KEYS = PATH_CONFIGURATIONS + "/{"
78 + PARAM_CONFIGURATION_KEY
79 + " : .+}/keys";
80
81 /**
82 * Path to a property resource.
83 * <p>
84 * The value of this constant is {@value}.
85 * </p>
86 */
87 public static final String PATH_PROPERTY_VALUE = PATH_PROPERTY_KEYS + "/{"
88 + PARAM_PROPERTY_KEY + "}";
89
90 /**
91 * Path to logout the user.
92 * <p>
93 * The value of this constant is {@value}.
94 * </p>
95 */
96 public static final String LOGOUT = "user/logout";
97
98 /**
99 * Path to the security resource.
100 * <p>
101 * The value of this constant is {@value}.
102 * </p>
103 */
104 public static final String PATH_SECURITY = "/security";
105
106 /**
107 * Identifier to tag the value to be encrypted.
108 * <p>
109 * The value of this constant is {@value}.
110 * </p>
111 */
112 public static final String PARAM_SECURITY_ENCRYPT = "encrypt";
113
114 /**
115 * Identifier to tag the value to be decrypted.
116 * <p>
117 * The value of this constant is {@value}.
118 * </p>
119 */
120 public static final String PARAM_SECURITY_DECRYPT = "decrypt";
121
122 /**
123 * Path to the JNDI resource.
124 * <p>
125 * The value of this constant is {@value}.
126 * </p>
127 */
128 public static final String PATH_JNDI = "/jndi";
129
130 /**
131 * Identifier of the application's group ID.
132 * <p>
133 * The value of this constant is {@value}.
134 * </p>
135 */
136 public static final String PARAM_JNDI_APP_GROUP_ID = "groupId";
137
138 /**
139 * Identifier of the application's artifact ID.
140 * <p>
141 * The value of this constant is {@value}.
142 * </p>
143 */
144 public static final String PARAM_JNDI_APP_ARTIFACT_ID = "artifactId";
145
146 /**
147 * Identifier of the application's version.
148 * <p>
149 * The value of this constant is {@value}.
150 * </p>
151 */
152 public static final String PARAM_JNDI_APP_VERSION = "version";
153
154 /**
155 * Identifier of the application's artifact type.
156 * <p>
157 * The value of this constant is {@value}.
158 * </p>
159 */
160 public static final String PARAM_JNDI_APP_ARCHIVE_TYPE = "archiveType";
161
162 /**
163 * Identifier of the application's classifier.
164 * <p>
165 * The value of this constant is {@value}.
166 * </p>
167 */
168 public static final String PARAM_JNDI_APP_CLASSIFIER = "classifier";
169
170 /**
171 * Identifier of the data source mapped name.
172 * <p>
173 * The value of this constant is {@value}.
174 * </p>
175 */
176 public static final String PARAM_JNDI_DS_MAPPED_NAME = "dsName";
177
178 /**
179 * Identifier of the data source configuration parameter to create table.
180 * <p>
181 * The value of this constant is {@value}.
182 * </p>
183 */
184 public static final String PARAM_JNDI_DS_CREATE_TABLE = "dsCreateTable";
185
186 /**
187 * Identifier of the data source configuration parameter to drop table.
188 * <p>
189 * The value of this constant is {@value}.
190 * </p>
191 */
192 public static final String PARAM_JNDI_DS_DROP_TABLE = "dsDropTable";
193
194 /**
195 * Identifier of the cache mapped name.
196 * <p>
197 * The value of this constant is {@value}.
198 * </p>
199 */
200 public static final String PARAM_JNDI_CACHE_MAPPED_NAME = "cacheName";
201
202 /**
203 * Identifier of the key security property.
204 * <p>
205 * The value of this constant is {@value}.
206 * </p>
207 */
208 public static final String PARAM_JNDI_SECURITY_KEY = "securityKey";
209
210 /**
211 * Identifier of the algorithm security property.
212 * <p>
213 * The value of this constant is {@value}.
214 * </p>
215 */
216 public static final String PARAM_JNDI_SECURITY_ALGORITHM =
217 "securityAlgorithm";
218
219 /**
220 * Identifier of the provider security property.
221 * <p>
222 * The value of this constant is {@value}.
223 * </p>
224 */
225 public static final String PARAM_JNDI_SECURITY_PROVIDER = "securityProvider";
226
227 /**
228 * Identifier of the transformation security property.
229 * <p>
230 * The value of this constant is {@value}.
231 * </p>
232 */
233 public static final String PARAM_JNDI_SECURITY_TRANSFORMATION =
234 "securityTransformation";
235
236 /**
237 * Path to a property descriptors resource.
238 * <p>
239 * The value of this constant is {@value}.
240 * </p>
241 */
242 public static final String PATH_PROPERTY_DESCRIPTORS = "/descriptors";
243
244 /**
245 * Path to a property descriptor resource.
246 * <p>
247 * The value of this constant is {@value}.
248 * </p>
249 */
250 public static final String PATH_PROPERTY_DESCRIPTOR =
251 PATH_PROPERTY_DESCRIPTORS + "/{" + PARAM_PROPERTY_KEY + "}";
252
253 // --- members --------------------------------------------------------------
254
255 // ****************************** Initializer *******************************
256
257 // ****************************** Constructors ******************************
258
259 private Paths()
260 {
261 }
262
263 // ****************************** Inner Classes *****************************
264
265 // ********************************* Methods ********************************
266
267 // --- init -----------------------------------------------------------------
268
269 // --- get&set --------------------------------------------------------------
270
271 // --- business -------------------------------------------------------------
272
273 // --- object basics --------------------------------------------------------
274
275 }