-
Notifications
You must be signed in to change notification settings - Fork 44
Expand file tree
/
Copy pathApplication.java
More file actions
219 lines (189 loc) · 5.19 KB
/
Copy pathApplication.java
File metadata and controls
219 lines (189 loc) · 5.19 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
/*******************************************************************************
* Copyright (c) 2013, 2025 James M. ZHOU
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*******************************************************************************/
package org.tinystruct;
import org.tinystruct.application.Context;
import org.tinystruct.application.Template;
import org.tinystruct.system.Configuration;
import org.tinystruct.system.annotation.Action;
import org.tinystruct.system.cli.CommandLine;
import java.util.Locale;
import java.util.Map;
/**
* Application interface used to indicate that an application should provide the standard methods.
*
* @author James Zhou
* @since 0.1.0
*/
public interface Application extends Runnable {
/**
* Constants for Language code.
*/
String LANGUAGE_CODE = "language_code";
/**
* Constant for language.
*/
String LANGUAGE = "language";
/**
* Constant for language tag.
*/
String LANGUAGE_TAG = "LANGUAGE_TAG";
/**
* Constant for default base url.
*/
String DEFAULT_BASE_URL = "default.base_url";
/**
* Constant for charset.
*/
String CHARSET = "charset";
/**
* Constant for default language.
*/
String DEFAULT_LANGUAGE = "default.language";
/**
* Constant for class id.
*/
String CLSID = "clsid";
/**
* Constant for request action.
*/
String REQUEST_ACTION = "REQUEST_ACTION";
/**
* Initialize for an application once it's loaded.
*/
void init();
/**
* Initialize for an application with {@link Context} once it's loaded.
*
* @param context context
*/
void init(Context context);
/**
* Set Locale for the application.
*
* @param language language name.
*/
void setLocale(String language);
/**
* Set a template for the current application.
*
* @param template {@link Template}
* @return A string of template rendered
* @throws ApplicationException application exception
*/
String setTemplate(Template template) throws ApplicationException;
/**
* Return if template is required or not.
*
* @return templateRequired boolean
*/
boolean isTemplateRequired();
/**
* Set up an action mapping for method trigger.
*
* @param action action name
* @param methodName method name
*/
@Deprecated(since = "1.8.0")
void setAction(String action, String methodName);
/**
* Return the configuration was set.
*
* @return configuration
*/
Configuration<String> getConfiguration();
/**
* Set configuration for application.
*
* @param config configuration
*/
void setConfiguration(Configuration<String> config);
/**
* Return a specific instance for this application.
*
* @param context Context ID
* @return an instance of this application
*/
Application getInstance(Context context);
/**
* To invoke the action with action name specified.
*
* @param action action name
* @return the result after method invoked
* @throws ApplicationException application exception
*/
Object invoke(String action) throws ApplicationException;
/**
* To invoke the action with action name specified.
*
* @param action action name
* @param parameters parameters
* @return the result after method invoked
* @throws ApplicationException application exception
*/
Object invoke(String action, Object[] parameters) throws ApplicationException;
/**
* Convert the application object to be a string for viewable.
*
* @return serialized for the application
*/
String toString();
/**
* Return the version of the application.
*
* @return version
*/
String version();
/**
* Return the context of the application.
*
* @return context
*/
Context getContext();
/**
* Get the name of the application.
*
* @return name
*/
String getName();
/**
* Return a map of command name -> map of Mode -> CommandLine for current application.
*
* @return A map for commandline grouped by mode
*/
Map<String, Map<Action.Mode, CommandLine>> getCommandLines();
/**
* Help information.
*
* @return help
*/
String help();
/**
* Set context for the application.
*
* @param context A context to be set
*/
Application setContext(Context context);
/**
* Destroy process.
*/
void destroy();
/**
* Get current locale setting.
*
* @return locale
*/
Locale getLocale();
}