|
This module provides a contract between API clients that can express some intention to invoke an operation and SPI providers that can handle that intention.
This is useful in client-server environments, where the intention can be constructed on server-side, but handled on client-side. The objects that describe the intention should be easy to construct, transfer and interpret.
Question (arch-overall): Describe the overall architecture. Answer:Intent is an description of some intended operation. It is specified by action type (String) and a URI. When some Intent is executed, proper handler is chosen and it performs the actual operation.
Intents provide loose coupling between modules that may request an operation and modules that can perform it. They can be easily serialized, so they are suitable for distributed heterogenous systems.
IntentAPI -API for describing and executing intended operations.
IntentHandlerSPI -SPI for handlers that are able to invoke proper operation for specified intents.
Question (arch-usecases): Describe the main use cases of the new API. Who will use it under what circumstances? What kind of code would typically need to be written to use the module? Answer:
Future<Object> result = new Intent(Intent.ACTION_VIEW, new URI("scheme://path/")).execute();
Object value = result.get();
new Intent(Intent.ACTION_VIEW, new URI("scheme://path/")).execute(new Callback() {
void success(Object result) {
// use the result somehow
}
void failure(Exception exception) {
// report the failure somehow
}
});
@IntentHandlerRegistration(
displayName = "Show my item in MyEditor",
position = 800,
uriPattern = "myscheme://.*",
actions = {Intent.ACTION_VIEW, Intent.ACTION_EDIT}
)
public static Object handleIntent(Intent intent) {
SomeType result = parseAndPerformIntentSomehow(intent);
return result;
}
@IntentHandlerRegistration(
displayName = "Show my item in MyEditor",
position = 800,
uriPattern = "myscheme://.*",
actions = "*"
)
public static void handleIntent(final Intent intent, final Result result) {
// Move the execution to another thread. Do not wait for the result
// here, just pass the result object.
EventQueue.invokeLater(new Runnable() {
public void run() {
try {
Object result = doSomethingInEDT(intent);
result.setResult(e);
} catch (Exception e) {
result.setException(e);
}
}
});
}
Question (arch-time):
What are the time estimates of the work?
Answer:
Done.
Question (arch-quality): How will the quality of your code be tested and how are future regressions going to be prevented? Answer:The code is checked by unit tests.
Question (arch-where): Where one can find sources for your module? Answer:
The sources for the module are in the Apache Git repositories or in the GitHub repositories.
These modules are required in project.xml:
No non-NB dependencies.
Question (dep-platform): On which platforms does your module run? Does it run in the same way on each? Answer:Any platform.
Question (dep-jre): Which version of JRE do you need (1.2, 1.3, 1.4, etc.)? Answer:1.6
Question (dep-jrejdk): Do you require the JDK or is the JRE enough? Answer:JRE
Just module JAR.
Question (deploy-nbm): Can you deploy an NBM via the Update Center? Answer:Yes.
Question (deploy-shared): Do you need to be installed in the shared location only, or in the user directory only, or can your module be installed anywhere? Answer:Installation location does not matter.
Question (deploy-packages): Are packages of your module made inaccessible by not declaring them public? Answer:Only API and SPI packages are public.
Question (deploy-dependencies): What do other modules need to do to declare a dependency on this one, in addition to or instead of the normal module dependency declaration (e.g. tokens to require)? Answer:Standard module dependency is sufficient.
Yes.
Question (compat-standards): Does the module implement or define any standards? Is the implementation exact or does it deviate somehow? Answer:No standards.
Question (compat-version): Can your module coexist with earlier and future versions of itself? Can you correctly read all old settings? Will future versions be able to read your current settings? Can you read or politely ignore settings stored by a future version? Answer:No settings are read or written.
Question (compat-deprecation): How the introduction of your project influences functionality provided by previous version of the product? Answer:No deprecation needed.
java.io.File directly?
Answer:
No.
Question (resources-layer): Does your module provide own layer? Does it create any files or folders in it? What it is trying to communicate by that and with which components? Answer:No.
Question (resources-read): Does your module read any resources from layers? For what purpose? Answer:No.
Question (resources-mask): Does your module mask/hide/override any resources provided by other modules in their layers? Answer:No.
Question (resources-preferences): Does your module uses preferences via Preferences API? Does your module use NbPreferences or or regular JDK Preferences ? Does it read, write or both ? Does it share preferences with other modules ? If so, then why ? Answer:No.
org.openide.util.Lookup
or any similar technology to find any components to communicate with? Which ones?
Answer:
No.
Question (lookup-register): Do you register anything into lookup for other code to find? Answer:The annotation processor is registered using ServiceProvider.
Question (lookup-remove): Do you remove entries of other modules from lookup? Answer:No.
System.getProperty) property?
On a similar note, is there something interesting that you
pass to java.util.logging.Logger? Or do you observe
what others log?
Answer:
No.
Question (exec-component): Is execution of your code influenced by any (string) property of any of your components? Answer:No.
Question (exec-ant-tasks): Do you define or register any ant tasks that other can use? Answer:No.
Question (exec-classloader): Does your code create its own class loader(s)? Answer:No.
Question (exec-reflection): Does your code use Java Reflection to execute other code? Answer:No.
Question (exec-privateaccess): Are you aware of any other parts of the system calling some of your methods by reflection? Answer:No.
Question (exec-process): Do you execute an external process from your module? How do you ensure that the result is the same on different platforms? Do you parse output? Do you depend on result code? Answer:No.
Question (exec-introspection): Does your module use any kind of runtime type information (instanceof,
work with java.lang.Class, etc.)?
Answer:
No.
Question (exec-threading): What threading models, if any, does your module adhere to? How the project behaves with respect to threading? Answer:The API is threadsafe. SPI implementations should ensure proper synchronization.
Question (security-policy): Does your functionality require modifications to the standard policy file? Answer:No.
Question (security-grant): Does your code grant additional rights to some other code? Answer:No.
No files are read or written by this module.
Question (format-dnd): Which protocols (if any) does your code understand during Drag & Drop? Answer:No Drag & Drop support.
Question (format-clipboard): Which data flavors (if any) does your code read from or insert to the clipboard (by access to clipboard on means calling methods onjava.awt.datatransfer.Transferable?
Answer:
No clipboard access.
No.
Question (perf-exit): Does your module run any code on exit? Answer:No.
Question (perf-scale): Which external criteria influence the performance of your program (size of file in editor, number of files in menu, in source directory, etc.) and how well your code scales? Answer:Code in the module is very simple. Performance is incluenced mosly by SPI implementations, which should run quite quickly.
Question (perf-limit): Are there any hard-coded or practical limits in the number or size of elements your code can handle? Answer:No.
Question (perf-mem): How much memory does your component consume? Estimate with a relation to the number of windows, etc. Answer:Very little memory consumed.
Question (perf-wakeup): Does any piece of your code wake up periodically and do something even when the system is otherwise idle (no user interaction)? Answer:No.
Question (perf-progress): Does your module execute any long-running tasks? Answer:No.
Question (perf-huge_dialogs): Does your module contain any dialogs or wizards with a large number of GUI controls such as combo boxes, lists, trees, or text areas? Answer:No.
Question (perf-menus): Does your module use dynamically updated context menus, or context-sensitive actions with complicated and slow enablement logic? Answer:No.
Question (perf-spi): How the performance of the plugged in code will be enforced? Answer:No performance criteria are enforced. The plugged-in code is invoked by a dedicated executor.