opendxl-streaming-client-java/README at master · shreyars14/opendxl-streaming-client-java · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
OpenDXL Streaming Java Client Library
=======================================

Overview
--------

The OpenDXL Streaming Java client library is used to consume records
from a
`Data Exchange Layer <http://www.mcafee.com/us/solutions/data-exchange-layer.aspx>`_
(DXL) Streaming Service.

The DXL Streaming Service exposes a REST-based API that communicates
with a back-end streaming platform (Kafka, Kinesis, etc.). The streaming service
performs authentication and authorization and exposes methods to retrieve
records.

One concrete example of a DXL Streaming Service is the
`McAfee MVISION EDR  <https://www.mcafee.com/enterprise/en-us/products/investigator.html>`_
"Events feed".

Documentation
-------------

See the
`GitHub Wiki <https://github.com/opendxl/opendxl-streaming-client-java/wiki>`_
for an overview of the OpenDXL Streaming Java client library and
examples.

See the
`OpenDXL Streaming Java Client Library Documentation <https://opendxl.github.io/opendxl-streaming-client-java/docs/index.html>`_
for API documentation and examples.

Installation
------------
To start using the OpenDXL Streaming Java Client Library:

* Download the `Latest Release <https://github.com/opendxl/opendxl-streaming-client-java/releases/latest>`_
* Extract the release .zip file
* View the `README.html` file located at the root of the extracted files.
  * The `README` links to the documentation which includes installation instructions, API details, and samples.
  * The SDK documentation is also available on-line `here <https://opendxl.github.io/opendxl-streaming-client-java/docs/javadoc/index.html>`_.

Maven Repository
----------------
Visit the [OpenDXL Streaming Java Client Maven Repository](https://search.maven.org/artifact/com.opendxl/dxlstreaming) for
access to all released versions including the appropriate dependency syntax for a large number of management
systems (Maven, Gradle, SBT, Ivy, Grape, etc.).

Maven:

<dependency>
  <groupId>com.opendxl</groupId>
  <artifactId>dxlstreamingclient</artifactId>
  <version>0.1.8</version>
</dependency>

or Gradle:
compile 'com.opendxl:dxlstreamingclient:0.1.8'

Bugs and Feedback
-----------------

For bugs, questions and discussions please use the
`GitHub Issues <https://github.com/opendxl/opendxl-streaming-client-java/issues>`_.

LICENSE
-------

Copyright 2018, McAfee LLC

Licensed under the Apache License, Version 2.0 (the "License"); you may not use
this file except in compliance with the License. You may obtain a copy of the
License at

`<http://www.apache.org/licenses/LICENSE-2.0>`_