Programming Guide » History » Version 4
chin-yeh, 08/25/2011 11:42 AM
| 1 | 2 | chin-yeh | {{toc}} |
|---|---|---|---|
| 2 | |||
| 3 | 1 | chin-yeh | h1. Programming Guide |
| 4 | 2 | chin-yeh | |
| 5 | There are number of APIs provided by DP. All of these APIs are wrapped and exposed through a client application, [[documentation#list-of-components|dp-client]]. Refer to the following sub sections for more information. |
||
| 6 | |||
| 7 | The Javadoc of *dp-client*: |
||
| 8 | > http://192.168.2.13:50000/dp_client_apidocs/ |
||
| 9 | |||
| 10 | The binary or source files of *dp-client*: |
||
| 11 | > [[wiki#SCM|SCM]] |
||
| 12 | |||
| 13 | Demo application of *dp-client*: |
||
| 14 | > http://192.168.2.66:8080/dp-test/index.html |
||
| 15 | 3 | chin-yeh | |
| 16 | h2. Query DP status |
||
| 17 | |||
| 18 | h3. Input Parameters |
||
| 19 | |||
| 20 | h3. Output Parameters |
||
| 21 | |||
| 22 | h3. Code Snippet |
||
| 23 | |||
| 24 | h2. Impose Sales Lock |
||
| 25 | |||
| 26 | h3. Input Parameters |
||
| 27 | |||
| 28 | h3. Output Parameters |
||
| 29 | |||
| 30 | h3. Code Snippet |
||
| 31 | |||
| 32 | h2. Release Sales Lock |
||
| 33 | |||
| 34 | h3. Input Parameters |
||
| 35 | |||
| 36 | h3. Output Parameters |
||
| 37 | |||
| 38 | h3. Code Snippet |
||
| 39 | |||
| 40 | |||
| 41 | h2. Commit Sales |
||
| 42 | |||
| 43 | h3. Input Parameters |
||
| 44 | |||
| 45 | h3. Output Parameters |
||
| 46 | |||
| 47 | h3. Code Snippet |
||
| 48 | |||
| 49 | |||
| 50 | h2. Generate the redirect URL for VIP Details page |
||
| 51 | |||
| 52 | h3. Input Parameters |
||
| 53 | |||
| 54 | h3. Output Parameters |
||
| 55 | |||
| 56 | h3. Code Snippet |
||
| 57 | |||
| 58 | |||
| 59 | |||
| 60 | h2. Exception Handling Strategies |
||
| 61 | |||
| 62 | The APIs would throw the following exceptions: |
||
| 63 | 4 | chin-yeh | * *RemoteException* - if there's any issue in communicating with the DP |
| 64 | 3 | chin-yeh | * *SQLException* - if there's any issue in persisting or updating the event |
| 65 | * *unchecked exception* - e.g. NullPointerException. This is more like a programming errors so do not catch it for whatever reasons. |
||
| 66 | ** _note: catch the *Exception* will catch both checked & unchecked exception_ |
||
| 67 | |||
| 68 | The above exceptions should never be ignored, at least, the full error stack trace should be logged. |