swagger-java-comet-client

Swagger Java Comet Client

License

License

Categories

Categories

Java Languages CLI User Interface Swagger Program Interface REST Frameworks
GroupId

GroupId

org.renci.io.swagger
ArtifactId

ArtifactId

swagger-java-comet-client
Last Version

Last Version

1.0.1
Release Date

Release Date

Type

Type

jar
Description

Description

swagger-java-comet-client
Swagger Java Comet Client
Project URL

Project URL

https://github.com/RENCI-NRIG/COMET-Client
Source Code Management

Source Code Management

https://github.com/RENCI-NRIG/COMET-Client

Download swagger-java-comet-client

How to add to project

<!-- https://jarcasting.com/artifacts/org.renci.io.swagger/swagger-java-comet-client/ -->
<dependency>
    <groupId>org.renci.io.swagger</groupId>
    <artifactId>swagger-java-comet-client</artifactId>
    <version>1.0.1</version>
</dependency>
// https://jarcasting.com/artifacts/org.renci.io.swagger/swagger-java-comet-client/
implementation 'org.renci.io.swagger:swagger-java-comet-client:1.0.1'
// https://jarcasting.com/artifacts/org.renci.io.swagger/swagger-java-comet-client/
implementation ("org.renci.io.swagger:swagger-java-comet-client:1.0.1")
'org.renci.io.swagger:swagger-java-comet-client:jar:1.0.1'
<dependency org="org.renci.io.swagger" name="swagger-java-comet-client" rev="1.0.1">
  <artifact name="swagger-java-comet-client" type="jar" />
</dependency>
@Grapes(
@Grab(group='org.renci.io.swagger', module='swagger-java-comet-client', version='1.0.1')
)
libraryDependencies += "org.renci.io.swagger" % "swagger-java-comet-client" % "1.0.1"
[org.renci.io.swagger/swagger-java-comet-client "1.0.1"]

Dependencies

compile (6)

Group / Artifact Type Version
com.googlecode.json-simple : json-simple jar 1.1.1
io.swagger : swagger-annotations jar 1.5.15
com.squareup.okhttp : okhttp jar 2.7.5
com.squareup.okhttp : logging-interceptor jar 2.7.5
com.google.code.gson : gson jar 2.8.1
org.threeten : threetenbp jar 1.3.5

test (1)

Group / Artifact Type Version
junit : junit jar 4.12

Project Modules

There are no modules declared in this project.

comet-client

Requirements

Building the API client library requires Maven to be installed.

Installation

To install the API client library to your local Maven repository, simply execute:

mvn install

To deploy it to a remote Maven repository instead, configure the settings of the repository and execute:

mvn deploy

Refer to the official documentation for more information.

Maven users

Add this dependency to your project's POM:

<dependency>
    <groupId>org.renci.io.swagger</groupId>
    <artifactId>swagger-java-comet-client</artifactId>
    <version>1.0.0</version>
    <scope>compile</scope>
</dependency>

Gradle users

Add this dependency to your project's build file:

compile "io.swagger:swagger-java-comet-client:1.0.0"

Others

At first generate the JAR by executing:

mvn package

Then manually install the following JARs:

  • target/swagger-java-comet-client-1.0.0.jar
  • target/lib/*.jar

Getting Started

Please follow the installation instruction and execute the following Java code:

import org.renci.io.swagger.client.*;
import org.renci.io.swagger.client.auth.*;
import org.renci.io.swagger.client.model.*;
import org.renci.io.swagger.client.api.DefaultApi;

import java.io.File;
import java.util.*;

public class DefaultApiExample {

    public static void main(String[] args) {
        
        DefaultApi apiInstance = new DefaultApi();
        String contextID = "contextID_example"; // String | 
        String family = "family_example"; // String | 
        String key = "key_example"; // String | 
        String readToken = "readToken_example"; // String | 
        String writeToken = "writeToken_example"; // String | 
        try {
            CometResponse result = apiInstance.deleteScopeDelete(contextID, family, key, readToken, writeToken);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#deleteScopeDelete");
            e.printStackTrace();
        }
    }
}

Documentation for API Endpoints

All URIs are relative to https://localhost:8080

Class Method HTTP request Description
DefaultApi deleteScopeDelete DELETE /deleteScope Delete scope within a context.
DefaultApi enumerateScopeGet GET /enumerateScope Retrieve a list of existing scopes within a given context.
DefaultApi getVersionGet GET /getVersion Retrieve the current Comet version and Comet API version.
DefaultApi readScopeGet GET /readScope Retrieve a value from a named scope within a context.
DefaultApi writeScopePost POST /writeScope Create or modify a named scope for slice/sliver within a context, with visibility label (user_key

Documentation for Models

Documentation for Authorization

All endpoints do not require authorization. Authentication schemes defined for the API:

Recommendation

It's recommended to create an instance of ApiClient per thread in a multithreaded environment to avoid any potential issues.

Author

[email protected]

org.renci.io.swagger

RENCI NRIG

Network Research and Infrastructure Group, RENCI/UNC Chapel Hill

Versions

Version
1.0.1
1.0.0