oracle.cloud.mobile.sync.mobileEndpoint

Class MobileEndpoint

java.lang.Object

oracle.cloud.mobile.sync.mobileEndpoint.MobileEndpoint

public class MobileEndpoint
extends java.lang.Object

Class that represents an endpoint in a custom API.

Constructor Summary

Constructors

Constructor and Description
MobileEndpoint(Synchronization synchronization, java.lang.String apiName, java.lang.String endpointPath, java.lang.Class mobileObjectClass) Creates a new MobileEndpoint object with specified settings.

Method Summary

Modifier and Type	Method and Description
MobileFile	createFile() Creates a new MobileFile.
MobileObject	createObject() Creates a new MobileObject.
FetchFileBuilder	fetchFile(java.lang.String id) Retrieves a FetchFileBuilder object from the endpoint.
FetchObjectBuilder	fetchObject(java.lang.String id) Retrieves a FetchObjectBuilder from endpoint with specified ID.
FetchCollectionBuilder	fetchObjects() Fetches a collection of objects from the endpoint.
java.lang.String	getApiName() Returns the name of the custom API.
java.lang.String	getEndpointPath() Returns the path to the API endpoint.
protected java.lang.String	getHeaderValue(java.util.Map headers, java.lang.String header)

Methods inherited from class java.lang.Object

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

Constructor Detail

MobileEndpoint

public MobileEndpoint(Synchronization synchronization,
                      java.lang.String apiName,
                      java.lang.String endpointPath,
                      java.lang.Class mobileObjectClass)

Creates a new MobileEndpoint object with specified settings.

Parameters:

synchronization - Synchronization Class Object

apiName - name of the custom code API

endpointPath - MobileEndPoint path to the API

mobileObjectClass - MobileObject class object

Method Detail

getApiName

public java.lang.String getApiName()

Returns the name of the custom API.

Returns:

name of the custom API

getEndpointPath

public java.lang.String getEndpointPath()

Returns the path to the API endpoint.

Returns:

endpoint path to the API

createObject

public MobileObject createObject()

Creates a new MobileObject. The object is not uploaded to the service. Explicitly MobileObject.saveResource() should be invoked.

Returns:

A local MobileObject

createFile

public MobileFile createFile()

Creates a new MobileFile. The object is not uploaded to the service. Explicitly MobileFile.saveResource() should be invoked.

Returns:

A local MobileFile

fetchObjects

public FetchCollectionBuilder fetchObjects()

Fetches a collection of objects from the endpoint. If the collection exists in the cache, the cached copy is returned. Otherwise, it is downloaded from the service.

Returns:

An FetchCollectionBuilder object

fetchObject

public FetchObjectBuilder fetchObject(java.lang.String id)

Retrieves a FetchObjectBuilder from endpoint with specified ID.

Parameters:

id - ID of the MobileObject

Returns:

A FetchObjectBuilder object

fetchFile

public FetchFileBuilder fetchFile(java.lang.String id)

Retrieves a FetchFileBuilder object from the endpoint.

Parameters:

id - ID of the MobileFile

Returns:

A FetchFileBuilder object

getHeaderValue

protected java.lang.String getHeaderValue(java.util.Map headers,
                                          java.lang.String header)