Skip to content

Commit a1aed83

Browse files
committed
Merge pull request kaazing#16 from chadpowers/develop
Doc link updates
2 parents 6736190 + 3ca448b commit a1aed83

8 files changed

Lines changed: 16 additions & 16 deletions

amqp-0-9-1/doc/p_dev_java_client_amqp.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ To Use the Java AMQP Client Library
2828
1. Set up your development environment.
2929

3030
1. Ensure you have a Java IDE, such as Eclipse, which can be downloaded from <http://www.eclipse.org/downloads/>.
31-
2. If you haven't done so already, download and install KAAZING Gateway, as described in [Setting Up KAAZING Gateway](../about/setup-guide.md), or a RFC-6455 WebSocket endpoint that supports AMQP 0-9-1.
31+
2. If you haven't done so already, download and install KAAZING Gateway, as described in [Setting Up KAAZING Gateway](https://github.com/kaazing/gateway/blob/develop/doc/about/setup-guide.md), or a RFC-6455 WebSocket endpoint that supports AMQP 0-9-1.
3232
3. To develop clients using the KAAZING Gateway Java AMQP client library, you must configure the Gateway or RFC-6455 WebSocket endpoint to communicate with an AMQP broker.
3333

3434
The following is an example of a configuration element for the AMQP service in the KAAZING Gateway, as specified in the configuration file `GATEWAY_HOME/conf/gateway-config.xml`:
3.75 KB
Loading

ws/doc/o_dev_java.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ Taking a Look at the Java Client Demo
4242

4343
Before you start, take a look at an out of the box demo built using the Java client library: the Java applet that is part of the KAAZING Gateway bundle. To see this Java applet in action, perform the following steps:
4444

45-
1. Start the Gateway as described in [Setting Up KAAZING Gateway](../about/setup-guide.md).
45+
1. Start the Gateway as described in [Setting Up KAAZING Gateway](https://github.com/kaazing/gateway/blob/develop/doc/about/setup-guide.md).
4646
2. In a browser, navigate to the out of the box demos at `http://localhost:8001/demo/`.
4747
3. Click **Java** and follow the instructions.
4848

@@ -51,7 +51,7 @@ The out of the box Java demo shows WebSocket being used in a Java environment.
5151
Taking a Look at the Java Client Demo Using Eclipse
5252
---------------------------------------------------
5353

54-
Running the out of the box Java demo in Eclipse enables you to see the code and a working Java client. The KAAZING Gateway download (the full download, not the “base” download) includes the demo files, and these can be easily added to an Eclipse project using the following steps (for download information, see **What are my download options?** in [Setting Up KAAZING Gateway](../about/setup-guide.md)):
54+
Running the out of the box Java demo in Eclipse enables you to see the code and a working Java client. The KAAZING Gateway download (the full download, not the “base” download) includes the demo files, and these can be easily added to an Eclipse project using the following steps (for download information, see **What are my download options?** in [Setting Up KAAZING Gateway](https://github.com/kaazing/gateway/blob/develop/doc/about/setup-guide.md)):
5555

5656
1. Open Eclipse. If you do have Eclipse, you can [download it](http://www.eclipse.org/downloads/ "Eclipse Downloads") and install it.
5757
2. In Eclipse, in the **File** menu, click **New**, and then click **Java Project**.
@@ -65,7 +65,7 @@ Running the out of the box Java demo in Eclipse enables you to see the code and
6565
`GATEWAY_HOME/demo/java/src/gateway/com/kaazing/net/ws/demo`.
6666
10. Copy the files named **LoginDialog.java** and **WebSocketFrame.java**.
6767
11. In Eclipse, right-click the **org.kaazing.net.ws.demo** package under the **src** folder in your new project, and click **Paste**. The demo source files are added to the package.
68-
12. Start the Gateway as described in **How do I start and stop the Gateway?** in [Setting Up KAAZING Gateway](../about/setup-guide.md).
68+
12. Start the Gateway as described in **How do I start and stop the Gateway?** in [Setting Up KAAZING Gateway](https://github.com/kaazing/gateway/blob/develop/doc/about/setup-guide.md).
6969
13. In Eclipse, from the **Run** menu, click **Run As** and then **Java Application**. (By default, Eclipse should be configured to build the project automatically. If you receive a build error, from the **Project** menu, click **Build Project**.)
7070

7171
The Java client launches in a new window titled **WebSocket Echo Demo**.

ws/doc/p_dev_java_eventsource.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ Use the Java EventSource API
99

1010
This procedure describes how you can use the `EventSource` API--provided by the Kaazing Java client library--in Java. This API allows you to take advantage of the server-sent events standard as described in the [HTML5 specification](http://www.w3.org/html/wg/html5/#server-sent-events). For example, you can create a Java applet or stand-alone Java application that uses the Java HTML5 Communications client library to receive streaming data from a news feed or streaming financial data. The support for server-sent events is provided by the `EventSource` class and its supporting classes.
1111

12-
The following steps show you how to use the `EventSource` API in a Java applet or stand-alone Java application. This example highlights some of the most commonly used `EventSource` methods and is not meant to be an end-to-end tutorial. Refer to the [EventSource API documentation](../apidoc/client/java/gateway/index.md) for a complete description of all the available methods. View the out of the box Server Sent Events demo code in `GATEWAY_HOME/demo/java/src/core/com/kaazing/net/sse/demo/ServerSentEventsApplet.java`. The example code below is taken from this demo.
12+
The following steps show you how to use the `EventSource` API in a Java applet or stand-alone Java application. This example highlights some of the most commonly used `EventSource` methods and is not meant to be an end-to-end tutorial. Refer to the [EventSource API documentation](http://developer.kaazing.com/documentation/5.0/apidoc/client/java/gateway/index.html) for a complete description of all the available methods. View the out of the box Server Sent Events demo code in `GATEWAY_HOME/demo/java/src/core/com/kaazing/net/sse/demo/ServerSentEventsApplet.java`. The example code below is taken from this demo.
1313

1414
Before You Begin
1515
----------------

ws/doc/p_dev_java_logging.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ To Enable the Java Client Logs
4949
- In Windows, in the Java Control Panel, on the **Advanced** tab, choose **Java console**, then select **Show console**.
5050
- On Mac OS X, for Java 7 (required), access the **Java** system preference in **System Preferences**, click **Advanced**, and under **Debugging**, click **Enable logging**. Then, under **Java console**, select **Show console**.
5151

52-
6. Start the Gateway as described in [Setting Up KAAZING Gateway](../about/setup-guide.md).
52+
6. Start the Gateway as described in [Setting Up KAAZING Gateway](https://github.com/kaazing/gateway/blob/develop/doc/about/setup-guide.md).
5353
7. Restart the browser and use the out of the box Java Echo Demo.
5454
8. In a browser, navigate to the out of the box demos at `http://localhost:8001/demo/`, click **Java** and follow the instructions. The Java Console will open and display all logs from the Java Client.
5555

ws/doc/p_dev_java_secure.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -9,9 +9,9 @@ This topic provides information on how to add user authentication functionality
99

1010
A challenge handler is a constructor used in an application to respond to authentication challenges from the Gateway when the application attempts to access a protected resource. Each of the resources protected by the Gateway is configured with a different authentication scheme (for example, Basic, Application Basic, Application Negotiate, or Application Token), and your application requires a challenge handler for each of the schemes that it will encounter or a single challenge handler that will respond to all challenges. Also, you can add a dispatch challenge handler to route challenges to specific challenge handlers according to the URI of the requested resource.
1111

12-
For information about each authentication scheme type, see [Configure the HTTP Challenge Scheme](../security/p_aaa_config_authscheme.md).
12+
For information about each authentication scheme type, see [Configure the HTTP Challenge Scheme](https://github.com/kaazing/gateway/blob/develop/doc/security/p_authentication_config_http_challenge_scheme.md).
1313

14-
Before you add security to your clients, follow the steps in [Secure Network Traffic with the Gateway](../security/o_tls.md) and [Configure Authentication and Authorization](../security/o_aaa_config_authentication.md) to set up security on KAAZING Gateway for your client. The authentication and authorization methods configured on the Gateway influence your client security implementation. In this procedure, we provide an example of the most common implementation.
14+
Before you add security to your clients, follow the steps in [Secure Network Traffic with the Gateway](../security/o_tls.md) and [Configure Authentication and Authorization](https://github.com/kaazing/gateway/blob/develop/doc/security/o_auth_configure.md) to set up security on KAAZING Gateway for your client. The authentication and authorization methods configured on the Gateway influence your client security implementation. In this procedure, we provide an example of the most common implementation.
1515

1616

1717
To Secure Your Java and Android Clients
@@ -40,7 +40,7 @@ A challenge handler is responsible for producing responses to authentication cha
4040
2. The authentication request and the header are converted into a ChallengeRequest (as defined in RFC 2617) and sent to a challenge handler registered in the client application for authentication challenge responses.
4141
3. The ChallengeResponse credentials generated by a registered challenge handler are included in a replay of the original request to the Gateway, which allows access to the resource (assuming the credentials are sufficient).
4242

43-
Authenticating your Java client involves implementing a [challenge handler](../apidoc/client/java/gateway/com/kaazing/net/auth/ChallengeHandler.md) to respond to authentication challenges from the Gateway. If your challenge handler is responsible for obtaining user credentials, then implement a [login handler](../apidoc/client/java/gateway/com/kaazing/net/auth/LoginHandler.md).
43+
Authenticating your Java client involves implementing a [challenge handler](../apidoc/client/java/gateway/com/kaazing/net/auth/ChallengeHandler.md) to respond to authentication challenges from the Gateway. If your challenge handler is responsible for obtaining user credentials, then implement a [login handler](http://developer.kaazing.com/documentation/5.0/apidoc/client/java/gateway/com/kaazing/net/auth/LoginHandler.html).
4444

4545
Challenge Handler Class Imports
4646
-----------------------------------------------------
@@ -136,7 +136,7 @@ There are two methods used in ChallengeHandler:
136136
- `canHandle(ChallengeRequest challengeRequest)` determines if the challenge handler can handle the authentication scheme required by the Gateway (for example, Basic, Application Basic, Negotiate, Application Negotiate, or Application Token). The method takes a ChallengeRequest object containing a challenge and returns true if the challenge handler has the potential to respond meaningfully to the challenge. If this method determines that the challenge handler can handle the authentication scheme, it returns true and the `handle()` method is used. If this method returns false, the ChallengeHandler class (that contains all of the registered individual ChallengeHandler objects) continues looking for a ChallengeHandler to handle the request.
137137
- `handle(ChallengeRequest challengeRequest)` handles the authentication challenge by returning a challenge response. Typically, the challenge response invokes a login handler to collect user credentials and transforms that information into a ChallengeResponse object. The ChallengeResponse sends the credentials to the Gateway in an Authorization header and notifies the Gateway on what challenge handler to use for future requests. If `handle()` cannot create a challenge response, it returns `null`.
138138

139-
For information about each authentication scheme type, see [Configure the HTTP Challenge Scheme](../security/p_aaa_config_authscheme.md).
139+
For information about each authentication scheme type, see [Configure the HTTP Challenge Scheme](https://github.com/kaazing/gateway/blob/develop/doc/security/p_authentication_config_http_challenge_scheme.md).
140140

141141
### Overriding Default Challenge Handler Implementations
142142

ws/doc/p_dev_java_tshoot.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ What Problem Are You Having?
3030
Kerberos challenge handler not working
3131
-------------------------------------------------------------
3232

33-
**Cause:** [Kerberos challenge handlers](p_dev_java_secure.md#kerberos_challenge) might not work for one or more of the following reasons:
33+
**Cause:** [Kerberos challenge handlers](https://github.com/kaazing/java.client/blob/develop/ws/doc/p_dev_java_secure.md#creating-kerberos-challenge-handlers) might not work for one or more of the following reasons:
3434

3535
- The client cannot connect to the Kerberos Domain Controller (KDC).
3636

@@ -60,7 +60,7 @@ Kerberos challenge handler not working
6060

6161
- Service name is in the incorrect format in the Kerberos challenge handler code.
6262

63-
**Solution:** The service name should be in the format: `HTTP/servergw.hostname.com`. See [Creating Kerberos Challenge Handlers](p_dev_java_secure.md#kerberos_challenge) for examples.
63+
**Solution:** The service name should be in the format: `HTTP/servergw.hostname.com`. See [Creating Kerberos Challenge Handlers](https://github.com/kaazing/java.client/blob/develop/ws/doc/p_dev_java_secure.md#creating-kerberos-challenge-handlers) for examples.
6464

6565
- The pop-up dialog in the client used to obtain user credentials does not ensure that the username format is correct.
6666

ws/doc/p_dev_java_websocket.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ There are two examples in this topic to show you how to use the WebSocket API in
2222
- [To Use the WebSocket API in Java](#to-use-the-websocket-api-in-java): The first example is a brief, general example of how your client can invoke the interfaces sequentially. The relevant interface will block the next interface until it has been successful or it will throw an exception.
2323
- [Build the Java API Client Demo](#build-the-java-api-client-demo): The second example provides the steps to create a standalone Java client, including the steps needed to compile and run the interface in Eclipse.
2424

25-
Refer to the [Java AP](../apidoc/client/java/gateway/index.md)I documentation for a complete description of all the available methods.
25+
Refer to the [Java API](http://developer.kaazing.com/documentation/5.0/apidoc/client/java/gateway/index.html) documentation for a complete description of all the available methods.
2626

2727
Before You Begin
2828
----------------
@@ -220,7 +220,7 @@ The URLFactory class is included to support custom protocols and schemes not sup
220220
- A specified protocol name, host name, port number, and file name.
221221

222222
</p>
223-
For more information about the URLFactory class, see the KAAZING Gateway [Java WebSocket API](../apidoc/client/java/gateway/index.md).
223+
For more information about the URLFactory class, see the KAAZING Gateway [Java WebSocket API](http://developer.kaazing.com/documentation/5.0/apidoc/client/java/gateway/index.html).
224224

225225
Setting and Overriding Defaults on the WebSocketFactory
226226
-------------------------------------------------------
@@ -378,7 +378,7 @@ The following procedure uses the Eclipse IDE. You can download Eclipse from [www
378378
import org.kaazing.net.ws.WebSocketMessageWriter;
379379
```
380380

381-
For information about these classes, see the [Java WebSocket API](../apidoc/client/java/gateway/index.md).
381+
For information about these classes, see the [Java WebSocket API](http://developer.kaazing.com/documentation/5.0/apidoc/client/java/gateway/index.html).
382382

383383
6. Change the default class statement that was generated by Eclipse to:
384384

@@ -837,7 +837,7 @@ The following procedure uses the Eclipse IDE. You can download Eclipse from [www
837837
Eclipse has real-time error checking to inform you of any missing syntax elements.
838838

839839
23. Save the client in Eclipse.
840-
24. Start the Gateway as described in **How do I start and stop the Gateway?** in [[Setting Up KAAZING Gateway](../about/setup-guide.md)](../about/setup-guide.md).
840+
24. Start the Gateway as described in **How do I start and stop the Gateway?** in [Setting Up KAAZING Gateway](https://github.com/kaazing/gateway/blob/develop/doc/about/setup-guide.md).
841841
25. Test your new client. In Eclipse, in the **Run** menu, click **Run**. The Java client launches. The **Location** field contains a URI for the Echo service running on the Gateway using the WebSocket scheme, ws://: `ws://localhost:8001/echo`.
842842
26. Click **Connect**. The Log displays:
843843

0 commit comments

Comments
 (0)