|
1 /* |
|
2 * Copyright (c) 2009 Nokia Corporation and/or its subsidiary(-ies). |
|
3 * All rights reserved. |
|
4 * This component and the accompanying materials are made available |
|
5 * under the terms of "Eclipse Public License v1.0" |
|
6 * which accompanies this distribution, and is available |
|
7 * at the URL "http://www.eclipse.org/legal/epl-v10.html". |
|
8 * |
|
9 * Initial Contributors: |
|
10 * Nokia Corporation - initial contribution. |
|
11 * |
|
12 * Contributors: |
|
13 * |
|
14 * Description: Java Debug API |
|
15 * |
|
16 */ |
|
17 |
|
18 |
|
19 #ifndef JAVADEBUGAPI_H |
|
20 #define JAVADEBUGAPI_H |
|
21 |
|
22 #include <e32cmn.h> |
|
23 |
|
24 /** |
|
25 * Java Debug API allows it's users to install, remove, start and |
|
26 * stop Java applications. |
|
27 * |
|
28 * @lib javadebugapi.lib |
|
29 * @since S60 v9.2 |
|
30 */ |
|
31 |
|
32 namespace java |
|
33 { |
|
34 namespace debug |
|
35 { |
|
36 |
|
37 /** |
|
38 * Installs Java application. |
|
39 * Java application is installed silently i.e. no prompts are shown to the user. |
|
40 * @param[in] aFilename shall point to local JAD or JAR file |
|
41 * @param[out] aSuiteUid returns the suite uid assigned to the application |
|
42 * @param[out] aApplicationUid returns a list of application uids assigned to applications inside suite uid |
|
43 * @capability TrustedUI |
|
44 * @return true if installation is successful |
|
45 */ |
|
46 IMPORT_C TBool installApp(HBufC& aFilename, TUid& aSuiteUid, RArray<TUid>& aApplicationUid); |
|
47 |
|
48 /** |
|
49 * Uninstalls Java application. |
|
50 * Java application is removed silently i.e. no prompts are shown to the user. |
|
51 * If application uid is given then the application suite it belongs is removed too. |
|
52 * @param[in] aUid application suite uid (or application uid) |
|
53 * @capability TrustedUI |
|
54 * @return true if application is uninstalled successfully |
|
55 */ |
|
56 IMPORT_C TBool uninstallApp(TUid aSuiteUid); |
|
57 |
|
58 /** |
|
59 * Starts Java application. |
|
60 * @param[in] aApplicationUid application uid |
|
61 * @param[in] aUeiParameters includes arguments defined in Unified Emulator Interface (UEI) specification. |
|
62 * If aUeiParameters contains unsupported options then those options are discarded silently. |
|
63 * Supported arguments: |
|
64 * -Xverbose[:options] |
|
65 * -Xdebug -Xrunjdwp:name=value[,name=value[...]] |
|
66 * For example, to start Java application in debug mode and set full tracing on |
|
67 * following UIE arguments could be given: |
|
68 * "-Xdebug -Xrunjdwp:server=y,address=localhost:8000 -Xverbose:all" |
|
69 * @capability NetworkControl |
|
70 * @return true if application is started |
|
71 */ |
|
72 IMPORT_C TBool startApp(TUid aApplicationUid, HBufC& aUeiParameters); |
|
73 |
|
74 /** |
|
75 * Stops Java application. |
|
76 * @param[in] aApplicationUid application uid |
|
77 * @capability PowerMgmt |
|
78 * @return true if application is stopped |
|
79 */ |
|
80 IMPORT_C TBool stopApp(TUid aApplicationUid); |
|
81 |
|
82 } // end namespace debug |
|
83 } // end namespace java |
|
84 |
|
85 #endif // JAVADEBUGAPI_H |