Skip to content

Commit 693a7c3

Browse files
committed
Update Java Repo docs
1 parent afdf09f commit 693a7c3

File tree

3 files changed

+69
-14
lines changed

3 files changed

+69
-14
lines changed

README.md

Lines changed: 0 additions & 2 deletions
This file was deleted.

README.txt

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
# ServiceStack.Java
2+
3+
This repository contains the source for ServiceStack plugins for the leading Android Studio, IntelliJ and Eclipse Java IDE's providing Java developers a highly productive development experience for consuming Typed ServiceStack Services using integration of [Add ServiceStack Reference](https://github.com/ServiceStack/ServiceStack/wiki/Add-ServiceStack-Reference) directly within their IDE!
4+
5+
## Install
6+
7+
### [Install ServiceStack IDEA Plugin on Android Studio and IntelliJ](https://github.com/ServiceStack/ServiceStack/wiki/Java-Add-ServiceStack-Reference#servicestack-idea-android-studio-plugin)
8+
- [Install ServiceStack IDEA from the Plugin repository](https://github.com/ServiceStack/ServiceStack/wiki/Java-Add-ServiceStack-Reference#install-servicestack-idea-from-the-plugin-repository)
9+
- [Download and Install ServiceStack IDEA Manually](https://github.com/ServiceStack/ServiceStack/wiki/Java-Add-ServiceStack-Reference#download-and-install-servicestack-idea-manually)
10+
11+
### [Installing ServiceStackEclipse Plugin on Eclipse](https://github.com/ServiceStack/ServiceStack.Java/tree/master/src/ServiceStackEclipse)
12+
13+
## Usage
14+
15+
### [Update ServiceStack Reference](https://github.com/ServiceStack/ServiceStack/wiki/Java-Add-ServiceStack-Reference#update-servicestack-reference)
16+
17+
For information on the different code-generation configuration options available and examples of using the `JsonServiceClient` refer to the [Java ServiceStack Reference Documentation](https://github.com/ServiceStack/ServiceStack/wiki/Java-Add-ServiceStack-Reference#update-servicestack-reference).
18+
19+
### [JsonServiceClient](https://github.com/ServiceStack/ServiceStack/wiki/Java-Add-ServiceStack-Reference#jsonserviceclient-api)
20+
21+
For information on using the generic Java JSON Service Client Typed API's see the [JsonServiceClient Documentation](https://github.com/ServiceStack/ServiceStack/wiki/Java-Add-ServiceStack-Reference#jsonserviceclient-api) or jump to the interested sections directly:
22+
23+
- [JsonServiceClient Usage](https://github.com/ServiceStack/ServiceStack/wiki/Java-Add-ServiceStack-Reference#jsonserviceclient-usage)
24+
- [Custom Urls Example Usage](https://github.com/ServiceStack/ServiceStack/wiki/Java-Add-ServiceStack-Reference#custom-example-usage)
25+
- [AutoQuery Example Usage](https://github.com/ServiceStack/ServiceStack/wiki/Java-Add-ServiceStack-Reference#autoquery-example-usage)
26+
- [Android Service Client](https://github.com/ServiceStack/ServiceStack/wiki/Java-Add-ServiceStack-Reference#androidserviceclient)
27+
- [AsyncServiceClient API](https://github.com/ServiceStack/ServiceStack/wiki/Java-Add-ServiceStack-Reference#asyncserviceclient-api)
28+
- [Async API Usage](https://github.com/ServiceStack/ServiceStack/wiki/Java-Add-ServiceStack-Reference#async-api-usage)
29+
- [Async Error Handling](https://github.com/ServiceStack/ServiceStack/wiki/Java-Add-ServiceStack-Reference#async-error-handling)
30+
- [Typed Error Handling](https://github.com/ServiceStack/ServiceStack/wiki/Java-Add-ServiceStack-Reference#typed-error-handling)
31+
- [JsonServiceClient Error Handlers](https://github.com/ServiceStack/ServiceStack/wiki/Java-Add-ServiceStack-Reference#jsonserviceclient-error-handlers)
32+
33+
## [Java generated DTO Types](https://github.com/ServiceStack/ServiceStack/wiki/Java-Add-ServiceStack-Reference#java-generated-dto-types)
34+
35+
Contains information on how **Java Add ServiceStack Reference** ensures a high-fidelity, idiomatic translation within the constraints of Java language and its built-in libraries, where .NET Server DTO's are translated into clean, conventional Java POJO's where .NET built-in Value Types mapped to their equivalent Java data Type. Use the links below to jump directly to the sections you're interested in:
36+
37+
- [.NET Attributes translated into Java Annotations](https://github.com/ServiceStack/ServiceStack/wiki/Java-Add-ServiceStack-Reference#net-attributes-translated-into-java-annotations)
38+
- [Terse, typed API's with IReturn interfaces](https://github.com/ServiceStack/ServiceStack/wiki/Java-Add-ServiceStack-Reference#terse-typed-apis-with-ireturn-interfaces)
39+
- [Getters and Setters generated for each property](https://github.com/ServiceStack/ServiceStack/wiki/Java-Add-ServiceStack-Reference#getters-and-setters-generated-for-each-property)
40+
- [Java Type Conversions](https://github.com/ServiceStack/ServiceStack/wiki/Java-Add-ServiceStack-Reference#java-type-conversions)
41+
- [Java Enums](https://github.com/ServiceStack/ServiceStack/wiki/Java-Add-ServiceStack-Reference#java-enums)
42+
- [Java Configuration](https://github.com/ServiceStack/ServiceStack/wiki/Java-Add-ServiceStack-Reference#java-configuration)
43+
44+
## Example [TechStacks Android App](https://github.com/ServiceStackApps/TechStacksAndroidApp)
45+
To demonstrate Java Native Types in action we've ported the Swift [TechStacks iOS App](https://github.com/ServiceStackApps/TechStacksApp) to a native Java Android App to showcase the responsiveness and easy-of-use of leveraging Java Add ServiceStack Reference in Android Projects.
46+
47+
[![](https://raw.githubusercontent.com/ServiceStack/Assets/master/img/release-notes/techstacks-android-app.jpg)](https://github.com/ServiceStackApps/TechStacksAndroidApp)
48+
49+
Checkout the [TechStacks Android App](https://github.com/ServiceStackApps/TechStacksAndroidApp) repository for a nice overview of how it leverages Java Native Types, Functional Java Utils and iOS-inspired Data Binding to easily develop services-heavy Mobile Apps.

src/ServiceStackEclipse/readme.md

Lines changed: 20 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,31 @@
1-
## ServiceStackEclipse
1+
### Eclipse Integration with ServiceStack
22

3-
To add to our client side support for Java clients, we have expanded our "Add ServiceStack Reference" functionality to the Eclipse IDE running on Windows, OSX and Linux.
3+
The **ServiceStackEclipse** plugin enables cross-platform [Add ServiceStack Reference](https://github.com/ServiceStack/ServiceStack/wiki/Add-ServiceStack-Reference) integration with Eclipse on Windows, OSX and Linux.
44

5-
This workflow works best when used in conjunction with a Maven project as it will add the ServiceStack.Java client library to your Maven dependencies. If you are using `Build Automatically` in Eclipse, these dependencies will automatically get pulled down after being added to the project and your new ServiceStack reference will build and be ready to use with the Java `JsonServiceClient`.
5+
### Install from Eclipse Marketplace
66

7-
#### Installation from the Eclipse Marketplace
7+
To install, search for **ServiceStack** in the Eclipse Marketplace at `Help -> Eclipse Marketplace`:
88

9-
To help make this plugin discoverable, easy to install and keep upto date, this plugin has been published to the Eclipse Marketplace.
9+
![](https://raw.githubusercontent.com/ServiceStack/Assets/master/img/servicestackeclipse/ss-eclipse-install-win.gif)
1010

11-
![](https://github.com/ServiceStack/Assets/raw/master/img/servicestackeclipse/ss-eclipse-install-win.gif)
11+
Find the **ServiceStackEclipse** plugin, click **Install** and follow the wizard to the end, restarting to launch Eclipse with the plugin loaded!
1212

13-
#### Add/Update ServiceStack Reference
13+
> **ServiceStackEclipse** is best used with Java Maven Projects where it automatically adds the **ServiceStack.Java** client library to your Maven Dependencies and when your project is set to **Build Automatically**, are then downloaded and registered, so you're ready to start consuming ServiceStack Services with the new `JsonServiceClient`
1414
15-
ServiceStackEclipse plugin introduces the similar workflow as the other supported IDEs by providing a simple dialog to add your server side DTOs to your client project.
15+
### Add ServiceStack Reference
1616

17-
![](https://github.com/ServiceStack/Assets/raw/master/img/servicestackeclipse/add-reference-demo.gif)
17+
Just like the [support in Android Studio](https://github.com/ServiceStack/ServiceStack/wiki/Java-Add-ServiceStack-Reference) you can right-click on a Java Package to open the **Add ServiceStack Reference...** dialog from the Context Menu:
1818

19-
Like Android Studio, if the reference is added in a Maven project, the `net.servicestack.client` Maven dependency is automatically added.
19+
![](https://raw.githubusercontent.com/ServiceStack/Assets/master/img/servicestackeclipse/add-reference-demo.gif)
2020

21-
The `Update ServiceStack Reference` menu is visible when you right click on the reference file in the package explorer. This will process and pass the requested options to the ServiceStack server and update the file in place.
21+
Complete the dialog to add the remote Servers generated Java DTO's to your selected Java package and the `net.servicestack.client` dependency to your Maven dependencies.
2222

23-
![](https://github.com/ServiceStack/Assets/raw/master/img/servicestackeclipse/update-reference-demo.gif)
23+
### Update ServiceStack Reference
24+
25+
Updating a ServiceStack Reference works as normal where you can change any of the available options in the header comments, save, then right-click on the file in the File Explorer and click on **Update ServiceStack Reference** in the Context Menu:
26+
27+
![](https://raw.githubusercontent.com/ServiceStack/Assets/master/img/servicestackeclipse/update-reference-demo.gif)
28+
29+
## [ServiceStack Java Documentation](https://github.com/ServiceStack/ServiceStack/wiki/Java-Add-ServiceStack-Reference#update-servicestack-reference)
30+
31+
For further information on the different code-generation configuration options available and examples of using the `JsonServiceClient` refer to the [Java ServiceStack Reference Documentation](https://github.com/ServiceStack/ServiceStack/wiki/Java-Add-ServiceStack-Reference#update-servicestack-reference).

0 commit comments

Comments
 (0)