Package com.onslip360

Class AbstractAPI<This extends AbstractAPI<This>>

java.lang.Object

com.onslip360.AbstractAPI<This>

All Implemented Interfaces:

Cloneable

Direct Known Subclasses:

API

public class AbstractAPI<This extends AbstractAPI<This>>
extends Object
implements Cloneable

Field Summary

Fields

Modifier and Type	Field	Description
static String	eventStreamType
static String	jsonType
static String	octetStreamType

Constructor Summary

Constructors

Constructor	Description
AbstractAPI(String base, String realm, String id, String key)

Method Summary

Modifier and Type	Method	Description
This	appName(String name)
This	at(String date)
This	at(Date date)
static API.DataStream	dataStream(InputStream is, long length, String type, String name)
static Date	date(String date)
static String	date(Date date)
This	failoverServiceEndpoint()
static API.DataStream	fileStream(File file, String type, String name)
This	forRealm(String realm, String id, String key)
String[]	getServiceEndpoints()
This	header(String name, String value)
This	ifMatch(String etag)
This	ifNoneMatch(String etag)
static String[]	oauthPKCE()
This	onProgress(ProgressHandler progress)
This	onResponseMetadata(ResponseMetadataHandler metadata)
ServerSentEvent.SSEStream<Map<String,Object>>	openEventStream(String id)
This	possess(String userAlias, String realm)
This	qp(String name, Boolean value)
This	qp(String name, Number value)
This	qp(String name, String value)
static String	query(String pattern, Object... args)
String	realm()
<T extends Onslip360Object<?>> void	request(String method, String path, T payload)
<T extends Onslip360Object<?>,R extends Onslip360Object<?>> R[]	requestArray(String method, String path, T payload, Class<R> type)
This	requestHandler(RequestHandler requestHandler)
<T extends Onslip360Object<?>,R extends Onslip360Object<?>> R	requestObject(String method, String path, T payload, Class<R> type)
This	setServiceEndpoints(API.ServiceEndpoint[] ses, boolean keepConstructorEndpoint)
static String	url(String pattern, Object... args)

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

eventStreamType

public static final String eventStreamType

See Also:

Constant Field Values

jsonType

public static final String jsonType

See Also:

Constant Field Values

octetStreamType

public static final String octetStreamType

See Also:

Constant Field Values

Constructor Detail

AbstractAPI

public AbstractAPI(String base,
                   String realm,
                   String id,
                   String key)

Method Detail

date

public static String date(Date date)

date

public static Date date(String date)

query

public static String query(String pattern,
                           Object... args)

url

public static String url(String pattern,
                         Object... args)

dataStream

public static API.DataStream dataStream(InputStream is,
                                        long length,
                                        @Nullable
                                        String type,
                                        @Nullable
                                        String name)

fileStream

public static API.DataStream fileStream(File file,
                                        @Nullable
                                        String type,
                                        @Nullable
                                        String name)
                                 throws FileNotFoundException

Throws:

FileNotFoundException

oauthPKCE

public static String[] oauthPKCE()

realm

@Nonnull
public String realm()

setServiceEndpoints

public This setServiceEndpoints(@Nullable
                                API.ServiceEndpoint[] ses,
                                boolean keepConstructorEndpoint)

getServiceEndpoints

@Nonnull
public String[] getServiceEndpoints()

failoverServiceEndpoint

public This failoverServiceEndpoint()

forRealm

public This forRealm(String realm,
                     @Nullable
                     String id,
                     @Nullable
                     String key)

possess

public This possess(String userAlias,
                    String realm)

at

public This at(@Nullable
               Date date)

at

public This at(@Nullable
               String date)

appName

public This appName(@Nullable
                    String name)

ifMatch

public This ifMatch(@Nullable
                    String etag)

ifNoneMatch

public This ifNoneMatch(@Nullable
                        String etag)

header

public This header(String name,
                   @Nullable
                   String value)

qp

public This qp(String name,
               @Nullable
               String value)

qp

public This qp(String name,
               @Nullable
               Number value)

qp

public This qp(String name,
               @Nullable
               Boolean value)

onProgress

public This onProgress(@Nullable
                       ProgressHandler progress)

onResponseMetadata

public This onResponseMetadata(@Nullable
                               ResponseMetadataHandler metadata)

requestHandler

public This requestHandler(@Nullable
                           RequestHandler requestHandler)

request

public <T extends Onslip360Object<?>> void request(String method,
                                                   String path,
                                                   @Nullable
                                                   T payload)
                                            throws IOException

Throws:

IOException

requestObject

@Nonnull
public <T extends Onslip360Object<?>,R extends Onslip360Object<?>> R requestObject(String method,
                                                                                         String path,
                                                                                         @Nullable
                                                                                         T payload,
                                                                                         Class<R> type)
                                                                                  throws IOException

Throws:

IOException

requestArray

@Nonnull
public <T extends Onslip360Object<?>,R extends Onslip360Object<?>> R[] requestArray(String method,
                                                                                          String path,
                                                                                          @Nullable
                                                                                          T payload,
                                                                                          Class<R> type)
                                                                                   throws IOException

Throws:

IOException

openEventStream

public ServerSentEvent.SSEStream<Map<String,Object>> openEventStream(String id)
                                                                    throws IOException

Throws:

IOException